Updated on 2025-08-13 GMT+08:00

TestPlan

Call the TestPlan extension to use CodeArts TestPlan capabilities.

Adding the Extension with GUI

Add the TestPlan extension when you orchestrate a pipeline. Set parameter as shown in Table 1.

Table 1 Parameter description

Parameter

Description

Name

Extension name, which can be customized.

  • Enter only letters, digits, hyphens (-), underscores (_), commas (,), semicolons (;), colons (:), periods (.), slashes (/), parentheses (), and spaces.
  • Enter 1 to 128 characters.

Select Task

Select an API automation test suite whose code source is the same repository as the pipeline you are configuring.

Parameters

  • Use global parameters of selected environment: Different environments configured in mutiple tasks can be selected and parameters in the corresponding environments can be used.
  • Use new execution parameters: You can directly enter the parameters to overwrite the global parameters used by the selected test task type.

Environment

When Parameter is set to Use global parameters of selected environment, select Default Environment.

Adding the Extension with YAML

Add the TestPlan extension when you orchestrate a pipeline. Configure the YAML syntax as follows:

  • TestPlan
    uses: CodeArtsTestPlan
    with:  
      jobId: vb180000vnrgoeib   
      environmentModel: 1
      environmentId: 7c2eff2377584811b7981674900158e8
    • jobId: ID of the API test task.
    • environmentModel: parameter source.
      • 0: Use new execution parameters.
      • 1: Use the global parameters of the selected environment.
    • environmentId: environment ID when environmentModel is set to 1.