Merge pull request #64 from MxIris-Reverse-Engineering/feat/ci-snapshot-testing

CI snapshot testing: SymbolTestsCore-only per-category coverage

Author: Mx-Iris

.github/workflows/macOS.yml

@@ -9,13 +9,14 @@ on:
 jobs:
   macos_test:
     name: Execute tests on macOS
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
+        # Apple Silicon runners only: MachOFileTests.preferredArchitecture == .arm64.
+        # Adding an Intel runner would load a different arch slice and drift snapshots.
         os: [macos-15]
         xcode-version: ["16.3"]
-        release: [2024]
-    runs-on: ${{ matrix.os }}
     env:
       MACHO_SWIFT_SECTION_SILENT_TEST: 1
       GH_TOKEN: ${{ github.token }}
@@ -27,11 +28,43 @@ jobs:
           xcode-version: ${{ matrix.xcode-version }}
       - name: Swift version
         run: swift --version
+
+      - name: Resolve SPM dependencies
+        run: swift package update
+
+      - name: Cache SymbolTests DerivedData
+        uses: actions/cache@v4
+        with:
+          path: Tests/Projects/SymbolTests/DerivedData
+          key: symboltests-${{ matrix.xcode-version }}-${{ hashFiles('Tests/Projects/SymbolTests/**/*.swift', 'Tests/Projects/SymbolTests/**/*.pbxproj') }}
+
+      - name: Build SymbolTestsCore fixture
+        working-directory: ${{ github.workspace }}
+        run: |
+          set -o pipefail
+          xcodebuild \
+            -project Tests/Projects/SymbolTests/SymbolTests.xcodeproj \
+            -scheme SymbolTestsCore \
+            -configuration Release \
+            -derivedDataPath Tests/Projects/SymbolTests/DerivedData \
+            -destination 'generic/platform=macOS' \
+            -quiet \
+            build
+
+      - name: Upload xcodebuild logs on failure
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: symboltests-derived-data-logs
+          path: Tests/Projects/SymbolTests/DerivedData/Logs
+          if-no-files-found: ignore
+
       - name: Build and run tests in debug mode
         run: |
           swift test \
             -c debug \
             --build-path .build-test-debug
+
       - name: Build and run tests in release mode
         run: |
           swift test \

.gitignore

@@ -15,6 +15,7 @@ Tests/__Snapshots__
 .claude
 .codex
 .opencode
+.worktrees/
 PrecompiledLibraries/swift-syntax/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
 .derived-data-log-*
 .package.env

README.md

@@ -160,6 +160,33 @@ swift-section interface --uses-system-dyld-shared-cache --cache-image-name Swift
 swift-section interface --dyld-shared-cache --cache-image-path /path/to/cache /path/to/dyld_shared_cache
 ```
 
+## Running Tests
+
+The snapshot tests in this repository rely on a fixture framework (`SymbolTestsCore`) built from an Xcode project in `Tests/Projects/SymbolTests/`. The framework binary is not checked in — rebuild it once after cloning:
+
+```bash
+./Scripts/build-test-fixtures.sh
+```
+
+Then run the tests:
+
+```bash
+swift package update
+swift test
+```
+
+Skipping the fixture build causes `MachOFileTests` to throw a "file not found" error at `Tests/Projects/SymbolTests/DerivedData/.../SymbolTestsCore` during test `init()`, before any assertions run.
+
+To regenerate snapshots after a legitimate Swift-compiler / metadata change:
+
+```bash
+SNAPSHOT_TESTING_RECORD=all swift test \
+    --filter SymbolTestsCoreDumpSnapshotTests \
+    --filter SymbolTestsCoreInterfaceSnapshotTests
+```
+
+Commit the updated `__Snapshots__/` files alongside the source change that prompted the regeneration.
+
 ## License
 
 [MachOObjCSection](https://github.com/p-x9/MachOObjCSection)

Scripts/build-test-fixtures.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+#
+# Builds the SymbolTestsCore fixture framework consumed by MachOSwiftSection's
+# snapshot tests. Run once after cloning, and again whenever
+# Tests/Projects/SymbolTests/SymbolTestsCore/**/*.swift (or the Xcode project
+# itself) changes. Output lands in Tests/Projects/SymbolTests/DerivedData/,
+# which is gitignored.
+#
+# If you skip this step, MachOFileTests.init() throws a "file not found" error
+# at the configured path under Tests/Projects/SymbolTests/DerivedData/…, and
+# every snapshot test aborts before asserting.
+
+set -euo pipefail
+
+# Resolve the script's own directory so the command works from any CWD.
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+REPO_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
+
+cd "$REPO_ROOT"
+
+xcodebuild \
+    -project Tests/Projects/SymbolTests/SymbolTests.xcodeproj \
+    -scheme SymbolTestsCore \
+    -configuration Release \
+    -derivedDataPath Tests/Projects/SymbolTests/DerivedData \
+    -destination 'generic/platform=macOS' \
+    -quiet \
+    build
+
+echo "SymbolTestsCore fixture built. Next: swift package update && swift test"