GitHub action

This topic describes how to integrate with GitHub's CI\CD (continuous integration\continuous delivery) build mechanism.

About the GitHub action

The Test Execution GitHub action allows you to trigger tests on an OpenText Enterprise Performance Engineering server, monitor the tests, generate analysis or trend reports, and get the report status.

The tests can be pre-existing ones referenced by their ID, or tests defined in a YAML file stored in the GitHub repository.

Back to top

Prerequisites

The following are the prerequisites for setting up the GitHub action.

  1. Perform these steps:

    actions/checkout@v4

    actions/setup-java@v4 (version 11)

    actions/setup-node@v4

  2. Perform an npm install.

  3. To save the reports to a build artifact, add actions/upload-artifact@v4

Note: User names and passwords should be saved as secrets and used as environment variables in the workflow.

Back to top

Action inputs

This table lists the action inputs for setting up and running a test.

Input

Description

Required

Default

lre_action

Action to be triggered. Current supported action: ExecuteLreTest

No

ExecuteLreTest

lre_description

Description of the action (will be displayed in console logs).

No

Not Applicable

lre_server

Server URL and port (when not mentioned, default is 80 or 433 for secured) and tenant (when not mentioned, default is ?tenant=fa128c06-5436-413d-9cfa-9f04bb738df3). e.g.: mylreserver.mydomain.com:81/?tenant=fa128c06-5436-413d-9cfa-9f04bb738df3'

Yes

Not Applicable

lre_https_protocol

Use secured protocol for connecting to LRE. Possible values: true or false.

No

false

lre_authenticate_with_token

Authenticate with a token. Required when configured for SSO . Possible values: true or false.

No

false

lre_username

Username

Yes

Not Applicable

lre_password

Password

Yes

Not Applicable

lre_domain

Domain (case sensitive)

Yes

Not Applicable

lre_project

Project (case sensitive)

Yes

Not Applicable

lre_test

A valid test ID# or relative path to yaml file in the git repo defining new test design creation

Yes

Not Applicable

lre_test_instance

The test instance. Specify AUTO to use any instance or enter a specific instance ID

No

AUTO

lre_timeslot_duration_hours

Timeslot duration in hours

No

0

lre_timeslot_duration_minutes

Timeslot duration in minutes

No

30

lre_post_run_action

Possible values for post run action: Collate Results, Collate and Analyze, or Do Not Collate

No

Do Not Collate

lre_vuds_mode

Use VUDS licenses. Possible values: true or false

No

false

lre_trend_report

One of the following values:

  • ASSOCIATED (the trend report defined in the test design will be used)

  • A valid report ID#

No value or not defined indicates no trend monitoring in build, but the trend report defined in LRE will not be canceled.

No

Not Applicable

lre_proxy_out_url

Proxy URL

No

Not Applicable

lre_username_proxy

Proxy username

No

Not Applicable

lre_password_proxy

Proxy password

No

Not Applicable

lre_search_timeslot

Experimental: Search for matching timeslot instead of creating a new timeslot. Possible values: true or false.

No

false

lre_status_by_sla

Report success status according to SLA. Possible values: true or false.

No

false

lre_output_dir

The directory to read the checkout folder and to save results . Use $CI_PROJECT_DIR.

No

./

lre_enable_stacktrace

If set to true, a stack trace of the exception will be displayed with errors in console logs.

No

false

For examples of using the action inputs, see the plugin documentation on github.com.

Back to top

See also: