Исключение тестов с xit

Jasmine предоставляет несколько способов для работы с тестами, один из которых — это исключение тестов, которые в данный момент не требуют выполнения. Для этого используется метод xit, который позволяет пометить тест как исключённый, не удаляя его полностью из кода тестов. Это бывает полезно, например, когда тест ещё не реализован или временно недоступен по какой-то причине.

Метод xit работает аналогично методу it, за исключением того, что тест, обёрнутый в xit, не будет выполняться. Пример использования:

xit('должен правильно работать калькулятор', function() {
    let result = calculator.add(1, 2);
    expect(result).toBe(3);
});

В этом примере тест не будет выполняться, так как он помечен через xit. При этом в отчёте о тестах тест будет отображён как “исключённый”.

Преимущества использования xit

  1. Временное исключение: Когда тесты не работают должным образом по техническим причинам (например, из-за изменений в зависимости или неполного функционала), xit позволяет временно исключить их из набора тестов, не удаляя код.
  2. Чистота кода: Вместо того чтобы полностью комментировать или удалять тесты, можно оставить их в коде, чтобы в будущем легко восстановить выполнение теста.
  3. Инкрементальная разработка: В процессе разработки тесты могут быть написаны заранее, но не все из них могут быть готовы к запуску. В таком случае использование xit позволяет оставить тесты в кодовой базе, не мешая основным тестам, которые уже готовы.

Поведение исключённых тестов

Когда тест помечен как исключённый с помощью xit, он не будет выполнен при запуске тестов. В отчёте тестового фреймворка будет отображаться как пропущенный. Например, в консоли Jasmine можно увидеть следующее:

  x должен правильно работать калькулятор
    - Ignored: Test skipped due to 'xit'

Это позволяет легко отслеживать, какие тесты были исключены и почему они не выполняются.

Рекомендуемые практики использования xit

  • Не использовать в продакшн-коде: Пометка тестов с помощью xit может быть полезной на стадии разработки, но её не следует использовать в финальных версиях кода. Тесты, которые не выполняются, могут создать иллюзию полной проверки кода и привести к незамеченным багам.
  • Комментировать причины исключения: Когда тест исключён с помощью xit, рекомендуется добавить комментарий, поясняющий, почему тест временно отключён. Это поможет другим разработчикам понять контекст и избежать ненужных недоразумений.
xit('должен правильно работать калькулятор', function() {
    // Тест не работает из-за багов в функционале сложения
    let result = calculator.add(1, 2);
    expect(result).toBe(3);
});
  • Использовать для тестов в разработке: Использование xit идеально подходит для тестов, которые ещё не завершены или не реализованы. Это может быть частью тестового подхода, при котором тесты пишутся до кода, но не все они сразу готовы к выполнению.

Отличие от it

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

При этом оба метода — it и xit — могут использоваться в одном наборе тестов, что позволяет управлять тем, какие тесты должны быть выполнены, а какие — нет. Например, в одном проекте можно использовать it для завершённых тестов и xit для тестов, которые пока не готовы.

Пример использования в реальных проектах

Рассмотрим более сложный пример с использованием xit. В проекте разрабатывается библиотека для работы с математическими операциями. Несколько тестов ещё не завершены, и их необходимо временно исключить из общего тестового набора:

describe('Калькулятор', function() {
    it('должен складывать два числа', function() {
        let result = calculator.add(1, 2);
        expect(result).toBe(3);
    });

    xit('должен вычитать два числа', function() {
        let result = calculator.subtract(3, 2);
        expect(result).toBe(1);
    });

    it('должен умножать два числа', function() {
        let result = calculator.multiply(2, 3);
        expect(result).toBe(6);
    });
});

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

Подытожим

Метод xit в Jasmine предоставляет разработчикам гибкий способ временно исключать тесты из набора выполняемых тестов. Это позволяет продолжать работать с кодом, не мешая основным тестам, и временно скрывать недоработанные или неактуальные тесты. Однако важно использовать xit с осторожностью и не злоупотреблять им, чтобы не потерять контроль над состоянием тестируемого кода.

Оглавление