Skip to main content

Test Packs

Use testPacks to sync test packs and test cases for a service.

Supported types​

Test pack type:

  • smoke
  • regression
  • manual

Test case type:

  • api
  • manual

Config shape​

testPacks:
  - name: checkout-smoke
    type: smoke
    environment: production
    releaseLabel: 2026.03
    testCases:
      - type: api
        title: create-order returns 201
        order: 1
        apiGroupName: checkout-api
        operationId: createOrder
        expectedStatusCode: 201
        requestTemplate: '{"amount":100}'
        requiresEvidence: false
        isCritical: true

      - type: manual
        title: checkout success path
        order: 2
        stepsList:
          - action: Open checkout and submit a valid card
            expectedResult: Payment is accepted
        expectedOutcome: Order is placed and confirmation is shown
        requiresEvidence: true
        isCritical: true

Required fields​

Pack level:

  • name
  • type

Case level:

  • type
  • title

Supported pack fields​

Pack fields currently supported by the CLI include:

  • name
  • type
  • environment
  • releaseLabel
  • testCases

Supported test case fields​

All test cases support:

  • type
  • title
  • order
  • description
  • priority
  • tags
  • linkedTicket
  • estimatedDurationMins
  • testOwner
  • requiresEvidence
  • isCritical

API test cases can also include:

  • apiGroupName
  • operationId
  • expectedStatusCode
  • requestTemplate
  • responseTimeMs
  • responseBody
  • assertions
  • mapName
  • frameName
  • focalPointName

Manual test cases can also include:

  • stepsList
  • expectedOutcome
  • preconditions
  • testData
  • postconditions

Behavior​

When running uigraph sync:

  1. CLI syncs each test pack first.
  2. CLI syncs all test cases inside that pack.
  3. CLI includes commit hash metadata when available.

Dry run prints test pack and test case summaries without sending data.

Notes​

  • stepsList is the supported field for manual step sequences.
  • apiGroupName and operationId are most useful when your synced API spec includes stable OpenAPI operationId values.
  • The CLI validates pack and case types, but it does not fully validate cross-references such as whether a named API group already exists in UiGraph.