TestCollection

TestCollection représente une collection de suites de tests et de cas de test de premier niveau au sein d'une suite ou d'un module. Elle offre également des méthodes pratiques pour itérer sur ses éléments.

INFO

La plupart des méthodes renvoient un itérateur plutôt qu'un tableau, ce qui améliore les performances si vous n'avez pas besoin de tous les éléments de la collection. Si vous préférez travailler avec un tableau, vous pouvez convertir l'itérateur comme suit : [...children.allSuites()].

Notez également que la collection elle-même est un itérateur :

for (const child of module.children) {
  console.log(child.type, child.name);
}

size

Le nombre de tests et de suites contenus dans la collection.

WARNING

Ce nombre inclut uniquement les tests et les suites de premier niveau ; il n'englobe pas les suites et les tests imbriqués.

at

function at(index: number): TestCase | TestSuite | undefined;

Renvoie le test ou la suite à un index spécifique. Cette méthode accepte les index négatifs.

array

function array(): (TestCase | TestSuite)[];

La même collection, mais sous forme de tableau. Ceci est utile si vous souhaitez utiliser des méthodes Array telles que map et filter, qui ne sont pas prises en charge par l'implémentation de TaskCollection.

allSuites

function allSuites(): Generator<TestSuite, undefined, void>;

Filtre toutes les suites faisant partie de cette collection et de ses enfants (suites imbriquées).

for (const suite of module.children.allSuites()) {
  if (suite.errors().length) {
    console.log('failed to collect', suite.errors());
  }
}

allTests

function allTests(state?: TestState): Generator<TestCase, undefined, void>;

Filtre tous les tests faisant partie de cette collection et de ses enfants (tests imbriqués).

for (const test of module.children.allTests()) {
  if (test.result().state === 'pending') {
    console.log('test', test.fullName, 'did not finish');
  }
}

Vous pouvez spécifier une valeur state pour filtrer les tests en fonction de leur état.

tests

function tests(state?: TestState): Generator<TestCase, undefined, void>;

Filtre uniquement les tests faisant partie de cette collection (tests de premier niveau). Vous pouvez spécifier une valeur state pour filtrer les tests en fonction de leur état.

suites

function suites(): Generator<TestSuite, undefined, void>;

Filtre uniquement les suites faisant partie de cette collection (suites de premier niveau).