Configuring an API Suite run

After you added the test resources that you created in the desktop client to the project, you can configure an API Suite to be run on HCL OneTest™ Server.

Before you begin

Procedure

  1. Open the project that contains the test assets or resources that you added from the Git repository, and then click Execution.
  2. Select the branch of the repository that contains the test assets or resources that you want to run.

    All test assets in the selected branch are displayed on the Execution page.

  3. Identify the test asset or resource that you want to run by performing any of the following steps:
    1. Identify the test asset or resource by scrolling through the list.
      Note: You can also identify the type of the asset from the icon that represents the test type as shown in the following table:
      Icon Represents the test asset or resource
      AFT Suite
      API Suite
      Compound Test
      JMeter Test
      JUnit Test
      Postman resources
      Rate Schedule
      VU Schedule
    2. Search for the test asset or resource by entering any text contained in the test asset or resource name in the Search text box.
    3. Create a filter query by using the New filter option by performing the following steps:
      1. Click New filter.
      2. Select an operator, and add a rule, or a group of rules.
      3. Add or enter the relevant parameters and either select or enter the condition and the criteria for the condition.
        You can select a parameter from the following list:
        • Type
        • Test Asset Name
        • Test Asset Path
        • Last Result
        • Next Run
        • Components
      4. Apply the filter query to filter the assets based on the query.

        The test assets that match the filter criteria are displayed.

      5. Save the filter query by performing the following steps, if you want to reuse the filter query later:
        1. Click Save.
        2. Enter a name for the filter query.
        3. Click Save.
    4. Retrieve a saved filter, if you have saved filter queries earlier by performing the following steps:
      Note: To open the filter query, you must have created and saved a filter query.
      1. Click the Open filters icon Image of the icon..
      2. Select the saved filter in the Filters dialog box.
      3. Click Apply to apply the filter.

        The test assets that match the filter criteria are displayed.

  4. Click the Execute icon Image of the icon. in the row of the identified test asset.

    The Execute test asset dialog box is displayed.

  5. Select the version of the test resources that you want to run by completing any of the following actions:
    Note: The test resources in the version can contain the test assets, datasets, AFT XML files, API environment tags, and other resources specific to projects created from any of the desktop clients.
    • Expand the list in the Version field, find the version of the test resources, and then select the version.
      Use the following details about the version of the test resources that are displayed to identify the version that you want:
      • Commit message.
      • Tags labeled by the user for the version committed.
      • The user who committed the version to the repository.
      • Relative time of the commit. For example, 2 hours ago or 3 days ago.

      The list displays the versions of the test resources committed by all users to the branch in the repository. The versions are arranged with the latest version that is committed, and then followed by the versions committed previously.

    • Expand the list in the Version field, and then search for the version that you want to select by entering a partial or the complete commit message of that version.

      The version that matches the search criteria is displayed and it is selected for the test run.

    The default value for the version selected for the run is the latest version in the selected branch in the repository. If you do not select any version, then the latest version is selected for the test run.
    Notes:
    • If you selected a version but you do not want to use that version in the test run, you can remove the selected version by clicking the Image of the icon. icon, then the default version is selected for the test run.
    • If you repeated a test or ran the test again from the Results page, then the version of the test resources that you had selected for the earlier run is shown as selected. You can either retain this version or select any other version from the list. You can also remove the previous version by clicking the Image of the icon. icon.
  6. Select the time for scheduling the test run from the following options:
    • Select Now to initiate the test run immediately after you click Execute.
      Important: Click Execute only after you have configured the other settings in this dialog box.
    • Select Later and configure the date and time for scheduling a test to run at the scheduled date and time.

    The default time for scheduling a run is Now.

    Notes:

    • If you have configured some or all of the settings for the current test run, and you do not want to continue with those settings, you can reset the settings by clicking Reset.

    • If you want to repeat a test run and do not want to use the saved settings from a previous run, you can reset all the saved settings to their default values by clicking Reset.

  7. Enter a label for the test run that helps you to identify the test on the Results page.

    After the test run completes, the label that you entered is displayed for the test under the Labels column on the Results page. After you have created a label, any member of the project can use that label.

    The default value for the Label field is null or an empty field.

    Important: The configuration that you set for the test run in the Execute test asset dialog box is preserved when you run the same test again. Those changes are not visible when another user logs in to HCL OneTest™ Server. For example, if you created new variables on the server, those variables are available only for you when the same test is run again.

    If you want to run the test immediately or at the scheduled time, click Execute, or continue with the next step.

  8. Click Advanced to make the following advanced configurations:
    1. Enter any JVM arguments that must be passed to the test run at run time in the JVM Arguments field, if applicable for the test.

      For example, you can set a maximum Java heap size.

    2. Enter program arguments that must be passed to the test run at run time in the Program Arguments, if applicable for the test.
      If the test that you want to configure supports Jaeger tracing, then do the required tasks in the following scenarios:
      If... Then...

      You want to obtain the test results as a Jaeger trace.

      Enter -history jaeger in the Program Arguments field.

      Jaeger is already set as a program argument and you want to remove the Jaeger trace for your test.

      Delete the -history jaeger entry in the Program Arguments field.

      You want the report as a test log and as a Jaeger trace.

      Enter -history jaeger,testlog in the Program Arguments field.
      Note: The default report format is the test log format for the test reports.
    3. Enter the environment variables that must be passed to the test run at run time in the Environment Variables field, if applicable for the test.

      For example, enter the environment variables when the third-party libraries that are used in the test run refer to the environment variables for configuration.

    Note: You must separate the arguments or variables with a white space when you enter them in the same line or start each argument or variable on a new line.

    The default value for each of the fields for the advanced settings is null or an empty field.

    If you want to run the test immediately or at the scheduled time, click Execute, or continue with the next step.

  9. Follow the instructions if the API Suite has an environment or secrets configured:
    1. Click the ENVIRONMENT tab, if it is not already open.
    2. Select the API test environment from the list if there are multiple environments configured in the test asset.
    3. Select the secrets collection that contains the secrets to be used for the test run.
    Notes:
    • The test asset that was created in the desktop client and added to the Git repository must have the environments defined as part of the API test project.
    • If the test asset contained secrets, then you must create those secrets in secrets collections in the project.

    The default value for the environment is the environment configured in the test asset. The default value for secrets is null or an empty field.

    If you want to run the test immediately or at the scheduled time, click Execute, or continue with the next step.

  10. Follow the instructions if you are running a test asset that contains datasets:
    1. Click the DATA SOURCES tab, if it is not already open.
    2. Consider the following information about datasets before you select a dataset:

      The default value for the datasets in the DATA SOURCES tab is null if the test asset did not have an associated dataset. If the asset had an associated dataset, the default value is the associated dataset.

      You can utilize the dataset stored as an Excel or CSV file to override the original dataset associated with the Suite, test, or schedule. For example, when you have associated a dataset in .xlsx, .xls, or .csv format with the test or schedule in desktop clients and if you have another set of data stored in an Excel or CSV file, then you can select that dataset from the Override list. If you want to run a test or schedule by using the schema created from the Data Fabrication page, see related links.
      Remember: You must have uploaded the dataset as an Excel or CSV file into the Git repository, and ensured that both the original dataset (from the test asset) and new datasets (added to the project) have the same column names.
    3. Select the dataset that you want to use in the test run from any of the following options:
      • Select the dataset that is displayed as the default dataset when the test asset contains a single dataset.
        Note: If there is only one dataset in the test asset, then that dataset is displayed as the default dataset.
      • Select the dataset from the list.
        Note: If there are multiple datasets in the test asset, the datasets are listed in their increasing alphabetical order.
      • Select the dataset from the Override list to override the dataset that was associated with the test in the desktop client.
        Important: If the test contains an encrypted dataset, the Project Owner must classify it in the DATA SECURITY tab on the Project page before you can select it. You must have added datasets to your project from the Dataset page for the datasets to be displayed in the Override list.

    If you want to run the test immediately or at the scheduled time, click Execute, or continue with the next step.

  11. Follow the instructions if the test requires a variable that must be passed to the test at the test run time.
    1. Click the VARIABLES tab, if it is not already open.
    2. Choose one of the following methods to add the variables:
      • To add new variables manually, click the Add Variable icon Image of the Add icon, enter the name, and value of the variable.
      • To add new variables from your local computer or from the Git repository that is associated with your server project, click the Upload icon Image of the icon and select the Upload from local system or Browse from server to select the variable file.
        Note: You must have created a file with the variables before you can select the file.

    The default value for the variables is null or an empty field.

    If you want to run the test immediately or at the scheduled time, click Execute, or continue with the next step.

  12. Follow the instructions if you want to change the location for running the test:
    1. Click the LOCATION tab, if it is not already open.
      The Default Cluster is the default location where the test runs, and it is listed under the Host column. The information about the availability of the default location is displayed.
      Important: You must have added remote Docker hosts that are registered with HCL OneTest™ Server to your project from the Infrastructure page. The remote Docker hosts are then displayed under the Override column.
      Notes:
      • If remote Docker hosts are not added to your project, the option No override options is displayed as the default value and the test runs in the Kubernetes cluster of HCL OneTest™ Server.
      • If remote Docker hosts are added to your project, the added Docker hosts are displayed along with their availability status and ownership information.
    2. Select the location where you want to run the test asset from the following options:
      • Select the Default Cluster when no remote Docker hosts are available in your project.
      • Select the remote Docker host from the list when a remote Docker host is available in your project.
      • Select No override options, if you selected any remote Docker host and want to revert to the Default Cluster to run the test asset.

    If you want to run the test immediately or at the scheduled time, click Execute.

  13. Click Execute.
    The test run is initiated.

Results

You have configured and either started or scheduled a test run of an API Suite.

What to do next

You can choose to perform any of the following tasks after you have initiated or scheduled a run: