Function coverage

Определение покрытия функций

Покрытие функций (Function Coverage) — это метрика тестирования, которая определяет, насколько полно тесты покрывают все функции или методы в коде. В контексте Jasmine, покрытия функций могут оцениваться на основе того, были ли вызваны все функции, написанные в коде, и были ли они протестированы с использованием различных данных и условий.

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

Структура теста в Jasmine

Jasmine использует различные блоки для написания тестов: describe, it, beforeEach, afterEach, а также утверждения (assertions) для проверки результатов работы функций. Чтобы обеспечить покрытие всех функций, необходимо протестировать каждую функцию, описанную в проекте, с разнообразными входными данными.

Пример базового теста:

describe("MyFunction", function() {
    it("должен вернуть правильный результат при корректных данных", function() {
        let result = MyFunction(2, 3);
        expect(result).toBe(5);
    });
});

Зачем нужно покрытие функций

Покрытие функций помогает:

Убедиться в корректности кода. Все функции должны быть протестированы на предмет выполнения своих обязанностей. Это помогает минимизировать ошибки и уязвимости.
Повысить уверенность в изменениях. При добавлении или изменении функционала тесты могут быть запущены, чтобы проверить, что новые изменения не нарушают работоспособность существующих функций.
Поддержка чистоты кода. Когда все функции покрыты тестами, становится проще поддерживать и расширять проект, ведь изменение одного компонента можно сразу протестировать.

Как достичь полного покрытия функций

Для достижения полного покрытия функций с помощью Jasmine, необходимо:

Покрытие каждой функции. Каждая функция в проекте должна быть протестирована хотя бы один раз. Это включает в себя как публичные методы, так и приватные, если это возможно.
Тестирование всех веток. Важно учитывать, что функции могут содержать различные условия и ветвления (например, операторы if, switch, циклы). Все возможные пути выполнения функции должны быть протестированы.

Пример функции с условием:

function checkNumber(num) {
    if (num > 0) {
        return "positive";
    } else if (num < 0) {
        return "negative";
    } else {
        return "zero";
    }
}

Для покрытия этой функции необходимо написать тесты для всех ветвей:

describe("checkNumber", function() {
    it("должен вернуть 'positive' для положительных чисел", function() {
        expect(checkNumber(1)).toBe("positive");
    });
    
    it("должен вернуть 'negative' для отрицательных чисел", function() {
        expect(checkNumber(-1)).toBe("negative");
    });
    
    it("должен вернуть 'zero' для нуля", function() {
        expect(checkNumber(0)).toBe("zero");
    });
});

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

Пример с использованием шпионов:

describe("someMethod", function() {
    it("должен вызвать callback с правильными параметрами", function() {
        let spy = jasmine.createSpy("callback");
        someMethod(spy);
        expect(spy).toHaveBeenCalledWith("expected parameter");
    });
});

Тестирование исключений. Функции должны правильно обрабатывать исключения, поэтому важно проверить, как они себя ведут в случае ошибок. Для этого можно использовать try-catch и другие механизмы обработки ошибок.

Пример теста на исключение:

describe("handleError", function() {
    it("должен выбрасывать исключение при неправильном входе", function() {
        expect(function() { handleError(null); }).toThrowError("Invalid input");
    });
});

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

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

При настройке покрытия с помощью Istanbul можно подключить плагин и запустить тесты с параметром для сбора информации о покрытии:

istanbul cover jasmine-node --coverage

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

Поддержание покрытия функций

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

Автоматическое добавление новых тестов при добавлении нового кода.
Использование систем непрерывной интеграции (CI), чтобы автоматически запускать тесты и контролировать покрытие.
Анализ покрытия на регулярной основе для выявления незаполненных частей кода.