describe( name, function )

warning

expect.js library is no longer maintained

expect.js library has been deprecated in favor of Chaijs.

Please migrate to the k6Chaijs library. The documentation below is retained for historical reasons.

To declare a new test case you call the describe(name, function) function. Provide the required name and implementation function. Names should be unique within the script, otherwise, the test cases will to be grouped.

Note: The first argument of the implementation function should be named t.

Behind the scenes, the describe() function creates a k6 group.

Returns

Example

import { describe } from 'https://jslib.k6.io/expect/0.0.4/index.js';
import http from 'k6/http';

export default function testSuite() {
  const success1 = describe('Basic test', (t) => {
    t.expect(1).toEqual(1);
  });

  console.log(success1); // true

  const success2 = describe('Another test', (t) => {
    throw 'Something entirely unexpected happened';
  });

  console.log(success2); // false

  const success3 = describe('Yet another test', (t) => {
    t.expect(true).toEqual(false);
  });

  console.log(success3); // false
}

Execution of this script should print the following output.