test(support): add SimulatedEnvironment for deterministic testing

Introduces a new testing support library 'testing/support' that provides
a clean, modular, and fully deterministic environment for testing
toxcore components.

Author: iphydf

CMakeLists.txt

@@ -87,7 +87,7 @@ if(MSVC AND MSVC_TOOLSET_VERSION LESS 143)
 else()
   set(CMAKE_C_STANDARD 11)
 endif()
-set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_C_EXTENSIONS OFF)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
@@ -533,6 +533,8 @@ make_version_script(toxcore ${toxcore_API_HEADERS})
 # "${CMAKE_INSTALL_INCLUDEDIR}/tox".
 install_module(toxcore DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/tox)
 
+add_subdirectory(testing)
+
 ################################################################################
 #
 # :: Unit tests: no networking, just pure function calls.
@@ -545,8 +547,8 @@ if(UNITTEST)
     toxcore/DHT_test_util.hh
     toxcore/crypto_core_test_util.cc
     toxcore/crypto_core_test_util.hh
-    toxcore/mem_test_util.cc
-    toxcore/mem_test_util.hh
+    toxcore/mono_time_test_util.cc
+    toxcore/mono_time_test_util.hh
     toxcore/network_test_util.cc
     toxcore/network_test_util.hh
     toxcore/test_util.cc
@@ -555,7 +557,7 @@ endif()
 
 function(unit_test subdir target)
   add_executable(unit_${target}_test ${subdir}/${target}_test.cc)
-  target_link_libraries(unit_${target}_test PRIVATE test_util)
+  target_link_libraries(unit_${target}_test PRIVATE test_util support)
   if(TARGET toxcore_static)
     target_link_libraries(unit_${target}_test PRIVATE toxcore_static)
   else()
@@ -570,7 +572,7 @@ function(unit_test subdir target)
   endif()
   target_link_libraries(unit_${target}_test PRIVATE GTest::gtest GTest::gtest_main GTest::gmock)
   set_target_properties(unit_${target}_test PROPERTIES COMPILE_FLAGS "${TEST_CXX_FLAGS}")
-  add_test(NAME ${target} COMMAND ${CROSSCOMPILING_EMULATOR} unit_${target}_test)
+  add_test(NAME ${target} COMMAND unit_${target}_test)
   set_property(TEST ${target} PROPERTY ENVIRONMENT "LLVM_PROFILE_FILE=${target}.profraw")
 endfunction()
 
@@ -612,8 +614,6 @@ if(UNITTEST AND TARGET GTest::gtest AND TARGET GTest::gmock)
   unit_test(toxcore util)
 endif()
 
-add_subdirectory(testing)
-
 ################################################################################
 #
 # :: Automated regression tests: create a tox network and run integration tests

auto_tests/CMakeLists.txt

@@ -32,7 +32,7 @@ function(auto_test target)
   elseif(TARGET Threads::Threads)
     target_link_libraries(auto_${target}_test PRIVATE Threads::Threads)
   endif()
-  add_test(NAME ${target} COMMAND ${CROSSCOMPILING_EMULATOR} auto_${target}_test)
+  add_test(NAME ${target} COMMAND auto_${target}_test)
   set_tests_properties(${target} PROPERTIES TIMEOUT "${TEST_TIMEOUT_SECONDS}")
   # add the source dir as environment variable, so the testdata can be found
   set_tests_properties(${target} PROPERTIES ENVIRONMENT "LLVM_PROFILE_FILE=${target}.profraw;srcdir=${CMAKE_CURRENT_SOURCE_DIR}")

auto_tests/scenarios/CMakeLists.txt

@@ -18,7 +18,7 @@ endif()
 function(scenario_test target)
   add_executable(auto_${target}_test ${target}_test.c)
   target_link_libraries(auto_${target}_test PRIVATE misc_tools scenario_framework)
-  add_test(NAME ${target} COMMAND ${CROSSCOMPILING_EMULATOR} auto_${target}_test)
+  add_test(NAME ${target} COMMAND auto_${target}_test)
   set_tests_properties(${target} PROPERTIES TIMEOUT "${TEST_TIMEOUT_SECONDS}")
   # add the source dir as environment variable, so the testdata can be found
   set_tests_properties(${target} PROPERTIES ENVIRONMENT "LLVM_PROFILE_FILE=${target}.profraw;srcdir=${CMAKE_CURRENT_SOURCE_DIR}/..")

other/analysis/gen-file.sh

@@ -11,6 +11,8 @@ CPPFLAGS+=("-Iother/bootstrap_daemon/src")
 CPPFLAGS+=("-Iother/fun")
 CPPFLAGS+=("-Itesting")
 CPPFLAGS+=("-Itesting/fuzzing")
+CPPFLAGS+=("-Itesting/support/doubles")
+CPPFLAGS+=("-Itesting/support/public")
 CPPFLAGS+=("-Itoxcore")
 CPPFLAGS+=("-Itoxcore/events")
 CPPFLAGS+=("-Itoxav")
@@ -51,33 +53,44 @@ callmain() {
 
 # Include all C and C++ code
 FIND_QUERY="find . '-(' -name '*.c' -or -name '*.cc' '-)'"
-# Excludes
-FIND_QUERY="$FIND_QUERY -and -not -wholename './_build/*'"
-FIND_QUERY="$FIND_QUERY -and -not -wholename './other/docker/*'"
-FIND_QUERY="$FIND_QUERY -and -not -wholename './super_donators/*'"
-FIND_QUERY="$FIND_QUERY -and -not -name amalgamation.cc"
-FIND_QUERY="$FIND_QUERY -and -not -name av_test.c"
-FIND_QUERY="$FIND_QUERY -and -not -name cracker.c"
-FIND_QUERY="$FIND_QUERY -and -not -name version_test.c"
-FIND_QUERY="$FIND_QUERY -and -not -name '*_fuzz_test.cc'"
-FIND_QUERY="$FIND_QUERY -and -not -wholename './testing/fuzzing/*'"
-FIND_QUERY="$FIND_QUERY -and -not -wholename './third_party/cmp/examples/*'"
-FIND_QUERY="$FIND_QUERY -and -not -wholename './third_party/cmp/test/*'"
+HEADER_QUERY="find . '-(' -name '*.h' -or -name '*.hh' '-)'"
+
+COMMON_EXCLUDES=""
+COMMON_EXCLUDES="$COMMON_EXCLUDES -and -not -wholename './_build/*'"
+COMMON_EXCLUDES="$COMMON_EXCLUDES -and -not -wholename './other/docker/*'"
+COMMON_EXCLUDES="$COMMON_EXCLUDES -and -not -wholename './super_donators/*'"
+COMMON_EXCLUDES="$COMMON_EXCLUDES -and -not -wholename './testing/fuzzing/*'"
+COMMON_EXCLUDES="$COMMON_EXCLUDES -and -not -wholename './third_party/cmp/examples/*'"
+COMMON_EXCLUDES="$COMMON_EXCLUDES -and -not -wholename './third_party/cmp/test/*'"
+
+# File name excludes
+COMMON_EXCLUDES="$COMMON_EXCLUDES -and -not -name amalgamation.cc"
+COMMON_EXCLUDES="$COMMON_EXCLUDES -and -not -name av_test.c"
+COMMON_EXCLUDES="$COMMON_EXCLUDES -and -not -name cracker.c"
+COMMON_EXCLUDES="$COMMON_EXCLUDES -and -not -name version_test.c"
+COMMON_EXCLUDES="$COMMON_EXCLUDES -and -not -name '*_fuzz_test.cc'"
 
 if [ "$SKIP_BENCHMARK" == 1 ]; then
-  FIND_QUERY="$FIND_QUERY -and -not -name '*_bench.cc'"
+  COMMON_EXCLUDES="$COMMON_EXCLUDES -and -not -name '*_bench.cc'"
 fi
 
 if [ "$SKIP_GTEST" == 1 ]; then
-  FIND_QUERY="$FIND_QUERY -and -not -name '*_test.cc'"
+  COMMON_EXCLUDES="$COMMON_EXCLUDES -and -not -name '*_test.cc'"
 fi
 
+FIND_QUERY="$FIND_QUERY $COMMON_EXCLUDES"
+HEADER_QUERY="$HEADER_QUERY $COMMON_EXCLUDES"
+
 readarray -t FILES <<<"$(eval "$FIND_QUERY")"
+readarray -t HEADERS <<<"$(eval "$HEADER_QUERY")"
 
-(for i in "${FILES[@]}"; do
+INCLUDES=$(for i in "${FILES[@]}" "${HEADERS[@]}"; do
   grep -o '#include <[^>]*>' "$i" |
     grep -E -v '<win|<ws|<iphlp|<libc|<mach/|<crypto_|<randombytes|<u.h>|<sys/filio|<stropts.h>|<linux'
-done) | sort -u >>amalgamation.cc
+done | sort -u)
+
+echo "$INCLUDES" | grep "<memory>" >>amalgamation.cc
+echo "$INCLUDES" | grep -v "<memory>" >>amalgamation.cc
 
 put auto_tests/check_compat.h
 

other/analysis/run-clang

@@ -36,7 +36,13 @@ run() {
     -Wno-unreachable-code-return \
     -Wno-unsafe-buffer-usage \
     -Wno-unused-parameter \
-    -Wno-used-but-marked-unused
+    -Wno-used-but-marked-unused \
+    -Wno-unneeded-member-function \
+    -Wno-unused-function \
+    -Wno-unused-member-function \
+    -Wno-unused-parameter \
+    -Wno-unused-template
+  # TODO(iphydf): Remove these last 5 when the test framework matures.
 }
 
 . other/analysis/variants.sh

other/analysis/run-gcc

@@ -65,7 +65,9 @@ run() {
     -Wunused-value \
     -Wunused-but-set-parameter \
     -Wunused-but-set-variable \
-    -fopenmp
+    -fopenmp \
+    -Wno-unused-function
+  # TODO(iphydf): Remove this last 1 when the test framework matures.
 }
 
 . other/analysis/variants.sh