Merge pull request #35 from itzmeanjan/use-gtest

Transition to using `google-test`
itzmeanjan · Jul 16, 2023 · 8cbb094 · 8cbb094
2 parents 36473f8 + e39d340
commit 8cbb094
Show file tree

Hide file tree

Showing 16 changed files with 281 additions and 300 deletions.
diff --git a/.github/workflows/test_ci.yml b/.github/workflows/test_ci.yml
@@ -9,7 +9,7 @@ on:
 jobs:
   build:
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     steps:
     - uses: actions/checkout@v3
@@ -19,6 +19,21 @@ jobs:
         sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-9 9
     - name: Fetch Dependency
       run: git submodule update --init
+    - name: Get CMake
+      run: sudo apt-get install cmake
+    - name: Setup Google-Test
+      run: |
+        pushd ~
+        git clone https://github.com/google/googletest.git -b v1.13.0
+        pushd googletest
+        mkdir build
+        pushd build
+        cmake .. -DBUILD_GMOCK=OFF
+        make
+        sudo make install
+        popd
+        popd
+        popd
     - name: Execute Tests
       run: make
     - name: Cleanup

diff --git a/Makefile b/Makefile
@@ -7,21 +7,40 @@ DEP_IFLAGS = -I ./sha3/include -I ./subtle/include
 
 all: test
 
-tests/a.out: tests/main.cpp include/*.hpp include/tests/*.hpp sha3/include/*.hpp subtle/include/*.hpp
-	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(IFLAGS) $(DEP_IFLAGS) $< -o $@
+tests/test_compression.o: tests/test_compression.cpp include/*.hpp
+	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(IFLAGS) $(DEP_IFLAGS) -c $< -o $@
+
+tests/test_field.o: tests/test_field.cpp include/*.hpp
+	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(IFLAGS) $(DEP_IFLAGS) -c $< -o $@
+
+tests/test_kem_kat.o: tests/test_kem_kat.cpp include/*.hpp
+	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(IFLAGS) $(DEP_IFLAGS) -c $< -o $@
+
+tests/test_kem.o: tests/test_kem.cpp include/*.hpp
+	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(IFLAGS) $(DEP_IFLAGS) -c $< -o $@
+
+tests/test_ntt.o: tests/test_ntt.cpp include/*.hpp
+	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(IFLAGS) $(DEP_IFLAGS) -c $< -o $@
+
+tests/test_serialize.o: tests/test_serialize.cpp include/*.hpp
+	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(IFLAGS) $(DEP_IFLAGS) -c $< -o $@
+
+tests/a.out: tests/test_compression.o tests/test_field.o tests/test_kem_kat.o tests/test_kem.o \
+				tests/test_ntt.o tests/test_serialize.o
+	$(CXX) $(OPT_FLAGS) $^ -lgtest -lgtest_main -o $@
 
 test: tests/a.out
 	./$<
 
-benchmarks/bench.out: benchmarks/main.cpp include/*.hpp include/benchmarks/*.hpp sha3/include/*.hpp subtle/include/*.hpp
+benchmarks/bench.out: benchmarks/main.cpp include/*.hpp sha3/include/*.hpp subtle/include/*.hpp
 	# In case you haven't built google-benchmark with libPFM support.
 	# More @ https://gist.github.com/itzmeanjan/05dc3e946f635d00c5e0b21aae6203a7
 	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(IFLAGS) $(DEP_IFLAGS) $< -lbenchmark -lpthread -o $@
 
 benchmark: benchmarks/bench.out
 	./$< --benchmark_time_unit=us --benchmark_counters_tabular=true
 
-benchmarks/perf.out: benchmarks/main.cpp include/*.hpp include/benchmarks/*.hpp sha3/include/*.hpp subtle/include/*.hpp
+benchmarks/perf.out: benchmarks/main.cpp include/*.hpp sha3/include/*.hpp subtle/include/*.hpp
 	# In case you've built google-benchmark with libPFM support.
 	# More @ https://gist.github.com/itzmeanjan/05dc3e946f635d00c5e0b21aae6203a7
 	$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(IFLAGS) $(DEP_IFLAGS) $< -lbenchmark -lpthread -lpfm -o $@

diff --git a/README.md b/README.md
@@ -71,6 +71,7 @@ $ cmake --version
 cmake version 3.22.1
 ```
 
+- For testing Kyber implementation, you need to globally install `google-test` library and headers. Follow [this](https://github.com/google/googletest/tree/main/googletest#standalone-cmake-project) guide if you haven't installed it yet.
 - For benchmarking Kyber implementation, targeting CPU systems, you'll need to have `google-benchmark` header and library globally installed. I found [this](https://github.com/google/benchmark#installation) guide helpful.
 - If you are on a machine running GNU/Linux kernel and you want to obtain CPU Cycle count for KEM routines, you should consider building `google-benchmark` library with `libPFM` support, following [this](https://gist.github.com/itzmeanjan/05dc3e946f635d00c5e0b21aae6203a7) step-by-step guide. Find more about libPFM @ https://perfmon2.sourceforge.net.
 - For importing dependencies `sha3`, `subtle` - initialize & update git submodule after cloning this repository.
@@ -89,16 +90,36 @@ popd
 For testing functional correctness and conformance ( with Kyber specification and reference implementation ) of this Kyber implementation, you have to issue
 
 ```bash
-make
-```
-
-```bash
-[test] Kyber prime field operations
-[test] (i)NTT over degree-255 polynomial
-[test] Polynomial serialization/ deserialization
-[test] Coefficient compression/ decompression
-[test] INDCCA2-secure Kyber KEM
-[test] Kyber KEM Known Answer Tests
+$ make -j8
+
+[==========] Running 10 tests from 1 test suite.
+[----------] Global test environment set-up.
+[----------] 10 tests from KyberKEM
+[ RUN      ] KyberKEM.CompressDecompressZq
+[       OK ] KyberKEM.CompressDecompressZq (202 ms)
+[ RUN      ] KyberKEM.ArithmeticOverZq
+[       OK ] KyberKEM.ArithmeticOverZq (298 ms)
+[ RUN      ] KyberKEM.Kyber512KeygenEncapsDecaps
+[       OK ] KyberKEM.Kyber512KeygenEncapsDecaps (0 ms)
+[ RUN      ] KyberKEM.Kyber768KeygenEncapsDecaps
+[       OK ] KyberKEM.Kyber768KeygenEncapsDecaps (0 ms)
+[ RUN      ] KyberKEM.Kyber1024KeygenEncapsDecaps
+[       OK ] KyberKEM.Kyber1024KeygenEncapsDecaps (0 ms)
+[ RUN      ] KyberKEM.Kyber512KnownAnswerTests
+[       OK ] KyberKEM.Kyber512KnownAnswerTests (8 ms)
+[ RUN      ] KyberKEM.Kyber768KnownAnswerTests
+[       OK ] KyberKEM.Kyber768KnownAnswerTests (13 ms)
+[ RUN      ] KyberKEM.Kyber1024KnownAnswerTests
+[       OK ] KyberKEM.Kyber1024KnownAnswerTests (20 ms)
+[ RUN      ] KyberKEM.NumberTheoreticTransform
+[       OK ] KyberKEM.NumberTheoreticTransform (0 ms)
+[ RUN      ] KyberKEM.PolynomialSerialization
+[       OK ] KyberKEM.PolynomialSerialization (0 ms)
+[----------] 10 tests from KyberKEM (545 ms total)
+
+[----------] Global test environment tear-down
+[==========] 10 tests from 1 test suite ran. (545 ms total)
+[  PASSED  ] 10 tests.
 ```
 
 ## Benchmarking

diff --git a/include/benchmarks/bench_kem.hpp → benchmarks/bench_kem.hpp b/include/benchmarks/bench_kem.hpp → benchmarks/bench_kem.hpp
diff --git a/benchmarks/main.cpp b/benchmarks/main.cpp
@@ -1,4 +1,4 @@
-#include "benchmarks/bench_kem.hpp"
+#include "bench_kem.hpp"
 
 // Register for benchmarking IND-CCA2-secure Kyber Key Encapsulation Mechanism
 

diff --git a/include/tests/test_kem.hpp b/include/tests/test_kem.hpp
diff --git a/include/tests/test_kyber.hpp b/include/tests/test_kyber.hpp
diff --git a/include/tests/test_ntt.hpp b/include/tests/test_ntt.hpp
diff --git a/include/tests/test_serialize.hpp b/include/tests/test_serialize.hpp
diff --git a/tests/main.cpp b/tests/main.cpp