API do Programa de Gestão (PGD)

Repositório com o código-fonte da API do Programa de Gestão (PGD).

Contextualização

O Programa de Gestão, segundo a Instrução Normativa n.º 65, de 30 de julho de 2020, da Secretaria de Gestão e Desempenho de Pessoal (SGP) do Ministério da Economia, é uma:

ferramenta de gestão autorizada em ato normativo de Ministro de Estado e respaldada pela norma de procedimentos gerais, que disciplina o exercício de atividades em que os resultados possam ser efetivamente mensurados, cuja execução possa ser realizada pelos participantes.

As atividades mensuradas podem ser realizadas tanto presencialmente quanto na modalidade de teletrabalho.

O objetivo desta API integradora é receber os dados enviados por diversos órgãos da administração, de modo a possibilitar a sua consolidação em uma base de dados.

Rodando a API

Instalar Docker CE aqui!
Clonar o repositório:

$ git clone http://git.planejamento.gov.br/seges-cginf/api-pgd.git

Dentro da pasta clonada execute o comando para gerar a imagem docker:

$ cd api-pgd

$ docker build -t api-pgd .

O parâmetro -t api-pgd define uma tag (um nome) para a imagem docker gerada.

Criar diretório com permissão correta para persistência do PgAdmin:

$ sudo mkdir -p pgadmin_data && sudo chown -R 5050:5050 ./pgadmin_data/

Tentar subir os containers:

$ docker-compose up

Vai dar um erro de permissão no pgadmin. Quando a mensagem de erro aparecer, pare os containers (ctrl + C) e digite novamente:

sudo chown -R 5050:5050 ./pgadmin_data/

Para ajustar as permissões de arquivo em todas as novas subpastas.

Para subir os containers:

$ docker-compose up -d

A API está disponível em http://localhost:5057 e em http://localhost:5057/docs você acessa a interface para interagir com a API.

Desenvolvendo

Durante o desenvolvimento é comum a necessidade de inclusão de novas biliotecas python ou a instalação de novos pacotes linux. Para que as mudanças surtam efeitos é necessário apagar os containers e refazer a imagem docker.

Desligando e removendo os conteiners:

$ docker-compose down

Buildando novamente o Dockerfile para gerar uma nova imagem:

$ docker build --rm -t api-pgd .

O parâmetro --rm remove a imagem criada anteriormente. 3. Agora a aplicação já pode ser subida novamente:

$ docker-compose up -d

Alternativamente você pode subir a aplicação sem o parâmetro detached -d possibilitando visualizar o log em tempo real, muito útil durante o desenvolvimento.

$ docker-compose up

Arquitetura da solução

O arquivo docker-compose.yml descreve a receita dos conteiners que compõem a solução. Atualmente são utilizados 3 containers: um rodando o BD Postgres 11, outro rodando a API e outro rodando o PgAdmin para acessar o Postgres e realizar consultas ou qualquer manipulação no BD. O PgAdmin está rodando em http://localhost:5050.

Dicas

Consulte o docker-compose.yml para descobrir o login e senha do PgAdmin e do Postgres
No PgAdmin utilize 'db' como valor para o endereço do Postgres. Isso é necessário porquê os conteiners utilizam uma rede interna do Docker para se comunicarem
Caso a modelagem ORM seja alterada, pode ser mais simples remover (dropar) o BD e recriá-lo novamente apenas subindo a solução. Para remover o BD utilize o PgAdmin

Rodando testes

É necessário entrar no container para rodar os testes:

$ docker exec -it api-pgd_web_1 /bin/bash

Para rodar os testes execute:

$ pytest test_api.py

Para rodar no modo verboso útil para debugar:

$ pytest test_api.py -vv

Para rodar um teste específico utilize o parâmetro -k. Este exemplo roda apenas o teste test_create_pt_invalid_cpf:

$ pytest test_api.py -k test_create_pt_invalid_cpf -vv

nitaibezerra / api-pgd