maximilianoalves / supertest-arch-example

pt_BR: Este projeto tem por objetivo apresentar uma arquitetura de testes de API utilizando SuperTest. // en_US: This project has with main objective show a simple architecture for api tests using SuperTest framework.

Architecture example using SuperTest for api tests

Para acessar a versão em Português do Brasil, basta clicar aqui! 🇧🇷

This project has with main objective show a simple architecture for api tests using SuperTest framework.

Technologies and tools used:

• ServeRest
• Javascript
• Supertest
• chai
• joi
• faker.js
• mocha
• mochawesome

File Structure

📦 supertest-arch-example
┣ 📂 .github
┃ ┗ 📂 workflows
┃ ┃ ┗ 📜 deploy.yml
┣ 📂 env
┃ ┗ 📜 production.env.json
┣ 📂 report
┃ ┣ 📂 assets
┃ ┗ 📜 index.html
┣ 📂 test
┃ ┣ 📂 login
┃ ┃ ┣ 📂 payloads
┃ ┃ ┃ ┗ 📜 login.payload.js
┃ ┃ ┣ 📂 requests
┃ ┃ ┃ ┗ 📜 login.request.js
┃ ┃ ┗ 📂 tests
┃ ┃ ┃ ┣ 📜 login.post.test.js
┃ ┣ 📂 produtos
┃ ┗ 📂 usuarios
┃ ┃ ┣ 📂 schemas
┃ ┃ ┃ ┣ 📜 usuario.schema.js
┃ ┃ ┃ ┗ 📜 usuarios.schema.js
┃ ┃ ┣ 📂 payloads
┃ ┃ ┃ ┗ 📜 usuario.payload.js
┃ ┃ ┣ 📂 requests
┃ ┃ ┃ ┗ 📜 usuarios.request.js
┃ ┃ ┗ 📂 tests
┃ ┃ ┃ ┣ 📜 usuarios.delete.test.js
┃ ┃ ┃ ┣ 📜 usuarios.get.test.js
┃ ┃ ┃ ┗ 📜 usuarios.post.test.js
┣ 📂 utils
┃ ┗ 📜 global.js
┣ 📜 .gitignore
┣ 📜 .mocharc.js
┣ 📜 README.md
┣ 📜 package-lock.json
┗ 📜 package.json

Execution Examples

• By npm:

  • To run all tests suite:
    • npm run test:prod
  • Only json schema tests suite:
    • npm run test:prod:schema

• By the command line:

  • To run all tests suite:
    • NODE_ENV=production mocha
  • Only json schema tests suite:
    • NODE_ENV=production mocha --grep=schema

Execution report

Using the mochawesome and git workflows:

• Job:
  • https://github.com/maximilianoalves/supertest-arch-example/actions/workflows/deploy.yml
• Report:
  • https://maximilianoalves.github.io/supertest-arch-example/

Doubts or improvements !? contact me: