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.
A descriptive title for the test case. This title appears in test reports and logs.
Optional configuration specific to this test case.
Overrides the base URL defined in the global configuration or test group for this specific test case.
testFn
(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
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");
});
});
A descriptive identifier for the test group.
Optional configuration applied to all tests within this group. See properties below.
Sets a base URL for all tests within the group. Can be overridden by individual test options.
A synchronous function that contains the test() declarations belonging to this group.
