Fix headless callbacks

.github/workflows/beta.yml

@@ -1,13 +1,14 @@
 name: Push beta branch
-on: 
+on:
   schedule:
     - cron: '0 0 * * 5'
   push:
     branches:
-      - 'master'
+      - master
   workflow_dispatch:
 jobs:
   push-beta:
+    if: github.repository == 'PathOfBuildingCommunity/PathOfBuilding'
     runs-on: ubuntu-22.04
     steps:
             - name: Set line endings
@@ -52,3 +53,4 @@ jobs:
               run: |
                   git commit -am "Weekly beta release" --allow-empty --author="github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>"
                   git push origin HEAD:beta --force
+>>>>>>> dev

.github/workflows/builddocker.yml

@@ -39,4 +39,4 @@ jobs:
           cache-from: type=gha
           cache-to: type=gha,mode=max
           tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/buildtest.yml

@@ -0,0 +1,50 @@
+---
+name: Run Build Diff Tests
+on:
+  pull_request:
+    branches:
+      - dev
+  workflow_dispatch:
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  run_build_diff:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout HEAD
+        uses: actions/checkout@v4
+      - name: Fetch Dev branch
+        id: get-dev-ref
+        run: |
+            git fetch --depth=1 origin dev
+            echo "devref=$(git rev-parse origin/dev)" >> "$GITHUB_OUTPUT"
+      - name: Download Dev branch cache
+        id: download-dev-ref-cache
+        uses: dawidd6/action-download-artifact@3ecf4024886f219d9290351234889bfb45d1b9da
+        with:
+          name: corpus-cache-devref-${{ steps.get-dev-ref.outputs.devref }}
+          path: /tmp/cache/
+          if_no_artifact_found: warn
+          search_artifacts: true
+      - name: Calculate build xmls and differences between them
+        shell: bash
+        run: |
+            mkdir /tmp/cache || true # Make sure /tmp/cache exists. Ignore exit code
+            chmod -R 777 /tmp/cache && docker compose run -v '/tmp/cache/:/cache' -e 'CACHEDIR=/cache' busted-diff | tee /tmp/dockerlog
+      - name: Generate artefact
+        run: |
+          sed -n '/Runtime comparison for/,/Savefile Diff for/{/Savefile Diff for/!p;}' /tmp/dockerlog > /tmp/artefact
+          sed -n '/Savefile Diff for/, $p' /tmp/dockerlog >> /tmp/artefact
+          [ -s /tmp/artefact ] || rm /tmp/artefact
+      - name: Upload artefact
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-diff-output
+          path: /tmp/artefact
+      - name: Upload dev ref cache
+        if: ${{ steps.download-dev-ref-cache.outputs.found_artifact == 'false' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: corpus-cache-devref-${{ steps.get-dev-ref.outputs.devref }}
+          path: /tmp/cache/

.github/workflows/unittest.yml

@@ -0,0 +1,17 @@
+name: Run Unit Tests
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - dev
+  pull_request:
+    branches:
+      - dev
+jobs:
+  run_unit_tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Run busted tests
+        run: docker compose run --no-TTY busted-tests

.lua-format

@@ -0,0 +1,8 @@
+column_limit: 160
+indent_width: 1
+use_tab: true
+tab_width: 4
+continuation_indent_width: 4
+spaces_before_call: 1
+keep_simple_control_block_one_line: false
+keep_simple_function_one_line: false

.luacheckrc

@@ -0,0 +1,4 @@
+globals = { "round", "modLib", "LoadModule", "data", "ModFlag", "KeywordFlag", "SkillType", "launch", "IsKeyDown", "copyTable", "main", "colorCodesA"}
+read_globals = {"DrawString", "SetDrawLayer", "GetDrawLayer", "ConPrintf", "SetDrawColor", "DrawStringWidth", "GetCursorPos", "SetViewport", "GetTime", "DrawImage", "NewFileSearch", "MakeDir"}
+max_line_length = false
+exclude_files = { "src\\TreeData", "src\\Data"}

CONTRIBUTING.md

@@ -299,11 +299,13 @@
 ```
 
 ## Testing
+Pob uses two types of tests. Unit tests that test specific calculations or mechanics and "build diff" tests that calculate the effect the changes have on a given list of builds.
+While both can be ran locally it's recommended to use the provided docker image for both ease of use and to keep everyone on the same page.
 
 PoB uses the [Busted](https://lunarmodules.github.io/busted/) framework to run its tests. Tests are stored under `spec/System` and run automatically when a PR is modified.
 More tests can be added to this folder to test specific functionality, or new test builds can be added to ensure nothing changed that wasn't intended. 
 
-### Running tests
+To run the build difference tests run `docker compose up busted-diff`. `busted-diff` first downloads the build corpus from `https://api.pob.codes/test-builds/corpus` and computes it alongside `spec/TestBuilds/` using the current working changes. Then it uses git to checkout the branch specified by `DEVREF` or `dev` by default and computes the same builds. Lastly it finds the differences in the outputs generated from both, does some post processing, and prints all of the information out. The downloaded builds and list stay with the calculated `DEVREF` cache and are reused together until that cache changes.
 
 1. Install [Docker](https://www.docker.com/get-started)
 2. Run `docker-compose up` from the command line

docker-compose.yml

@@ -13,3 +13,28 @@ services:
     working_dir: /workdir
     volumes:
       - ./:/workdir:ro
+  busted-diff:
+    #build: .
+    image: ghcr.io/pathofbuildingcommunity/pathofbuilding-tests:latest
+    environment: #Where in the container the folders are stored
+      WORKDIR: /workdir
+      HOME: /tmp
+      DEVREF: ${DEVREF:-origin/dev}
+      HEADREF: $HEADREF
+      LUA_PATH: "/usr/share/lua/5.1/?.lua;/usr/share/lua/5.1/?/init.lua;;"
+      LUA_CPATH: "/usr/lib/lua/5.1/?.so;;"
+    container_name: busted-diff
+    tty: true
+    # Dependencies used by the existing build-diff scripts; the image provides LuaJIT.
+    command:
+      - /bin/sh
+      - -ec
+      - |
+        apk add --no-cache git parallel libxml2-utils lua5.1-posix lua5.1-curl zlib-dev
+        luarocks install lua-zlib 1.4-0
+        exec su -p nobody -s /bin/sh -c 'dos2unix < /workdir/spec/BuildDiff.sh | /bin/sh'
+    security_opt:
+      - no-new-privileges:true
+    working_dir: /workdir
+    volumes:
+      - ./:/workdir:ro

spec/BuildDiff.sh

@@ -0,0 +1,81 @@
+#!/bin/sh
+set -eo pipefail
+umask 0
+
+# If external cache dir has not been defined keep it inside the container
+if [[ -z "$CACHEDIR" ]]
+then
+    mkdir /tmp/cachedir
+    export CACHEDIR="/tmp/cachedir"
+fi
+
+# Copy mounted workdir to allow for changes during test run
+rm -rf /tmp/workdir && mkdir /tmp/workdir && cp -rf "$WORKDIR"/. /tmp/workdir/ && cd /tmp/workdir
+
+git config --global --add safe.directory /tmp/workdir
+git config --global --add advice.detachedHead false
+
+if [[ ! -z "$HEADREF" ]]
+then
+    git diff --no-color "$HEADREF" -- /tmp/workdir/.busted /tmp/workdir/src/HeadlessWrapper.lua /tmp/workdir/spec/ > /tmp/HeadPatch &&
+    git reset --hard "$HEADREF" && git clean -fd && git apply --allow-empty --index /tmp/HeadPatch
+fi
+
+headsha=$(git rev-parse HEAD)
+devsha=$(git rev-parse "$DEVREF")
+
+# Keep the input corpus with the calculated base, as in the existing workflow.
+if [[ ! -f "$CACHEDIR/$devsha" ]]; then
+    curl --fail --show-error --silent https://api.pob.codes/test-builds/corpus -o "$CACHEDIR/corpus.json"
+    luajit spec/FetchTestBuilds.lua "$CACHEDIR"
+fi
+cp "$CACHEDIR/builds.txt" spec/builds.txt
+
+rm -rf /tmp/headsha && mkdir /tmp/headsha
+rm -f /tmp/workdir/src/Settings.xml
+cat /tmp/workdir/spec/builds.txt | dos2unix | parallel --will-cite --ungroup --pipe -N50 'LINKSBATCH="$(mktemp){#}"; cat > $LINKSBATCH; BUILDLINKS="$LINKSBATCH" BUILDCACHEPREFIX="/tmp/headsha" busted --lua=luajit -r generate' && \
+BUILDCACHEPREFIX='/tmp/headsha' busted --lua=luajit -r generate && date > "/tmp/headsha/$headsha" && echo "[+] Build cache computed for $headsha (headsha)" || exit $?
+
+if [[ ! -f "$CACHEDIR/$devsha" ]] # Output of builds outdated or nonexistent
+then
+	rm -rf "$CACHEDIR"/*.build
+
+    # Keep new changes to tests related files
+    git diff --no-color "$DEVREF" -- /tmp/workdir/.busted /tmp/workdir/src/HeadlessWrapper.lua /tmp/workdir/spec/ > /tmp/DevPatch && \
+    git reset --hard "$DEVREF" && git clean -fd && git apply --allow-empty --index /tmp/DevPatch && \
+    cat /tmp/workdir/spec/builds.txt | dos2unix | parallel --will-cite --ungroup --pipe -N50 'LINKSBATCH="$(mktemp){#}"; cat > $LINKSBATCH; BUILDLINKS="$LINKSBATCH" BUILDCACHEPREFIX="$CACHEDIR" busted --lua=luajit -r generate' && \
+    BUILDCACHEPREFIX="$CACHEDIR" busted --lua=luajit -r generate && date > "$CACHEDIR/$devsha" && echo "[+] Build cache computed for $devsha (devsha)" || exit $?
+fi
+
+for runTime in "$CACHEDIR"/*.time
+do
+    BASENAME=$(basename "$runTime")
+
+    DIFFOUTPUT=$(luajit spec/DiffRuntime.lua "/tmp/headsha/$BASENAME" "$runTime" "$BASENAME") || {
+        echo "## Runtime comparison for $BASENAME"
+        echo '```'
+        echo "$DIFFOUTPUT"
+        echo '```'
+    }
+done
+
+for build in "$CACHEDIR"/*.build
+do
+    BASENAME=$(basename "$build")
+
+    # Only print the header if there is a diff to display
+    DIFFOUTPUT=$(diff <(xmllint --exc-c14n "$build") <(xmllint --exc-c14n "/tmp/headsha/$BASENAME")) || {
+        echo "## Savefile Diff for $BASENAME"
+        echo '```diff'
+        echo "$DIFFOUTPUT"
+        echo '```'
+    }
+
+    # Dedicated output diff
+    DIFFOUTPUT=$(luajit spec/DiffOutput.lua "/tmp/headsha/$BASENAME" "$build") || {
+        echo "## Output Diff for $BASENAME"
+        echo '```'
+        echo "$DIFFOUTPUT"
+        echo '```'
+    }
+done

spec/DiffOutput.lua

@@ -0,0 +1,74 @@
+-- https://stackoverflow.com/questions/19326368/iterate-over-lines-including-blank-lines
+local function splitLines(s)
+	if s:sub(-1)~="\n" then s=s.."\n" end
+	return s:gmatch("(.-)\n")
+end
+
+local function buildOutputMap(filecontent)
+	local playerOutput = {}
+    local minionOutput = {}
+	for line in splitLines(filecontent) do
+		local stat = line:match('<PlayerStat%s+([^>]+)')
+		local key, val = stat and stat:match('stat="(.-)"'), stat and stat:match('value="(.-)"')
+        if key then
+		    playerOutput[key] = val
+		else
+			local stat = line:match('<MinionStat%s+([^>]+)')
+			local key, val = stat and stat:match('stat="(.-)"'), stat and stat:match('value="(.-)"')
+			if key then
+				minionOutput[key] = val
+			end
+        end
+	end
+	return playerOutput, minionOutput
+end
+
+local headhnd = io.open(arg[1], "r")
+local devhnd = io.open(arg[2], "r")
+
+if headhnd and devhnd then
+	local playerHEADOutput, minionHEADOutput = buildOutputMap(headhnd:read("*a"))
+	local playerDEVOutput, minionDEVOutput = buildOutputMap(devhnd:read("*a"))
+	local mismatch = {}
+    local mismatchFound = false
+	for key, val in pairs(playerHEADOutput) do
+		if not playerDEVOutput[key] or playerDEVOutput[key] ~= val then
+			mismatch[key] = {devOutput = playerDEVOutput[key], headOutput = val}
+            mismatchFound = true
+		end
+	end
+	for key, val in pairs(playerDEVOutput) do
+		if not mismatch[key] and (not playerHEADOutput[key] or playerHEADOutput[key] ~= val) then
+			mismatch[key] = {headOutput = playerHEADOutput[key], devOutput = val}
+            mismatchFound = true
+		end
+	end
+	for key, val in pairs(mismatch) do
+		print(key .. " Mismatch in player outputs: ")
+		print("\t" .."head Output: " .. tostring(val["headOutput"]))
+		print("\t" .."dev Output: " .. tostring(val["devOutput"]))
+	end
+	mismatch = {}
+	for key, val in pairs(minionHEADOutput) do
+		if not minionDEVOutput[key] or minionDEVOutput[key] ~= val then
+			mismatch[key] = {devOutput = minionDEVOutput[key], headOutput = val}
+            mismatchFound = true
+		end
+	end
+	for key, val in pairs(minionDEVOutput) do
+		if not mismatch[key] and (not minionHEADOutput[key] or minionHEADOutput[key] ~= val) then
+			mismatch[key] = {headOutput = minionHEADOutput[key], devOutput = val}
+            mismatchFound = true
+		end
+	end
+	for key, val in pairs(mismatch) do
+		print(key .. " Mismatch in minion outputs: ")
+		print("\t" .."head Output: " .. tostring(val["headOutput"]))
+		print("\t" .."dev Output: " .. tostring(val["devOutput"]))
+	end
+    if mismatchFound then
+        os.exit(1) -- Make the exit codes of the script match the exit codes of the diff utility
+    end
+else
+    os.exit(2)
+end

spec/DiffRuntime.lua

@@ -0,0 +1,17 @@
+local headHnd = io.open(arg[1], "r")
+local devHnd = io.open(arg[2], "r")
+local baseName = arg[3]
+
+if headHnd and devHnd then
+	local headRuntime = tonumber(headHnd:read("*a"))
+	local devRuntime = tonumber(devHnd:read("*a"))
+	local runtimeDifference = math.abs(headRuntime / devRuntime - 1)
+	if runtimeDifference >= 0.1 then
+		print(string.format("%s Took longer than 10%% to calculate (%d%%)", baseName, math.floor(runtimeDifference*100)))
+		print("\thead runtime: " .. headRuntime .. "ms")
+		print("\tdev Output: " .. devRuntime .. "ms")
+		os.exit(1) -- Make the exit codes of the script match the exit codes of the diff utility
+	end
+else
+	os.exit(2)
+end

spec/FetchTestBuilds.lua

@@ -0,0 +1,21 @@
+-- Store the API corpus alongside the calculated base cache, outside Git.
+package.path = "runtime/lua/?.lua;" .. package.path
+local json = require("dkjson")
+local base64 = require("base64")
+local zlib = require("zlib")
+local cache = assert(arg[1])
+local input = assert(io.open(cache .. "/corpus.json", "r"))
+local corpus = assert(json.decode(input:read("*a")))
+input:close()
+assert(corpus.schemaVersion == 2 and #corpus.builds > 0 and #corpus.builds == corpus.count, "Invalid build corpus")
+local list = assert(io.open(cache .. "/builds.txt", "w"))
+for _, entry in ipairs(corpus.builds) do
+    assert(#entry.sha256 == 64 and entry.sha256:match("^%x+$"), "Invalid build filename")
+    local xml = zlib.inflate()(base64.decode(entry.code:gsub("-", "+"):gsub("_", "/")))
+    local output = assert(io.open(cache .. "/" .. entry.sha256 .. ".xml", "w"))
+    output:write(xml)
+    output:close()
+    list:write(entry.sha256, "\n")
+end
+list:close()
+print("[+] Downloaded " .. corpus.count .. " builds from corpus " .. corpus.snapshotId)