Accessing test assets from a server project

HCL OneTest™ Server projects manage access to your test assets, which are stored in a Git repository. Projects are either public by default or private. Private projects are not discoverable by other users. You can either create your own project or you can request to be a member of another public project.

If you decide to create your own project, you add details about the project, add one or more Git repositories, optionally add secrets, and classify encrypted datasets. If you decide that you want to be a member of another public project, see Becoming a project member.

Before you begin

To collaborate with other project stakeholders, you can open test assets from a local clone of the Git repository, pull project test assets from a Git repository, and push changes made to your local test assets to a Git repository. Consider the following information before you create a project and add a repository to that project.

Sign up and login

To create one or more projects to manage access to your test assets, you must log in to HCL OneTest Server by providing the application URL in a browser.

If you are a new user, and LDAP and Active Directory are not configured, you must first sign up by completing a form that specifies user information such as an email, user name, and password, then you can log in by using that information. For more information about login and new user sign up, see Administering security.

Installing Git

You must install Git or upgrade the version if you already have installed Git. You can find the instructions to install or upgrade at Installing Git.

Setting up repositories and user identities

After you install Git, you must set up your Git repository and set up access for members. You must ensure that the repository contains your test assets. For more information about Git, see Git.

To set up accounts for users or members, see Account Setup and Configuration for GitHub.

Optionally, you can use a command line utility or Git tool to access the repository, upload your test assets, fetch or pull from the repository, push to the repository, clone the repository, and other operations you want to perform in Git. For more information about how to use Git, see the documentation for your preferred method for accessing and using Git in the Git documentation.

Local and shared repositories

After you create a remote or shared repository in Git, you can create a local version of the repository by cloning the remote repository. You must ensure that your test assets are available in the remote repository and are also cloned to the local repository.

Alternatively, if your test assets are on your local system, you can set up a Git repository in the bare mode, add the project files to the local repository, and then commit and push from the local repository to the remote repository in Git by using your preferred method for doing this.
Note: While copying the test assets from your local system to the repository, you must ensure that you copy the entire project that contains the test assets.
Setting up user authentication for Git repository
The administrator can set up different types of authentication for accessing the Git repository. HCL OneTest Server supports the following authentication types:
  • HTTP with user name and password
  • HTTP without user name and password
  • HTTPS with user name and password
  • HTTPS without user name and password
  • SSH with SSH key and passphrase
  • SSH with SSH key and without a passphrase

Based on the authentication type that is set for a repository, the user must provide the same authentication values in HCL OneTest Server while adding a repository.

Preparing test assets
You must ensure that you complete the following operations in the desktop clients where you are authoring your test before you check in and commit the test assets to the Git repository.
Test type Task More information

API suite in HCL OneTest API

Change the local stub to a remote stub See Running tests
Add the library files See Running tests

About this task

You must create a project and configure it. If you defer the configuration of a project when you create a project, you can update the project configuration settings by opening the project, adding repositories, using secrets, and encrypting datasets, if applicable.

The following tasks explain how you can manage access to test assets through projects:

Creating a project

To manage access to test assets, you must create and configure a project.

Before you begin

You must have registered with your user information and logged into HCL OneTest Server.

About this task

When you create a project, you must configure it. Configuring a project includes details such as making the project public or private, providing a name and description, adding one or more Git repositories, and optionally adding secrets. To run the tests that are associated with an encrypted dataset, you must categorize encrypted datasets by creating a classification.

You can decide to configure the project when you create it or configure it later. If you configure the project now, its configuration is automatically saved. If you configure it later, you must save the project.

The following tasks explain how you can create and configure a project:

Adding details

The first step is to create a project and provide some details about it.

About this task

You create a project and give it a name and description.

Procedure

  1. Log in to HCL OneTest Server.
  2. From the Home page, create a project.
  3. Decide if you want a public project, which is the default, or a private project, then, give it a name and an optional description.

Adding repositories

As a project owner, you can add repositories to a server project. When you add new repositories, you can access the test assets available in the respective repository.

To gain access to the repository, there are three types of authentication, which are HTTPS, HTTP and SSH. Based on the type of authentication, you must provide the credentials to access the repository.

Before you begin

  • You must have created a project on HCL OneTest Server.
  • You must have been granted access to the repository.
  • In the case of SSH authentication, you must have an appropriate deploy key and passphrase, if applicable.
To add one or more repositories, you must log in to HCL OneTest Server by providing the application URL in a browser.

About this task

A project can contain one or more repositories. When you add a repository to your project, you clone the repository. Based on the authentication type, you can provide the necessary details such as a Git URL, deploy key and passphrase.

Procedure

  1. After you log in, go to the project Home page and add one or more repositories to your project by following these steps:
    1. Add a Git repository URI.
    2. To provide credentials, click the Expand icon Expand Git credentials icon to open a page and enter the required credentials. If the Git repository uses SSH authentication, you must provide the SSH key. If the Git repository uses HTTP basic authentication, you must provide a user name and password.
    3. Click Add.
      A copy of your existing Git repository is cloned.
      Note: Depending on the size of the repository you are cloning, it can take a few to several minutes to clone a copy of the repository.
      You can work with that repository by completing the following tasks:
      • Editing the settings
      • Selecting a folder to scope the access to a subset of the repository
      • Changing the credentials
      • Removing references to the repository
      For more information, see Working with Git repositories.
  2. Optional: Repeat the applicable steps to add another repository.

What to do next

  • If you are working with an API Suite and the project test asset contains environment variables that are required for test runs, you must configure the environment variables as secrets under a secrets collection by using the Secrets tab. Configuring secrets enable the API suite to run correctly on the server. For details, see Protecting API test assets by using secrets.
  • If you are working with tests other than an API suite and the project test asset contains encrypted datasets, you must configure the project in HCL OneTest Server by using the Data Security tab. For details, see Managing an encrypted dataset.
  • You can add users to your public or private project. See Adding users to a project.

Adding users to a project

As a project owner, you can add users to your project so they can access your test assets.

Before you begin

You own a project.

About this task

As a project owner, you can add other users to your project. For example, a large number of test assets must be run and you want your test team to help run them and see the results.

Procedure

  1. You can add users to a public or private project if you own it. To add one or more users to be members of your project, you can choose to configure your project by clicking the Settings icon Configure project icon on the Project card in the list of My Projects, or by clicking Configure in the navigation when the project is already open.
  2. Add users by entering the user name of the user you want to add. You can add a partial name and then press Enter to see the user that you want to add.
  3. Select that user and then assign a role by clicking Viewer, Tester, or Owner on the Add People page. When you add a user, the default role is Viewer. For more information about each role, see Managing access to projects.

    The added user after logging in can see the owner's project in their list of My Projects.

  4. Repeat the applicable steps to add another user.

What to do next

You can add or remove roles to one or more projects that you own. See Managing access to projects. All users can request to be a member of another public project. See Becoming a project member.

Viewing an overview of the projects test assets, runs, and results

As a project member, you can see the overall status of the testing activities for your project.

Before you begin

You have configured a project with a repository, which includes test assets, and those test assets were run.

About this task

If you configured a project with one or more Git repositories and ran some tests, you can see the proportions of test asset types, the overall test run statistics, the last test assets that were run, when tests were added or changed, and any scheduled test runs. Opening each card provides you with more information.

Procedure

  1. Click the Overview icon from the navigation to see the Overview page.
  2. To see the status of a collection of tests for a different date, change the date range.
  3. To see new or modified tests for a different date, change the date range.
  4. To see details for test results, the last run, new or modified tests, or scheduled test runs, open each of those cards.

What to do next

You can run tests or view test results.

Feedback