Pruebas de APIs con Cypress: POST, PUT y DELETE

Clase 9 de 17 • Curso de Automatización de Pruebas de Backend con Cypress

Contenido del curso

Introduccion a la Automatización Backend

Conociendo Cypress

Validando el contenido de la respuesta

Haciendo diferentes tipos de peticiones

Bases de Datos

Prueba en conjunto

15
Pruebas de Integración entre APIs y Bases de Datos
09:08 min

Próximos pasos

Tomar examen

Resumen

¿Cómo probar peticiones con API usando Cypress?

Las peticiones HTTP son una parte esencial del uso de APIs en el ámbito de desarrollo web. En esta clase aprenderás a cómo ejecutar un flujo de trabajo que te será de utilidad al probar APIs utilizando Cypress. Aprenderemos a realizar las peticiones POST, GET, PUT y DELETE, además de cómo validar respuestas y gestionar datos de prueba.

¿Cómo crear un archivo de pruebas en Cypress?

Para comenzar, es importante tener un archivo de pruebas donde ejecutar nuestro código. Aquí te mostramos cómo crearlo y realizar una prueba de petición:

describe('Probando requests', () => {
  let empleado;

  before(() => {
    empleado = {
      firstName: 'Javier',
      lastName: 'Prueba',
      email: 'javier@prueba.com'
    };
  });

  it('Debe crear un nuevo empleado', () => {
    cy.request({
      method: 'POST',
      url: '/employees',
      body: empleado
    }).then(response => {
      expect(response.status).to.eq(201);
      expect(response.body).to.have.property('id');
      cy.wrap(response.body.id).as('employeeId');
    });
  });
});

¿Cómo validar los resultados de las pruebas?

Para garantizar que las peticiones han sido exitosas, es crucial validar las respuestas que recibimos al interactuar con las APIs. Aquí tienes cómo hacerlo:

Status Code: Verificamos que el estado devuelto corresponda al esperado, como el 201 al crear un recurso.
Cuerpo de la respuesta: Asegúrate de que los datos retornados sean los enviados.

Ejemplo de validación de respuesta:

cy.request({
  method: 'GET',
  url: `/employees/${this.employeeId}`
}).then(response => {
  expect(response.status).to.eq(200);
  expect(response.body.firstName).to.eq('Javier');
});

¿Cómo actualizar y eliminar un registro?

Modificar y eliminar registros son tareas comunes durante las pruebas. Usamos métodos PUT y DELETE para estas operaciones.

Para actualizar un registro:

cy.request({
  method: 'PUT',
  url: `/employees/${this.employeeId}`,
  body: {
    firstName: 'Pepito',
    lastName: 'Desarrollador',
    email: 'nuevo@correo.com'
  }
}).then(response => {
  expect(response.status).to.eq(200);
  expect(response.body).to.have.property('id', this.employeeId);
});

Para eliminar un registro:

cy.request({
  method: 'DELETE',
  url: `/employees/${this.employeeId}`
}).then(response => {
  expect(response.status).to.eq(200);
});

¿Qué hacer para evitar dejar datos de prueba en la base de datos?

Es importante no dejar trazos de nuestros datos de prueba en la base de datos. Por ello, considera eliminar datos de prueba al finalizar el test. También, los hooks de Cypress pueden automatizar estas acciones.

Reto: Lleva este flujo al siguiente nivel. Usa hooks de Cypress para crear y limpiar automáticamente tus datos antes y después de las pruebas. Esto mejora la confiabilidad y limpieza de las pruebas.

Próximos pasos en la exploración de APIs

Las APIs van evolucionando, y entender cómo testear GraphQL será un añadido vital para cualquier tester moderno. En nuestra próxima clase, nos profundizaremos en las APIs de tipo GraphQL, cada vez más adoptadas por empresas por su eficiencia y flexibilidad. No te quedes atrás en esta emocionante área del testing.

Jairo Campos Ruiz

student•

Cypress nos ofrece una manera muy fácil de tener json, imágenes y un sinfín de archivos para poder utilizarlos en las pruebas, por ejemplo si tenemos una api donde tenemos que iniciar sesión con un usuario para hacer peticiones para no tener que escribir esto una y otra vez.

Para poder usarlo vamos a la carpeta fixtures y creamos un archivo json con los datos de employee

{
  "first_name": "Test",
  "last_name": "Last Name",
  "email": "Test@gmail.com",
  "gender": "Male"
}

Luego en el test dentro del describe hacemos un beforeEach

  beforeEach(function () {
    //Es para poder cargar json de la carpeta fixtures, por ejemplo
    //si tenemos usuarios de ejemplo con diferentes niveles de privilegios
    //y queremos estar usándolos continuamente
    cy.fixture("employee.json").then((employee) => {
      this.employee = employee;
    });
  });

Ahora en los test de crear, comprobar y demás podemos hacer uso de los datos que precargamos, no se os puede olvidar que para hacer uso del this las funciones no pueden ser lambdas.

  it("Debe crear un empleado", function () {
    cy.request({
      url: "employees",
      method: "POST",
      body: this.employee,
    }).then((response) => {
      expect(response.status).to.eq(201);
      expect(response.body).to.have.property("id");

      const id = response.body.id;
      cy.wrap(id).as("id");
    });
  });

Ahora para comprobar si se ha creado no tenemos porque traernos todos los resultados podemos usar el id, aparte aquí en lugar de comprobar solo el nombre compruebo el cuerpo entero del body.

  it("Debe de validar que se haya creado en la base de datos comprobando todos los parámetros", function () {
    cy.request("GET", `employees/${this.id}`).then((response) => {
      expect(response.body).deep.equal({
        id: this.id,
        ...this.employee,
      });
    });
  });

Cuantos menos datos tengamos hardcodeados menos frágiles serán nuestros tests.

Emmanuel Rodríguez

student•

¡Genial! 🤟 Esto esta genial cuando desde nuestro Frontend tenemos la posibilidad de utilizar un server como propio lo qué, al realizar por UI peticiones podemos mejor interceptar las operaciones con interceptor. .

Nota. No es necesario que anexes la extensión del archivo, Cypress posee una jerarquía de búsqueda.

. El cual estará realizando "un falso espejo" o mock. Sin embargo, como es nuestro backend (utilizando express / nest / etc.), no podemos lanzar un CRUD porque estaremos lanzando procesos que afectarán en directo en nuestra base de datos. . Te recomiendo que, en cuyo caso, generes un mock de la capa concerniente y cuando lances tu E2E, obtengas por ruta una respuesta deseada. . Por ejemplo, supongamos que tenemos la capa del modelo de la siguiente forma:

// User.entity.ts
type TQUser = { id: number }

// User.model.ts
export default class User {
   // Static response without using the parameter
    findMany(query: TQUser) {
        return {
            "id": 2,
            "name": "Antonina Fawltey",
            "email": "afawltey1@uol.com.br"
        }
    }
}

Entonces, ya que Cypress incorpora SinonJS, una librería similar a Supertest / SuperAgent para pruebas E2E, podemos generar un mock de nuestra capa y por ende, realizar prueba tipo Unit Test.

import User from './models/User.model'

describe('Testing User Routes', () => {
    beforeEach(function () {
        cy.fixture('user').then((user) => this.user = user)
        cy.stub(User.prototype, 'findMany', () => this.user)
    })

    it('should be success and valid response', function () {
        const user = new User()
        const response = user.findMany({id: 2})
        expect(response).to.deep.equal(this.user)
        expect(response).to.have.property('name')
        expect(response).to.have.property('email')
    })
})

Pruebas de APIs con Cypress: POST, PUT y DELETE

Introduccion a la Automatización Backend

Automatización de Pruebas Backend con Cypress

Fundamentos del Backend Testing y APIs

Análisis de APIs con DevTools y Postman

Conociendo Cypress

Configuración de Ambiente de Desarrollo con Cypress y JSON Server

Pruebas de Headers en Cypress para Validar Content Type

Validación de Status Codes en APIs con Cypress

Validando el contenido de la respuesta

Validación de Respuestas HTTP en APIs con Cypress

Validación de Errores en APIs con Cypress

Haciendo diferentes tipos de peticiones