build: migrate from Allure 2 to Allure 3#2501
Conversation
Adds the Allure 3 report configuration file at the project root. Configures custom grouping by parentSuite (platform) then tag (unit-test/integration-test). Note: The Gradle plugin 4.x generates its own config and passes it via --config, so this file is not auto-discovered by Gradle. It is used when running the Allure 3 CLI directly. The plugin's default grouping (parentSuite/suite/subSuite) already satisfies the grouping requirement.
- Replace allure-report + allure-adapter-base v2.12.0 with single io.qameta.allure plugin v4.0.2 - Update report generator from 2.33.0 to 3.9.0 - Bump allure-bom from 2.29.1 to 2.35.2 - Remove manual AspectJ weaver config (plugin 4.x auto-manages it) - Modernize reporting.baseDir to reporting.baseDirectory - Add buildscript commons-io 2.22.0 to work around Gradle's bundled commons-io 2.15.1 conflicting with the plugin's commons-compress No test source code changes required — allure-java API stays at 2.x. CI workflow unchanged — report output path is the same.
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@build.gradle`:
- Around line 3-10: The buildscript block currently declares a
buildscript.dependencies entry for classpath 'commons-io:commons-io:2.22.0' but
has no buildscript.repositories, so that dependency can fail to resolve; add a
buildscript.repositories block (e.g., include mavenCentral() and any other
needed repos like google() or gradlePluginPortal()) inside the buildscript scope
before the dependencies block so the commons-io artifact can be fetched during
configuration.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: d0765316-929d-436c-9da3-284ac6a40621
📒 Files selected for processing (2)
allurerc.mjsbuild.gradle
| buildscript { | ||
| dependencies { | ||
| // Force commons-io 2.22.0+ on the buildscript classpath. | ||
| // Gradle ships commons-io 2.15.1 which lacks the Supplier overload | ||
| // of IOUtils.skip() required by commons-compress 1.28.0 (used by | ||
| // the Allure Gradle plugin's Node.js download task). | ||
| classpath 'commons-io:commons-io:2.22.0' | ||
| } |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Locate the Gradle file(s) referenced
ls -la
find . -maxdepth 3 -name "build.gradle" -o -name "build.gradle.kts" | sed 's|^\./||'
echo "---- build.gradle (first 140 lines) ----"
if [ -f build.gradle ]; then
nl -ba build.gradle | sed -n '1,140p'
else
echo "build.gradle not found at repo root"
fi
echo "---- build.gradle (search for buildscript.repositories / buildscript { repositories ) ----"
if [ -f build.gradle ]; then
rg -n --hidden --no-ignore-vcs "buildscript\\s*\\{|buildscript\\.repositories|repositories\\s*\\{" build.gradle
echo "---- grep specifically for buildscript repositories block ----"
rg -n --hidden --no-ignore-vcs "buildscript\\s*\\{[\\s\\S]{0,400}?repositories\\s*\\{" build.gradle || true
fi
echo "---- Search entire repo for buildscript classpath / repositories in buildscript ----"
rg -n --hidden --no-ignore-vcs "classpath ['\"]commons-io:commons-io:2\\.22\\.0['\"]|buildscript\\.repositories|buildscript\\s*\\{[\\s\\S]{0,300}?repositories\\s*\\{" . || trueRepository: jbangdev/jbang
Length of output: 2470
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Show build.gradle with line numbers (up to 160)
echo "---- build.gradle (1-160) ----"
if [ -f build.gradle ]; then
awk '{printf "%6d\t%s\n", NR, $0}' build.gradle | sed -n '1,160p'
else
echo "build.gradle not found"
fi
echo "---- rg: buildscript.repositories or buildscript { ... repositories { ----"
rg -n --hidden --no-ignore-vcs "buildscript\\.repositories|buildscript\\s*\\{[[:space:][:print:]]{0,600}?repositories\\s*\\{" build.gradle || true
echo "---- rg: commons-io classpath ----"
rg -n --hidden --no-ignore-vcs "commons-io:commons-io:2\\.22\\.0" build.gradle || trueRepository: jbangdev/jbang
Length of output: 5634
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "---- buildscript.repositories across repo ----"
rg -n --hidden --no-ignore-vcs "buildscript\\.repositories" . || true
echo "---- any buildscript { blocks across repo ----"
rg -n --hidden --no-ignore-vcs "buildscript\\s*\\{" . || true
echo "---- commons-io classpath across repo ----"
rg -n --hidden --no-ignore-vcs "commons-io:commons-io:2\\.22\\.0" . || trueRepository: jbangdev/jbang
Length of output: 286
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "---- settings.gradle (1-220) ----"
if [ -f settings.gradle ]; then
awk '{printf "%6d\t%s\n", NR, $0}' settings.gradle | sed -n '1,220p'
else
echo "settings.gradle not found"
fiRepository: jbangdev/jbang
Length of output: 895
🌐 Web query:
Gradle buildscript { dependencies { classpath ... } } without buildscript.repositories use project repositories or default repositories?
💡 Result:
In Gradle, the buildscript block does not automatically inherit or use the repositories defined in the project's standard repositories {} block [1][2]. The buildscript block exists in a separate scope specifically for configuring the build script's own classpath (e.g., loading plugins or custom build logic), while the standard repositories {} block is used to resolve the project's application dependencies [3][1][2]. If you define dependencies within a buildscript block but omit the repositories {} block inside it, Gradle will not automatically look at your project-level repositories [1]. Instead, Gradle typically fails with an error indicating that it cannot resolve the dependencies because no repositories are defined [4][5]. While some users may observe behavior where specific dependencies resolve even without an explicit repository block—sometimes leading to the assumption that implicit repositories are included—this is generally due to how specific Gradle versions or environments are configured (e.g., pre-configured default repositories in certain plugins or environments) [4]. For predictable and portable builds, you must explicitly declare the necessary repositories inside the buildscript block if your dependencies are not available in standard public locations or if you want to ensure the build does not rely on implicit, environment-specific defaults [4][6]. In modern Gradle development, the recommended approach is to move away from the legacy buildscript block entirely in favor of the plugins {} block [7]. The plugins {} block integrates with pluginManagement in settings.gradle, which provides a centralized and more robust way to manage plugin repositories and versions across multi-project builds [7].
Citations:
- 1: https://docs.gradle.org/current/userguide/declaring_repositories_basics.html
- 2: https://stackoverflow.com/questions/30158971/whats-the-difference-between-buildscript-and-allprojects-in-build-gradle
- 3: https://stackoverflow.com/questions/17773817/purpose-of-buildscript-block-in-gradle
- 4: https://stackoverflow.com/questions/68287553/where-does-gradle-look-for-buildscript-dependencies-when-there-are-no-repositori
- 5: buildSrc plugin cannot use more than one repository gradle/gradle#29610
- 6: https://docs.gradle.org/9.5.0/userguide/declaring_repositories.html
- 7: https://stefma.medium.com/its-time-to-ditch-the-buildscript-block-a1ab12e0d9ce
Add buildscript.repositories for the commons-io buildscript classpath dependency.
buildscript.dependencies won’t use the later project-level repositories { ... }, so commons-io:commons-io:2.22.0 may fail to resolve on a clean environment.
Suggested fix
buildscript {
+ repositories {
+ mavenCentral()
+ }
dependencies {
// Force commons-io 2.22.0+ on the buildscript classpath.
// Gradle ships commons-io 2.15.1 which lacks the Supplier overload
// of IOUtils.skip() required by commons-compress 1.28.0 (used by
// the Allure Gradle plugin's Node.js download task).
classpath 'commons-io:commons-io:2.22.0'
}
}🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@build.gradle` around lines 3 - 10, The buildscript block currently declares a
buildscript.dependencies entry for classpath 'commons-io:commons-io:2.22.0' but
has no buildscript.repositories, so that dependency can fail to resolve; add a
buildscript.repositories block (e.g., include mavenCentral() and any other
needed repos like google() or gradlePluginPortal()) inside the buildscript scope
before the dependencies block so the commons-io artifact can be fetched during
configuration.
Add allurerc.mjs with environment matchers that group test results by OS (Linux, macOS, Windows) using the existing parentSuite labels. This enables Allure 3's side-by-side Environments view in the merged report. The Gradle plugin's allureReport task generates a minimal JSON config that can't express JS-based matchers, so a finalizedBy task re-runs the CLI with allurerc.mjs to overwrite the report. This runs automatically whenever allureReport is invoked, including from CI.
The old URL returned 404. Updated to the correct Allure 3 docs path.
maxandersen
force-pushed
the
build/allure3-migration
branch
from
f6c03b0 to
c7f550f
Compare
|
opened these issues thus far: allure-framework/allure-gradle#201 - cant tell gradle about allure3 config |
The allureReportCustomConfig task hardcoded the Unix executable path (allure), which doesn't exist on Windows. Use allure.bat (or .cmd fallback) matching how the Allure Gradle plugin resolves the executable.
|
1 participant
TL;DR: pr to see how allure 3 looks like. I really don't want to introduce yet another layer that relies on nodejs but we already use it for docs generation so maybe not too much of a loss?
Summary
Migrate test reporting from Allure 2 to Allure 3.
Changes
allure-report+allure-adapter-basev2.12.0 with singleio.qameta.allurev4.0.2-javaagentconfig — plugin 4.x auto-manages itreporting.baseDir→reporting.baseDirectorybuildscript { classpath 'commons-io:commons-io:2.22.0' }to fix a classpath conflict (Gradle ships commons-io 2.15.1 which lacks a method required by the plugin's commons-compress 1.28.0)What stays the same
@Description,@Issue, andAllure.step()usage is unchangedbuild/reports/allure-report/allureReport/index.html), artifact upload patterns, and multi-OS result merging all work the sameVerified locally
./gradlew clean test allureReport— 629 tests pass (601 passed, 28 skipped)./gradlew --no-daemon allureReport --clean— works (matches CI usage)allureRawResultElementsmerge mechanism intactSummary by CodeRabbit