Test Declaration

Magnitude tests are defined using the globally available test function imported from magnitude-test.

import { test } from 'magnitude-test';

test('Descriptive test title', async (agent) => {
  // Test logic using agent
});

`test(title, options?, testFn)`

Defines a new test case.

string

required

A descriptive title for the test case. This title appears in test reports and logs.

object

Optional configuration specific to this test case.

Show options properties

string

Overrides the base URL defined in the global configuration or test group for this specific test case.

(agent) => Promise<void>

required

An asynchronous function containing the test logic. It receives an agent object with the properties described below.

Show testFn context properties

object

required

The agent object providing methods for AI interaction (agent.act(), agent.check()) and access to Playwright’s agent.page and agent.context. See AI Steps and Checks, Low-Level AI Actions, and Playwright Access.

`test.group(id, options?, groupFn)`

Defines a group of test cases, allowing shared options (like url) to be applied to all tests within the group.

import { test } from 'magnitude-test';

test.group('User Authentication Flow', { url: '/login' }, () => {
  test('should display login form', async (agent) => {
    await agent.check("Login form is visible");
  });

  test('should allow login with valid credentials', async (agent) => {
    await agent.act("Log in with valid credentials");
    await agent.check("User is redirected to dashboard");
  });
});

string

required

A descriptive identifier for the test group.

object

Optional configuration applied to all tests within this group. See properties below.

Show options properties

string

Sets a base URL for all tests within the group. Can be overridden by individual test options.

() => void

required

A synchronous function that contains the test() declarations belonging to this group.

Getting Started

Core Concepts

Testing Web Apps

Advanced

Integrations

Reference

`test(title, options?, testFn)`

`test.group(id, options?, groupFn)`

​test(title, options?, testFn)

​test.group(id, options?, groupFn)

`test(title, options?, testFn)`

`test.group(id, options?, groupFn)`