Setup Overview¶

To be able to use the Allure Reporting Server in the System Health Lab. The following instructions will need to be executed below.

Examples

There are examples on this repository that outlines step 2-4 in a language dependent. With the examples, you only need to focus on 2-3 since step 4 can just be copy pasted (with tiny setup change). Essentially with the examples, you can copy it to your own repository and change the tests and the source files that you are testing, .

1. Setup a Allure Project¶

This is done by an administrator that have access to the Allure Reporting Server.

Login as an administrator using credential
At the top-right corner, press the button that signifies addition and create a project

Credentials

The credentials that are entered here will need to be known for the Upload step

2. Create your own tests (in your own repository)¶

This will need to be done by the developer/engineer that will be using this test reporting server. See examples in this repository.

3. Setup the Testing Folder Structure (in your own repository)¶

This is important for code readability, and that is by splitting the tests from the source files. See examples in this repository how this is done.

4. Setup the Continuous Integration Pipeline (in your own repository)¶

This is dependent on how your CI pipeline will work, but usually the steps are:

Install dependencies
Run the Test
Upload the test

Uploading tests¶

This is done using upload_scripts in this repository. If you take a good look at the .github/workflows/test.yml, this is an example of file that you will just copy, and no configuration that you need to do aside from changing the PROJECT_NAME.

Environment Variables

If your repository does not belong in the uwasystemhealthlab organisation, you will have to put the environment variables:

1
2
3

ALLURE_USER=<CHANGE THIS>
ALLURE_PASSWORD=<CHANGE THIS>
ALLURE_API_SERVER=<CHANGE THIS>

Otherwise, no extra step that needs to be done.