Использование Jest для имитации Elasticsearch

5 декабря 2022 г.

Поскольку вы открыли эту статью, я предполагаю, что вы либо используете Elasticsearch, либо планируете это делать.

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

Текущая компания, в которой я работаю, имеет более 90% покрытия кода как модульными, так и интеграционными тестами! Я бы порекомендовал всем покрыть свою кодовую базу тестами, поскольку, как сказал один мудрый человек:

<цитата>

[Без модульных тестов] Вы не проводите рефакторинг, вы просто меняете дерьмо. — Гамлет Д'Арси

Настройка

Представьте, что у вас есть простой сервер RESTful с некоторой логикой, использующей Elasticsearch. В текущей витрине — CRUD сервер.

const Hapi = require('@hapi/hapi');
const Qs = require('qs');
const {createHandler} = require("./create/index.js");
const {readAllHandler, readHandler} = require("./read/index.js");
const {updateHandler} = require("./update/index.js");
const {deleteAllHandler, deleteHandler} = require("./delete/index.js");

const init = async () => {

    const server = Hapi.server({
    port: 3000,
    host: 'localhost',
    query: {
        parser: (query) => Qs.parse(query)
    }
    });

    server.route({
    method: 'POST',
    path: '/',
    handler: createHandler
    });

    server.route({
    method: 'GET',
    path: '/{id}',
    handler: readHandler
    });

    server.route({
    method: 'GET',
    path: '/',
    handler: readAllHandler
    });

    server.route({
    method: 'PATCH',
    path: '/{id}',
    handler: updateHandler
    });

    server.route({
    method: 'DELETE',
    path: '/{id}',
    handler: deleteHandler
    });

    server.route({
    method: 'DELETE',
    path: '/',
    handler: deleteAllHandler
    });

    await server.start();

    server.events.on('log', (event, tags) => {
    console.log({event}, {tags})
    if (tags.error) {
        console.log(`Server error: ${event.error ? event.error.message : 'unknown'}`);
    }
    });
    console.log('Server running on %s', server.info.uri);
};

process.on('unhandledRejection', (err) => {

    console.log(err);
    process.exit(1);
});

init();

Войти в полноэкранный режим Выйти из полноэкранного режима. Теперь вам нужно покрыть логику каждого маршрута некоторыми тестами, чтобы заблокировать функциональность и предотвратить нарушение бизнес-логики.

Одно из очевидных, но не простых решений — использовать Docker и каждый раз запускать Elastic для тестов.

Однако стоит ли? Я имею в виду, действительно ли вы хотите увеличить время раскрутки конвейерной среды? Есть ли готовые решения для этого?

Этот подключаемый модуль загружает и кэширует двоичный файл Elasticsearch при запуске jest, затем подключаемый модуль автоматически запускает Elastic на определенных портах и отключает его после завершения тестов.

Как добавить тесты?

У меня есть пример настройки шутливых тестов и без них в pull request так что вы можете сравнить все изменения. А теперь давайте рассмотрим это шаг за шагом.