Mapping credentials by using an environment file

You can map the variables referenced in the test to secrets configured in the security group by using an environment file, so that HCL DevOps Test Hub (Test Hub) can resolve the secret values at run time.

Before you begin

You must have completed the following tasks:

Ensured that you are assigned a role as a Project Owner or Tester in the project. See Managing access to the server projects.
Ensured that your project contains test assets.
Read and understood the information in Edit branch overview and Create or select an Edit branch.

About this task

You can use an environment file to map authentication values and security tokens to the variables referenced in your test. You can define authentication mapping for multiple users in a single environment file, or create separate environment files for individual users and select the required environment file when you run the test.

Procedure

Log in to Test Hub.
The Projects page of the initial team space is displayed.
Click My projects > project_name to open the project that contains the Salesforce application.
The Overview page of the project is displayed.
Click Author > Test Editor.
The Test Editor page and the test navigator panel are displayed.
Click the Action Menu icon and select Environment, or right-click the application folder in the test navigator panel and select My New > Environment.
The Edit branch dialog is displayed.

If the Edit branch dialog is not displayed, then go to step 6.
Select your action to either select an existing Edit branch or create an Edit branch:
- Perform the following steps to select an existing Edit branch:
  1. Select Use an existing edit branch.
  2. Select an Edit branch from the Select branch list if Edit branches already exist for your repository.
    
    Note:
    A warning message is displayed if the Edit branch, you selected is behind the source branch. To update the selected edit branch and maintain synchronization with the source branch, you can select the Update branch option when switching checkbox.
  3. Click Ok.
- Perform the following steps to create the Edit branch:
  1. Select Create new edit branch.
  2. Enter a name for the Edit branch in the Branch Name field.
  3. Click Save.
In the Create Environment dialog, configure the following environment details:
1. Select a target application from the Application drop-down list. For example, Mysecrets.
2. Enter a unique name for your environment in the Name field. For example, SFEnv.dte.yaml.
Click Done.
The new environment file is created and displayed in Test Editor.
Perform the following steps to add specific variables in the Variables section:
1. Click + Create Variable.
2. Enter the variable name in the Name column.
3. Enter the corresponding secret reference in the Value column.
  For example, configure the variables that correspond to $(Password)and $(Verification_Code).
Click the Save icon to save the environment details.
From the Environment list at the top right of the Test Editor page, select the required environment. For example, SFLenv .
The selected environment enables Test Hub to resolve the secret references from the configured security group.

Results

You have mapped the variables referenced in the test to the secrets configured in the security group by using an environment file.