Add fixtures runner

Author: febo

.github/workflows/main.yml

@@ -26,41 +26,6 @@ jobs:
       - name: Lint Programs
         run: pnpm programs:lint
 
-  format_and_lint_client_js:
-    name: Format & Lint Client JS
-    runs-on: ubuntu-latest
-    steps:
-      - name: Git Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Environment
-        uses: ./.github/actions/setup
-
-      - name: Format Client JS
-        run: pnpm clients:js:format
-
-      - name: Lint Client JS
-        run: pnpm clients:js:lint
-
-  # format_and_lint_client_rust:
-  #   name: Format & Lint Client Rust
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - name: Git Checkout
-  #       uses: actions/checkout@v4
-
-  #     - name: Setup Environment
-  #       uses: ./.github/actions/setup
-  #       with:
-  #         clippy: true
-  #         rustfmt: true
-
-  #     - name: Format Client Rust
-  #       run: pnpm clients:rust:format
-
-  #     - name: Lint Client Rust
-  #       run: pnpm clients:rust:lint
-
   build_programs:
     name: Build programs
     runs-on: ubuntu-latest
@@ -85,7 +50,7 @@ jobs:
           path: ./target/deploy/*.so
           if-no-files-found: error
 
-      - name: Save Program Builds For Client Jobs
+      - name: Save Program Builds For Fixtures Job
         uses: actions/cache/save@v4
         with:
           path: ./**/*.so
@@ -110,4 +75,31 @@ jobs:
           solana: true
 
       - name: Test Programs
-        run: pnpm programs:test
+        run: RUST_LOG=error pnpm programs:test
+
+  run_fixtures:
+    name: Run Fixtures
+    runs-on: ubuntu-latest
+    needs: build_programs
+    steps:
+      - name: Git Checkout
+        uses: actions/checkout@v4
+
+      - name: Purge environment
+        uses: ./.github/actions/purge
+
+      - name: Setup Environment
+        uses: ./.github/actions/setup
+        with:
+          cargo-cache-key: cargo-program-tests
+          cargo-cache-fallback-key: cargo-programs
+          solana: true
+
+      - name: Restore Program Builds
+        uses: actions/cache/restore@v4
+        with:
+          path: ./**/*.so
+          key: ${{ runner.os }}-builds-${{ github.sha }}
+
+      - name: Run Fixtures
+        run: RUST_LOG=error pnpm fixtures:run

package.json

@@ -21,7 +21,9 @@
     "clients:rust:format": "zx ./scripts/client/format-rust.mjs",
     "clients:rust:lint": "zx ./scripts/client/lint-rust.mjs",
     "clients:rust:publish": "zx ./scripts/client/publish-rust.mjs",
-    "clients:rust:test": "zx ./scripts/client/test-rust.mjs"
+    "clients:rust:test": "zx ./scripts/client/test-rust.mjs",
+    "fixtures:run": "zx ./scripts/fixtures.mjs run",
+    "fixtures:clean": "zx ./scripts/fixtures.mjs clean"
   },
   "devDependencies": {
     "@iarna/toml": "^2.2.5",

scripts/fixtures.mjs

@@ -0,0 +1,60 @@
+#!/usr/bin/env zx
+import 'zx/globals';
+import { existsSync } from 'fs';
+import { cliArguments, workingDirectory } from './utils.mjs';
+
+// Git repository for the SPL Token program.
+const SPL_TOKEN_GIT = "https://github.com/solana-program/token.git";
+// Directory where the SPL Token program is cloned. Since it is not meant to be
+// checked in, it is cloned in the target directory.
+const SPL_TOKEN_DIR = path.join(workingDirectory, 'target', 'spl-token');
+// Directory where the fixtures are generated. They get generated everytime the
+// `SPL_TOKEN_GIT` repository is cloned to make sure they are up to date.
+const FIXTURES_DIR = path.join(workingDirectory, 'target', 'spl-token', 'fixtures');
+// Path to the Cargo.toml file of the fixtures CLI program.
+const FIXTURES_MANIFEST = path.join(workingDirectory, 'fixtures', 'Cargo.toml');
+// Directory where the program binary is found.
+const OUTPUT_DIR = path.join(workingDirectory, 'target', 'deploy');
+// Directory where the CLI executale is found.
+const CLI_OUTPUT_DIR = path.join(workingDirectory, 'target', 'release');
+
+const [command, ...args] = cliArguments();
+
+switch (command) {
+    case 'clean':
+        await clean();
+        break;
+    case 'run':
+        await run(args);
+        break;
+    default:
+        throw new Error(`Unknown command: ${command}`);
+}
+
+async function clean() {
+    await $`rm -rf ${SPL_TOKEN_DIR}`;
+}
+
+async function run(args) {
+    // On first run (or CI), clone the SPL Token program and generate the fixtures.
+    // This allows re-runing the fixtures without having to run the tests again. To
+    // force re-generating the fixtures, delete the `SPL_TOKEN_DIR` directory.
+    if (!existsSync(SPL_TOKEN_DIR)) {
+        await $`mkdir ${SPL_TOKEN_DIR}`;
+        await $`git clone ${SPL_TOKEN_GIT} ${SPL_TOKEN_DIR}`;
+
+        cd(SPL_TOKEN_DIR);
+        // TODO: this can be removed once the mollusk checks PR is merged.
+        await $`git switch febo/mollusk-checks`;
+        
+        await $`EJECT_FUZZ_FIXTURES=${FIXTURES_DIR} cargo test-sbf --features mollusk-svm/fuzz --test processor`;
+    }
+
+    cd(workingDirectory);
+    // Make sure that the program is up to date.
+    await $`pnpm programs:build`;
+    // Builds the fixtures CLI program.
+    await $`cargo build --manifest-path ${FIXTURES_MANIFEST} --release`;
+    // Run the fixtures.
+    await $`SBF_OUT_DIR="${OUTPUT_DIR}" ${CLI_OUTPUT_DIR}/fixtures --directory ${FIXTURES_DIR} ${args ? args.join(' ') : ''}`;
+}