toolchains.yml

name: Maven toolchains no unexpected growth (#534)

# Regression test for #534: invoking setup-java multiple times appended
# malformed / duplicated entries to ~/.m2/toolchains.xml. Each invocation with a
# distinct mvn-toolchain-id must add exactly one <toolchain> entry, keep a single
# <toolchains> root, and remain valid XML.

on:
  push:
    branches: [main]
  pull_request:
  workflow_dispatch:

permissions:
  contents: read

jobs:
  toolchains-growth-baseline:
    name: 'BASELINE v5.4.0: toolchains.xml duplicates on re-run - ${{ matrix.os }}'
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
      - name: Set up JDK 21 (toolchain id jdk-21)
        uses: actions/setup-java@1bcf9fb12cf4aa7d266a90ae39939e61372fe520 # v5.4.0 (published)
        with:
          distribution: temurin
          java-version: '21'
          mvn-toolchain-id: jdk-21

      - name: Set up JDK 17 (toolchain id jdk-17)
        uses: actions/setup-java@1bcf9fb12cf4aa7d266a90ae39939e61372fe520 # v5.4.0 (published)
        with:
          distribution: temurin
          java-version: '17'
          mvn-toolchain-id: jdk-17

      - name: Set up JDK 11 (toolchain id jdk-11)
        uses: actions/setup-java@1bcf9fb12cf4aa7d266a90ae39939e61372fe520 # v5.4.0 (published)
        with:
          distribution: temurin
          java-version: '11'
          mvn-toolchain-id: jdk-11

      - name: Re-run JDK 21 (same id jdk-21 - v5.4.0 duplicates it)
        uses: actions/setup-java@1bcf9fb12cf4aa7d266a90ae39939e61372fe520 # v5.4.0 (published)
        with:
          distribution: temurin
          java-version: '21'
          mvn-toolchain-id: jdk-21

      - name: Show and assert the previous (buggy) behavior
        shell: bash
        run: |
          set -euo pipefail
          TC="$HOME/.m2/toolchains.xml"
          test -f "$TC" || { echo "::error::toolchains.xml not found"; exit 1; }
          cat "$TC"
          echo "----"
          total=$(grep -o "<toolchain>" "$TC" | wc -l | tr -d '[:space:]')
          dup21=$(grep -o "<id>jdk-21</id>" "$TC" | wc -l | tr -d '[:space:]')
          echo "<toolchain> entries: $total"
          echo "jdk-21 occurrences:  $dup21"
          # v5.4.0 has no de-duplication, so the re-run of jdk-21 leaves it duplicated.
          if [ "$dup21" -lt 2 ]; then
            echo "::error::expected v5.4.0 to duplicate jdk-21 (>=2), got $dup21"
            exit 1
          fi
          echo "OK (baseline): v5.4.0 duplicated jdk-21 (${dup21}x) - this is the bug fixed by #534"

  toolchains-growth:
    name: 'CURRENT: toolchains.xml stays consistent - ${{ matrix.os }}'
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
      - name: Set up JDK 21 (toolchain id jdk-21)
        uses: actions/setup-java@0f481fcb613427c0f801b606911222b5b6f3083a # v5.5.0
        with:
          distribution: temurin
          java-version: '21'
          mvn-toolchain-id: jdk-21

      - name: Set up JDK 17 (toolchain id jdk-17)
        uses: actions/setup-java@0f481fcb613427c0f801b606911222b5b6f3083a # v5.5.0
        with:
          distribution: temurin
          java-version: '17'
          mvn-toolchain-id: jdk-17

      - name: Set up JDK 11 (toolchain id jdk-11)
        uses: actions/setup-java@0f481fcb613427c0f801b606911222b5b6f3083a # v5.5.0
        with:
          distribution: temurin
          java-version: '11'
          mvn-toolchain-id: jdk-11

      - name: Re-run JDK 21 (same id jdk-21 must not duplicate)
        uses: actions/setup-java@0f481fcb613427c0f801b606911222b5b6f3083a # v5.5.0
        with:
          distribution: temurin
          java-version: '21'
          mvn-toolchain-id: jdk-21

      - name: Inspect and validate toolchains.xml
        shell: bash
        run: |
          set -euo pipefail
          TC="$HOME/.m2/toolchains.xml"
          echo "Reading $TC"
          test -f "$TC" || { echo "::error::toolchains.xml not found"; exit 1; }
          cat "$TC"
          echo "----"

          count_tag() { grep -o "$1" "$TC" | wc -l | tr -d '[:space:]'; }

          OPEN_ROOT=$(count_tag "<toolchains")
          TOOLCHAINS=$(count_tag "<toolchain>")

          echo "root <toolchains> occurrences: $OPEN_ROOT"
          echo "<toolchain> entries:           $TOOLCHAINS"

          # Exactly one root element.
          if [ "$OPEN_ROOT" -ne 1 ]; then
            echo "::error::expected exactly 1 <toolchains> root, got $OPEN_ROOT"
            exit 1
          fi

          # 3 distinct ids were used (jdk-21 twice must collapse) -> expect 3 entries.
          if [ "$TOOLCHAINS" -ne 3 ]; then
            echo "::error::expected 3 <toolchain> entries, got $TOOLCHAINS (unexpected growth/duplication)"
            exit 1
          fi

          # Each id appears exactly once.
          for id in jdk-21 jdk-17 jdk-11; do
            n=$(grep -o "<id>$id</id>" "$TC" | wc -l | tr -d '[:space:]')
            echo "id $id count: $n"
            if [ "$n" -ne 1 ]; then
              echo "::error::id $id appears $n times, expected 1"
              exit 1
            fi
          done

          # Well-formedness check when xmllint is available.
          if command -v xmllint >/dev/null 2>&1; then
            xmllint --noout "$TC"
            echo "xmllint: well-formed"
          fi

          echo "OK: toolchains.xml is consistent"