Updated on 2024-01-18 GMT+08:00

Creating an API Automation Test Suite

Prerequisites

API automation test cases have been created.

Procedure

  1. Log in to the CodeArts homepage, search for your target project, and click the project name to access the project.
  2. In the navigation pane, choose Testing > Testing Execution.
  3. Click next to Test case library and select a test plan as required.
  4. On the Auto API Test tab page, click Create Test Suite in the upper left corner. The creation page is displayed.
  5. Enter basic information such as the name, click Add Case or Add Now, and select the test case to be executed.

  6. Complete the execution settings as required and click Save.

    Configuration Item

    Mandatory

    Description

    Resource Pool

    Yes

    The resource pool allows you to access your own execution resources. When executing a task, you can select an agent in the resource pool to execute the task. This improves the task execution efficiency and does not depend on public resources of CodeArts.

    ID

    No

    You can enter a number of 3 to 128 characters.

    Tag

    No

    Set tags for the current task as required. The tags are separated by spaces. Each task can be associated with a maximum of 10 tags.

    Module

    No

    Module of the current test case. The module list comes from the project settings. For details, see Setting Modules.

    Processor

    No

    Person who needs to complete the test task.

    Environment Parameters

    No

    Environment parameters can be referenced by parameters, checkpoints, variables, and URLs of test steps in the entire project.

    Max. Duration

    Yes

    The longest time taken for executing a test case. Cases exceeding this limit will fail. The task continues until the last case is complete. The value can be minute-level, hour-level, or day-level.

    Configure Test Suite Parameters

    No

    Add new parameters or modify existing global parameters of the test suite.

    Execute

    Yes

    There are two types. By default, the task is executed only once.

    • Once: The test suite is executed only once.
    • Regularly: After you set an execution frequency, the test suite is executed periodically. Set this parameter to daily.

    Start

    Yes

    There are two execution modes. By default, the task is executed immediately.

    • Immediately: The task is executed immediately after it is executed.
    • At specific time: The task is executed after a specified time.

    Sequence

    Yes

    There are two modes. The default mode is Serial.

    • Serial: Test cases in the API test suite are executed in serial mode.
    • Parallel: Test cases in the API test suite are executed in parallel mode.