How allure-framework/allure-java works
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 Runtime API · AllureLifecycle.java Lifecycle engine · AllureJupiter.java Framework adapters · AllureHttpClient.java HTTP clients
Components 20
Test frameworks
- Framework adapters
allure-jupiter/src/main/java/io/qameta/allure/jupiter/AllureJupiter.java - JUnit Platform
allure-junit-platform/src/main/java/io/qameta/allure/junitplatform/AllureJunitPlatform.java - BDD adapters
allure-cucumber7-jvm/src/main/java/io/qameta/allure/cucumber7jvm/AllureCucumber7Jvm.java
Tool integrations
- HTTP clients
allure-java-httpclient/src/main/java/io/qameta/allure/javahttpclient/AllureHttpClient.java - Apache clients
allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientResponse.java - Browser integrations
allure-playwright/src/main/java/io/qameta/allure/playwright/AllurePlaywright.java - Other integrations
allure-grpc/src/main/java/io/qameta/allure/grpc/AllureGrpc.java - Assertion integrations
allure-assertj/src/main/java/io/qameta/allure/assertj/AllureAspectJ.java
Runtime and results
- Runtime API
allure-java-commons/src/main/java/io/qameta/allure/Allure.java - Lifecycle engine
allure-java-commons/src/main/java/io/qameta/allure/AllureLifecycle.java - Thread context
allure-java-commons/src/main/java/io/qameta/allure/internal/AllureThreadContext.java - Result metadata
allure-java-commons/src/main/java/io/qameta/allure/util/ResultsUtils.java - Result model
allure-model/src/main/java/io/qameta/allure/model/TestResult.java - HTTP exchange model
allure-java-commons/src/main/java/io/qameta/allure/http/HttpExchange.java - Allure result files
Utilities and extensions
- Kotlin extensions
allure-kotlin-extensions/src/main/kotlin/io/qameta/allure/kotlin/extensions/Allure.kt - Coroutine support
allure-kotlin-coroutines/src/main/kotlin/io/qameta/allure/kotlin/coroutines/AllureCoroutines.kt - JavaDoc descriptions
allure-descriptions-javadoc/src/main/java/io/qameta/allure/description/JavaDocDescriptionsProcessor.java - Test-plan filtering
allure-java-commons/src/main/java/io/qameta/allure/testfilter/TestPlanReader.java
Other components
- Test runner
Connections 22
- 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
allure-junit-platform/src/main/java/io/qameta/allure/junitplatform/AllureJunitPlatform.java - BDD adapters → Runtime API: records results
- Runtime API → Lifecycle engine: delegates lifecycle
allure-java-commons/src/main/java/io/qameta/allure/Allure.java - Lifecycle engine → Thread context: binds items
allure-java-commons/src/main/java/io/qameta/allure/AllureLifecycle.java - Lifecycle engine → Result metadata: updates results
allure-java-commons/src/main/java/io/qameta/allure/AllureLifecycle.java - Runtime API → Result model: records model
allure-java-commons/src/main/java/io/qameta/allure/Allure.java - Lifecycle engine → Allure result files: writes results
- HTTP clients → Runtime API: adds attachments
allure-java-httpclient/src/main/java/io/qameta/allure/javahttpclient/AllureHttpClient.java - HTTP clients → HTTP exchange model: captures exchanges
allure-java-httpclient/src/main/java/io/qameta/allure/javahttpclient/AllureHttpClient.java - Apache clients → Runtime API: adds attachments
allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientResponse.java - Apache clients → HTTP exchange model: builds exchanges
allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientResponse.java - Browser integrations → Runtime API: records activity
- Other integrations → Runtime API: records activity
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