Модуль assert в Node.js

Java FileВстроенные модули Node.js


В Node.js,assertмодуль — это встроенная служебная библиотека для написания модульных тестов. Он предоставляет набор функций утверждений для проверки того, соответствует ли поведение кода ожиданиям. Если утверждение не выполняется,assertмодуль выбросит исключениеAssertionErrorисключение.

assertМодуль отлично подходит для использования во время разработки и тестирования, помогая разработчикам быстро находить проблемы в коде.


Как использовать модуль assert?

Чтобы использоватьassertмодуль, сначала нужно импортировать его:

const assert = require('assert');

Основные методы утверждений

1. assert.ok(value[, message])

assert.ok()является самым базовым методом утверждения. Он проверяетvalueявляется ли оно истинным значением. Еслиvalueоно является ложным, то выбрасываетAssertionError。

Пример

assert.ok(true); // успешно
assert.ok(1); // пройдено
assert.ok(false); // выбрасывает AssertionError
assert.ok(0, 'value is falsy'); // выбрасывает AssertionError: value is falsy

2. assert.equal(actual, expected[, message])

assert.equal()Использует==оператор для сравненияactualиexpectedравны ли они (нестрогое равенство).

Пример

assert.equal(1, 1); // пройдено
assert.equal(1, '1'); // пройдено
assert.equal(1, 2); // выбрасывает AssertionError

3. assert.strictEqual(actual, expected[, message])

assert.strictEqual()Использует===оператор для сравненияactualиexpectedстрого ли они равны.

Пример

assert.strictEqual(1, 1); // пройдено
assert.strictEqual(1, '1'); // выбрасывает AssertionError

4. assert.deepEqual(actual, expected[, message])

assert.deepEqual()Используется для сравнения, равно ли содержимое двух объектов или массивов (рекурсивное сравнение).

Пример

assert.deepEqual({ a: 1 }, { a: 1 }); // пройдено
assert.deepEqual([1, 2], [1, 2]); // пройдено
assert.deepEqual({ a: 1 }, { a: '1' }); // пройдено (нестрогое сравнение)

5. assert.deepStrictEqual(actual, expected[, message])

assert.deepStrictEqual()Похоже наdeepEqual, но использует строгое сравнение (===)。

Пример

assert.deepStrictEqual({ a: 1 }, { a: 1 }); // пройдено
assert.deepStrictEqual({ a: 1 }, { a: '1' }); // выбрасывает AssertionError

Другие распространённые методы утверждений

1. assert.notEqual(actual, expected[, message])

Проверяетactualиexpectedчто они не равны (!=)。

Пример

assert.notEqual(1, 2); // пройдено
assert.notEqual(1, '1'); // выбрасывает AssertionError

2. assert.notStrictEqual(actual, expected[, message])

Проверяетactualиexpectedне являются ли они строго неравными (!==)。

Пример

assert.notStrictEqual(1, '1'); // пройдено
assert.notStrictEqual(1, 1); // выбрасывает AssertionError

3. assert.throws(block[, error][, message])

Проверяетblockвыбросит ли функция ошибку.

Пример

assert.throws(
  () => {
    throw new Error('Wrong value');
  },
  Ошибка
); // пройдено

assert.throws(
  () => {
    throw new Error('Wrong value');
  },
  /Wrong/
); // пройдено (регулярное выражение соответствует сообщению об ошибке)

4. assert.doesNotThrow(block[, error][, message])

Проверяетblockпроверяет, что функция не выбросит ошибку.

Пример

assert.doesNotThrow(
  () => {
    const x = 1 + 1;
  },
  Ошибка
); // пройдено

5. assert.fail([message])

Принудительно выбрасываетAssertionError。

Пример

assert.fail('Test failed'); // выбрасывает AssertionError: Test failed

Практический пример применения

Предположим, у нас есть простая функцияadd, используемая для вычисления суммы двух чисел:

Пример

function add(a, b) {
  return a + b;
}

Мы можем использоватьassertмодуль для написания тестов для него:

Пример

const assert = require('assert');

// Тест обычного случая
assert.strictEqual(add(1, 2), 3, '1 + 2 должно быть 3');
assert.strictEqual(add(-1, 1), 0, '-1 + 1 должно быть 0');

// Тест граничного случая
assert.strictEqual(add(0, 0), 0, '0 + 0 должно быть 0');
assert.strictEqual(add(1.5, 2.5), 4, '1.5 + 2.5 должно быть 4');

// Тест случая ошибки
assert.throws(
  () => добавьте('1', 2),
  TypeError,
  'Добавление строки к числу должно выбрасывать TypeError'
);

Примечания

  1. Продакшен-среда:assertМодуль в основном используется в средах разработки и тестирования. Не рекомендуется использовать его в продакшене, потому что сбои утверждений приведут к падению программы.

  2. Строгий режим: Node.js также предоставляетassert/strictмодуль, который являетсяassertстрогой версией модуля. Все сравнения используют строгое равенство (===)。

    const assert = require('assert/strict');
  3. Пользовательские сообщения об ошибках: Предоставляйте понятные сообщения об ошибках для каждого утверждения, что помогает быстро находить проблемы.

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


Итог

assertМодуль — это простой, но мощный инструмент тестирования в Node.js, особенно подходящий для модульного тестирования и проверки кода на этапе разработки. Правильно используя различные методы утверждений, вы можете эффективно обеспечивать корректность кода. Помните, что после завершения разработки следует заменитьassertмодуль для более всестороннего тестирования.

Java FileВстроенные модули Node.js

Другие расширения