group( name, fn )

Note
For details about using the check() function with async values, refer to the jslib utils check.

Run code inside a group. Groups are used to organize results in a test.

Parameter	Type	Description
name	string	Name of the group.
fn	function	Group body - code to be executed in the group context.

Returns

Type	Description
any	The return value of fn.

Limitations

Warning
Avoid using group with async functions or asynchronous code. If you do, k6 might apply tags in an unreliable or unintuitive way.

If you start promise chains or use await within group, some code within the group will be waited for and tagged with the proper group tag, but others won’t be.

To avoid confusion, async functions are forbidden as group() arguments. That still lets users make and chain promises within a group, but doing so is unsupported and not recommended.

For more information, refer to k6 #2728, which tracks possible solutions and provides detailed explanations.

Example

import { group } from 'k6';

export default function () {
  group('visit product listing page', function () {
    // ...
  });
  group('add several products to the shopping cart', function () {
    // ...
  });
  group('visit login page', function () {
    // ...
  });
  group('authenticate', function () {
    // ...
  });
  group('checkout process', function () {
    // ...
  });
}

The above code will present the results separately depending on the group execution.

Learn more on Groups and Tags.