# allure-framework/allure-java architecture

> Architecture diagram of the GitHub repository allure-framework/allure-java, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/allure-framework/allure-java
- Repository: https://github.com/allure-framework/allure-java

## Overview

Allure Java is a family of JVM test-framework adapters and optional tool integrations that produce Allure result files for Allure Report. A test framework runs a suite through its adapter; the adapter and runtime API record test lifecycle, steps, metadata, and attachments, which are written as result files. Optional integrations capture HTTP, browser, assertion, and other tool activity. The README documents the broad adapter-to-runtime relationship; sampled code confirms selected runtime APIs and HTTP capture models, but does not establish every adapter’s internal call sequence.

Main entry points: [`allure-java-commons/src/main/java/io/qameta/allure/Allure.java`](https://github.com/allure-framework/allure-java/blob/main/allure-java-commons/src/main/java/io/qameta/allure/Allure.java) (Runtime API), [`allure-java-commons/src/main/java/io/qameta/allure/AllureLifecycle.java`](https://github.com/allure-framework/allure-java/blob/main/allure-java-commons/src/main/java/io/qameta/allure/AllureLifecycle.java) (Lifecycle engine), [`allure-jupiter/src/main/java/io/qameta/allure/jupiter/AllureJupiter.java`](https://github.com/allure-framework/allure-java/blob/main/allure-jupiter/src/main/java/io/qameta/allure/jupiter/AllureJupiter.java) (Framework adapters), [`allure-java-httpclient/src/main/java/io/qameta/allure/javahttpclient/AllureHttpClient.java`](https://github.com/allure-framework/allure-java/blob/main/allure-java-httpclient/src/main/java/io/qameta/allure/javahttpclient/AllureHttpClient.java) (HTTP clients)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frameworks["Test frameworks"]
  node_framework_adapters["Framework adapters<br/>[AllureJupiter.java]"]
  node_custom_platform["JUnit Platform"]
  node_bdd_adapters["BDD adapters"]
end

subgraph group_capture["Tool integrations"]
  node_http_clients["HTTP clients"]
  node_apache_clients["Apache clients"]
  node_browser_tools["Browser integrations"]
  node_other_integrations["Other integrations<br/>[AllureGrpc.java]"]
  node_assertion_tools["Assertion integrations<br/>[AllureAspectJ.java]"]
end

subgraph group_runtime["Runtime and results"]
  node_runtime_api["Runtime API<br/>[Allure.java]"]
  node_lifecycle["Lifecycle engine"]
  node_context["Thread context"]
  node_metadata["Result metadata<br/>[ResultsUtils.java]"]
  node_result_model["Result model<br/>[TestResult.java]"]
  node_http_capture_model["HTTP exchange model<br/>[HttpExchange.java]"]
  node_result_files[("Allure result files")]
end

subgraph group_extensions["Utilities and extensions"]
  node_kotlin_api["Kotlin extensions<br/>[Allure.kt]"]
  node_coroutine_support["Coroutine support"]
  node_javadoc_descriptions["JavaDoc descriptions"]
  node_test_plan["Test-plan filtering"]
end

node_test_runner(("Test runner"))

node_test_runner -->|"runs tests"| node_framework_adapters
node_test_runner -->|"runs tests"| node_custom_platform
node_test_runner -->|"runs tests"| node_bdd_adapters
node_framework_adapters -->|"records results"| node_runtime_api
node_custom_platform -->|"records results"| node_runtime_api
node_bdd_adapters -->|"records results"| node_runtime_api
node_runtime_api -->|"delegates lifecycle"| node_lifecycle
node_lifecycle -->|"binds items"| node_context
node_lifecycle -.->|"updates results"| node_metadata
node_runtime_api -->|"records model"| node_result_model
node_lifecycle -.->|"writes results"| node_result_files
node_http_clients -->|"adds attachments"| node_runtime_api
node_http_clients -->|"captures exchanges"| node_http_capture_model
node_apache_clients -->|"adds attachments"| node_runtime_api
node_apache_clients -->|"builds exchanges"| node_http_capture_model
node_browser_tools -->|"records activity"| node_runtime_api
node_other_integrations -->|"records activity"| node_runtime_api
node_assertion_tools -->|"records assertions"| node_runtime_api
node_kotlin_api -->|"wraps API"| node_runtime_api
node_coroutine_support -->|"propagates context"| node_runtime_api
node_javadoc_descriptions -.->|"supplies descriptions"| node_result_model
node_test_plan -.->|"filters tests"| node_framework_adapters

click node_framework_adapters "https://github.com/allure-framework/allure-java/blob/main/allure-jupiter/src/main/java/io/qameta/allure/jupiter/AllureJupiter.java"
click node_custom_platform "https://github.com/allure-framework/allure-java/blob/main/allure-junit-platform/src/main/java/io/qameta/allure/junitplatform/AllureJunitPlatform.java"
click node_bdd_adapters "https://github.com/allure-framework/allure-java/blob/main/allure-cucumber7-jvm/src/main/java/io/qameta/allure/cucumber7jvm/AllureCucumber7Jvm.java"
click node_runtime_api "https://github.com/allure-framework/allure-java/blob/main/allure-java-commons/src/main/java/io/qameta/allure/Allure.java"
click node_lifecycle "https://github.com/allure-framework/allure-java/blob/main/allure-java-commons/src/main/java/io/qameta/allure/AllureLifecycle.java"
click node_context "https://github.com/allure-framework/allure-java/blob/main/allure-java-commons/src/main/java/io/qameta/allure/internal/AllureThreadContext.java"
click node_metadata "https://github.com/allure-framework/allure-java/blob/main/allure-java-commons/src/main/java/io/qameta/allure/util/ResultsUtils.java"
click node_result_model "https://github.com/allure-framework/allure-java/blob/main/allure-model/src/main/java/io/qameta/allure/model/TestResult.java"
click node_http_capture_model "https://github.com/allure-framework/allure-java/blob/main/allure-java-commons/src/main/java/io/qameta/allure/http/HttpExchange.java"
click node_http_clients "https://github.com/allure-framework/allure-java/blob/main/allure-java-httpclient/src/main/java/io/qameta/allure/javahttpclient/AllureHttpClient.java"
click node_apache_clients "https://github.com/allure-framework/allure-java/blob/main/allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientResponse.java"
click node_browser_tools "https://github.com/allure-framework/allure-java/blob/main/allure-playwright/src/main/java/io/qameta/allure/playwright/AllurePlaywright.java"
click node_other_integrations "https://github.com/allure-framework/allure-java/blob/main/allure-grpc/src/main/java/io/qameta/allure/grpc/AllureGrpc.java"
click node_assertion_tools "https://github.com/allure-framework/allure-java/blob/main/allure-assertj/src/main/java/io/qameta/allure/assertj/AllureAspectJ.java"
click node_kotlin_api "https://github.com/allure-framework/allure-java/blob/main/allure-kotlin-extensions/src/main/kotlin/io/qameta/allure/kotlin/extensions/Allure.kt"
click node_coroutine_support "https://github.com/allure-framework/allure-java/blob/main/allure-kotlin-coroutines/src/main/kotlin/io/qameta/allure/kotlin/coroutines/AllureCoroutines.kt"
click node_javadoc_descriptions "https://github.com/allure-framework/allure-java/blob/main/allure-descriptions-javadoc/src/main/java/io/qameta/allure/description/JavaDocDescriptionsProcessor.java"
click node_test_plan "https://github.com/allure-framework/allure-java/blob/main/allure-java-commons/src/main/java/io/qameta/allure/testfilter/TestPlanReader.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_framework_adapters,node_custom_platform,node_bdd_adapters toneBlue
class node_http_clients,node_apache_clients,node_browser_tools,node_other_integrations,node_assertion_tools toneAmber
class node_runtime_api,node_lifecycle,node_context,node_metadata,node_result_model,node_http_capture_model,node_result_files toneMint
class node_kotlin_api,node_coroutine_support,node_javadoc_descriptions,node_test_plan toneRose
class node_test_runner toneIndigo
```

## Components

### Test frameworks

- [Framework adapters](https://github.com/allure-framework/allure-java/blob/main/allure-jupiter/src/main/java/io/qameta/allure/jupiter/AllureJupiter.java): `allure-jupiter/src/main/java/io/qameta/allure/jupiter/AllureJupiter.java`
- [JUnit Platform](https://github.com/allure-framework/allure-java/blob/main/allure-junit-platform/src/main/java/io/qameta/allure/junitplatform/AllureJunitPlatform.java): `allure-junit-platform/src/main/java/io/qameta/allure/junitplatform/AllureJunitPlatform.java`
- [BDD adapters](https://github.com/allure-framework/allure-java/blob/main/allure-cucumber7-jvm/src/main/java/io/qameta/allure/cucumber7jvm/AllureCucumber7Jvm.java): `allure-cucumber7-jvm/src/main/java/io/qameta/allure/cucumber7jvm/AllureCucumber7Jvm.java`

### Tool integrations

- [HTTP clients](https://github.com/allure-framework/allure-java/blob/main/allure-java-httpclient/src/main/java/io/qameta/allure/javahttpclient/AllureHttpClient.java): `allure-java-httpclient/src/main/java/io/qameta/allure/javahttpclient/AllureHttpClient.java`
- [Apache clients](https://github.com/allure-framework/allure-java/blob/main/allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientResponse.java): `allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientResponse.java`
- [Browser integrations](https://github.com/allure-framework/allure-java/blob/main/allure-playwright/src/main/java/io/qameta/allure/playwright/AllurePlaywright.java): `allure-playwright/src/main/java/io/qameta/allure/playwright/AllurePlaywright.java`
- [Other integrations](https://github.com/allure-framework/allure-java/blob/main/allure-grpc/src/main/java/io/qameta/allure/grpc/AllureGrpc.java): `allure-grpc/src/main/java/io/qameta/allure/grpc/AllureGrpc.java`
- [Assertion integrations](https://github.com/allure-framework/allure-java/blob/main/allure-assertj/src/main/java/io/qameta/allure/assertj/AllureAspectJ.java): `allure-assertj/src/main/java/io/qameta/allure/assertj/AllureAspectJ.java`

### Runtime and results

- [Runtime API](https://github.com/allure-framework/allure-java/blob/main/allure-java-commons/src/main/java/io/qameta/allure/Allure.java): `allure-java-commons/src/main/java/io/qameta/allure/Allure.java`
- [Lifecycle engine](https://github.com/allure-framework/allure-java/blob/main/allure-java-commons/src/main/java/io/qameta/allure/AllureLifecycle.java): `allure-java-commons/src/main/java/io/qameta/allure/AllureLifecycle.java`
- [Thread context](https://github.com/allure-framework/allure-java/blob/main/allure-java-commons/src/main/java/io/qameta/allure/internal/AllureThreadContext.java): `allure-java-commons/src/main/java/io/qameta/allure/internal/AllureThreadContext.java`
- [Result metadata](https://github.com/allure-framework/allure-java/blob/main/allure-java-commons/src/main/java/io/qameta/allure/util/ResultsUtils.java): `allure-java-commons/src/main/java/io/qameta/allure/util/ResultsUtils.java`
- [Result model](https://github.com/allure-framework/allure-java/blob/main/allure-model/src/main/java/io/qameta/allure/model/TestResult.java): `allure-model/src/main/java/io/qameta/allure/model/TestResult.java`
- [HTTP exchange model](https://github.com/allure-framework/allure-java/blob/main/allure-java-commons/src/main/java/io/qameta/allure/http/HttpExchange.java): `allure-java-commons/src/main/java/io/qameta/allure/http/HttpExchange.java`
- **Allure result files**

### Utilities and extensions

- [Kotlin extensions](https://github.com/allure-framework/allure-java/blob/main/allure-kotlin-extensions/src/main/kotlin/io/qameta/allure/kotlin/extensions/Allure.kt): `allure-kotlin-extensions/src/main/kotlin/io/qameta/allure/kotlin/extensions/Allure.kt`
- [Coroutine support](https://github.com/allure-framework/allure-java/blob/main/allure-kotlin-coroutines/src/main/kotlin/io/qameta/allure/kotlin/coroutines/AllureCoroutines.kt): `allure-kotlin-coroutines/src/main/kotlin/io/qameta/allure/kotlin/coroutines/AllureCoroutines.kt`
- [JavaDoc descriptions](https://github.com/allure-framework/allure-java/blob/main/allure-descriptions-javadoc/src/main/java/io/qameta/allure/description/JavaDocDescriptionsProcessor.java): `allure-descriptions-javadoc/src/main/java/io/qameta/allure/description/JavaDocDescriptionsProcessor.java`
- [Test-plan filtering](https://github.com/allure-framework/allure-java/blob/main/allure-java-commons/src/main/java/io/qameta/allure/testfilter/TestPlanReader.java): `allure-java-commons/src/main/java/io/qameta/allure/testfilter/TestPlanReader.java`

### Other components

- **Test runner**

## Connections

- Test runner → Framework adapters: runs tests
- Test runner → JUnit Platform: runs tests
- Test runner → BDD adapters: runs tests
- Framework adapters → Runtime API: records results
- JUnit Platform → Runtime API: records results (evidence: `allure-junit-platform/src/main/java/io/qameta/allure/junitplatform/AllureJunitPlatform.java`)
- BDD adapters → Runtime API: records results
- Runtime API → Lifecycle engine: delegates lifecycle (evidence: `allure-java-commons/src/main/java/io/qameta/allure/Allure.java`)
- Lifecycle engine → Thread context: binds items (evidence: `allure-java-commons/src/main/java/io/qameta/allure/AllureLifecycle.java`)
- Lifecycle engine → Result metadata: updates results (evidence: `allure-java-commons/src/main/java/io/qameta/allure/AllureLifecycle.java`)
- Runtime API → Result model: records model (evidence: `allure-java-commons/src/main/java/io/qameta/allure/Allure.java`)
- Lifecycle engine → Allure result files: writes results
- HTTP clients → Runtime API: adds attachments (evidence: `allure-java-httpclient/src/main/java/io/qameta/allure/javahttpclient/AllureHttpClient.java`)
- HTTP clients → HTTP exchange model: captures exchanges (evidence: `allure-java-httpclient/src/main/java/io/qameta/allure/javahttpclient/AllureHttpClient.java`)
- Apache clients → Runtime API: adds attachments (evidence: `allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientResponse.java`)
- Apache clients → HTTP exchange model: builds exchanges (evidence: `allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientResponse.java`)
- Browser integrations → Runtime API: records activity
- Other integrations → Runtime API: records activity (evidence: `allure-grpc/src/main/java/io/qameta/allure/grpc/AllureGrpc.java`)
- Assertion integrations → Runtime API: records assertions
- Kotlin extensions → Runtime API: wraps API
- Coroutine support → Runtime API: propagates context
- JavaDoc descriptions → Result model: supplies descriptions
- Test-plan filtering → Framework adapters: filters tests
