TestOps logo
Try TestOps

GitLab CI

GitLab CI integration connects GitLab pipelines with Allure TestOps: uploads test results during a pipeline run using allurectl, lets TestOps trigger GitLab pipelines, and maps CI variables to launch environments.

This page covers GitLab CI. For issue linking or launch export to GitLab work items, see GitLab Issues.

Before you begin

  • The URL of your TestOps instance and the numeric TestOps project ID.
  • Access to edit .gitlab-ci.yml in the repository.
  • A GitLab personal or project access token for the TestOps-to-GitLab trigger path.

1. Send results from GitLab to TestOps

Create the TestOps token

  1. In Allure TestOps, click your avatar and open API Tokens.
  2. Click + Token.
  3. Enter a name for the token, for example Token for GitLab, and click Create.
  4. Copy the generated token.

Store the token in GitLab

  1. In GitLab, open the project and go to Settings → CI/CD.
  2. Under Variables, click Add variable.
  3. Fill in the fields:
    • Type — Variable
    • Visibility — Masked
    • Key — ALLURE_TOKEN
    • Value — the API token copied from TestOps
  4. Click Add variable.

Update .gitlab-ci.yml

Add the required variables, download allurectl in before_script, and wrap the test command with watch:

test:
  stage: test
  image: gradle
  variables:
    ALLURE_ENDPOINT: https://testops.example.com
    ALLURE_PROJECT_ID: 1
    ALLURE_RESULTS: build/allure-results
  before_script:
    - curl -fsSL https://github.com/allure-framework/allurectl/releases/latest/download/allurectl_linux_amd64 -o allurectl
    - chmod +x allurectl
  script:
    - ./allurectl watch -- gradle clean test
  • ALLURE_ENDPOINT — TestOps base URL.
  • ALLURE_PROJECT_ID — numeric TestOps project ID.
  • ALLURE_RESULTS — directory where the test framework writes Allure result files. To specify multiple directories, separate them with commas or use a wildcard pattern.
  • ALLURE_TOKEN — the masked GitLab variable that stores the TestOps token.

If the runner image does not include curl, use wget or bake allurectl into the runner image.

Verify the upload

After the next pipeline run:

  1. In GitLab, open the job that runs tests. Near the end of its log there should be a link to the TestOps launch.

    The GitLab job log shows the link to the launch created in Allure TestOps.

  2. Open the launch in TestOps and confirm test results are present.

  3. Open one result and confirm it links back to the GitLab pipeline.

    The test result page links back to the GitLab pipeline that produced the upload.

2. Let TestOps trigger GitLab pipelines

Add the global GitLab integration

An instance administrator should:

  1. Open Administration → Integrations.
  2. Click + Add integration.
  3. Select GitLab.
  4. Fill in the fields:
    • Name — a recognizable name, for example GitLab production.
    • Endpoint — the URL of the GitLab instance, for example https://gitlab.example.com/.
  5. If the GitLab instance uses a self-signed SSL certificate, check Disable certificate validation.
  6. Click Add integration.

Create a GitLab access token

  1. In GitLab, click your avatar and go to Preferences.
  2. In the left menu, click Access Tokens.
  3. If the token creation form is not visible, click Add new token above the token list.
  4. Fill in the fields:
    • Token name — a recognizable name, for example Token for Allure TestOps.
    • Expiration date — how long the token should stay valid. After this date the integration stops working and you must create a new token.
    • Select scopes — check api and read_api.
  5. Click Create personal access token. The page reloads and the Your new personal access token field appears at the top. Copy the token.

You can also use a project access token, but it grants access to only one GitLab project.

Add the GitLab integration to the project

  1. In TestOps, open the target project and go to Settings → Integrations.
  2. Under Available integrations, find the GitLab integration and click Add integration.
  3. Enter the GitLab token in the Token field.
  4. Click Test connection. A "Connection established" message confirms the token is correct.
  5. Click Add integration.

Configure the GitLab-backed job in TestOps

After the first successful upload, TestOps creates the GitLab-backed job automatically:

  1. Open Jobs in the project.

  2. Click ⋯ next to the job and select Configure.

  3. Fill in the fields:

    • Name — a stable display name.
    • Build server — the global GitLab integration added by the administrator.
    • Job can be used to run tests — enable to allow triggering from TestOps.
    • Parameters — see Section 3.

    The dialog allows to set job settings.

  4. Click Submit.

3. Pass parameters and branch values

GitLab uses CI variables for passing parameters to pipelines. Allure TestOps integrates this with its Environment concept, letting you control parameters for new jobs and see parameters from jobs triggered outside TestOps.

Set default values in GitLab

Add variables and their defaults to the variables block in .gitlab-ci.yml:

test:
  stage: test
  image: gradle
  variables:
    ALLURE_ENDPOINT: https://testops.example.com
    ALLURE_PROJECT_ID: 1
    ALLURE_RESULTS: build/allure-results
    PRODUCT_VERSION: "1.23"
    TESTS_BROWSER: chrome
  before_script:
    - curl -fsSL https://github.com/allure-framework/allurectl/releases/latest/download/allurectl_linux_amd64 -o allurectl
    - chmod +x allurectl
  script:
    - ./allurectl watch -- gradle clean test

Add global environment names

An instance administrator should:

  1. Open Administration → Environment.

  2. For each parameter, click + Create, enter the name, and click Submit.

    Environment variable names are added in the Administration section.

Map parameters in the project

  1. In the project, open Settings → Environment.

  2. For each parameter, click + Create (or the edit icon if it already exists):

    • Mapping key — the GitLab variable name, for example TESTS_BROWSER.
    • Environment variable — the global parameter name created by the administrator.

  3. Click Submit.

    Mapping environment variables is configured in the project settings.

Add parameters to the job

  1. Open Jobs, click ⋯ next to the job, and select Configure.

  2. In the Parameters section, click Add for each parameter:

    • Name — the GitLab variable name (matches the mapping key).
    • Value — the default value.
    • Environment Variable — the global parameter name.

    Multiple environment variables can be specified in the dialog.

  3. Click Submit.

If the project has multiple branches, add a Branch environment variable in Allure TestOps and map it to the GitLab variable that controls branch selection. This special name instructs GitLab which branch to use when TestOps triggers the pipeline.

Troubleshooting

No results arrive in TestOps

Check:

  • ALLURE_TOKEN is set as a masked variable in GitLab CI/CD settings;
  • ALLURE_ENDPOINT, ALLURE_PROJECT_ID, and ALLURE_RESULTS point to the expected TestOps project and results directory;
  • the job runs ./allurectl watch -- <test command>.

TestOps triggers the pipeline but results go into a new standalone launch

ALLURE_JOB_RUN_ID is not reaching allurectl. Confirm that the variable is passed through the pipeline's environment and that the run was triggered from TestOps, not manually from GitLab.

© Qameta Software Inc. All rights reserved.