9 Assertion API

9.1 Assertions in software development

In software development, assertions state facts about values or pieces of code that must be true. If they aren’t, an exception is thrown. Node.js supports assertions via its built-in module assert – for example:

import * as assert from 'assert/strict';
assert.equal(3 + 5, 8);

This assertion states that the expected result of 3 plus 5 is 8. The import statement uses the recommended strict version of assert.

9.2 How assertions are used in this book

In this book, assertions are used in two ways: to document results in code examples and to implement test-driven exercises.

9.2.1 Documenting results in code examples via assertions

In code examples, assertions express expected results. Take, for example, the following function:

function id(x) {
  return x;
}

id() returns its parameter. We can show it in action via an assertion:

assert.equal(id('abc'), 'abc');

In the examples, I usually omit the statement for importing assert.

The motivation behind using assertions is:

• You can specify precisely what is expected.
• Code examples can be tested automatically, which ensures that they really work.

9.2.2 Implementing test-driven exercises via assertions

The exercises for this book are test-driven, via the test framework Mocha. Checks inside the tests are made via methods of assert.

The following is an example of such a test:

// For the exercise, you must implement the function hello().
// The test checks if you have done it properly.
test('First exercise', () => {
  assert.equal(hello('world'), 'Hello world!');
  assert.equal(hello('Jane'), 'Hello Jane!');
  assert.equal(hello('John'), 'Hello John!');
  assert.equal(hello(''), 'Hello !');
});

For more information, consult §10 “Getting started with quizzes and exercises”.

9.3 Normal comparison vs. deep comparison

The strict equal() uses === to compare values. Therefore, an object is only equal to itself – even if another object has the same content (because === does not compare the contents of objects, only their identities):

assert.notEqual({foo: 1}, {foo: 1});

deepEqual() is a better choice for comparing objects:

assert.deepEqual({foo: 1}, {foo: 1});

This method works for Arrays, too:

assert.notEqual(['a', 'b', 'c'], ['a', 'b', 'c']);
assert.deepEqual(['a', 'b', 'c'], ['a', 'b', 'c']);

9.4 Quick reference: module assert

For the full documentation, see the Node.js docs.

9.4.1 Normal equality

• function equal(actual: any, expected: any, message?: string): void

  actual === expected must be true. If not, an AssertionError is thrown.

  assert.equal(3+3, 6);

• function notEqual(actual: any, expected: any, message?: string): void

  actual !== expected must be true. If not, an AssertionError is thrown.

  assert.notEqual(3+3, 22);

The optional last parameter message can be used to explain what is asserted. If the assertion fails, the message is used to set up the AssertionError that is thrown.

let e;
try {
  const x = 3;
  assert.equal(x, 8, 'x must be equal to 8')
} catch (err) {
  assert.equal(
    String(err),
    'AssertionError [ERR_ASSERTION]: x must be equal to 8');
}

9.4.2 Deep equality

• function deepEqual(actual: any, expected: any, message?: string): void

  actual must be deeply equal to expected. If not, an AssertionError is thrown.

  assert.deepEqual([1,2,3], [1,2,3]);
  assert.deepEqual([], []);
  
  // To .equal(), an object is only equal to itself:
  assert.notEqual([], []);

• function notDeepEqual(actual: any, expected: any, message?: string): void

  actual must not be deeply equal to expected. If it is, an AssertionError is thrown.

  assert.notDeepEqual([1,2,3], [1,2]);

9.4.3 Expecting exceptions

If you want to (or expect to) receive an exception, you need throws(): This function calls its first parameter, the function block, and only succeeds if it throws an exception. Additional parameters can be used to specify what that exception must look like.

• function throws(block: Function, message?: string): void

  assert.throws(
    () => {
      null.prop;
    }
  );

• function throws(block: Function, error: Function, message?: string): void

  assert.throws(
    () => {
      null.prop;
    },
    TypeError
  );

• function throws(block: Function, error: RegExp, message?: string): void

  assert.throws(
    () => {
      null.prop;
    },
    /^TypeError: Cannot read properties of null \(reading 'prop'\)$/
  );

• function throws(block: Function, error: Object, message?: string): void

  assert.throws(
    () => {
      null.prop;
    },
    {
      name: 'TypeError',
      message: "Cannot read properties of null (reading 'prop')",
    }
  );

9.4.4 Another tool function

• function fail(message: string | Error): never

  Always throws an AssertionError when it is called. That is occasionally useful for unit testing.

  try {
    functionThatShouldThrow();
    assert.fail();
  } catch (_) {
    // Success
  }