cost-tracking: add testing infrastructure

In this commit we add the infrastructure necessary to test the runtime's
cost tracking. We take advantage of the tests that already exist to
check the interpreter and the runtime match in the results that they
produce, and add an assertion that the tracked costs should also be
equivalent.

To trigger the cost tracking tests, a new feature `test-cost-tracking`
is added. By default cost tracking checks are *not* included, to
preserve current behavior.

We also add the tests to the CI infrastructure, by adding a new matrix
field controlling if we test with cost tracking or not.

Resolves: #636

Author: ureeves

.github/workflows/ci.yaml

@@ -52,7 +52,9 @@ jobs:
     strategy:
       matrix:
         clarity_version: [1, 2, 3]
-    name: Clarity::V${{ matrix.clarity_version }} Artifacts
+        cost_tracking: [false, true]
+
+    name: Clarity::V${{ matrix.clarity_version }} Artifacts${{ matrix.cost_tracking && ' (cost-tracking)' || ''}}
     steps:
       - name: Checkout PR
         uses: actions/checkout@v4
@@ -69,21 +71,22 @@ jobs:
       - name: Create archive of test binaries
         run: |
           cargo llvm-cov nextest-archive \
-            --features test-clarity-v${{ matrix.clarity_version }} \
+            --features test-clarity-v${{ matrix.clarity_version }}\
+                       ${{ matrix.cost_tracking && ',test-cost-tracking' || ''}} \
             --workspace \
-            --archive-file nextest-archive-v${{ matrix.clarity_version }}.tar.zst
+            --archive-file nextest-archive-v${{ matrix.clarity_version }}-${{ matrix.cost_tracking }}.tar.zst
 
       - name: Upload test binaries
         uses: actions/upload-artifact@v4
         with:
-          name: nextest-archive-v${{ matrix.clarity_version }}
-          path: nextest-archive-v${{ matrix.clarity_version }}.tar.zst
+          name: nextest-archive-v${{ matrix.clarity_version }}-${{ matrix.cost_tracking }}
+          path: nextest-archive-v${{ matrix.clarity_version }}-${{ matrix.cost_tracking }}.tar.zst
           if-no-files-found: error
 
       - name: Upload standard.wasm file
         uses: actions/upload-artifact@v4
         with:
-          name: standard-v${{ matrix.clarity_version }}.wasm
+          name: standard-v${{ matrix.clarity_version }}-${{ matrix.cost_tracking }}.wasm
           path: ${{github.workspace}}/clar2wasm/src/standard/standard.wasm
           if-no-files-found: error
 
@@ -96,7 +99,8 @@ jobs:
       fail-fast: false
       matrix:
         clarity_version: [1, 2, 3]
-    name: Clarity::V${{ matrix.clarity_version }} Tests
+        cost_tracking: [false, true]
+    name: Clarity::V${{ matrix.clarity_version }} Tests${{ matrix.cost_tracking && ' (cost-tracking)' || ''}}
     steps:
       - name: Checkout PR
         uses: actions/checkout@v4
@@ -113,27 +117,27 @@ jobs:
       - name: Download standard.wasm file
         uses: actions/download-artifact@v4
         with:
-          name: standard-v${{ matrix.clarity_version }}.wasm
+          name: standard-v${{ matrix.clarity_version }}-${{ matrix.cost_tracking }}.wasm
           path: ${{github.workspace}}/clar2wasm/src/standard/
 
       - name: Download archive
         uses: actions/download-artifact@v4
         with:
-          name: nextest-archive-v${{ matrix.clarity_version }}
+          name: nextest-archive-v${{ matrix.clarity_version }}-${{ matrix.cost_tracking }}
 
       - name: Run tests and output coverage
         shell: bash
         run: |
           cargo llvm-cov nextest \
-            --archive-file nextest-archive-v${{ matrix.clarity_version }}.tar.zst \
+            --archive-file nextest-archive-v${{ matrix.clarity_version }}-${{ matrix.cost_tracking }}.tar.zst \
             --codecov \
-            --output-path codecov-v${{ matrix.clarity_version }}.json
+            --output-path codecov-v${{ matrix.clarity_version }}-${{ matrix.cost_tracking }}.json
 
       - name: Upload codecov.json
         uses: actions/upload-artifact@v4
         with:
-          name: code-coverage-v${{ matrix.clarity_version }}
-          path: codecov-v${{ matrix.clarity_version }}.json
+          name: code-coverage-v${{ matrix.clarity_version }}-${{ matrix.cost_tracking }}
+          path: codecov-v${{ matrix.clarity_version }}-${{ matrix.cost_tracking }}.json
           if-no-files-found: error
 
   # Code coverage

clar2wasm/Cargo.toml

@@ -23,11 +23,17 @@ wat = "1.0.74"
 [features]
 flamegraph = []
 pb = []
+
 # Test-specific features
+
+# Clarity version to test - default v2
 test-clarity-v1 = []
 test-clarity-v2 = []
 test-clarity-v3 = []
 
+# Whether to test cost tracking code
+test-cost-tracking = []
+
 [dev-dependencies]
 criterion = "0.5"
 proptest = "1.2.0"