Skip to main content

createCase

codebolt.autoTesting.createCase(params: ICreateCaseParams): Promise<ICreateCaseResponse>

Creates a new test case with steps, labels, and priority.

Parameters​

  • params (ICreateCaseParams): Parameters for creating the test case including key, name, steps, and labels.

Returns​

  • Promise<[ICreateCaseResponse](/docs/reference/type-reference/codeboltjs/interfaces/ICreateCaseResponse)>: A promise that resolves to the created test case.

Examples​

// Create a simple test case
const testCase = await codebolt.autoTesting.createCase({
  key: 'TEST-001',
  name: 'Login Test',
  description: 'Verify user can login',
  steps: [
    { content: 'Go to login page', order: 1 },
    { content: 'Enter credentials', order: 2 },
    { content: 'Click submit', order: 3 },
    { content: 'Verify success', order: 4 }
  ],
  priority: 'high',
  labels: ['authentication', 'smoke']
});

// Create with minimal details
const simple = await codebolt.autoTesting.createCase({
  key: 'TEST-002',
  name: 'Simple Test',
  steps: [{ content: 'Run test', order: 1 }]
});

Notes​

  • Steps are executed in order
  • Priorities: low, medium, high, automated
  • Labels help categorize tests
  • Keys should be unique