Integration with YouTrack

This page describes how to set up Allure TestOps integration with the YouTrack issue tracker. With this integration, an Allure TestOps launch, test result or a defect can have clickable links to related YouTrack issues.

Both cloud and self-hosted editions of YouTrack are supported. Note that for adding an issue to a test case manually, YouTrack must be accessible from the Allure TestOps server.

To use automatic linking between test cases and issues, a test author needs to define a relation using an Allure Report adapter for their test framework. Here's an example of such a definition:

import { test } from "@playwright/test";
import { allure } from "allure-playwright";

test("Some test", async ({ page }) => {
  allure.label("youtrack-prod", "BUG-123");
  // ...
});

This code defines a relation between the test and the “BUG-123” issue in the “youtrack-prod” issue tracker. To make this an actual link in the web interface, Allure TestOps will use an issue mapping for “youtrack-prod”, as configured on step 4.

Note that while the example above works, in a real project we recommend to define your own wrapper function instead of specifying the key in allure.label() every time. Please consult the Allure Report documentation for your test framework.

First, the administrator specifies the URL of the YouTrack server.

Then, any project's owner creates an authentication token in YouTrack, adds it to Allure TestOps, and configures issue mapping.

1. Specify YouTrack URL in Allure TestOps

1. Log into Allure TestOps using an administrator account.

2. Click on your avatar and go to Administration → Integrations.

3. Click Add integration in the top right corner of the page.

4. In the dialog that appears, select YouTrack.

5. Fill in the fields:

   • Name — a name to help you recognize the integration, e.g., “YouTrack production”.
   • Endpoint — the URL of the YouTrack instance, e.g., “https://example.youtrack.cloud/”.

6. If your YouTrack server uses a self-signed SSL certificate, check the Disable certificate validation checkbox.

7. Click Add integration.

2. Create a token in YouTrack

Skip this if you prefer to use your username and password as the credentials on the next step.

1. In YouTrack, click on your avatar and go to Profile.

2. Go to the Account Security tab.

3. Under the Tokens section, click New token.

4. Fill in the fields:

   • Token Name — a name to help you recognize the token, e.g., “Token for Allure TestOps”.
   • Scope — “YouTrack”.

5. Click Create, then click Copy token.

   The new token will be copied into your clipboard.

   You will need this token on the next step.

3. Add the YouTrack credentials to Allure TestOps

1. In Allure TestOps, go to the project page.

2. In the menu on the left, click Settings → Integrations.

3. Under the Available integrations, find the YouTrack integration and click Add integration next to it.

4. In the dialog that appears, fill in the fields:

   • Username — the username that you use to log into YouTrack.
   • Password — the password that you use to log into YouTrack or the token that you got on step 2.

   Check that the credentials are correct

   Click Test connection. After a few moments, a message should appear saying “Connection established”.

5. Click Add integration to close the dialog and save the settings.

4. Configure issue mapping

1. In Allure TestOps, go to the project page.

2. In the menu on the left, click Settings → Issues.

3. Click Create.

4. Fill in the fields:

   • Key — a short integration identifier that you are going to use when writing the tests.
   • Issue tracker — the name of the integration that you added on step 1.

5. Click Submit.