Testes api Pública do Banco Central do Brasil

Projeto de testes automatizados para api Pública do Banco Central do Brasil

Conteúdo

• Estrutura do Projeto
• Requisitos
• Iniciando
• Executando os testes
• Relatório
• Executando com Docker
• Lint do código

Esse projeto inclui:

• Framworks:
  • Supertest
  • Jest
• Features:
  • Data driven testes
  • Validação de Json Schema
  • Cliente http compartilhado
  • Execução com Docker
  • ES6 style class-based approach
  • Formatador e lint de código (ESlint, Prettier)
  • Relatório em html

Estrutura do Projeto:

.
├── babel.config.js
├── base-files // Arquivos base usados para comparação nos testes
│   └── json
│       ├── cotacao_do_dia_10_05_2020.json
│       └── schema_cotacao_do_dia.json
├── config
│   ├── config.json // Contém as configurações como baseUrl e outras
│   └── EnvironmentVariables.js
├── Dockerfile
├── helpers // Coleção de classes com funções de apoio aos testes
│   ├── Cliente.helper.js //Cliente http compartilhado entre os testes
│   ├── FileSystem.helper.js
│   └── Schemavalidator.helper.js
├── jest.setup.js
├── LICENSE
├── Makefile
├── package.json
├── README.md
├── specs // Pasta que contém os arquivos de testes
│   └── CotacaoDoDIa.test.js //Arquivo com os testes automatizados
└── yarn.lock

Requisitos

• node >= 12.18.x - Como instalar o Node
• yarn >= 1.21.x - Como instalar o Yarn
• Docker (Opcional) >= 18.09 - Como instalar o Docker

Iniciando

Clonar o repositório:

$ git clone https://github.com/Schveitzer/testes-api-banco-central.git
$ cd testes-api-banco-central

Instalar as dependências:

$ yarn install

Para executar os testes:

$ yarn init:tests

Relatório de execução

Será gerado um relatório no formato html na pasta: /relatorios/report.html

Executando com Docker

Para executar os testes usando docker:

Buildar a imagem:

$ make -i build

Executar os testes:

$ make test.run

Copiar o relatório gerado:

O arquivo será copiado para a pasta /relatorios

$ make get.report

Lint do Código

Para executar o lint do código execute:

$ yarn code:format

Base url e outras configurações

As variaveis de ambiente usadas no testes são carregadas a partir do arquivo EnvironmentVariables.js , para alterar o endereço do base_url edite o endereço no arquivo config.json.