Configuring an AFT Suite run

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

Before you begin

You must have completed the following tasks:

Procedure

  1. Log in to HCL OneTest™ Server.

    The team space that contains your project is displayed.

  2. Open the project that contains the test assets, and then click Execution.
  3. Select the branch of the repository that contains the test assets.
    The test assets that are contained in the selected branch of the repository are displayed in the following tabs on the Execution page:
    Tab Description
    SUITES Lists all Suites, compound tests, Rate Schedules, or VU Schedules that are in the selected branch of the repository.
    TESTS Lists all API tests, functional tests, and performance tests that are in the selected branch of the repository.
    ADVANCED Lists all assets that are displayed when custom filters are applied for assets in the selected branch of the repository.
  4. Identify the test asset or resource that you want to run by performing any of the following actions:
    • Scroll through the list.
      Tip: You can hover over the icon in the Type column to know the type of the test asset.
      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 Listed in the SUITES tab Listed in the TESTS tab Listed in the ADVANCED tab
      API test image of checkmark image of checkmark
      Functional test image of checkmark image of checkmark
      Performance test image of checkmark image of checkmark
      AFT Suite image of checkmark image of checkmark
      API Suite image of checkmark image of checkmark
      Compound Test image of checkmark image of checkmark
      Rate Schedule image of checkmark image of checkmark
      VU Schedule image of checkmark image of checkmark
    • Search for the test asset or resource by entering any text contained in the test asset or resource name in the Search field.
    • Click the Filter icon Image of the filter icon in the SUITES or TESTS tab to filter the displayed assets based on the asset type.

      For example, select API Suite in the SUITES tab to display all API Suites or select Functional Test in the TESTS tab to display all functional tests in the selected branch of the repository.

    • Click the Filter icon Image of the filter icon in the ADVANCED tab, and then create a filter query by using the New filter option by performing the following steps:
      1. Click New filter.
      2. Enter a name for the filter.
      3. Select an operator, and add a rule, or a group of rules.
      4. 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
      5. Save the filter query to save and apply the filter query to filter the assets based on the query.

        The test assets that match the filter criteria are displayed.

    • Retrieve and apply a saved filter query, if you have saved filter queries previously by performing the following steps:
      Note: The filter query applied previously is selected and the assets based on that filter query are displayed. To apply a different filter query, you must have created and saved the filter query.
      1. Click the Filter icon Image of the filter icon in the ADVANCED tab.

        The filter queries that you created and saved are displayed.

      2. Click the filter that you want to apply.

        The test assets that match the filter criteria are displayed.

  5. Click the Execute icon Image of the icon. in the row of the identified test asset.
    The Execute test asset dialog is displayed.
    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.

  6. 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 of 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. As a result, 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 chose 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.
  7. Select the time for scheduling the test run from the following options:
    • No action is required if you want to initiate the test run immediately after you click Execute.
      Important: Click Execute only after you have configured the other settings in this dialog.
      Note: The default time for scheduling a run is Now.
    • Select Later and configure the date and time to schedule a test run.

    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.

  8. 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 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.

    If you are running an AFT Suite and the following conditions are true, then you must perform the next step:
    • You do not want to run the test on the agent configured in the AFT XML file.
    • You have not selected the agent from the Override column in the Location tab.
  9. Click Advanced to make the following advanced configurations:
    1. Add the following setting in the Program Arguments field:

      -swaplocation <configured_agent_location>:<overriding_agent_location>

      For example, if the configured agent location is 91.2.352.24 and the remote agent where you want to run the test is 100.35.117.164, then the entry in the Program Arguments field is as follows:

      -swaplocation 91.2.352.24:100.35.117.164

      If the test that you want to configure supports the presentation of the test results data in different formats, then do the required tasks in the following scenarios:
      If... Then...
      You want the test results data in different supported formats.

      Enter -history cisterna in the Program Arguments field.

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

      Enter -history jaeger 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.

      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.
      Note: The default report format is the test log format for the test reports.
    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.

  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.
      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 are running a test that has static agents configured:
    1. Click the LOCATION tab, if it is not already open.
      The static agents that are configured in the test asset are listed under the Host column. The information about the availability of the agent is displayed.
      Note: You must have added agents to your project from the Infrastructure page for the agents to be displayed under the Override column.
    2. Select the agent where you want to run the test asset in the following scenarios:
      If... Then... Action
      The agent that is specified in the test assets is available and no other agents are added to the project. The agent that is specified in the test assets is displayed in the Override column. Select the agent in the Host that is also displayed in the Override column as the location to run the test.
      The agent that is specified in the test assets is not available and no other agents are added to the project. There is no agent displayed for override in the Override column. You cannot run the test on the agent.

      You must wait until the agent is available to run the test on the agent.
      The agent that is specified in the test assets is available and there are other agents that are added to the project. Agents that have capabilities that match with the agent capabilities specified in the test assets are listed in the Override column as follows:
      • Agents with capabilities that best match the capabilities in the agent in the asset are at the top of the list.
      • Agents with capabilities that do not match with the capabilities in the agent in the asset are listed subsequently.
      You can find details of both agents for the matching capabilities when you hover over the agent in the Override column.       		Perform any of the following actions:
      • Select the agent in the Host that is also displayed in the Override column as the location to run the test.
      • Select an agent in the Override column as the location to run the test.
    3. Click Execute.
      The test run is initiated.

    The default value for the agents is null or an empty field if no agents were configured in the test asset. If the test asset contains agents that are configured, then the default agent is the first item to be displayed on the list of agents listed in the increasing alphabetical order.

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

  13. 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 the following remote hosts to your project that are then displayed under the Override column:
      • Docker hosts that are registered with HCL OneTest™ Server.
      • Kubernetes clusters that are registered with a team space.
      Notes:
      • If the remote Docker hosts or clusters 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 or clusters are added to your project, the added Docker hosts or clusters 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 or clusters are available in your project.
      • Select the remote Docker host or cluster from the list when a remote Docker host or cluster is available in your project.
      • Select No override options, if you selected any remote Docker host or cluster and want to revert to the Default Cluster to run the test asset.
    3. Click Execute.
      The test run is initiated.
  14. Click Execute.
    The test run is initiated.

Results

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

What to do next

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