Allure

Import test results from Allure format into Testomat.io. The reporter automatically parses Allure results, extracts test information, and creates tests in your project.

Quick Start

Install the reporter:

npm install @testomatio/reporter --save-dev

Run your tests to generate Allure results, then import:

TESTOMATIO={API_KEY} npx @testomatio/reporter allure allure-results

You can pass:

• A folder path (e.g., allure-results)
• A glob pattern (e.g., "allure-results/*-result.json")

The reporter automatically finds Allure result files (*-result.json) and container files (*-container.json) in the specified location.

What Gets Imported

Field	Source	Notes
Test Title	name field	Test method name
Status	status field	passed, failed, broken → failed, skipped/pending
Suite	suite label	Suite title
Epic	epic label	Sent as link { label: "epic:Value" }
Feature	feature label	Sent as link { label: "feature:Value" }
File	testClass label + language	Source file name (e.g., LoginTest.kt)
Code	Source file	Fetched if file exists (see Source Code)
Steps	steps array	Converted with category=“user”; per-step status mapped (passed, broken/failed → failed, skipped → none)
Attachments	attachments array	Uploaded as artifacts
Parameters	parameters array	Converted to example object
Description	description field	Mapped directly
Message/Stack	statusDetails	Error information from failed tests
Linked cases	@TmsLink (links[type=tms])	Each id links the result to an existing Testomat.io case

Linking results to existing cases with @TmsLink

To make reported results update existing test cases instead of creating duplicates, annotate tests with @TmsLink pointing at the Testomat.io test ID:

@TmsLink("1a2b3c4d")
@Test
void testLogin() { ... }

Allure writes this into the result JSON as a link with type: "tms":

"links": [{ "name": "1a2b3c4d", "type": "tms", "url": "https://app.testomat.io/.../test/1a2b3c4d" }]

The reader maps every @TmsLink to a linked case ({ "test": "<id>" }), so a single run updates all of them — the same mechanism as the runtime linkTest() helper. A test linked to several cases is fully supported:

@TmsLinks({ @TmsLink("00056731"), @TmsLink("00056729") })   // both cases get updated
@Test
void testCheckout() { ... }

Links whose URL points at a Testomat.io test page are also recognized even when type is missing (e.g. .../test/1a2b3c4d).

test_id and @TmsLink are separate concerns. @TmsLink links cases. The test_id is a distinct field, set from a native Testomat.io id in the source (e.g. a // @T1a2b3c4d marker) when present. As a fallback, when a test has no test_id, the first linked case is adopted as the test_id so the test matches an existing case instead of creating a method-named duplicate — the id still stays in links, so every linked case is updated.

ID format. Testomat.io test IDs are exactly 8 characters. The reader accepts the bare id (1a2b3c4d) or the T / @T markers Testomat uses (T1a2b3c4d, @T1a2b3c4d) and normalizes them to the bare 8-char id. Values that are not valid 8-char Testomat IDs — a numeric Allure TestOps ID (@AllureId(12345)), a JIRA key, or a 6-digit TMS number — are ignored rather than sent, so they never produce unmatchable IDs. Those tests are still imported; they just match by title/historyId or are created fresh.

Skipped tests (@Ignore / @Disabled)

Allure processes @TmsLink during test execution, so skipped tests never get a tms link in their result JSON — the annotation is simply absent. Left alone, those tests reach Testomat.io unlinked and create duplicate cases titled with the raw method name.

The reader recovers the links by reading @TmsLink straight from the test source. Point it at your test sources with --java-tests (works for Java and Kotlin):

npx @testomatio/reporter allure "allure-results/*-result.json" --java-tests src/test

For each test that is not yet linked, the reader locates the test method in source and reads all its @TmsLinks — including @TmsLinks(...) containers (single- or multi-line). The lookup is method-scoped, so only that method’s links are used. This requires the test sources to be present on the machine that runs the reporter.

If the sources are not available at report time, fix it on the generation side instead — make the link available even when the test is skipped, e.g. move it to a place Allure always records (a class-level link, or a non-skip exclusion such as Assumptions.assumeTrue(false) inside the body instead of @Disabled), so @TmsLink ends up in the result JSON.

Retry Deduplication

If a test was run multiple times (retries), results are combined into 1 test. Tests are deduplicated by historyId - so 3 retry attempts of the same test count as 1 test, not 3.

Failure information is preserved: If any retry attempt fails, all failure messages and stack traces from failed attempts are combined. The final status reflects the last attempt.

• If all attempts failed → combines all failure messages and stack traces
• If final attempt passed but earlier attempts failed → marked as failed with combined failure info

Console output shows the deduplication:

[TESTOMATIO] Found 4 result files and 0 container files
[TESTOMATIO] Processed 2 unique tests (from 4 result files)

Command Options

npx @testomatio/reporter allure <pattern> [options]

Option	Description
<pattern>	Folder path or glob pattern (e.g., allure-results or allure-results/*-result.json)
--with-package	Keep full package path in file name (default: strip package)
--java-tests <dir>	Path to test source files for code fetching
--lang <lang>	Language for source code parsing (java, kotlin, python, ruby, etc.)
--timelimit <sec>	Kill process after N seconds if stuck

File Path Behavior

By default, only the class name is used as the file (e.g., LoginTest.kt).

With --with-package, the full package path is included:

com/example/app/tests/ui/LoginTest.kt

Artifacts

Attachments (screenshots, videos, logs) from Allure results are uploaded as artifacts.

Note: Artifacts require S3-compatible storage to be configured. If S3 is not set up, attachments will be omitted from the report.

See Artifacts documentation for S3 configuration details.

Source Code

Test code snippets are fetched from source files when available.

Note: Source code extraction requires access to test source files. Use --java-tests <dir> to specify the source directory. If source files are not accessible, code field will be empty.

Examples

Java / JUnit

mvn clean test
TESTOMATIO={API_KEY} npx @testomatio/reporter allure "target/allure-results/*-result.json" --lang java --java-tests src/test/java

Kotlin / Android

./gradlew connectedAndroidTest
TESTOMATIO={API_KEY} npx @testomatio/reporter allure "build/allure-results/*-result.json" --lang kotlin

Migration from Allure Report

Migration Steps

1. Keep Allure for test execution - Continue using Allure in your test framework

2. Add Testomat.io import - Add one command to your CI pipeline to import Allure results:

npx @testomatio/reporter allure allure-results

3. Configure S3 (optional) - Set up S3 storage to enable artifact uploads

4. Remove Allure report generation - Once satisfied with Testomat.io reports, you can remove Allure HTML report generation step

5. Enable PR comments - Add GH_PAT: ${{ github.token }} to enable automatic PR comments with test results

Comparison

With Allure only:

mvn test
allure generate allure-results

With Testomat.io:

mvn test
npx @testomatio/reporter allure allure-results

Debugging

Enable debug mode to see detailed information:

DEBUG=@testomatio/reporter:* npx @testomatio/reporter allure "allure-results/*-result.json"

A debug file is created at /tmp/testomatio.debug.latest.json with the exact data sent to Testomat.io.

GitHub Actions Workflow

Example workflow for Java/JUnit projects with Allure:

name: CI with Allure

on:
  pull_request:
  workflow_dispatch:

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up JDK
        uses: actions/setup-java@v4
        with:
          java-version: '17'
          distribution: 'temurin'

      - name: Run tests
        run: mvn clean test

      - name: Import to Testomat.io
        run: npx @testomatio/reporter allure target/allure-results --lang java --java-tests src/test/java
        if: always()
        env:
          TESTOMATIO: ${{ secrets.TESTOMATIO }}
          TESTOMATIO_TITLE: 'PR ${{ github.event.number }}'
          # Optional: S3 for artifacts
          # S3_BUCKET: ${{ secrets.S3_BUCKET }}
          # S3_REGION: ${{ secrets.S3_REGION }}
          # S3_ACCESS_KEY_ID: ${{ secrets.S3_ACCESS_KEY_ID }}
          # S3_SECRET_ACCESS_KEY: ${{ secrets.S3_SECRET_ACCESS_KEY }}