@cyborgtests/test v0.0.7

Cyborg Test

Cyborg Test is a powerfull extension for Playwright that allows you to include manual verification steps in your automated test flow. When a manual step is hit, a separate window appears showing the step description that needs to be executed, so a tester can mark it as passed or failed. This lets you combine automated checks with human input in the same test case.

Installation

npm install @cyborgtests/test

This library expects @playwright/test to be available in your project as peer dependency.

Usage

import test from '@cyborgtests/test';

// Regular Playwright test syntax with additional `manualStep` helper
// that pauses execution until the tester confirms the step.
test('example with manual step', async ({ page, manualStep }) => {
  await page.goto('https://example.com');

  await manualStep('Verify the login screen is displayed correctly');

  // continue with the rest of your automated script
});

When manualStep is called the test pauses and the Cyborg Test UI window appears. Use the ✅ Step passed or ❌ Step failed buttons to resume the test. Failing a step throws an error so your CI can detect it.

Soft Fail for Manual Steps

You can use manualStep.soft to mark a manual step as a soft fail. If a soft manual step fails, the test will continue running, and the failure will be annotated as a soft fail (warning) in the report.

Usage:

await manualStep('This is a hard manual step'); // Test fails if this step fails
await manualStep.soft('This is a soft manual step'); // Test continues if this step fails, and a warning is shown

• Soft fails are shown as warnings in the UI and annotated in the test report.
• Use soft fails for non-critical manual verifications where you want to highlight issues but not fail the entire test.

Analytics Configuration

The package includes Google Analytics integration that is enabled by default. The following data is collected:

• Unique user ID (generated on first run)
• Test execution events (start of the test)
• Test results (passed/failed)
• External link clicks
• Browser, OS information and country

This data helps us understand how the tool is being used and improve it. No personal or sensitive information is collected.

To turn off analytics, use the following configuration:

import { config } from '@cyborgtests/test';

config.setConfig({
  analyticsEnabled: false
});