HCL OneTest Server

This action enables you to integrate with HCL OneTest™ Server.

How this works

After you complete the integration, you can run tests assets that are available in a project of HCL OneTest™ Server from a Github action.

Pre requisites

1. Create a github repository
2. Create a folder named ".github" in the root of the repository
3. Create a folder named "workflows" inside the ".github" folder.
4. Create a .yml file with any name , inside the "workflow" folder and you need to code as following example in that yml file

Example usage

name: HCL OneTest Server

on:
    workflow_dispatch:
        inputs:
            server_url:
                description: 'Server URL'
                required: true
            offline_token:
                description: 'Offline Token'
                required: true
            team_space:
                description: 'Team Space Name'
                required: true
            project:
                description: 'Project'
                required: true
            branch:
                description: 'Branch'
                required: true
            assetId:
                description: 'AssetID'
                required: true
            environment:
                description: 'API Test Environment'
                required: false
            datasets:
                description: 'Datasets'
                required: false
            exportReport:
                description: 'Export Junit Report'
                required: false
            multipleValues:
                description: 'Multiple Values'
                required: false

jobs:

    OTS-Action:
        runs-on: self-hosted
        name: HCL OneTest Server
        steps:
         - name: Execute Test
           uses: SonaHJ/OTSAction@HCLOneTestServer_03
           with:
            serverUrl: '${{ github.event.inputs.server_url }}'
            offlineToken: '${{ github.event.inputs.offline_token }}'
            teamspace: '${{ github.event.inputs.team_space }}'
            project: '${{ github.event.inputs.project }}'
            branch: '${{ github.event.inputs.branch }}'
            assetId: '${{ github.event.inputs.assetId }}'
            environment: '${{ github.event.inputs.environment }}'
            datasets: '${{ github.event.inputs.datasets }}'
            exportReport: '${{ github.event.inputs.exportReport }}'
            multipleValues: '${{ github.event.inputs.multipleValues }}'

7. Replace the example input values with your details.
8. Push it into the main branch
9. Go to the Actions section in the repository and select the workflow.
10. Click the Run workflow dropdown and the list of input boxes get displayed.

To configure agent:

1. Go to settings (Repo).
2. Select action -> runner.
3. Click Create self-hosted runner, follow the download and configure instruction

Inputs

serverUrl

URL of the HCL OneTest Server where the tests are located. URL should be of the format - https://hostname

offlineToken

Required Input the offline user token for the corresponding HCL OneTest Server

teamspace

Required Team Space name of the project.

project

Required Project name of the test.

branch

Required Project name of the test.

assetId

Required AssetId of the test file in HCL OneTest Server.

environment

Optional. Test environment corresponding to the test. Mandatory to input the value if you want to run API test.

datasets

Optional. Semicolon (;) delimited list of source:replacement datasets for the job to run. For example, dataset1:dataset2;dataset3:dataset4

exportReport

Optional. Use this option to export the Junit report generated for the test in XML format. Specify the complete path to the directory including the filename. For example, C:/TestFolder/TestFile.xml

multipleValues

you may only define up to 10 inputs for a workflow_dispatch event. Remaining inputs need to be Key=Value pair.

https://github.community/t/you-may-only-define-up-to-10-inputs-for-a-workflow-dispatch-event/160733

github/docs#15710

Specify the below inputs in the Key=Value format. Ex: Key1=Value1|Key2=Value2

Multiplevalue inputs

variables

Optional. Variables corresponding to the test. The format is key1=value1;key2=value2

tags

Optional. Variables corresponding to the test. The format is key1=value1;key2=value2