Référence rapide

Antisèche de la bibliothèque d'assertions Chai.js

Guide de référence rapide pour Chai.js : styles BDD expect et should, style TDD assert, égalité profonde, vérification des types et chai-jquery.

· Publié le

Chai Chai est une bibliothèque d'assertions BDD / TDD pour Node.js et les navigateurs qui s'associe idéalement avec Mocha ou Jest.

Style BDD (expect)

const { expect } = require('chai');

Égalité et types

expect(val).to.equal(expected);         // Égalité stricte (===)
expect(val).to.eql(expected);           // Égalité profonde (Deep equality)
expect(val).to.deep.equal(expected);    // Identique à .eql

expect(val).to.be.a('string');
expect(val).to.be.an('array');
expect(val).to.be.an.instanceOf(User);

Valeurs de vérité et existence

expect(val).to.be.ok;          // Valeur truthy
expect(val).to.be.true;
expect(val).to.be.false;
expect(val).to.exist;          // Ni null ni undefined
expect(val).to.be.null;
expect(val).to.be.undefined;
expect(val).to.be.empty;        // Tableau, chaîne ou objet vide

Comparaisons numériques

expect(score).to.be.above(5);           // Strictement supérieur (gt)
expect(score).to.be.at.least(5);        // Supérieur ou égal (gte)
expect(score).to.be.below(10);          // Strictement inférieur (lt)
expect(score).to.be.at.most(10);        // Inférieur ou égal (lte)
expect(score).to.be.within(5, 10);      // Intervalle inclusif
expect(pi).to.be.closeTo(3.14, 0.01);   // Tolérance sur nombre flottant

Objets et collections

expect(array).to.include(item);
expect(array).to.have.members([1, 2, 3]);
expect(array).to.have.lengthOf(3);

expect(obj).to.have.property('name');
expect(obj).to.have.property('name', 'Alice');
expect(obj).to.have.nested.property('address.city', 'London');
expect(obj).to.have.all.keys('id', 'name');

Exceptions levées par les fonctions

expect(() => badFunction()).to.throw();
expect(() => badFunction()).to.throw(TypeError);
expect(() => badFunction()).to.throw(/invalid argument/);
expect(() => goodFunction()).to.not.throw();

Style TDD (assert)

const { assert } = require('chai');

assert.ok(val, 'value is truthy');
assert.equal(actual, expected, 'compares with ==');
assert.strictEqual(actual, expected, 'compares with ===');
assert.deepEqual(actual, expected, 'deep equality');

assert.isTrue(val);
assert.isFalse(val);
assert.isNull(val);
assert.isNotNull(val);
assert.isUndefined(val);
assert.isDefined(val);

assert.typeOf(val, 'string');
assert.instanceOf(val, Model);
assert.lengthOf(val, 3);
assert.include(list, item);
assert.match(str, /regex/);
assert.throws(() => { /* error test */ }, /error regex/);

Chai avec jQuery (chai-jquery)

chai.use(require('chai-jquery'));

// Vérifications d'états du DOM
expect($elem).to.be.visible;
expect($elem).to.be.hidden;
expect($elem).to.be.enabled;
expect($elem).to.be.disabled;
expect($elem).to.be.checked;

// CSS et attributs
expect($elem).to.have.class('active');
expect($elem).to.have.id('submit-btn');
expect($elem).to.have.attr('disabled');
expect($elem).to.have.css('display', 'block');
expect($elem).to.have.text('Hello World');

Sujets associés