Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions .github/CI-ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,12 +154,30 @@ Both methods run in parallel. Results are merged (union) before testing. This le
2. **No regression** — If Scalpel fails, grep results are still used
3. **Gradual migration** — Once Scalpel is validated, grep can be removed

Scalpel is configured permanently in `.mvn/extensions.xml` (version `0.1.0`). On developer machines it is a no-op — without CI environment variables (`GITHUB_BASE_REF`), no base branch is detected and Scalpel returns immediately. The `mvn validate` with report mode adds ~60-90 seconds in CI.

Note: the script overrides `fullBuildTriggers` to empty (`-Dscalpel.fullBuildTriggers=`) because Scalpel's default (`.mvn/**`) would trigger a full build whenever `.mvn/extensions.xml` itself changes (e.g., Dependabot bumping Scalpel).
Scalpel is configured permanently in `.mvn/extensions.xml`. On developer machines it is a no-op (disabled via `-Dscalpel.enabled=false` in `.mvn/maven.config`). The CI script overrides this with `-Dscalpel.enabled=true`. The `mvn validate` with report mode adds ~60-90 seconds in CI.

Scalpel is only invoked when a **subdirectory** `pom.xml` is changed (e.g. `parent/pom.xml`, `components/camel-kafka/pom.xml`). Changes to the **root** `pom.xml` are excluded because it contains build-infrastructure config (license plugin, checkstyle, etc.) that does not affect module compilation or test behavior. Without this filter, Scalpel would report every module as affected since they all inherit from the root POM.

#### Scalpel features used for shadow comparison

- **Source-set-aware propagation**: Distinguishes test-jar dependencies from regular dependencies. A module that depends only on another module's test-jar (e.g., `camel-core`'s test-jar with test utilities) is propagated through the `TEST` source set, not the `MAIN` source set. This prevents a change to test utilities from triggering tests in all ~500 modules that depend on `camel-core`.
- **`skipTestsForDownstreamModules`**: Allows specifying modules whose tests should be skipped when they appear as downstream dependents (mirrors the `EXCLUSION_LIST` in `incremental-build.sh`). This gives Scalpel an accurate picture of what skip-tests mode would actually test.

#### Shadow comparison

Scalpel runs in **shadow mode**: it observes what skip-tests mode *would* have done and reports it in a collapsible section of the PR comment, without affecting actual test execution. This allows the team to validate Scalpel's decisions across many PRs before switching to Scalpel-driven test execution.

The shadow comparison section shows:
- How many modules Scalpel would test (direct + downstream)
- How many downstream modules would have tests skipped (generated code, meta-modules)
- The full list of modules in each category

#### Configuration notes

The script overrides `fullBuildTriggers` to empty (`-Dscalpel.fullBuildTriggers=`) because Scalpel's default (`.mvn/**`) would trigger a full build whenever `.mvn/extensions.xml` itself changes (e.g., Dependabot bumping Scalpel).

The grep-based script fetches the PR diff via the GitHub REST API (unchanged). Scalpel uses local git history to compare effective POM models — the CI workflow pre-fetches the base branch (`git fetch --deepen=200` + fetch of `origin/main`) so Scalpel's JGit can find the merge-base. Scalpel disables its built-in JGit fetch (`-Dscalpel.fetchBaseBranch=false`) to avoid JGit issues in shallow CI clones. The `--deepen=200` fetches only commit metadata (not file blobs), adding ~2-3 seconds to the job.

## Manual Integration Test Advisories

Some modules are excluded from CI's `-amd` expansion (the `EXCLUSION_LIST`) because they are generated code, meta-modules, or expensive integration test suites. When a contributor changes one of these modules, CI cannot automatically test all downstream effects.
Expand Down
124 changes: 114 additions & 10 deletions .github/actions/incremental-build/incremental-build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -243,19 +243,20 @@ analyzePomDependencies() {
runScalpelDetection() {
echo " Running Scalpel change detection..."

# Ensure sufficient git history for JGit merge-base detection
# (CI uses shallow clones; Scalpel needs to find the merge base)
git fetch origin main:refs/remotes/origin/main --depth=200 2>/dev/null || true
git fetch --deepen=200 2>/dev/null || true

# Scalpel is permanently configured in .mvn/extensions.xml.
# On developer machines it's a no-op (no GITHUB_BASE_REF → no base branch detected).
# On developer machines it's a no-op (disabled via -Dscalpel.enabled=false in .mvn/maven.config).
# The CI script overrides this with -Dscalpel.enabled=true.
# Base branch is pre-fetched by the CI workflow (fetchBaseBranch=false).
# Run Maven validate with Scalpel in report mode:
# - mode=report: write JSON report without trimming the reactor
# - fullBuildTriggers="": override .mvn/** default (Scalpel lives in .mvn/extensions.xml)
# - alsoMake/alsoMakeDependents=false: we only want directly affected modules
# (our script handles -amd expansion separately)
local scalpel_args="-Dscalpel.enabled=true -Dscalpel.mode=report -Dscalpel.fullBuildTriggers= -Dscalpel.alsoMake=false -Dscalpel.alsoMakeDependents=false"
# - fetchBaseBranch=false: base branch is pre-fetched by the CI workflow
# - skipTestsForDownstreamModules: derived from EXCLUSION_LIST — tells Scalpel which
# downstream modules should not run tests in skip-tests mode (for shadow comparison)
# Strip the Maven "!:" prefix from each entry to get bare artifact IDs for Scalpel.
local skip_downstream
skip_downstream=$(echo "$EXCLUSION_LIST" | sed 's/!://g')
local scalpel_args="-Dscalpel.enabled=true -Dscalpel.mode=report -Dscalpel.fullBuildTriggers= -Dscalpel.fetchBaseBranch=false -Dscalpel.excludePaths=.github/**,.mvn/** -Dscalpel.skipTestsForDownstreamModules=${skip_downstream}"
# For workflow_dispatch, GITHUB_BASE_REF may not be set
if [ -z "${GITHUB_BASE_REF:-}" ]; then
scalpel_args="$scalpel_args -Dscalpel.baseBranch=origin/main"
Expand All @@ -265,6 +266,7 @@ runScalpelDetection() {
./mvnw -B -q validate $scalpel_args ${MAVEN_EXTRA_ARGS:-} -l /tmp/scalpel-validate.log 2>/dev/null || {
echo " WARNING: Scalpel detection failed (exit $?), skipping"
grep -i "scalpel" /tmp/scalpel-validate.log 2>/dev/null | head -5 || true
scalpel_failure_reason="Scalpel detection failed (mvn validate exited with error)"
return
}

Expand All @@ -273,6 +275,7 @@ runScalpelDetection() {
if [ ! -f "$report" ]; then
echo " WARNING: Scalpel report not found at $report"
grep -i "scalpel" /tmp/scalpel-validate.log 2>/dev/null | head -5 || true
scalpel_failure_reason="Scalpel report not found (merge-base may be unreachable in shallow clone)"
return
fi

Expand All @@ -283,6 +286,7 @@ runScalpelDetection() {
local trigger_file
trigger_file=$(jq -r '.triggerFile // "unknown"' "$report")
echo " Scalpel: Full build triggered by change to $trigger_file"
scalpel_failure_reason="Scalpel triggered a full build (changed file: $trigger_file)"
return
fi

Expand All @@ -293,9 +297,24 @@ runScalpelDetection() {
scalpel_managed_deps=$(jq -r '(.changedManagedDependencies // []) | if length > 0 then join(", ") else "" end' "$report" 2>/dev/null || true)
scalpel_managed_plugins=$(jq -r '(.changedManagedPlugins // []) | if length > 0 then join(", ") else "" end' "$report" 2>/dev/null || true)

# Scalpel shadow comparison data:
# - Modules Scalpel skip-tests mode would test (testsSkipped != true)
# - Modules Scalpel would skip (testsSkipped == true, from skipTestsForDownstreamModules)
# - Breakdown by category (DIRECT, DOWNSTREAM)
scalpel_would_test=$(jq -r '[.affectedModules[] | select(.testsSkipped != true)] | map(.artifactId) | sort | join(",")' "$report" 2>/dev/null || true)
scalpel_would_skip=$(jq -r '[.affectedModules[] | select(.testsSkipped == true)] | map(.artifactId) | sort | join(",")' "$report" 2>/dev/null || true)
scalpel_direct_count=$(jq '[.affectedModules[] | select(.category == "DIRECT")] | length' "$report" 2>/dev/null || echo "0")
scalpel_downstream_tested=$(jq '[.affectedModules[] | select(.category == "DOWNSTREAM" and .testsSkipped != true)] | length' "$report" 2>/dev/null || echo "0")
scalpel_downstream_skipped=$(jq '[.affectedModules[] | select(.category == "DOWNSTREAM" and .testsSkipped == true)] | length' "$report" 2>/dev/null || echo "0")

local mod_count
mod_count=$(jq '.affectedModules | length' "$report" 2>/dev/null || echo "0")
echo " Scalpel detected $mod_count affected modules"
local test_count=0
if [ -n "$scalpel_would_test" ]; then
test_count=$(echo "$scalpel_would_test" | tr ',' '\n' | grep -c . || true)
fi
echo " Scalpel detected $mod_count affected modules ($test_count would be tested)"
echo " Direct: $scalpel_direct_count, Downstream tested: $scalpel_downstream_tested, Downstream skipped: $scalpel_downstream_skipped"
if [ -n "$scalpel_props" ]; then
echo " Changed properties: $scalpel_props"
fi
Expand Down Expand Up @@ -382,6 +401,81 @@ checkManualItTests() {
fi
}

# ── Scalpel shadow comparison ──────────────────────────────────────────

# Write Scalpel shadow comparison section to the PR comment.
# Shows what Scalpel skip-tests mode would have tested vs what the current
# approach actually tested — observation only, does not affect test execution.
writeScalpelComparison() {
local comment_file="$1"

# If Scalpel failed, show why in the PR comment
if [ -n "$scalpel_failure_reason" ]; then
echo "" >> "$comment_file"
echo "<details><summary>:microscope: Scalpel shadow comparison (skip-tests mode)</summary>" >> "$comment_file"
echo "" >> "$comment_file"
echo ":warning: $scalpel_failure_reason" >> "$comment_file"
echo "" >> "$comment_file"
echo "> :information_source: Shadow mode — Scalpel observes but does not affect test execution. [Learn more](https://github.com/maveniverse/scalpel)" >> "$comment_file"
echo "" >> "$comment_file"
echo "</details>" >> "$comment_file"
return
fi

# Skip if no Scalpel data (Scalpel was not invoked for this PR)
if [ -z "$scalpel_would_test" ] && [ -z "$scalpel_would_skip" ]; then
return
fi

local scalpel_test_count=0
local scalpel_skip_count=0
if [ -n "$scalpel_would_test" ]; then
scalpel_test_count=$(echo "$scalpel_would_test" | tr ',' '\n' | grep -c . || true)
fi
if [ -n "$scalpel_would_skip" ]; then
scalpel_skip_count=$(echo "$scalpel_would_skip" | tr ',' '\n' | grep -c . || true)
fi

echo "" >> "$comment_file"
echo "<details><summary>:microscope: Scalpel shadow comparison (skip-tests mode)</summary>" >> "$comment_file"
echo "" >> "$comment_file"
echo "**Scalpel skip-tests mode would test ${scalpel_test_count} modules** (${scalpel_direct_count} direct + ${scalpel_downstream_tested} downstream)" >> "$comment_file"

if [ "$scalpel_downstream_skipped" -gt 0 ]; then
echo "" >> "$comment_file"
echo "${scalpel_downstream_skipped} downstream module(s) would have tests skipped (generated code, meta-modules)" >> "$comment_file"
fi

# Show which modules Scalpel would test
if [ -n "$scalpel_would_test" ]; then
echo "" >> "$comment_file"
echo "<details><summary>Modules Scalpel would test (${scalpel_test_count})</summary>" >> "$comment_file"
echo "" >> "$comment_file"
echo "$scalpel_would_test" | tr ',' '\n' | while read -r m; do
[ -n "$m" ] && echo "- \`$m\`" >> "$comment_file"
done
echo "" >> "$comment_file"
echo "</details>" >> "$comment_file"
fi

# Show which modules would have tests skipped
if [ -n "$scalpel_would_skip" ]; then
echo "" >> "$comment_file"
echo "<details><summary>Modules with tests skipped (${scalpel_skip_count})</summary>" >> "$comment_file"
echo "" >> "$comment_file"
echo "$scalpel_would_skip" | tr ',' '\n' | while read -r m; do
[ -n "$m" ] && echo "- \`$m\`" >> "$comment_file"
done
echo "" >> "$comment_file"
echo "</details>" >> "$comment_file"
fi

echo "" >> "$comment_file"
echo "> :information_source: Shadow mode — Scalpel observes but does not affect test execution. [Learn more](https://github.com/maveniverse/scalpel)" >> "$comment_file"
echo "" >> "$comment_file"
echo "</details>" >> "$comment_file"
}

# ── Comment generation ─────────────────────────────────────────────────

writeComment() {
Expand Down Expand Up @@ -539,6 +633,13 @@ main() {
scalpel_props=""
scalpel_managed_deps=""
scalpel_managed_plugins=""
# Scalpel shadow comparison data
scalpel_would_test=""
scalpel_would_skip=""
scalpel_direct_count="0"
scalpel_downstream_tested="0"
scalpel_downstream_skipped="0"
scalpel_failure_reason=""

# Step 2a: Grep-based detection (existing approach)
if [ -n "$pom_files" ]; then
Expand Down Expand Up @@ -762,6 +863,9 @@ main() {
local comment_file="incremental-test-comment.md"
writeComment "$comment_file" "$pl" "$dep_module_ids" "$all_changed_props" "$testedDependents" "$extraModules" "$scalpel_managed_deps" "$scalpel_managed_plugins"

# Scalpel shadow comparison (observation only)
writeScalpelComparison "$comment_file"

# Check for tests disabled in CI via @DisabledIfSystemProperty(named = "ci.env.name")
local disabled_tests
disabled_tests=$(detectDisabledTests "$final_pl")
Expand Down
7 changes: 7 additions & 0 deletions .github/workflows/pr-build-main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,13 @@ jobs:
with:
persist-credentials: false
ref: ${{ inputs.pr_ref || '' }}
- name: Fetch base branch for Scalpel change detection
if: ${{ !inputs.skip_full_build }}
run: |
# Scalpel needs the merge base between HEAD and the base branch.
# The checkout is depth=1, so deepen both sides for merge-base reachability.
git fetch --deepen=200 2>/dev/null || true
git fetch --no-tags --depth=200 origin "${GITHUB_BASE_REF:-main}:refs/remotes/origin/${GITHUB_BASE_REF:-main}"
- id: install-packages
uses: ./.github/actions/install-packages
- id: install-mvnd
Expand Down
5 changes: 4 additions & 1 deletion .github/workflows/sonar-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,10 @@ jobs:
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
with:
persist-credentials: false

- name: Fetch base branch for Scalpel change detection
run: |
git fetch --deepen=200 2>/dev/null || true
git fetch --no-tags --depth=200 origin "${GITHUB_BASE_REF:-main}:refs/remotes/origin/${GITHUB_BASE_REF:-main}"
- id: install-packages
uses: ./.github/actions/install-packages

Expand Down
2 changes: 1 addition & 1 deletion .mvn/extensions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@
<extension>
<groupId>eu.maveniverse.maven.scalpel</groupId>
<artifactId>extension3</artifactId>
<version>0.3.5</version>
<version>0.3.7</version>
</extension>
</extensions>
2 changes: 1 addition & 1 deletion parent/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@
<nullaway-version>0.13.7</nullaway-version>
<jt400-version>21.0.6</jt400-version>
<jte-version>3.2.4</jte-version>
<junit-jupiter-version>5.14.4</junit-jupiter-version>
<junit-jupiter-version>5.14.3</junit-jupiter-version>
<junit6-jupiter-version>6.1.0</junit6-jupiter-version>
<junit-pioneer-version>2.3.0</junit-pioneer-version>
<juniversalchardet-version>1.0.3</juniversalchardet-version>
Expand Down
Loading