Phase 0: correctness and safety fixes, Java 25 baseline (#51)

Author: Frotty

.circleci/config.yml

@@ -0,0 +1,11 @@
+# Normalise line endings so an editor or script on Windows cannot turn a
+# one-line change into a whole-file diff.
+* text=auto eol=lf
+
+# Fixtures and build artefacts are binary.
+*.w3x binary
+*.w3m binary
+*.scx binary
+*.mpq binary
+*.blp binary
+*.jar binary

.gitattributes

@@ -0,0 +1,71 @@
+name: Build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    # Linux and Windows both, because path handling differs and most
+    # consumers build on one or the other.
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest, windows-latest ]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v7
+
+      - uses: actions/setup-java@v5
+        with:
+          distribution: temurin
+          java-version: '25'
+
+      - uses: gradle/actions/setup-gradle@v6
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.x'
+
+      - run: ./gradlew build jacocoTestReport
+
+      # Confirms that something other than JMPQ3 can read what JMPQ3 wrote.
+      # The Gradle run exported the rebuilt archives and their expected content
+      # digests; tools/mpqref.py is an independent implementation.
+      - name: Verify rebuilt archives with the reference implementation
+        run: |
+          python tools/mpqref.py selftest
+          python tools/mpqref.py verify build/roundtrip/archives --manifest build/roundtrip/expected.tsv
+
+      # Catches drift between the committed golden manifest and the fixtures.
+      - name: Check the golden manifest is up to date
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          python tools/mpqref.py manifest src/test/resources/mpqs \
+            --names src/main/resources/DefaultListfile.txt \
+            -o /tmp/fixtures.tsv
+          diff -u src/test/resources/golden/fixtures.tsv /tmp/fixtures.tsv
+
+      - name: Upload test report
+        if: failure()
+        uses: actions/upload-artifact@v7
+        with:
+          name: test-report-${{ matrix.os }}
+          path: build/reports/tests/test
+          retention-days: 7
+
+      - name: Report coverage
+        if: matrix.os == 'ubuntu-latest'
+        uses: coverallsapp/github-action@v2
+        with:
+          file: build/reports/jacoco/test/jacocoTestReport.xml
+          format: jacoco
+          fail-on-error: false

.github/workflows/build.yml

@@ -1,5 +1,4 @@
-# This workflow will build a package using Gradle and then publish it to GitHub packages when a release is created
-# For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#Publishing-using-gradle
+# Publishes the library to GitHub Packages when a release is created.
 
 name: Gradle Package
 
@@ -8,30 +7,25 @@ on:
     types: [created]
 
 jobs:
-  build:
-
+  publish:
     runs-on: ubuntu-latest
     permissions:
       contents: read
       packages: write
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up JDK 11
-      uses: actions/setup-java@v2
-      with:
-        java-version: '11'
-        distribution: 'adopt'
-        server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
-        settings-path: ${{ github.workspace }} # location for the settings.xml file
-
-    - name: Build with Gradle
-      run: gradle build
-
-    # The USERNAME and TOKEN need to correspond to the credentials environment variables used in
-    # the publishing section of your build.gradle
-    - name: Publish to GitHub Packages
-      run: gradle publish
-      env:
-        USERNAME: ${{ github.actor }}
-        TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/checkout@v7
+
+      - uses: actions/setup-java@v5
+        with:
+          distribution: temurin
+          java-version: '25'
+
+      - uses: gradle/actions/setup-gradle@v6
+
+      - run: ./gradlew build
+
+      - run: ./gradlew publish
+        env:
+          USERNAME: ${{ github.actor }}
+          TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/gradle-publish.yml

@@ -21,4 +21,7 @@ out/
 src/test/resources/mpqs/War3x.w3x
 src/test/resources/War3x.w3x
 
-.scannerwork
+.scannerwork
+# Python bytecode from tools/
+__pycache__/
+*.pyc