feat: add math cairo tests under vm/src/tests/cairo_test_suite

.github/workflows/rust.yml

@@ -47,7 +47,6 @@ jobs:
         - cairo_bench_programs
         - cairo_proof_programs
         - cairo_test_programs
-        - cairo_test_suite_programs
         - cairo_1_test_contracts
         - cairo_2_test_contracts
     name: Build Cairo programs
@@ -88,8 +87,7 @@ jobs:
         && matrix.program-target != 'cairo_2_test_contracts'
       run: |
           make python-deps
-          . cairo-vm-env/bin/activate
-          echo PATH=$PATH >> $GITHUB_ENV
+          echo "$(pwd)/cairo-vm-env/bin" >> $GITHUB_PATH
 
     - name: Install cairo 1 compiler
       if: steps.cache-programs.outputs.cache-hit != 'true' && matrix.program-target == 'cairo_1_test_contracts'
@@ -101,7 +99,9 @@ jobs:
 
     - name: Build programs
       if: steps.cache-programs.outputs.cache-hit != 'true'
-      run: make -j ${{ matrix.program-target }}
+      run: |
+        [ -d cairo-vm-env ] && . cairo-vm-env/bin/activate || true
+        make -j ${{ matrix.program-target }}
 
   # NOTE: used to reduce the amount of cache steps we need in later jobs
   # TODO: remove this cache once the workflow finishes
@@ -136,12 +136,6 @@ jobs:
         path: ${{ env.CAIRO_PROGRAMS_PATH }}
         key: cairo_bench_programs-cache-${{ hashFiles('cairo_programs/**/*.cairo', 'vm/src/tests/cairo_test_suite/**/*.cairo', 'Makefile', 'requirements.txt') }}
         fail-on-cache-miss: true
-    - name: Fetch cairo test suite programs
-      uses: actions/cache/restore@v3
-      with:
-        path: ${{ env.CAIRO_PROGRAMS_PATH }}
-        key: cairo_test_suite_programs-cache-${{ hashFiles('cairo_programs/**/*.cairo', 'vm/src/tests/cairo_test_suite/**/*.cairo', 'Makefile', 'requirements.txt') }}
-        fail-on-cache-miss: true
     - name: Fetch test contracts (Cairo 1)
       uses: actions/cache/restore@v3
       with:

CHANGELOG.md

@@ -11,11 +11,14 @@ Both branches support Stwo prover opcodes (Blake2s, QM31) since v2.0.0.
 ---
 
 #### Upcoming Changes
+* feat: add math Cairo test suite under `vm/src/tests/cairo_test_suite` using the `test_utils` feature flag [#2379](https://github.com/starkware-libs/cairo-vm/pull/2379)
+
 * feat: add `test_helpers` module (`error_utils`, `test_utils`) with `assert_mr_eq`, `load_cairo_program!` macro and `expect_*` error checkers, behind `test_utils` feature flag [#2381](https://github.com/starkware-libs/cairo-vm/pull/2381)
 
 * feat(makefile,ci): add `cairo_test_suite_programs` Makefile target and CI integration to compile Cairo test suite programs before running tests [#2380](https://github.com/starkware-libs/cairo-vm/pull/2380)
 
 * Add Stwo cairo runner API [#2351](https://github.com/starkware-libs/cairo-vm/pull/2351)
+
 * feat: make max traceback entries configurable [#2370](https://github.com/starkware-libs/cairo-vm/pull/2370)
 
 * feat: create and use VirtualMachineConfig [#2369](https://github.com/starkware-libs/cairo-vm/pull/2369)

Makefile

@@ -277,7 +277,7 @@ check:
 
 cairo_test_suite_programs: $(COMPILED_CAIRO_TEST_SUITE)
 
-cairo_test_programs: $(COMPILED_TESTS) $(COMPILED_BAD_TESTS) $(COMPILED_NORETROCOMPAT_TESTS) $(COMPILED_PRINT_TESTS) $(COMPILED_MOD_BUILTIN_TESTS) $(COMPILED_SECP_CAIRO0_HINTS) $(COMPILED_KZG_DA_CAIRO0_HINTS) $(COMPILED_SEGMENT_ARENA_CAIRO0_HINTS)
+cairo_test_programs: $(COMPILED_TESTS) $(COMPILED_BAD_TESTS) $(COMPILED_NORETROCOMPAT_TESTS) $(COMPILED_PRINT_TESTS) $(COMPILED_MOD_BUILTIN_TESTS) $(COMPILED_SECP_CAIRO0_HINTS) $(COMPILED_KZG_DA_CAIRO0_HINTS) $(COMPILED_SEGMENT_ARENA_CAIRO0_HINTS) $(COMPILED_CAIRO_TEST_SUITE)
 cairo_proof_programs: $(COMPILED_PROOF_TESTS) $(COMPILED_MOD_BUILTIN_PROOF_TESTS) $(COMPILED_STWO_EXCLUSIVE_TESTS)
 cairo_bench_programs: $(COMPILED_BENCHES)
 cairo_1_test_contracts: $(CAIRO_1_COMPILED_CASM_CONTRACTS)

vm/src/tests/cairo_test_suite/common/math_test.cairo

@@ -0,0 +1,31 @@
+%builtins range_check
+
+from starkware.cairo.common.math import (
+    assert_not_zero,
+    assert_not_equal,
+    assert_nn,
+    assert_le,
+    assert_lt,
+    assert_nn_le,
+    assert_in_range,
+    assert_250_bit,
+    split_felt,
+    assert_le_felt,
+    assert_lt_felt,
+    abs_value,
+    sign,
+    unsigned_div_rem,
+    signed_div_rem,
+    safe_div,
+    safe_mult,
+    split_int,
+    sqrt,
+    horner_eval,
+    is_quad_residue,
+    assert_is_power_of_2,
+)
+
+
+func main{range_check_ptr}() {
+    return ();
+}

vm/src/tests/cairo_test_suite/common/math_test_utils.rs

@@ -0,0 +1,37 @@
+use std::sync::LazyLock;
+
+use crate::{math_utils::is_quad_residue, utils::CAIRO_PRIME};
+use num_bigint::BigUint;
+use num_integer::Integer;
+
+/// RC_BOUND = 2^128
+pub static RC_BOUND: LazyLock<BigUint> = LazyLock::new(|| BigUint::from(2u64).pow(128));
+
+/// MAX_DIV = CAIRO_PRIME // RC_BOUND
+pub static MAX_DIV: LazyLock<BigUint> = LazyLock::new(|| CAIRO_PRIME.div_floor(&RC_BOUND));
+
+/// Returns 1 if `a` is a quadratic residue modulo CAIRO_PRIME, 0 if not, and -1 on error.
+pub fn is_quad_residue_mod_prime(a: &BigUint) -> i64 {
+    match is_quad_residue(a, &CAIRO_PRIME) {
+        Ok(true) => 1,
+        Ok(false) => 0,
+        Err(_) => -1,
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    /// Returns 1 for a known quadratic residue: 4 = 2² mod CAIRO_PRIME.
+    #[test]
+    fn test_quad_residue_mod_prime_returns_1_for_residue() {
+        assert_eq!(is_quad_residue_mod_prime(&BigUint::from(4u32)), 1);
+    }
+
+    /// Returns 0 for a known non-residue: 3 is not a square mod CAIRO_PRIME.
+    #[test]
+    fn test_quad_residue_mod_prime_returns_0_for_non_residue() {
+        assert_eq!(is_quad_residue_mod_prime(&BigUint::from(3u32)), 0);
+    }
+}

vm/src/tests/cairo_test_suite/common/mod.rs

@@ -0,0 +1,2 @@
+mod math_test_utils;
+mod test_math_cairo;