Add test that launches Oolite, creates a snapshot and closes it (#591)

* Add JS quit command and related Obj-C plumbing
* Make AddOns folder in oolite.app not build
* Add Python test that launches Oolite, takes a snapshot and quits
* Add to test_builds workflow
* Add Windows test build
* Update OOlite.nsi to exclude AddOns in oolite.app folder as it is already one level up
* Install mesa for Windows CI
* Gallium driver env var
* Fix appimage (old Ubuntu doesn't have Wayland)
* Update README.md to show how to run test
* Check png size
* Move quitGame into ifndef NDEBUG
* Better comments

Author: mcarans

.github/workflows/build-all.yaml

@@ -1,6 +1,4 @@
----
-name: build-all
-
+name: Build Oolite package for various platforms
 on:
   workflow_dispatch:
   push:
@@ -35,7 +33,7 @@ jobs:
 
       - name: Install packages
         run: |
-          sudo oolite/ShellScripts/Linux/install_deps_root.sh
+          sudo oolite/ShellScripts/Linux/install_deps_root.sh --skip-wayland
 
       - name: Build Oolite
         run: |

.github/workflows/test_builds.yaml

@@ -1,4 +1,4 @@
-name: Build Oolite package on various platforms
+name: Test Oolite package on various platforms
 on:
   push:
   pull_request:
@@ -23,7 +23,7 @@ jobs:
           sudo ShellScripts/Linux/install_deps_root.sh
       - name: Build Oolite
         run: |
-          ShellScripts/common/build_oolite.sh pkg-appimage
+          ShellScripts/common/build_oolite.sh test
 
   fedora:
     runs-on: ubuntu-latest
@@ -38,10 +38,15 @@ jobs:
         run: |
           dnf -y update
           dnf -y install git
-      - name: Checkout Oolite
+      - name: Pre-setup ownership
         run: |
+          # This must run before the checkout action if the action tries to do git commands
+          mkdir -p "$GITHUB_WORKSPACE"
           git config --global --add safe.directory "$GITHUB_WORKSPACE"
-          git clone --recursive https://github.com/${{ github.repository }} .
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          submodules: true
       - name: Checkout dependencies
         run: |
           ShellScripts/Linux/checkout_deps.sh
@@ -50,7 +55,7 @@ jobs:
           ShellScripts/Linux/install_deps_root.sh
       - name: Build Oolite
         run: |
-          ShellScripts/common/build_oolite.sh pkg-appimage
+          ShellScripts/common/build_oolite.sh test
 
   arch:
     runs-on: ubuntu-latest
@@ -65,10 +70,15 @@ jobs:
         run: |
           pacman -Syu --noconfirm
           pacman -S --noconfirm --needed git
-      - name: Checkout Oolite
+      - name: Pre-setup ownership
         run: |
+          # This must run before the checkout action if the action tries to do git commands
+          mkdir -p "$GITHUB_WORKSPACE"
           git config --global --add safe.directory "$GITHUB_WORKSPACE"
-          git clone --recursive https://github.com/${{ github.repository }} .
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          submodules: true
       - name: Checkout dependencies
         run: |
           ShellScripts/Linux/checkout_deps.sh
@@ -77,4 +87,39 @@ jobs:
           ShellScripts/Linux/install_deps_root.sh
       - name: Build Oolite
         run: |
-          ShellScripts/common/build_oolite.sh pkg-appimage
+          ShellScripts/common/build_oolite.sh test
+
+  windows:
+    runs-on: windows-latest
+    steps:
+      - name: Set up MSYS2
+        uses: msys2/setup-msys2@v2
+        with:
+          update: true
+
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          submodules: true
+
+      - name: Download latest release assets
+        uses: robinraju/release-downloader@v1
+        with:
+          repository: OoliteProject/oolite_windeps_build
+          latest: true
+          fileName: "*"
+          out-file-path: build/packages
+
+      - name: Install packages
+        shell: msys2 {0}
+        env:
+          msystem: UCRT64
+        run: |
+          ShellScripts/Windows/install_deps.sh clang
+
+      - name: Build Oolite
+        shell: msys2 {0}
+        env:
+          msystem: UCRT64
+        run: |
+          ShellScripts/common/build_oolite.sh test

DebugOXP/Debug.oxp/Scripts/oolite-debug-console.js

@@ -858,6 +858,16 @@ this.evaluate = function evaluate(command, PARAM)
 	}
 }
 
+this.quit = function() {
+    log("debugConsole.automation", "Triggering global quitGame bridge...");
+
+    // This calls the native function in OOJSGlobal.m, which in turn calls [Universe quitGame]
+    if (typeof quitGame === "function") {
+        quitGame();
+    } else {
+        log("debugConsole.automation", "Error: quitGame() global function not found. Did you recompile?");
+    }
+};
 
 // Identify the location of the eval() command above for the debug location formatter.
 this.markConsoleEntryPoint = special.markConsoleEntryPoint;

Makefile

@@ -33,7 +33,7 @@ help:
 .PHONY: release
 release:
 	$(MAKE) -f GNUmakefile debug=no strip=yes lto=yes
-	mkdir -p build/AddOns && rm -rf build/AddOns/Basic-debug.oxp && cp -rf DebugOXP/Debug.oxp build/AddOns/Basic-debug.oxp
+	mkdir -p oolite.app/AddOns && rm -rf oolite.app/AddOns/Basic-debug.oxp && cp -rf DebugOXP/Debug.oxp oolite.app/AddOns/Basic-debug.oxp
 
 .PHONY: release-deployment
 release-deployment:
@@ -42,18 +42,21 @@ release-deployment:
 .PHONY: release-snapshot
 release-snapshot:
 	$(MAKE) -f GNUmakefile SNAPSHOT_BUILD=yes debug=no
-	mkdir -p build/AddOns && rm -rf build/AddOns/Basic-debug.oxp && cp -rf DebugOXP/Debug.oxp build/AddOns/Basic-debug.oxp
+	mkdir -p oolite.app/AddOns && rm -rf oolite.app/AddOns/Basic-debug.oxp && cp -rf DebugOXP/Debug.oxp oolite.app/AddOns/Basic-debug.oxp
 
 .PHONY: debug
 debug:
 	$(MAKE) -f GNUmakefile debug=yes strip=no
-	mkdir -p build/AddOns && rm -rf build/AddOns/Basic-debug.oxp && cp -rf DebugOXP/Debug.oxp build/AddOns/Basic-debug.oxp
+	mkdir -p oolite.app/AddOns && rm -rf oolite.app/AddOns/Basic-debug.oxp && cp -rf DebugOXP/Debug.oxp oolite.app/AddOns/Basic-debug.oxp
+
+.PHONY: test
+test: release-snapshot
+	tests/run_test.sh
 
 .PHONY: clean
 clean:
 	$(MAKE) -f GNUmakefile clean
 	$(RM) -rf oolite.app
-	$(RM) -rf build/AddOns
 
 .PHONY: all
 all: release release-deployment release-snapshot debug

README.md

@@ -101,13 +101,13 @@ sudo ShellScripts/Linux/install_deps_root.sh
 
 ### Building Oolite
 
-Next run this in your bash or MSYS2 prompt to build Oolite:
+Next run this in your Bash or MSYS2 prompt to build Oolite:
 
 ```bash
 ShellScripts/common/build_oolite.sh release
 ```
 
-The completed build (executable and games files) can be found in the Oolite.app directory.
+The completed build (executable and games files) can be found in the oolite.app directory.
 
 Subsequently, you can clean and build as follows:
 
@@ -116,6 +116,12 @@ make -f Makefile clean
 make -f Makefile release -j$(nproc)
 ```
 
+You can run a test from your Bash or MSYS2 prompt as follows:
+
+```bash
+make -f Makefile test
+```
+
 On Linux, you will need to run this beforehand: `source /usr/local/share/GNUstep/Makefiles/GNUstep.sh`
 
 On Windows, this is set up be default in the shell: `source $MINGW_PREFIX/share/GNUstep/Makefiles/GNUstep.sh`

ShellScripts/Linux/install_deps_root.sh

@@ -4,6 +4,16 @@
 
 
 run_script() {
+    local skip_wayland=false
+
+    # Parse arguments
+    while [[ "$#" -gt 0 ]]; do
+        case $1 in
+            -s|--skip-wayland) skip_wayland=true; shift ;;
+            *) shift ;;
+        esac
+    done
+
     # If current user ID is NOT 0 (root)
     if [[ $EUID -ne 0 ]]; then
         echo "This script requires root to install dependencies. Rerun and escalate privileges (eg. sudo ...)"
@@ -30,6 +40,17 @@ run_script() {
     if ! install_package gnutls-dev; then
         return 1
     fi
+    # Check Python
+    if ! python3 --version >/dev/null 2>&1; then
+        if ! install_package python; then
+            return 1
+        fi
+    fi
+    if [[ $skip_wayland == false ]]; then
+        if ! install_package xwfb-run; then
+            return 1
+        fi
+    fi
     if ! install_package icu-dev; then
         return 1
     fi

ShellScripts/Linux/install_freedesktop_fn.sh

@@ -5,7 +5,7 @@ install_freedesktop() {
     # $1: app folder (destination)
     # $2: appdata or metainfo
 
-    local err_msg="❌ Error: Failed to install "
+    local err_msg="❌ Error: Failed to"
 
     SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" &> /dev/null && pwd)
     pushd "$SCRIPT_DIR"
@@ -19,13 +19,19 @@ install_freedesktop() {
     APPSHR="$1/share"
 
     # Install binaries and scripts
-    install -D "$PROGDIR/oolite" "$APPBIN/oolite" || { echo "$err_msg oolite binary" >&2; return 1; }
-    install -D "$PROGDIR/run_oolite.sh" "$APPBIN/run_oolite.sh" || { echo "$err_msg run_oolite.sh" >&2; return 1; }
-    install -D "$PROGDIR/splash-launcher" "$APPBIN/splash-launcher" || { echo "$err_msg splash-launcher" >&2; return 1; }
+    install -D "$PROGDIR/oolite" "$APPBIN/oolite" || { echo "$err_msg install oolite binary" >&2; return 1; }
+    install -D "$PROGDIR/run_oolite.sh" "$APPBIN/run_oolite.sh" || { echo "$err_msg install run_oolite.sh" >&2; return 1; }
+    install -D "$PROGDIR/splash-launcher" "$APPBIN/splash-launcher" || { echo "$err_msg install splash-launcher" >&2; return 1; }
 
     # Resources copy
     mkdir -p "$APPBIN/Resources"
-    cp -rf "$PROGDIR/Resources/." "$APPBIN/Resources/" || { echo "$err_msg Copying Resources folder" >&2; return 1; }
+    cp -rf "$PROGDIR/Resources/." "$APPBIN/Resources/" || { echo "$err_msg copy Resources folder" >&2; return 1; }
+
+    # AddOns copy if folder exists in oolite.app
+    if [ -d "$PROGDIR/AddOns" ]; then
+        mkdir -p "$APPBIN/AddOns"
+        cp -rf "$PROGDIR/AddOns/." "$APPBIN/AddOns/" || { echo "$err_msg copy AddOns folder" >&2; return 1; }
+    fi
 
     install -D "GNUstep.conf.template" "$APPBIN/Resources/GNUstep.conf.template" || { echo "$err_msg GNUstep template" >&2; return 1; }
 

ShellScripts/Linux/install_package_fn.sh

@@ -37,6 +37,15 @@ install_package() {
                 arch) PKG_NAME="gnutls" ;;
             esac ;;
 
+        "python")
+            case "$CURRENT_DISTRO" in
+                debian) PKG_NAME="python3-pip" ;;
+                redhat) PKG_NAME="python3-pip" ;;
+                arch) PKG_NAME="python-pip" ;;
+            esac ;;
+
+        "xwfb-run") PKG_NAME="xwayland-run weston" ;;
+
         "icu-dev")
             case "$CURRENT_DISTRO" in
                 debian) PKG_NAME="libicu-dev" ;;

ShellScripts/Windows/install_deps.sh

@@ -39,6 +39,8 @@ run_script() {
     pacman -S pactoys --noconfirm
     pacboy -S binutils --noconfirm
     pacboy -S uutils-coreutils --noconfirm
+    pacboy -S python-pip --noconfirm
+    pacboy -S mesa --noconfirm
 
     source ../common/checkout_submodules_fn.sh
     checkout_submodules

ShellScripts/common/post_build.sh

@@ -44,7 +44,7 @@ run_script() {
     for resdir in "${RESOURCE_DIRS[@]}"; do
         cp -rfu "$resdir" "$PROGDIR/Resources"
     done
-    
+
     cp -fu Resources/README.TXT "$PROGDIR/Resources"
     cp -fu Resources/InfoPlist.strings "$PROGDIR/Resources"
     cp -fu src/Cocoa/Info-Oolite.plist "$PROGDIR/Resources/Info-gnustep.plist"