M

MLOG

Русский

Полное руководство по интеграционному тестированию с упором на тестирование API с использованием Supertest, охватывающее настройку, лучшие практики и передовые методы для надежного тестирования приложений.

Интеграционное тестирование: освоение тестирования API с помощью Supertest

В сфере разработки программного обеспечения крайне важно убедиться, что отдельные компоненты корректно функционируют в изоляции (модульное тестирование). Однако не менее важно проверить, что эти компоненты без проблем работают вместе. Именно здесь в игру вступает интеграционное тестирование. Интеграционное тестирование фокусируется на проверке взаимодействия между различными модулями или сервисами внутри приложения. В этой статье мы подробно рассмотрим интеграционное тестирование, уделив особое внимание тестированию API с помощью Supertest — мощной и удобной библиотеки для проверки HTTP-утверждений в Node.js.

Что такое интеграционное тестирование?

Интеграционное тестирование — это вид тестирования программного обеспечения, при котором отдельные программные модули объединяются и тестируются как единая группа. Его цель — выявить дефекты во взаимодействиях между интегрированными частями. В отличие от модульного тестирования, которое сосредоточено на отдельных компонентах, интеграционное тестирование проверяет поток данных и поток управления между модулями. Распространенные подходы к интеграционному тестированию включают:

В контексте API интеграционное тестирование включает проверку того, что различные API корректно работают вместе, что данные, передаваемые между ними, согласованы, и что система в целом функционирует так, как ожидается. Например, представьте приложение для электронной коммерции с отдельными API для управления продуктами, аутентификации пользователей и обработки платежей. Интеграционное тестирование гарантирует, что эти API правильно взаимодействуют, позволяя пользователям просматривать товары, безопасно входить в систему и совершать покупки.

Почему важно интеграционное тестирование API?

Интеграционное тестирование API критически важно по нескольким причинам:

Рассмотрим глобальную платформу для бронирования путешествий. Интеграционное тестирование API имеет первостепенное значение для обеспечения бесперебойной связи между API, обрабатывающими бронирование авиабилетов, отелей и платежными шлюзами из разных стран. Неправильная интеграция этих API может привести к некорректным бронированиям, сбоям платежей и плохому пользовательскому опыту, что негативно скажется на репутации и доходах платформы.

Представляем Supertest: мощный инструмент для тестирования API

Supertest — это высокоуровневая абстракция для тестирования HTTP-запросов. Он предоставляет удобный и текучий (fluent) API для отправки запросов к вашему приложению и проверки ответов. Созданный на базе Node.js, Supertest специально разработан для тестирования HTTP-серверов на Node.js. Он отлично работает с популярными фреймворками для тестирования, такими как Jest и Mocha.

Ключевые особенности Supertest:

Настройка тестовой среды

Прежде чем мы начнем, давайте настроим базовую тестовую среду. Предполагается, что у вас установлены Node.js и npm (или yarn). Мы будем использовать Jest в качестве фреймворка для тестирования и Supertest для тестирования API.

  1. Создайте проект Node.js:
mkdir api-testing-example
cd api-testing-example
npm init -y
  1. Установите зависимости:
npm install --save-dev jest supertest
npm install express  # Или ваш предпочитаемый фреймворк для создания API
  1. Настройте Jest: Добавьте следующее в ваш файл package.json:
{
  "scripts": {
    "test": "jest"
  }
}
  1. Создайте простой API-эндпоинт: Создайте файл с именем app.js (или аналогичным) со следующим кодом:
const express = require('express');
const app = express();
const port = 3000;

app.get('/hello', (req, res) => {
  res.send('Hello, World!');
});

app.listen(port, () => {
  console.log(`Example app listening at http://localhost:${port}`);
});

module.exports = app; // Экспортируем для тестирования

Написание вашего первого теста с Supertest

Теперь, когда наша среда настроена, давайте напишем простой тест с Supertest для проверки нашего API-эндпоинта. Создайте файл с именем app.test.js (или аналогичным) в корне вашего проекта:

const request = require('supertest');
const app = require('./app');

describe('GET /hello', () => {
  it('responds with 200 OK and returns "Hello, World!"', async () => {
    const response = await request(app).get('/hello');
    expect(response.statusCode).toBe(200);
    expect(response.text).toBe('Hello, World!');
  });
});

Объяснение:

Чтобы запустить тест, выполните следующую команду в вашем терминале:

npm test

Если все настроено правильно, вы должны увидеть, что тест прошел успешно.

Продвинутые техники Supertest

Supertest предлагает широкий спектр возможностей для продвинутого тестирования API. Давайте рассмотрим некоторые из них.

1. Отправка тел запросов

Для отправки данных в теле запроса вы можете использовать метод .send(). Например, давайте создадим эндпоинт, который принимает данные в формате JSON:

app.post('/users', express.json(), (req, res) => {
  const { name, email } = req.body;
  // Симулируем создание пользователя в базе данных
  const user = { id: Date.now(), name, email };
  res.status(201).json(user);
});

Вот как можно протестировать этот эндпоинт с помощью Supertest:

describe('POST /users', () => {
  it('creates a new user', async () => {
    const userData = {
      name: 'John Doe',
      email: 'john.doe@example.com',
    };

    const response = await request(app)
      .post('/users')
      .send(userData)
      .expect(201);

    expect(response.body).toHaveProperty('id');
    expect(response.body.name).toBe(userData.name);
    expect(response.body.email).toBe(userData.email);
  });
});

Объяснение:

2. Установка заголовков

Для установки пользовательских заголовков в ваших запросах вы можете использовать метод .set(). Это полезно для установки токенов аутентификации, типов контента или других пользовательских заголовков.

describe('GET /protected', () => {
  it('requires authentication', async () => {
    const response = await request(app).get('/protected').expect(401);
  });

  it('returns 200 OK with a valid token', async () => {
    // Симулируем получение валидного токена
    const token = 'valid-token';

    const response = await request(app)
      .get('/protected')
      .set('Authorization', `Bearer ${token}`)
      .expect(200);

    expect(response.text).toBe('Protected Resource');
  });
});

Объяснение:

3. Работа с Cookies

Supertest также может работать с cookies. Вы можете устанавливать cookies с помощью метода .set('Cookie', ...), или вы можете использовать свойство .cookies для доступа и изменения cookies.

4. Тестирование загрузки файлов

Supertest можно использовать для тестирования API-эндпоинтов, которые обрабатывают загрузку файлов. Вы можете использовать метод .attach() для прикрепления файлов к запросу.

5. Использование библиотек утверждений (Chai)

Хотя встроенной библиотеки утверждений Jest достаточно для многих случаев, вы также можете использовать более мощные библиотеки утверждений, такие как Chai, вместе с Supertest. Chai предоставляет более выразительный и гибкий синтаксис утверждений. Чтобы использовать Chai, вам нужно его установить:

npm install --save-dev chai

Затем вы можете импортировать Chai в ваш тестовый файл и использовать его утверждения:

const request = require('supertest');
const app = require('./app');
const chai = require('chai');
const expect = chai.expect;

describe('GET /hello', () => {
  it('responds with 200 OK and returns "Hello, World!"', async () => {
    const response = await request(app).get('/hello');
    expect(response.statusCode).to.equal(200);
    expect(response.text).to.equal('Hello, World!');
  });
});

Примечание: Возможно, вам потребуется настроить Jest для корректной работы с Chai. Это часто включает добавление файла настройки, который импортирует Chai и настраивает его для работы с глобальным expect от Jest.

6. Повторное использование агентов

Для тестов, которые требуют настройки определенной среды (например, аутентификации), часто бывает полезно повторно использовать агент Supertest. Это позволяет избежать избыточного кода настройки в каждом тестовом случае.

describe('Authenticated API Tests', () => {
  let agent;

  beforeAll(() => {
    agent = request.agent(app); // Создаем постоянный агент
    // Симулируем аутентификацию
    return agent
      .post('/login')
      .send({ username: 'testuser', password: 'password123' });
  });

  it('can access a protected resource', async () => {
    const response = await agent.get('/protected').expect(200);
    expect(response.text).toBe('Protected Resource');
  });

  it('can perform other actions that require authentication', async () => {
    // Выполняем здесь другие действия, требующие аутентификации
  });
});

В этом примере мы создаем агент Supertest в хуке beforeAll и аутентифицируем его. Последующие тесты в блоке describe могут затем повторно использовать этот аутентифицированный агент, не требуя повторной аутентификации для каждого теста.

Лучшие практики интеграционного тестирования API с Supertest

Для обеспечения эффективного интеграционного тестирования API рассмотрите следующие лучшие практики:

Распространенные ошибки, которых следует избегать

Заключение

Интеграционное тестирование API является неотъемлемой частью процесса разработки программного обеспечения. Используя Supertest, вы можете легко писать исчерпывающие и надежные тесты интеграции API, которые помогают обеспечить качество и стабильность вашего приложения. Не забывайте сосредотачиваться на тестировании сквозных рабочих процессов, использовании реалистичных данных, изоляции тестов и автоматизации процесса тестирования. Следуя этим лучшим практикам, вы можете значительно снизить риск проблем с интеграцией и поставлять более надежный и стабильный продукт.

По мере того как API продолжают быть движущей силой современных приложений и микросервисных архитектур, важность надежного тестирования API, и особенно интеграционного тестирования, будет только расти. Supertest предоставляет мощный и доступный инструментарий для разработчиков по всему миру для обеспечения надежности и качества их взаимодействий через API.