Esse projeto é um template para testes utilizando o Jest e seus facilitadores. Aqui, temos exemplos de testes em uma API usando Supertest. Para a documentação, utilizamos BDD e a biblioteca jest-cucumber para nos auxiliar na escrita.
Antes de começar, verifique se você atendeu aos seguintes requisitos:
-
Você já instalou o node? Caso não tenha instalado, baixe .pkg (Mac OS) e siga as instruções no link abaixo:
-
Caso esteja usando uma distribuição Linux Ubuntu, segue:
Para instalar as dependências desse projeto, siga a(s) instrução/instruções abaixo:
Linux e macOS:
Para esse contexto, iremos usar apenas os comandos de instalação das dependências:
npm i ou npm i -D
Caso você receba uma mensagem de <¡Erro!>, execute o comando dessa forma:
npm i -f ou npm install --force
Se um problema de vulnerabilidade qualquer for apresentado, utilize o seguinte comando:
npm audit fix -f
Para executar esse template, siga estas etapas:
npm run test <-- Para executar esse comando, no arquivo package.json, remova a instrução --detectOpenHandles ou execute:
npm run full
No npm run test serão executados todos os testes e o modo debug estará ativado (vide jest.config.js). Os relatórios gerados ficarão dispostos na pasta jest-reports.
Ao executar o npm run full, o relatório allure-jest abrirá automaticamente no seu navegador padrão.
.
├── sources
| ├── config
| ├── jest-allure
| ├── target
| └── tests
| ├── api
| ├── data
| ├── features
| └── steps
ℹ️ Os relatórios são gerados uma pasta acima (diretório raíz, antes da sources) e estão dispostos na pasta jest-reports. São eles:
╒ jest-allure (main report)
╞ jest-coverage
╞ jest-html-reporters
╞ jest-simple-report (jest-report (default))
╘ jest-stare
Para contribuir com esse template, siga as seguintes etapas:
- Bifurque este repositório (realize um fork conforme instruções da github).
- Crie uma branch:
git checkout -b <nome_branch>. - Faça suas alterações e confirme-as:
git commit -m '<mensagem_commit>'. - Envie para o branch original:
git push origin <nome_do_projeto> / <local>. - Crie a solicitação de pull.
Como alternativa, consulte a documentação do GitHub em como criar uma solicitação de pull request.
Agradecemos às seguintes pessoas que contribuíram para este projeto:
Anderson Patricio |
Lucas Nunes |
Niky Lima |
Roni Garcia |
Fique à vontade para contribuir nesse projeto! Clone, crie sua branch e seja feliz!
↳ Projetos da comunidade fomentadora do Jest
↳ Projeto utilizando Supertest
↳ Projeto utilizando Supertest + Jest
↳ Todos os relatórios integrados com Jest