add firedancer conformance to ci

Author: buffalojoec

.github/workflows/main.yml

@@ -140,6 +140,31 @@ jobs:
             echo "CU usage has changed. Please run `cargo bench` and commit the new results.";
             exit 1;
           fi
+  
+  fd_conformance:
+    name: Builtin-BPF Conformance Test
+    runs-on: ubuntu-latest
+    needs: build_programs
+    steps:
+      - name: Git Checkout
+        uses: actions/checkout@v4
+      
+      - name: Setup Environment
+        uses: ./.github/actions/setup
+        with:
+          cargo-cache-key: cargo-program-conformance
+          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: Builtin-BPF Conformance Test
+        shell: bash
+        run: pnpm zx ./scripts/ci/fd-conformance.mjs
 
   ## SKIP: IDL is hand-cranked here for now.
   ##

scripts/ci/fd-conformance.mjs

@@ -0,0 +1,88 @@
+#!/usr/bin/env zx
+
+// Firedancer conformance testing of the Core BPF Config program against its
+// original builtin implementation.
+//
+// Note: This script can only be run on Ubuntu.
+
+import 'zx/globals';
+import fs from 'node:fs';
+import { workingDirectory } from '../utils.mjs';
+
+// Clone the conformance harness.
+const harnessPath = path.join(workingDirectory, 'solana-conformance');
+await $`git clone -b core-bpf https://github.com/buffalojoec/solana-conformance.git`;
+
+// Clone the test vectors.
+const testVectorsPath = path.join(harnessPath, 'impl', 'test-vectors');
+await $`git clone https://github.com/firedancer-io/test-vectors.git ${testVectorsPath}`;
+
+// Clone the SolFuzz-Agave harness.
+const solFuzzAgavePath = path.join(harnessPath, 'impl', 'agave-v2.1.0');
+await $`git clone -b agave-v2.1.0 http://github.com/firedancer-io/solfuzz-agave.git ${solFuzzAgavePath}`;
+
+// Move into the conformance harness.
+cd(harnessPath);
+
+// Build the environment.
+await $`bash install_ubuntu_lite.sh`;
+
+// // Build the Agave target with the builtin version.
+// await $`make -j -C impl lib/libsolfuzz_agave_v2.0.so`;
+// const builtinTargetPath = path.join(
+//     harnessPath,
+//     'impl',
+//     'lib',
+//     'libsolfuzz_agave_v2.0.so',
+// );
+
+// // Build the Agave target with the BPF version.
+// await $`PROGRAM="config" make -j -C impl lib/libsolfuzz_agave_v2.0_core_bpf.so`;
+// const bpfTargetPath = path.join(
+//     harnessPath,
+//     'impl',
+//     'lib',
+//     'libsolfuzz_agave_core_bpf_config.so',
+// );
+
+// // Run the tests.
+// const fixturesPath = path.join(
+//     harnessPath,
+//     'test-vectors',
+//     'instr',
+//     'fixtures',
+//     'config',
+// );
+// await $`solana-test-suite run-tests -i ${fixturesPath} -s ${builtinTargetPath} -t ${bpfTargetPath}`;
+
+// // Find the results files.
+// function findResultFile(dirPath) {
+//     const files = fs.readdir(dirPath);
+//     const resultFile = files.find(file => file.endsWith('.txt'));
+//     if (!resultFile) throw new Error(`No result file found in ${dirPath}`);
+//     return path.join(dirPath, resultFile);
+// }
+
+// const builtinResultsPath = findResultFile(path.join(
+//     harnessPath,
+//     'test_results',
+//     'libsolfuzz_agave_v2.0',
+// ));
+
+// const bpfResultsPath = findResultFile(path.join(
+//     harnessPath,
+//     'test_results',
+//     'libsolfuzz_agave_core_bpf_config',
+// ));
+
+// // Assert conformance.
+// const [builtinResults, bpfResults] = await Promise.all([
+//     fs.readFile(builtinResultsPath, 'utf-8'),
+//     fs.readFile(bpfResultsPath, 'utf-8'),
+// ]);
+
+// if (builtinResults !== bpfResults) {
+//     throw new Error(`Error: mismatches detected.`);
+// } else {
+//     console.log('All tests passed.');
+// }