Skip to content

Teste na API ServerRest com automação e report Newman

Notifications You must be signed in to change notification settings

inessmelo/ServerRest_API

Repository files navigation

📌 ServerRest_API

  • Descrição: é uma API REST gratuita que simula uma loja virtual com intuito de servir de material de estudos de testes de API.
  • Documentação: ServeRest Swagger


🎯 Propósito do Repositório

Este repositório tem como único objetivo servir de espaço para estudos e testes pessoais, com foco no aprendizado e prática de testes de serviços (APIs).

Important

  • O conteúdo aqui presente não deve ser utilizado em ambientes produtivos.
  • O repositório não representa um produto final, mas sim um ambiente experimental para treinamento, aprimoramento de habilidades e validação de conceitos relacionados a testes de API.
  • As implementações podem sofrer alterações constantes durante o processo de aprendizagem.


📖 Índice

  • Sobre o Projeto
  • Tecnologias Utilizadas
  • Estrutura do Projeto
  • Como Executar
  • Resultados e Demonstrações
  • Aprendizados e Contribuições
  • Próximos Passos


📝 Sobre o Projeto

  • Objetivo principal: Servir como ambiente de estudo contínuo e aperfeiçoamento em testes de serviços (APIs).
  • Contexto: Projeto criado no âmbito de desafios de QA e prática pessoal, com foco no desenvolvimento de habilidades em automação de testes.
  • Problemas abordados:
    • Automação de dados para permitir sua reutilização em diferentes requisições e reduzindo retrabalho.
    • Uso de randomização de dados dentro das coleções do Postman, garantindo maior robustez e variedade nos cenários de teste.


🛠 Tecnologias Utilizadas

  • Linguagem: JavaScript
  • Ferramentas: Postman , Newman, JS
  • Tipos de Teste: Teste Funcional e Automação


📂 Estrutura do Projeto

  • README.md = Arquivo de informação sobre o projeto de teste
  • ServerRest.postman_collection.json = Collection com os Cenarios de testes elaborados
  • ServerRest.postman_environment.json = Variaveis utilizadas para a automação dos cenarios de testes implemnentados na Collection


▶️ Como Executar

  1. Ter uma conta no Postman;

  2. Instale o Node.JS em seu computador

  3. Verificar se o Node e NPM foram instalados corretamente;

    No console (eu utilizo o GitBash) digitar os comandos node -v e npm -v

    image image
  4. Exportar toda a Collection e toda a Environment do Postman e add em um pasta;

  5. Instalar o Newman de forma global via linha de comando;

npm install -g newman

Verificar no console se foi instalado corretamente digitando o comando newman -v
image

  1. Instalar o Report Newman em HTML de forma global via linha de comando
npm install -g newman-reporter-htmlextra
  1. Rodar o Newman newman run e o Report HTML -r htmlreport junto com a collection e o environment
    newman run ServerRest.postman_collection.json -e ServerRest.postman_environment.json -r cli,htmlextra
    


📊 Resultados e Demonstrações

  • Criação de relatórios detalhados (Status Report) utilizando o Newman via linha de comando, garantindo maior visibilidade e rastreabilidade dos resultados dos testes.

    • Visualizando com Report CLI

    • image
    • Visualizando com Report HMTLExtra

    image


🚀 Aprendizados e Contribuições

  1. Criação de scripts em JavaScript para geração de massa de dados utilizada nas requisições;
  2. Randomização com comando Random do Postman;
  3. Reaproveitamento da massa de dados gerada em requisições anteriores para utilização em chamadas subsequentes.
  4. Expansão e detalhamento de cenários de teste dentro de cada requisição, cobrindo suas respectivas rotas.
  5. Geração de relatórios de execução por meio da integração do Newman.
  6. Automatizar a subida dos testes do Postman em tempo real para o GitHub sem efetuar comando GIT via SSH.
  7. Rodar na pipeline Gitction a automação
    7.1. Dificuldade: Codigo para automatizar onde quebrava a pipeline
    7.2. Identificar o erro - versão 7.3. Resolver o conflito de versão e rodar td scrit da atuomação via pipeline a cada pull/push


📌 Próximos Passos

  • Adicionar testes de regressão
  • Criar relatórios automáticos de QA
  • Expandir documentação


👩‍💻 Contatos

About

Teste na API ServerRest com automação e report Newman

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published