Merge pull request #605 from pq-code-package/test_simplification

Make `tests` a shallow wrapper around `make`

Author: hanno-becker

BUILDING.md

@@ -11,38 +11,50 @@ To build **mlkem-native**, you need `make` and a C90 compiler. To use the test s
 You can build and test **mlkem-native** as follows:
 
 ```bash
-make quickcheck       # With native code backend (if available)
-make OPT=0 quickcheck # With C backend
+make test       # With native code backend (if available)
+make OPT=0 test # With C backend
 ```
 
-To merely build test and benchmarking components, use the following `make` targets:
+To merely build test components, use the following `make` targets:
 
 ```bash
-make mlkem
+make func
 make nistkat
 make kat
+make acvp
 ```
 
-For benchmarking, specify the cycle counting method. Currently, **mlkem-native** is supporting PERF, PMU (AArch64 and x86 only), M1 (Apple Silicon only):
+To run them, add `run_`:
+
+```bash
+make run_func
+make run_nistkat
+make run_kat
+make run_acvp
+```
+
+The resulting binaries can be found in `test/build` (their full path is printed by `make`).
+
+For benchmarking, specify the cycle counting method. Currently, **mlkem-native** is supporting PERF, PMU (AArch64 and
+x86 only), M1 (Apple Silicon only):
+
 ```
 # CYCLES has to be on of PERF, PMU, M1, NO
-make bench CYCLES=PERF
-make bench_components CYCLES=PERF
+make run_bench CYCLES=PERF
+make run_bench_components CYCLES=PERF
 ```
 
-The resulting binaries can then be found in `test/build`.
-
 ### Using `tests` script
 
-We recommend compiling and running tests and benchmarks using the [`./scripts/tests`](scripts/tests) script. For
+For convenience, you can also use the [`./scripts/tests`](scripts/tests) script as a wrapper around `make`. For
 example,
 
 ```bash
 ./scripts/tests func
 ```
 
-will compile and run functionality tests. For detailed information on how to use the script, please refer to the
-`--help` option.
+will compile and run functionality tests. For detailed information on how to use the script, please refer to
+`./scripts/tests --help`.
 
 ### Windows
 
@@ -59,11 +71,15 @@ There are further scripts used for development of mlkem-native, such as `format`
 
 ### nix setup
 
-We specify the development environment for mlkem-native using nix. If you want to help develop mlkem-native, please setup nix using the [nix installer script](https://nixos.org/download/), not your package manager. 
+We specify the development environment for mlkem-native using nix. If you want to help develop mlkem-native, please setup nix using the [nix installer script](https://nixos.org/download/), not your package manager.
 
 All the development and build dependencies are specified in [flake.nix](flake.nix). To execute a bash shell, run
 ```bash
 nix develop --experimental-features 'nix-command flakes'
 ```
 
 To confirm that everything worked, try `lint` or `tests cbmc`.
+
+# Checking the proofs
+
+To check the CBMC proofs, enter the `nix` development environment and use `tests cbmc`.

Makefile

@@ -12,24 +12,24 @@
 	run_bench_512 run_bench_768 run_bench_1024 run_bench \
 	bench_components_512 bench_components_768 bench_components_1024 bench_components \
 	run_bench_components_512 run_bench_components_768 run_bench_components_1024 run_bench_components \
-	buildall checkall all \
+	build test all \
 	clean quickcheck check-defined-CYCLES
 
-.DEFAULT_GOAL := buildall
-all: quickcheck
+.DEFAULT_GOAL := build
+all: build
 
 W := $(EXEC_WRAPPER)
 
 include mk/config.mk
 include mk/components.mk
 include mk/rules.mk
 
-quickcheck: checkall
+quickcheck: test
 
-buildall: func nistkat kat acvp
+build: func nistkat kat acvp
 	$(Q)echo "  Everything builds fine!"
 
-checkall: run_kat run_nistkat run_func run_acvp
+test: run_kat run_nistkat run_func run_acvp
 	$(Q)echo "  Everything checks fine!"
 
 run_kat_512: kat_512
@@ -60,23 +60,35 @@ run_acvp: acvp
 	python3 ./test/acvp_client.py
 
 func_512:  $(MLKEM512_DIR)/bin/test_mlkem512
+	$(Q)echo "  FUNC       ML-MEM-512:   $^"
 func_768:  $(MLKEM768_DIR)/bin/test_mlkem768
+	$(Q)echo "  FUNC       ML-MEM-768:   $^"
 func_1024: $(MLKEM1024_DIR)/bin/test_mlkem1024
+	$(Q)echo "  FUNC       ML-MEM-1024:  $^"
 func: func_512 func_768 func_1024
 
 nistkat_512: $(MLKEM512_DIR)/bin/gen_NISTKAT512
+	$(Q)echo "  NISTKAT    ML-MEM-512:   $^"
 nistkat_768: $(MLKEM768_DIR)/bin/gen_NISTKAT768
+	$(Q)echo "  NISTKAT    ML-MEM-768:   $^"
 nistkat_1024: $(MLKEM1024_DIR)/bin/gen_NISTKAT1024
+	$(Q)echo "  NISTKAT    ML-MEM-1024:  $^"
 nistkat: nistkat_512 nistkat_768 nistkat_1024
 
 kat_512: $(MLKEM512_DIR)/bin/gen_KAT512
+	$(Q)echo "  KAT        ML-MEM-512:   $^"
 kat_768: $(MLKEM768_DIR)/bin/gen_KAT768
+	$(Q)echo "  KAT        ML-MEM-768:   $^"
 kat_1024: $(MLKEM1024_DIR)/bin/gen_KAT1024
+	$(Q)echo "  KAT        ML-MEM-1024:  $^"
 kat: kat_512 kat_768 kat_1024
 
 acvp_512:  $(MLKEM512_DIR)/bin/acvp_mlkem512
+	$(Q)echo "  ACVP       ML-MEM-512:   $^"
 acvp_768:  $(MLKEM768_DIR)/bin/acvp_mlkem768
+	$(Q)echo "  ACVP       ML-MEM-768:   $^"
 acvp_1024: $(MLKEM1024_DIR)/bin/acvp_mlkem1024
+	$(Q)echo "  ACVP       ML-MEM-1024:  $^"
 acvp: acvp_512 acvp_768 acvp_1024
 
 lib: $(BUILD_DIR)/libmlkem.a

README.md

@@ -30,11 +30,14 @@ sudo apt-get install make gcc python3 git
 git clone https://github.com/pq-code-package/mlkem-native.git
 cd mlkem-native
 
-# Build and run base tests
-make quickcheck
+# Build and run tests
+make build
+make test
 
-# Build and run all tests
+# The same using `tests`, a convenience wrapper around `make`
 ./scripts/tests all
+# Show all options
+./scripts/tests --help
 ```
 
 See [BUILDING.md](BUILDING.md) for more information.

mk/rules.mk

@@ -2,17 +2,17 @@
 $(BUILD_DIR)/mlkem512/bin/%: $(CONFIG)
 	$(Q)echo "  LD      $@"
 	$(Q)[ -d $(@D) ] || mkdir -p $(@D)
-	$(LD) $(CFLAGS) -o $@ $(filter %.o,$^) $(LDLIBS)
+	$(Q)$(LD) $(CFLAGS) -o $@ $(filter %.o,$^) $(LDLIBS)
 
 $(BUILD_DIR)/mlkem768/bin/%: $(CONFIG)
 	$(Q)echo "  LD      $@"
 	$(Q)[ -d $(@D) ] || mkdir -p $(@D)
-	$(LD) $(CFLAGS) -o $@ $(filter %.o,$^) $(LDLIBS)
+	$(Q)$(LD) $(CFLAGS) -o $@ $(filter %.o,$^) $(LDLIBS)
 
 $(BUILD_DIR)/mlkem1024/bin/%: $(CONFIG)
 	$(Q)echo "  LD      $@"
 	$(Q)[ -d $(@D) ] || mkdir -p $(@D)
-	$(LD) $(CFLAGS) -o $@ $(filter %.o,$^) $(LDLIBS)
+	$(Q)$(LD) $(CFLAGS) -o $@ $(filter %.o,$^) $(LDLIBS)
 
 $(BUILD_DIR)/%.a: $(CONFIG)
 	$(Q)echo "  AR      $@"
@@ -44,7 +44,6 @@ endif
 
 $(BUILD_DIR)/%.c.o: %.c $(CONFIG)
 	$(Q)echo "  CC      $@"
-	$(Q)echo "  $(CC) -c -o $@ $(CFLAGS) $<"
 	$(Q)[ -d $(@D) ] || mkdir -p $(@D)
 	$(Q)$(CC) -c -o $@ $(CFLAGS) $<