Модульное тестирование в TypeScript
Практики модульного тестирования в проектах TypeScript для обеспечения качества кода.
Модульные тесты проверяют корректность кода. Система типов TypeScript идеально сочетается с фреймворками тестирования, позволяя писать типобезопасный тестовый код.
Схема SVG: рабочий процесс модульного тестирования
Зачем нужно модульное тестирование
Модульное тестирование — важное средство обеспечения качества кода. Оно проверяет корректность кода и предотвращает ошибки.
В проектах TypeScript тестовый код также получает преимущества от системы типов: ошибки типов выявляются во время компиляции, IDE предоставляет интеллектуальные подсказки, а тестовый код становится надёжнее.
Более того, тестовый код — также лучшая документация; через тесты можно понять ожидаемое поведение функций/классов.
Обеспечение качества:Модульные тесты быстро выявляют регрессионные проблемы, гарантируя, что изменения кода не нарушают существующую функциональность.
Настройка фреймворка тестирования
Jest — самый популярный фреймворк тестирования для проектов TypeScript.
Установите Jest
# - ts-jest:Позволяет Jest запускать TypeScript
# - @types/jest:Определения типов для Jest
npm install --save-dev jest ts-jest @types/jest
# Инициализация конфигурации Jest
npx ts-jest config:init
ts-jest:Это препроцессор, который позволяет Jest запускать файлы TypeScript напрямую без ручной компиляции.
Настройте jest.config.js
Настройте тестовую среду Jest.
jest.config.js
// Используйте пресет ts-jest
preset: 'ts-jest',
// Тестовая среда: node или браузер
testEnvironment: 'node',
// Каталог тестовых файлов
roots: ['<rootDir>/src'],
// Шаблон сопоставления тестовых файлов
testMatch: ['**/__tests__/**/*.ts'],
// Поддерживаемые расширения файлов
moduleFileExtensions: ['ts', 'js', 'json'],
// Файлы для сбора покрытия
collectCoverageFrom: [
'src/**/*.ts',
'!src/**/*.d.ts' // Исключить файлы деклараций типов
]
}
Примечания по конфигурации:Тестовые файлы обычно размещаются в каталоге __tests__ или заканчиваются на .test.ts.
Функции тестов
Сначала напишите бизнес-код, который нужно протестировать.
src/utils/calculator.ts
export class Calculator {
// Сложение
add(a: number, b: number): number {
return a + b;
}
// Вычитание
subtract(a: number, b: number): number {
return a - b;
}
// Умножение
multiply(a: number, b: number): number {
return a * b;
}
// Деление
divide(a: number, b: number): number {
if (b === 0) {
throw new Error("Нельзя делить на ноль");
}
return a / b;
}
}
Затем напишите соответствующий тестовый код.
src/utils/calculator.test.ts
// Набор тестов: Тесты для класса Calculator
describe("Calculator", () => {
let calculator: Calculator;
// Создать новый экземпляр Calculator перед каждым тестом
beforeEach(() => {
calculator = new Calculator();
});
// Тест сложения
describe("add", () => {
it("должен складывать два числа", () => {
expect(calculator.add(2, 3)).toBe(5);
});
it("должен обрабатывать отрицательные числа", () => {
expect(calculator.add(-1, 1)).toBe(0);
});
});
// Тест деления
describe("divide", () => {
it("должен делить два числа", () => {
expect(calculator.divide(10, 2)).toBe(5);
});
it("должен выдавать ошибку при делении на ноль", () => {
// Ожидается, что будет выброшена ошибка
expect(() => calculator.divide(10, 0)).toThrow();
});
});
});
Результат выполнения:
Calculator
add
✓ should add two numbers
✓ should handle negative numbers
divide
✓ should divide two numbers
✓ should throw error when dividing by zero
describe/it:describe используется для группировки тестов, а it (или test) используется для определения отдельных тестовых случаев.
Тестирование сервиса
Протестируйте бизнес-логику сервисного слоя.
src/services/userService.ts
export interface User {
id: number;
name: string;
}
// Класс сервиса пользователей
export class UserService {
private users: User[] = [];
private nextId = 1;
// Создать пользователя
createUser(name: string): User {
const user = { id: this.nextId++, name };
this.users.push(user);
return user;
}
// Получить пользователя
getUser(id: number): User | undefined {
return this.users.find(u => u.id === id);
}
// Получить всех пользователей
getAllUsers(): User[] {
return [...this.users];
}
}
src/services/userService.test.ts
describe("UserService", () => {
let service: UserService;
beforeEach(() => {
service = new UserService();
});
describe("createUser", () => {
it("должен создать пользователя с id", () => {
const user = service.createUser("Alice");
expect(user.id).toBe(1);
expect(user.name).toBe("Alice");
});
it("должен увеличивать id для каждого пользователя", () => {
const user1 = service.createUser("Alice");
const user2 = service.createUser("Bob");
expect(user2.id).toBe(user1.id + 1);
});
});
describe("getUser", () => {
it("должен возвращать пользователя по id", () => {
const created = service.createUser("Alice");
const found = service.getUser(created.id);
// Используйте опциональную цепочку и toBe
expect(found?.name).toBe("Alice");
});
it("должен возвращать undefined для несуществующего id", () => {
const found = service.getUser(999);
expect(found).toBeUndefined();
});
});
});
Результат выполнения:
UserService
createUser
✓ should create a user with id
✓ should increment id for each user
getUser
✓ should return user by id
✓ should return undefined for non-existent id
Изоляция тестов:Каждый тестовый случай должен быть независимым; используйте beforeEach, чтобы каждый тест имел чистое состояние.
Мок
Используйте моки для имитации зависимостей, таких как внешние API, базы данных и т. д.
Пример
const mockCallback = jest.fn(x => x * 2);
// Используйте мок-функцию
[1, 2, 3].forEach(mockCallback);
// Проверьте, что функция была вызвана 3 раза
expect(mockCallback).toHaveBeenCalledTimes(3);
// Проверить аргументы, с которыми была вызвана функция
expect(mockCallback).toHaveBeenCalledWith(2);
// Мок-модуль: имитировать весь модуль
jest.mock("./api", () => ({
fetchUser: jest.fn(() => Promise.resolve({ id: 1, name: "Alice" }))
}));
Результат выполнения:
✓ mock 函数被调用 3 次
Назначение моков:Когда тестируемый код зависит от внешних систем, использование моков изолирует зависимости, чтобы тестировалась только логика целевого кода.
Примечания
- Расположение тестового файла:Поместите в каталог __tests__ или используйте суффикс .test.ts
- Именование тестов:Используйте описательные имена тестов, отражающие ожидаемое поведение
- Независимые тесты:Каждый тест должен выполняться независимо, не полагаясь на другие тесты
- Покрытие:Сосредоточьтесь на покрытии тестами основной бизнес-логики
Лучшие практики:Тесты должны быть быстрыми, надежными и независимыми друг от друга. Следуйте принципу AAA: Arrange (подготовка), Act (выполнение), Assert (проверка).
Итог
Модульное тестирование — важное средство обеспечения качества кода TypeScript.
- Jest:Самый популярный фреймворк для тестирования TypeScript
- describe:Используется для группировки связанных тестов
- it/test:Определяют отдельные тестовые случаи
- expect:Проверяют результаты тестов
- Mock:Мокируют внешние зависимости
Другие расширенияРекомендации:Пишите тесты для критической бизнес-логики, чтобы гарантировать, что изменения кода не приводят к появлению ошибок.