Add some basic tests. Doesn't test the samplers yet.

Author: lorenzhs

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "extlib/tlx"]
 	path = extlib/tlx
 	url = https://github.com/tlx/tlx
+[submodule "extlib/googletest"]
+	path = extlib/googletest
+	url = https://github.com/google/googletest.git

CMakeLists.txt

@@ -3,6 +3,7 @@
 #
 # Root CMake build script for sampler
 #
+# Copyright (C) 2015-2017 Timo Bingmann <[email protected]>
 # Copyright (C) 2017 Lorenz Hübschle-Schneider <[email protected]>
 #
 # All rights reserved. Published under the BSD-2 license in the LICENSE file.
@@ -34,6 +35,8 @@ option(SAMPLING_USE_LTO
 option(SAMPLING_USE_MKL
   "Build with Intel MKL random generator if available." ON)
 
+option(SAMPLING_BUILD_TESTS "Build libsampling's tests." OFF)
+
 
 ################################################################################
 
@@ -224,6 +227,28 @@ macro(set_join var)
   string(STRIP ${var} "${${var}}")
 endmacro(set_join)
 
+###############################################################################
+# enable gtest framework, valgrind, and collection of results
+
+enable_testing()
+include(CTest)
+
+### google test + mock - enable "make test" and add_test()
+
+# this fixes compilation with static libs on MSVC
+set(gtest_force_shared_crt ON CACHE BOOL "on" FORCE)
+if(NOT MSVC)
+  # silence some warnings
+  set(GTEST_SAVE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-missing-field-initializers -Wno-deprecated")
+endif()
+
+add_subdirectory(extlib/googletest/googletest)
+
+if(NOT MSVC)
+  set(CMAKE_CXX_FLAGS "${GTEST_SAVE_CXX_FLAGS}")
+endif()
+
 ################################################################################
 
 # use tlx
@@ -297,4 +322,8 @@ add_subdirectory(sampling)
 # descend into benchmark suite
 add_subdirectory(benchmark)
 
+if(SAMPLING_BUILD_TESTS)
+  add_subdirectory(tests)
+endif()
+
 ################################################################################

README.md

@@ -28,4 +28,10 @@ Build with cmake (version 2.8.12 or later is required). Remember to fetch the su
 
 **Optional Dependencies:** An MPI library for Algorithm P's test runner (Algorithm P itself is implemented independently of MPI), Intel Math Kernel Library (MKL) for faster random variate generation
 
+### Tests
+
+To run the tests, set the cmake variable `SAMPLING_BUILD_TESTS` to `ON`.  Make sure that the `extlib/googletest` submodule is present.  Build, then execute the tests with `ctest`.
+
+We plan to make the test suite more comprehensive in the future.
+
 **[License](/LICENSE):** 2-clause BSD

extlib/googletest

@@ -0,0 +1,85 @@
+################################################################################
+# tests/CMakeLists.txt
+#
+# Copyright (C) 2015-2017 Timo Bingmann <[email protected]>
+# Copyright (C) 2017 Lorenz Hübschle-Schneider <[email protected]>
+#
+# All rights reserved. Published under the BSD-2 license in the LICENSE file.
+################################################################################
+
+include_directories(SYSTEM ${gtest_SOURCE_DIR}/include ${gtest_SOURCE_DIR})
+
+# macro for building test target programs with correct libraries
+macro(sampling_build_target TARGETNAME)
+
+  add_executable(${TARGETNAME} ${ARGN})
+  target_link_libraries(${TARGETNAME} sampling gtest gtest_main)
+
+endmacro(sampling_build_target)
+
+# macro for building test programs, without main() in gtest_main
+macro(sampling_build_plain PROGNAME)
+
+  string(REPLACE "/" "_" TESTNAME "${PROGNAME}") # replace slashes
+
+  sampling_build_target(${TESTNAME} ${PROGNAME}.cpp ${ARGN})
+
+endmacro(sampling_build_plain)
+
+# macro for building test programs, adding gtest runner in gtest_main
+macro(sampling_build_only PROGNAME)
+
+  # append gtest runner program.
+  sampling_build_plain(${PROGNAME} ${ARGN})
+
+endmacro(sampling_build_only)
+
+# macro for registering test programs: maybe prepend valgrind
+macro(sampling_test_only TESTNAME)
+
+  set(TARGETNAME ${TESTNAME} ${ARGN})
+  string(REPLACE "/" "_" TARGETNAME "${TARGETNAME}") # replace slashes
+  string(REPLACE ";" "_" TARGETNAME "${TARGETNAME}") # stringify list
+
+  if(USE_VALGRIND)
+    # prepend valgrind call
+    add_test(
+      NAME ${TARGETNAME}
+      COMMAND /usr/bin/valgrind ${SAMPLING_VALGRIND_OPTS}
+      --xml=yes --xml-file=${TESTNAME}.xml
+      ./${TESTNAME} ${ARGN})
+  else()
+    add_test(
+      NAME ${TARGETNAME}
+      COMMAND ${TESTNAME} ${ARGN})
+  endif()
+
+endmacro(sampling_test_only)
+
+# macro for building and running test programs
+macro(sampling_build_test PROGNAME)
+
+  sampling_build_only(${PROGNAME})
+
+  string(REPLACE "/" "_" TESTNAME "${PROGNAME}") # replace slashes
+  sampling_test_only(${TESTNAME})
+
+endmacro(sampling_build_test)
+
+### list of tests in subdirectories
+
+sampling_build_test(hash_test)
+sampling_build_test(hypergeometric_distribution_test)
+sampling_build_test(statistics_test)
+
+if(MPI_FOUND)
+#   sampling_build_only(mpi_test)
+#   # run test with mpirun
+#   add_test(mpi_test1 ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} 1 mpi_test)
+#   add_test(mpi_test2 ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} 2 mpi_test)
+#   add_test(mpi_test3 ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} 3 mpi_test)
+#   add_test(mpi_test7 ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} 7 mpi_test)
+#   add_test(mpi_test8 ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} 8 mpi_test)
+endif()
+
+################################################################################

tests/CMakeLists.txt

@@ -0,0 +1,62 @@
+/*******************************************************************************
+ * tests/hash_test.cpp
+ *
+ * Copyright (C) 2016-2017 Lorenz Hübschle-Schneider <[email protected]>
+ *
+ * All rights reserved. Published under the BSD-2 license in the LICENSE file.
+ ******************************************************************************/
+
+#include <sampling/hash.hpp>
+
+#include <gtest/gtest.h>
+
+using namespace sampling;
+
+template <typename T>
+void check_hash(uint32_t reference, const T& val) {
+    HashCrc32Fallback<T> h;
+    uint32_t crc = h(val);
+    ASSERT_EQ(reference, crc);
+
+#ifdef SAMPLING_HAVE_SSE4_2
+    // SSE4.2 is enabled, check that one as well
+    HashCrc32Sse42<T> h2;
+    uint32_t crc2 = h2(val);
+    ASSERT_EQ(reference, crc2);
+#endif
+}
+
+TEST(Hash, TestCRC32) {
+    check_hash(0xb798b438, 0);
+    check_hash(0x6add1e80, 1);
+    check_hash(0xa530b397, 426468);
+
+    char zeroes4[4], zeroes7[7], zeroes32[32], testvec[44];
+    memset(&zeroes4, 0, 4);
+    // 4 char-zeroes should yield the same result as a uint32_t-zero
+    check_hash(0xb798b438, zeroes4);
+
+    // Something oddly-sized
+    memset(&zeroes7, 0, 7);
+    check_hash(0x44c19592, zeroes7);
+
+    // 32 bytes of zeroes - test vector at
+    // https://tools.ietf.org/html/draft-ietf-tsvwg-sctpcsum-01
+    memset(&zeroes32, 0, 32);
+    check_hash(0x756EC955, zeroes32);
+
+    // the other IETF test vector, 13 zeroes followed by byte values 1 to 0x1f
+    memset(&testvec, 0, 13);
+    for (size_t i = 1; i <= 0x1f; ++i) {
+        testvec[i + 12] = i;
+    }
+    check_hash(0x5b988D47, testvec);
+
+    // Some more random tests
+    check_hash(0x3e2fbccf, 'a'); // char
+    check_hash(0x9da0355c, "a"); // char[2]
+    check_hash(0x64e2a555, "hello world");
+    check_hash(0x3cc762b0, "123456789");
+}
+
+/******************************************************************************/

tests/hash_test.cpp

@@ -0,0 +1,48 @@
+/*******************************************************************************
+ * tests/hypergeometric_distribution_test.cpp
+ *
+ * Copyright (C) 2017 Lorenz Hübschle-Schneider <[email protected]>
+ *
+ * All rights reserved. Published under the BSD-2 license in the LICENSE file.
+ ******************************************************************************/
+
+#include <sampling/hypergeometric_distribution.hpp>
+
+#include <gtest/gtest.h>
+
+using namespace sampling;
+
+TEST(Hypergeometric, Simple) {
+    hypergeometric hyp(42);
+
+    // Test a known sequence
+    ASSERT_EQ(9, hyp(10, 6, 14));
+    ASSERT_EQ(8, hyp(10, 6, 14));
+    ASSERT_EQ(9, hyp(10, 6, 14));
+    ASSERT_EQ(9, hyp(10, 6, 14));
+    ASSERT_EQ(10, hyp(10, 6, 14));
+    ASSERT_EQ(9, hyp(10, 6, 14));
+    ASSERT_EQ(8, hyp(10, 6, 14));
+    ASSERT_EQ(10, hyp(10, 6, 14));
+    ASSERT_EQ(8, hyp(10, 6, 14));
+    ASSERT_EQ(9, hyp(10, 6, 14));
+
+    // Test with nbad = 0
+    ASSERT_EQ(7, hyp(10, 0, 7));
+    ASSERT_EQ(7, hyp(10, 0, 7));
+    ASSERT_EQ(7, hyp(10, 0, 7));
+    ASSERT_EQ(7, hyp(10, 0, 7));
+
+    ASSERT_EQ(42, hyp(100, 0, 42));
+    ASSERT_EQ(42, hyp(100, 0, 42));
+    ASSERT_EQ(42, hyp(100, 0, 42));
+    ASSERT_EQ(42, hyp(100, 0, 42));
+
+    // Test with ngood = 0
+    ASSERT_EQ(0, hyp(0, 10, 5));
+    ASSERT_EQ(0, hyp(0, 10, 5));
+    ASSERT_EQ(0, hyp(0, 10, 5));
+    ASSERT_EQ(0, hyp(0, 10, 5));
+}
+
+/******************************************************************************/

tests/hypergeometric_distribution_test.cpp

@@ -0,0 +1,37 @@
+/*******************************************************************************
+ * tests/statistics_test.cpp
+ *
+ * Copyright (C) 2015 Timo Bingmann <[email protected]>
+ * Copyright (C) 2017 Lorenz Hübschle-Schneider <[email protected]>
+ *
+ * All rights reserved. Published under the BSD-2 license in the LICENSE file.
+ ******************************************************************************/
+
+#include <sampling/benchmark.hpp>
+
+#include <gtest/gtest.h>
+
+using namespace sampling;
+
+TEST(Statistics, Simple) {
+    statistics stats;
+
+    // Test that empty statistics are handled correctly
+    ASSERT_EQ(0.0, stats.avg());
+    ASSERT_EQ(0.0, stats.stddev());
+
+    stats.push(1.0);
+    // Test that stddev() handles a single value
+    ASSERT_EQ(0.0, stats.stddev());
+
+    for (size_t i = 2; i <= 1000; ++i) {
+        stats.push(1.0 / static_cast<double>(i));
+    }
+
+    ASSERT_EQ(1000, stats.count);
+    ASSERT_DOUBLE_EQ(0.0074854708605503447, stats.avg());
+    ASSERT_DOUBLE_EQ(0.039868430925506362, stats.stddev());
+    ASSERT_DOUBLE_EQ(0.039848491723996423, stats.stddev(0));
+}
+
+/******************************************************************************/