Dockerfile, standardise test names

Signed-off-by: muraca <[email protected]>

Dockerfile

@@ -0,0 +1,7 @@
+FROM rust:1.75
+
+WORKDIR /usr/src/halo2-playground
+COPY . .
+RUN cargo test --release --no-run
+
+ENTRYPOINT ["cargo", "test", "--release"]

README.md

@@ -8,7 +8,26 @@ We wrote this crate to get a first-hand feeling of the user friendlyness
 of the [Halo2](https://github.com/zcash/halo2) proving system.
 
 ## Running the tests
-To run the tests, run the command `cargo test --release`.  
+To run the tests, run the command `cargo test --release`.
 The command `cargo test` works too, but in that case you may want
-to give your computer a couple of minutes to compute the test results.  
-The flag `-- --nocapture` can be used to print the execution times for proof generation and verification.
+to give your computer a couple of minutes to compute the test results.
+The flag `-- --nocapture` can be used to print the execution times for proof generation and verification.
+
+The single circuits can be tested by matching the test name with `sudoku`, `permutation` or `factorial`.
+The tests that match the `mock` pattern are written using the `MockProver` struct, while the others use the custom real-world provers.
+
+### Running via docker
+To run the tests via docker, the simplest way is to build the docker image:
+```bash
+docker build -t halo2-playground .
+```
+and then run the tests:
+```bash
+docker run --rm halo2-playground
+```
+
+It will run `cargo test --release` inside the docker container, so you can append any other flag, including a match for the tests you want to run.
+For example, to run only the tests in the `sudoku` module, you can run:
+```bash
+docker run --rm halo2-playground sudoku
+```

src/lib.rs

@@ -5,6 +5,7 @@ mod sudoku_circuit;
 pub use sudoku_circuit::SudokuCircuit;
 
 mod truncated_factorial_circuit;
+pub use truncated_factorial_circuit::TruncatedFactorialCircuit;
 
 /// This chip implements a gate that enforces two
 /// sets of values to be a permutation of each other.

src/permutation_circuit.rs

@@ -168,7 +168,7 @@ mod tests {
     use crate::utilities::{inverse_permutation, PermutationsIter};
 
     #[test]
-    fn permutation_circuit_comprehensive_7_length_test() {
+    fn mock_permutation() {
         use halo2_proofs::{dev::MockProver, pasta::Fp};
 
         let objects: [Value<Fp>; 7] = core::array::from_fn(|n| Value::known(Fp::from(n as u64)));
@@ -190,7 +190,7 @@ mod tests {
     }
 
     #[test]
-    fn permutation_circuit_test_with_actual_prover() {
+    fn permutation() {
         use halo2_proofs::pasta::Fp;
 
         use crate::utilities::{ProverWrapper, VerifierWrapper};

src/sudoku_circuit.rs

@@ -450,7 +450,7 @@ mod tests {
     }
 
     #[test]
-    fn sudoku_circuit_test() {
+    fn mock_sudoku() {
         use halo2_proofs::{dev::MockProver, pasta::Fp};
 
         const POW_OF_2_MAX_ROWS: u32 = 10;
@@ -487,7 +487,7 @@ mod tests {
     }
 
     #[test]
-    fn sudoku_test_with_actual_prover() {
+    fn sudoku() {
         use crate::utilities::{ProverWrapper, VerifierWrapper};
 
         const POW_OF_2_MAX_ROWS: u32 = 9;

src/truncated_factorial_circuit.rs

@@ -145,7 +145,7 @@ mod tests {
     }
 
     #[test]
-    fn factorial_up_to_20() {
+    fn mock_factorial_1_to_20() {
         const POW_OF_2_MAX_ROWS: u32 = 6;
 
         /// Further information compression,
@@ -211,15 +211,31 @@ mod tests {
         // of `N_FACTORS` does not wrap around in the field,
         // should fail.
         batch_test_with_params_fail!(
-            {1, three}{2, three}{3, three}{4, three}{5, three}
-            {6, three}{7, three}{8, three}{9, three}{10, three}
-            {11, three}{12, three}{13, three}{14, three}{15, three}
-            {16, three}{17, three}{18, three}{19, three}{20, three}
+            {1, three}
+            {2, three}
+            {3, three}
+            {4, three}
+            {5, three}
+            {6, three}
+            {7, three}
+            {8, three}
+            {9, three}
+            {10, three}
+            {11, three}
+            {12, three}
+            {13, three}
+            {14, three}
+            {15, three}
+            {16, three}
+            {17, three}
+            {18, three}
+            {19, three}
+            {20, three}
         );
     }
 
     #[test]
-    fn product_1000_consecutive_numbers() {
+    fn mock_factorial_1000() {
         /// This macro exists because [`iter_apply_macro`] requires
         /// a macro argument. It mostly behaves like a generic function,
         /// with `mul_batch_size` and `n_columns` as generic parameters
@@ -269,7 +285,7 @@ mod tests {
     }
 
     #[test]
-    fn test_with_actual_prover() {
+    fn factorial() {
         const MAX_NR_ROWS_POW_2_EXPONENT: u32 = 4;
         const N_FACTORS: usize = 1000;