add basic unittest for Random

Author: merlinvn

TODO.md

@@ -0,0 +1,8 @@
+# Random class
+
+- [] Review all the unit tests
+
+# Project wide
+
+- add gcov
+- add CI/Coverage

src/Core/Random/Random.cpp

@@ -10,10 +10,11 @@
 #include <gsl/gsl_randist.h>
 
 #include <cmath>
+#include <cstdint>
 #include <random>
 
 // Constructor
-Random::Random(gsl_rng* rng) : seed_(0) {
+Random::Random(gsl_rng* rng, uint64_t seed) : seed_(seed) {
   if (rng != nullptr) {
     // If an external RNG is provided, take ownership using the unique_ptr
     rng_.reset(rng);

src/Core/Random/Random.h

@@ -36,7 +36,7 @@ class Random {
    *
    * @param external_rng Pointer to an external GSL RNG. Defaults to nullptr.
    */
-  explicit Random(gsl_rng* external_rng = nullptr);
+  explicit Random(gsl_rng* external_rng = nullptr, uint64_t seed = 0);
 
   /**
    * @brief Destructor.

tests/.clang-tidy

@@ -0,0 +1,104 @@
+Checks: >
+  *,
+  -altera-id-dependent-backward-branch,
+  -altera-struct-pack-align,
+  -altera-unroll-loops,
+  -fuchsia-*,
+  -llvmlibc-*,
+  -llvm-header-guard,
+  -llvm-include-order,
+  -cppcoreguidelines-owning-memory,
+  -cppcoreguidelines-non-private-member-variables-in-classes,
+  -cppcoreguidelines-avoid-non-const-global-variables,
+  -cppcoreguidelines-avoid-magic-numbers,
+  -google-readability-todo,
+  -modernize-use-trailing-return-type,
+  -modernize-pass-by-value,
+  -misc-non-private-member-variables-in-classes,
+  -performance-avoid-endl,
+  -readability-magic-numbers
+
+# Checks: >
+#   *,
+#   -cppcoreguidelines-owning-memory
+#   -google-readability-todo,
+#   -altera-unroll-loops,
+#   -altera-id-dependent-backward-branch,
+#   -altera-struct-pack-align,
+#   -fuchsia-*,
+#   fuchsia-multiple-inheritance,
+#   -llvm-header-guard,
+#   -llvm-include-order,
+#   -llvmlibc-*,
+#   -modernize-use-trailing-return-type,
+#   -misc-non-private-member-variables-in-classes,
+#   -cppcoreguidelines-pro-type-vararg,
+#   -cppcoreguidelines-avoid-c-arrays,
+#   -hicpp-vararg,
+#   -hicpp-avoid-c-arrays,
+#   -modernize-avoid-c-arrays
+
+WarningsAsErrors: ""
+# WarningsAsErrors: "*,-readability-convert-member-functions-to-static"
+
+CheckOptions:
+  - key: "readability-identifier-length.MinimumVariableNameLength"
+    value: "2"
+  - key: "readability-identifier-length.MinimumParameterNameLength"
+    value: "2"
+  - key: "readability-identifier-length.MinimumLoopCounterNameLength"
+    value: "2"
+  - { key: readability-identifier-naming.NamespaceCase, value: lower_case }
+  - {
+      key: readability-identifier-naming.MacroDefinitionCase,
+      value: UPPER_CASE,
+    }
+  - { key: readability-identifier-naming.ClassCase, value: CamelCase }
+  - { key: readability-identifier-naming.StructCase, value: CamelCase }
+  - { key: readability-identifier-naming.EnumCase, value: CamelCase }
+  - { key: readability-identifier-naming.EnumConstantCase, value: CamelCase }
+  - { key: readability-identifier-naming.TypedefCase, value: CamelCase }
+  - { key: readability-identifier-naming.TypeAliasCase, value: CamelCase }
+  - { key: readability-identifier-naming.UnionCase, value: CamelCase }
+
+  - { key: readability-identifier-naming.FunctionCase, value: lower_case }
+  - { key: readability-identifier-naming.GlobalFunctionCase, value: lower_case }
+
+  - { key: readability-identifier-naming.GlobalVariableCase, value: CamelCase }
+
+  - { key: readability-identifier-naming.LocalVariableCase, value: aNy_CasE }
+  - { key: readability-identifier-naming.ParameterCase, value: aNy_CasE }
+  #static
+  - { key: readability-identifier-naming.ClassMemberCase, value: lower_case }
+  - { key: readability-identifier-naming.ClassMethodCase, value: lower_case }
+
+  - { key: readability-identifier-naming.MethodCase, value: lower_case }
+  - { key: readability-identifier-naming.PrivateMethodCase, value: lower_case }
+
+  - { key: readability-identifier-naming.MemberCase, value: lower_case }
+  - { key: readability-identifier-naming.PrivateMemberCase, value: lower_case }
+  - { key: readability-identifier-naming.PrivateMemberSuffix, value: "_" }
+
+  - { key: readability-identifier-naming.VariableCase, value: lower_case }
+
+  - { key: readability-identifier-naming.StaticVariableCase, value: lower_case }
+  - {
+      key: readability-identifier-naming.ConstexprVariableCase,
+      value: UPPER_CASE,
+    }
+  #constant
+  - { key: readability-identifier-naming.GlobalConstantCase, value: lower_case }
+
+  - { key: readability-identifier-naming.MemberConstantCase, value: lower_case }
+
+  - { key: readability-identifier-naming.StaticConstantCase, value: lower_case }
+
+  - {
+      key: readability-identifier-naming.TemplateParameterCase,
+      value: CamelCase,
+    }
+  # some magic number
+  - {
+      key: readability-magic-numbers.IgnoredIntegerValues,
+      value: "-1; 0; 1; 2; 3; 4; 5;10;100",
+    }

tests/CMakeLists.txt

@@ -3,17 +3,24 @@ include_directories(${CMAKE_SOURCE_DIR}/src)
 # Find Google Test
 find_package(GTest REQUIRED)
 
+file(GLOB_RECURSE MALASIM_TEST_SOURCES
+  "*.cpp"
+  "Core/Random/*.cpp"
+)
+
+
 # Add test executable
 add_executable(runTests
-    # Add your test files here
-    example_test.cpp
+  ${MALASIM_TEST_SOURCES}
 )
 
+add_dependencies(runTests MalaSimCore)
+
 # Link the core library and GTest to the test executable
 target_link_libraries(runTests PRIVATE
   GTest::gtest_main
   MalaSimCore
 )
 
 # Add tests
-add_test(NAME example_test COMMAND ${CMAKE_BINARY_DIR}/bin/runTests)
+add_test(NAME malasim_test COMMAND ${CMAKE_BINARY_DIR}/bin/runTests)