Cadastro de cliente
Cadastro de produto
Contratação de plano
Resgate de plano
Aporte extra

A API implementa todas as regras de negócio necessárias, como validação do período de venda dos produtos, requisitos de valor mínimo de aporte e regras de carência para resgate.

Para qualquer dúvida ou problema, entre em contato com:

Email: [email protected]
Telefone: +55 99955-0862

A aplicação roda na porta https://localhost:8000.
A documentação da API pode ser acessada em https://localhost:8000/docs.

- Docker
- Docker Compose

1. Construir a Imagem Docker

Para construir a imagem Docker do projeto, execute o seguinte comando:

make build
#ou
docker-compose build --no-cache

2. Executar o Projeto

Para iniciar os serviços definidos no docker-compose.yml, execute:

make run
#ou
docker-compose up -d

3. Aplicar Migrações

Para aplicar todas as migrações pendentes, execute:

make db-upgrade
#ou
docker-compose run --rm web poetry run alembic upgrade head

4. Parar os Serviços

Para parar todos os serviços, execute:

make down
#
docker-compose down

Para rodar os testes é necessário que os containers estejam ativos.

1. Executar Testes

Para executar todos os testes, utilize:

make test
# ou
docker-compose run --rm web poetry run pytest tests/ --disable-warnings

Você pode especificar um módulo opcionalmente:

MODULE=unit/cliente make test

2. Executar Testes com relatório de cobertura

Para executar os testes e gerar um relatório de cobertura, utilize:

make test-coverage
# ou
docker-compose run --rm web poetry run pytest --cov=api --cov-report=term-missing --cov-report=html

O relatório será gerado em em htmlcov/index.html, abra o arquivo no seu navegador.

Esta seção apresenta as evidências do funcionamento das apis desenvolvidas para o projeto.

Esta seção apresenta as evidências dos testes realizados no projeto. As evidências incluem a saída dos testes e capturas de tela, proporcionando uma visão clara da cobertura e dos resultados dos testes.

O relatório de cobertura é gerado em uma etapa do CI/CD e pode ser acessado em https://gomeslucasm.github.io/brasil_prev/index.html.

Os testes foram executados utilizando o pytest com cobertura de código. Abaixo estão as saídas dos testes indicando a cobertura para cada módulo.

Os teste foram executados utilizando o comando make test, para garantir que todos os endpoints implementados estejam funcionando corretamente. A imagem abaixo mostra a saída dos testes:

Os testes de cobertura foram executados utilizando o comando make test-coverage, que executa os testes e gera um relatório de cobertura de código. A imagem abaixo mostra a saída do teste de cobertura: