Home
Test Manager Guide
This guide describes how to manage and track your overall test effort. This guide is intended for test managers.
Protecting API test assets by using secrets
Secrets are key-value pairs that are created for your project in HCL DevOps Test Hub (Test Hub) under a classification. You can create classification for your project that enable you or members in your project to use secrets at test runtime either in Test Hub or in HCL DevOps Test Integrations and APIs (Test Integrations and APIs).
Creating a secret in a classification
You must create secrets in the classifications that is set in your project so that the members of the project with access to the secrets can use them in specific during an API Suite run.

Test Manager Guide
This guide describes how to manage and track your overall test effort. This guide is intended for test managers.
- Managing team spaces
  You might want to become a team space member, add members to your team space, change a user role in a team space, modify the team space, or delete a team space.
- Managing DevOps Test Hub projects
  HCL DevOps Test Hub (Test Hub) projects manage access to your test assets, which are stored in a Git repository. Projects are maintained in a team space. Projects are either public by default or private. Private projects are not discoverable by other users. You can either add your own project or you can request to be a member of another public project.
- Managing repositories
  After you create a project in HCL DevOps Test Hub (Test Hub), you can add repositories that contain test assets and resources to the project. You can also change the repository details, update the user credentials of a repository, delete a repository, create a webhook for the configured repository.
- Protecting API test assets by using secrets
  Secrets are key-value pairs that are created for your project in HCL DevOps Test Hub (Test Hub) under a classification. You can create classification for your project that enable you or members in your project to use secrets at test runtime either in Test Hub or in HCL DevOps Test Integrations and APIs (Test Integrations and APIs).
  - Creating a secret in a classification
    You must create secrets in the classifications that is set in your project so that the members of the project with access to the secrets can use them in specific during an API Suite run.
  - Granting access to members or member roles
    You can grant Read access to the secrets added to the classification in your project at the role level for members of a designated role. Additionally, you can provide Read and Write access to specific members. Without access to the classification, members cannot view, create, edit, delete, or use the secrets added to the classification.
  - Managing secrets
    You can view, edit, or delete the secrets configured under a classification any time after you created secrets or after you were granted access to the secrets classification. You can change the value of the secret by editing the secret. You can delete secrets that you no longer require in your test environment.
- Managing notifications
  HCL DevOps Test Hub (Test Hub) provides a feature to display notifications for different events within the user interface (UI) of Test Hub. You can configure an SMTP server on Test Hub when you want Test Hub to send out notifications about the different events as emails to the subscribed users. You can also configure third-party applications as webhooks on Test Hub when you want Test Hub to send push notifications about the server events to the third-party applications in a preset template.

Creating a secret in a classification

You must create secrets in the classifications that is set in your project so that the members of the project with access to the secrets can use them in specific during an API Suite run.

Before you begin

You must have completed the following tasks:

Created a project on Test Hub.
Created a classification. See Creating a classification.
You must be a member with access to the secrets in the classification. See Granting access to members or member roles.

About this task

You can also configure secrets such that the secrets can be used across different test environments by members with access to the classification. Secrets correspond to the environment variables or tags that you create in a Test Integrations and APIs project specific to an environment.

Procedure

Log in to Test Hub.

The team space that contains your project is displayed.
Click Active projects > My projects > project_name to open the project that contains the test assets.

The Overview page of the project is displayed.
Click Manage > Security.
The Security page is displayed.
Click a classification for which you want to add the secrets under the Classification.
Click Add Secret.
The Add Secret dialog is displayed.
Enter a name for the secret as its Identifier, and then enter the password as the Value for the secret.

For example, enter the name of the secret to access a database as dbcred and enter the password required to access the database as its value.
Click Create.

A message is displayed that confirms the creation of the secret.

Results

You have created secrets in the selected classification for your project.

What to do next

You can view, edit, or delete the secrets added to a classification any time you want.
You can use the secrets in the tests that require these secrets during test runs.