Allure reporter support

.gitignore

@@ -7,7 +7,7 @@ yarn-error.log*
 lerna-debug.log*
 # package-lock.json
 
-
+sample_allure/
 tests/adapter/cucumber/node_modules
 
 # Diagnostic reports (https://nodejs.org/api/report.html)

README.md

@@ -76,6 +76,7 @@ npx testomatio-reporter <command> [options]
 | [TestCafe](./docs/frameworks.md#testcafe)       | [Detox](./docs/frameworks.md#detox)           | [Codeception](https://github.com/testomatio/php-reporter) |
 | [Newman (Postman)](./docs/frameworks.md#newman) | [JUnit](./docs/junit.md#junit)                | [NUnit](./docs/junit.md#nunit)                            |
 | [PyTest](./docs/junit.md#pytest)                | [PHPUnit](./docs/junit.md#phpunit)            | [Protractor](./docs/frameworks.md#protractor)             |
+| [Allure](./docs/allure.md)                      |                                               |                                                           |
 
 or **any [other via JUnit](./docs/junit.md)** report....
 
@@ -137,9 +138,10 @@ Bring this reporter on CI and never lose test results again!
   - [HTML report](./docs/pipes/html.md)
   - [Markdown report](./docs/pipes/markdown.md)
   - [Bitbucket](./docs/pipes/bitbucket.md)
-- 🔗 [Linking Tests](./docs/linking-tests.md)
-- 📓 [JUnit](./docs/junit.md)
+- 📓 [JUnit Reports](./docs/junit.md)
 - 🗄️ [Artifacts](./docs/artifacts.md)
+- 🔬 [Allure Reports](./docs/allure.md)
+- 🔗 [Linking Tests](./docs/linking-tests.md)
 - 🔂 [Workflows](./docs/workflows.md)
 - 🖊️ [Logger](./docs/logger.md)
 - 🪲 [Debug File Format](./docs/debug-file-format.md)

docs/allure.md

@@ -0,0 +1,225 @@
+# Allure Reports Import
+
+Import test results from [Allure](https://docs.qameta.io/allure-report/) format into Testomat.io. The reporter automatically parses Allure results, extracts test information, and creates tests in your project.
+
+## Quick Start
+
+Install the reporter:
+
+```bash
+npm install @testomatio/reporter --save-dev
+```
+
+Run your tests to generate Allure results, then import:
+
+```bash
+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](#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 |
+| **Test ID** | `@TmsLink` (`links[type=tms]`) | Used to match existing Testomat.io test cases |
+
+## Matching Existing Tests 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:
+
+```java
+@TmsLink("T1a2b3c4d")   // or the bare id: @TmsLink("1a2b3c4d")
+@Test
+void testLogin() { ... }
+```
+
+Allure writes this into the result JSON as a link with `type: "tms"`:
+
+```json
+"links": [{ "name": "T1a2b3c4d", "type": "tms", "url": "https://app.testomat.io/.../test/1a2b3c4d" }]
+```
+
+The reader reads that link's name and sends it as the test's `test_id`, so Testomat.io matches the
+existing case. Links whose URL points at a Testomat.io test page are also recognized even when `type`
+is missing (e.g. `.../test/1a2b3c4d`). When no `@TmsLink` is present, the reader falls back to an ID
+parsed from the source code (if available).
+
+**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.
+
+## 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
+
+```bash
+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](./artifacts.md) 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
+
+```bash
+mvn clean test
+TESTOMATIO={API_KEY} npx @testomatio/reporter allure "target/allure-results/*-result.json" --lang java --java-tests src/test/java
+```
+
+### Kotlin / Android
+
+```bash
+./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:
+
+```bash
+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:**
+```bash
+mvn test
+allure generate allure-results
+# Upload HTML report manually or share locally
+```
+
+**With Testomat.io:**
+```bash
+mvn test
+npx @testomatio/reporter allure allure-results
+# Automatic cloud report with history, PR comments, analytics
+```
+
+## Debugging
+
+Enable debug mode to see detailed information:
+
+```bash
+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:
+
+```yaml
+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 }}
+```