Convert to Azahar from Citra (RIP)

Author: ian-h-chamberlain

.github/workflows/ci.yml

@@ -68,20 +68,20 @@ jobs:
         # Still run doc tests even if lib/integration tests fail:
         if: ${{ !cancelled() }}
         env:
-          # This ensures the citra logs and video output get persisted to a
+          # This ensures the emulator logs and video output get persisted to a
           # directory where the artifact upload can find them.
           RUSTDOCFLAGS: " --persist-doctests target/armv6k-nintendo-3ds/debug/doctests"
         uses: ./run-tests
         with:
           working-directory: ctru-rs
           args: --doc --package test-runner -v
 
-      - name: Upload citra logs and capture videos
+      - name: Upload emulator logs and capture videos
         uses: actions/upload-artifact@v3
         # We always want to upload artifacts regardless of previous success/failure
         if: ${{ !cancelled() }}
         with:
-          name: citra-logs-${{ matrix.toolchain }}-${{ matrix.ctru-rs-ref }}
+          name: emu-logs-${{ matrix.toolchain }}-${{ matrix.ctru-rs-ref }}
           path: |
             ctru-rs/target/armv6k-nintendo-3ds/debug/**/*.txt
             ctru-rs/target/armv6k-nintendo-3ds/debug/**/*.webm

README.md

@@ -8,7 +8,7 @@ when working with these actions, in order to get useful test output on failures.
 ## Components
 
 * `setup`: action for setting up the Rust 3DS toolchain in workflows
-* `run-tests`: action for running test executables with Citra in workflows
+* `run-tests`: action for running test executables with [Azahar](https://github.com/azahar-emu/azahar) in workflows
 
 ## Usage
 

run-tests/Dockerfile

@@ -1,15 +1,15 @@
 FROM buildpack-deps:latest as builder
 
 WORKDIR /tmp
-COPY ./docker/download_citra.sh /usr/local/bin/download_citra
+COPY ./docker/download_emulator.sh /usr/local/bin/download_emulator
 RUN apt-get update -y && apt-get install -y jq
 
-ARG TAG=r0c2f076
-RUN download_citra ${TAG}
+ARG EMU_TAG=2120.2
+RUN download_emulator ${EMU_TAG}
 
 FROM devkitpro/devkitarm:latest as devkitarm
 
-# For some reason, citra isn't always happy when you try to run it for the first time,
+# For some reason, the emulator isn't always happy when you try to run it for the first time,
 # so we build a simple dummy program to force it to create its directory structure
 RUN cd /opt/devkitpro/examples/3ds/graphics/printing/hello-world && \
     echo 'int main(int, char**) {}' > source/main.c && \
@@ -38,16 +38,16 @@ ENV DEVKITPRO=/opt/devkitpro
 ENV DEVKITARM=${DEVKITPRO}/devkitARM
 ENV PATH=${DEVKITARM}/bin:${PATH}
 
-COPY --from=builder /tmp/citra.AppImage /usr/local/bin/citra
+COPY --from=builder /tmp/azahar.AppImage /usr/local/bin/azahar
 COPY --from=devkitarm /tmp/hello-world.3dsx /tmp/
-# We run citra once before copying our config file, so it should create its
+# We run azahar once before copying our config file, so it should create its
 # necessary directory structure and run once with defaults
-RUN xvfb-run citra --appimage-extract-and-run /tmp/hello-world.3dsx; \
+RUN xvfb-run azahar --appimage-extract-and-run /tmp/hello-world.3dsx; \
     rm -f /tmp/hello-world.3dsx
 # Initial run seems to miss this one directory so just make it manually
-RUN mkdir -p /root/.local/share/citra-emu/log
+RUN mkdir -p /root/.local/share/azahar-emu/log
 
-COPY ./docker/sdl2-config.ini /root/.config/citra-emu/
+COPY ./docker/sdl2-config.ini /root/.config/azahar-emu/
 COPY ./docker/test-runner.gdb /app/
 COPY ./docker/entrypoint.sh /app/
 

run-tests/action.yml

@@ -1,6 +1,6 @@
 name: Cargo 3DS Test
 description: >
-  Run `cargo 3ds test` executables using Citra. Note that to use this action,
+  Run `cargo 3ds test` executables using an emulator. Note that to use this action,
   you must use a container image of `devkitpro/devkitarm` and mount
   `/var/run/docker.sock:/var/run/docker.sock` into the container so that the
   runner image can be built by the action.

run-tests/docker/download_citra.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -euxo pipefail
+
+TAG=$1
+
+curl "https://api.github.com/repos/azahar-emu/azahar/releases/tags/${TAG}" |
+    jq --raw-output '.assets[].browser_download_url' |
+    grep -E 'azahar-.*-linux-appimage[.]tar.gz' |
+    xargs wget -O azahar-linux-appimage.tar.gz
+
+tar --strip-components 1 -xvf azahar-linux-appimage.tar.gz

run-tests/docker/download_emulator.sh

@@ -34,29 +34,29 @@ fi
 
 VIDEO_OUT="${EXE_NOEXT}_capture.webm"
 
-CITRA_LOG_DIR=~/.local/share/citra-emu/log
-CITRA_OUT="$CITRA_LOG_DIR/citra_output.txt"
+EMULATOR_LOG_DIR=~/.local/share/azahar-emu/log
+EMULATOR_OUT="$EMULATOR_LOG_DIR/emulator_output.txt"
 
 xvfb-run --auto-servernum \
-    citra \
+    azahar \
     --appimage-extract-and-run \
     --dump-video="$VIDEO_OUT" \
     "$EXE_TO_RUN" \
-    &>"$CITRA_OUT" &
-CITRA_PID=$!
+    &>"$EMULATOR_OUT" &
+EMULATOR_PID=$!
 
-# Citra takes a little while to start up, so wait a little before we try to connect
+# Azahar takes a little while to start up, so wait a little before we try to connect
 sleep 5
 
 arm-none-eabi-gdb --silent --batch-silent --command /app/test-runner.gdb "$EXE_ELF"
 STATUS=$?
 
-kill $CITRA_PID
+kill $EMULATOR_PID
 cleanup_jobs
 
-CITRA_LOG="$CITRA_LOG_DIR/citra_log.txt"
+EMULATOR_LOG="$EMULATOR_LOG_DIR/azahar_log.txt"
 
-for f in "$CITRA_LOG" "$CITRA_OUT"; do
+for f in "$EMULATOR_LOG" "$EMULATOR_OUT"; do
     OUT="${EXE_NOEXT}_$(basename "$f")"
     if test -f "$f"; then
         cp "$f" "$OUT"