https://github.com/leohspaixao/cypress-serverest

Repositório para fins de estudo de API testing automation.
https://github.com/leohspaixao/cypress-serverest

Last synced: 17 days ago
JSON representation

Repositório para fins de estudo de API testing automation.

• Host: GitHub
• URL: https://github.com/leohspaixao/cypress-serverest
• Owner: LeohsPaixao
• License: mit
• Created: 2023-12-15T17:22:50.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-20T14:56:53.000Z (2 months ago)
• Last Synced: 2024-11-20T15:41:29.879Z (2 months ago)
• Language: JavaScript
• Size: 249 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# **Teste Automatizado de API com Cypress e ServeREST**

Este projeto visa realizar testes automatizados de API utilizando a ferramenta Cypress em conjunto com a API ServeREST.

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

[![Node.js Version](https://img.shields.io/badge/Node.js-%3E=20.9.0-brightgreen.svg)](https://nodejs.org/)

[![Badge ServeRest](https://img.shields.io/badge/API-ServeRest-green)](https://github.com/ServeRest/ServeRest/)

## ServeREST

O ServeREST é uma API RESTful de teste, disponível em [ServeREST GitHub](https://github.com/ServeRest/ServeRest). Certifique-se de referenciar este projeto ao utilizar a API em seus testes.

## GitHub Actions

Este projeto está integrado ao GitHub Actions para automação de testes. Os testes são executados automaticamente em cada push para o repositório.

## Configuração do Ambiente

Certifique-se de ter as versões corretas do Node.js, Cypress e ServeREST instaladas.

 ````json

  { "node": "20.9.0",   "cypress": "13.6.1",   "serveRest": "2.28" }

 ````

## Configuração

1. **Clonar o repositório e instale as dependências**

 ````bash

    git clone [email protected]:LeohsPaixao/cypress-serveRest.git

    cd cypress-serveRest

    npm install

 ````

2. **Inicie o servidor ServeRest**

   Obs.: É necessário abrir um terminal separado para rodar o servidor do ServeRest.

 ````bash

    npm start # Abrirá na porta 3000 (Default)

 ````

3. **Rode os testes**

 ````bash

    npm run cy:open # Rode os testes no modo interativo do cypress

    npm run cy:run # Rode os testes no modo headless do cypress

 ````

## Test Report

 **Em Desenvolvimento 🛠️**

 Este projeto visa utilizar o Allure Report para os reports dos testes tanto no Github Actions quanto localmente. Atualizações sobre o progresso dessa implementação serão fornecidas.

## Exemplos de Uso

 A seguir estão alguns exemplos de código para demonstrar como usar a ferramenta Cypress em conjunto com a API ServeREST.

 ````javascript

 describe('Teste de Login via API', () => {

  it('Deve realizar o login com sucesso', () => {

    cy.request({

      log: true,

      failOnStatusCode: true,

      method: 'POST',

      url: '/login',

      headers: {

        "accept": "application/json",

        "content-type": "application/json"

      },

      body: {

        "email": "[email protected]",

        "password": "teste"

      },

    }).then((response) => {

      console.log(response);

      expect(response.status).to.equal(200);

      expect(response.body.message).to.equal("Login realizado com sucesso");

    });

  });

 })

 ````

## Licença

 Este projeto é licenciado sob a MIT License - veja o arquivo LICENSE para detalhes.