Merge pull request #130 from Flow-IPC/tkt-flow-94_should-log-perf

Flow has gained a unit test suite similar to Flow-IPC and now houses various common test utilities, so they are removed here, and instead we reuse them from their new location in Flow. / In test/demo programs using the new (albeit optional) flow::log::Config::init_component_to_union_idx_mapping() arg in the now-recommended way.

Author: ygoldfeld

conanfile.py

@@ -125,7 +125,6 @@ def requirements(self):
             flow_version = load_version_from_file("./flow/VERSION")
             self.requires("capnproto/1.0.1")
             self.requires(f"flow/{flow_version}")
-            self.requires("gtest/1.14.0")
             self.requires("jemalloc/5.2.1")
 
     def build_requirements(self):

flow

@@ -94,9 +94,9 @@ void setup_logging(std::optional<flow::log::Simple_ostream_logger>* std_logger,
   // Console logger setup.
   static Config std_log_config;
   std_log_config.init_component_to_union_idx_mapping<Flow_log_component>
-    (1000, Config::standard_component_payload_enum_sparse_length<Flow_log_component>());
+    (1000, Config::standard_component_payload_enum_sparse_length<Flow_log_component>(), true);
   std_log_config.init_component_to_union_idx_mapping<ipc::Log_component>
-    (2000, Config::standard_component_payload_enum_sparse_length<ipc::Log_component>());
+    (2000, Config::standard_component_payload_enum_sparse_length<ipc::Log_component>(), true);
   std_log_config.init_component_names<Flow_log_component>(flow::S_FLOW_LOG_COMPONENT_NAME_MAP, false, "flow-");
   std_log_config.init_component_names<ipc::Log_component>(ipc::S_IPC_LOG_COMPONENT_NAME_MAP, false, "ipc-");
   std_logger->emplace(&std_log_config);

ipc_core

@@ -15,73 +15,14 @@
 # See the License for the specific language governing
 # permissions and limitations under the License.
 
-# We'll need Google's unit-test framework, so let's find that.
-block()
-  set(lib_name "gtest")
-  # Search for static lib specifically.  TODO: Is this needed really?  Being paranoid here?
-  if(UNIX)
-    set(lib_name "lib${lib_name}.a")
-  else()
-    message(FATAL_ERROR "Unsupported OS; please modify script to search for static lib Windows-style.")
-  endif()
-  find_library(GTEST_LIB NAMES ${lib_name})
-  if(NOT GTEST_LIB)
-    message(FATAL_ERROR
-              "Could not find Google unit-test gtest library ([${lib_name}]) location via CMake uber-searcher "
-              "find_library().  Do not fret: Please build gtest if not yet done and try again; "
-              "if it is still not found then please supply the full path to the library file (including "
-              "the file itself) as the CMake knob (cache setting) GTEST_LIB.")
-  endif()
-  message(VERBOSE "CMake uber-searcher find_library() located Google unit-test gtest lib (see below); "
-                    "though you can override this via cache setting.")
-
-  # Search for its include-root.
-  find_path(GTEST_INCLUDE_DIR NAMES gtest/gtest.h)
-  if(NOT GTEST_INCLUDE_DIR)
-    message(FATAL_ERROR
-              "Could not find Google unit-test gtest/*.h include-path via CMake uber-searcher "
-              "find_path(gtest/gtest.h).  Do not fret: Please build gtest if not yet done and try again; "
-              "if it is still not found then please supply the full path to gtest/gtest.h (excluding the "
-              "directory and file themselves) as the CMake knob (cache setting) GTEST_INCLUDE_DIR.")
-  endif()
-
-  # Note: These days Google's unit-test framework, at least when built with CMake, exports
-  # the stuff needed to just do find_package(GTest).  We could use that above, as we do for Cap'n Proto
-  # and others.  However I (ygoldfel) have it on good authority that people build the notoriously easy-to-build
-  # GTest in a myriad ways, and this find_package() support may not be produced.  So we go with the
-  # naughty more-manual way above.
-endblock()
-
-message(STATUS "Google unit-test gtest lib location: [${GTEST_LIB}].")
+include("${FLOW_LIKE_META_ROOT_flow}/tools/cmake/FlowLikeLoadGoogleTest.cmake")
+# See instructions in that file re. mechanics and conventions of GoogleTest-using programs;
+# we shall declare a few now.  GTEST_LIB and GTEST_INCLUDE_DIR are set for us.
 
 # This test requires some little silly capnp schemas.
 find_package(CapnProto CONFIG REQUIRED)
 
 # Test program: unit_test.
-# Unit tests are built on Google's unit-test framework.  The conventions we use are roughly as follows.
-#   - The unit test files shall be interspersed together with the code of the various libraries libipc_*,
-#     albeit always in directories named test/.
-#     - In addition the needed program driver(s) (i.e., guys with main()), in the root namespace, shall *not* be
-#       so interspersed but rather will live separately under unit_test/ (here).
-#   - Let `class X` in namespace N (so N::X) be located in D/X.hpp (at least), where D is a directory usually
-#     corresponding to namespace N (more or less).
-#   - Its unit test might be then called X_test and shall reside in namespace N::test::X_test.
-#     Its source code shall be in D/test/X_test.cpp.
-#   - Any supporting code outside of that file can be anywhere under D/test, in files named `test_*.hpp` and
-#     `test_*.cpp`; a convention might be to start with `test_X.?pp`, though even more support files may also
-#     be present.
-#     - For support files like this potentially applicable to ~all unit tests, they shall live in ipc::test
-#       and therefore ipc/test/.
-#
-# The relevant translation units (.cpp, .capnp -> .c++) shall be listed directly below, in normal CMake fashion,
-# under the relevant unit-test executables.  We do not make an intermediate libtest* or anything like that;
-# the relevant object files are compiled directly from their relevant source files.  (This is pretty common
-# when using the GOogle unit-test framework.)  Do note, again, that those relevant source files are directly
-# under the sub-projects' source trees: ipc_*/src/.../test/....
-#
-# This executable, libipc_unit_test, is the compendium of unit tests to execute.
-# In addition there are more executables which it will itself run as needed as part of certain specific unit tests.
-# These are built below.
 
 # Test program libipc_test_borrower.exec: executed by ipc/shm/arena_lend/jemalloc/test/shm_pool_collection_test.
 
@@ -123,9 +64,9 @@ endfunction()
 set(isal_root ${FLOW_LIKE_META_ROOT_ipc_shm_arena_lend}/src)
 
 set(SRCS
+    ${FLOW_LIKE_META_ROOT_flow}/src/flow/test/test_common_util.cpp
+    ${FLOW_LIKE_META_ROOT_flow}/src/flow/test/test_file_util.cpp
     ${FLOW_LIKE_META_ROOT_ipc_core}/src/ipc/test/test_common_util.cpp
-    ${FLOW_LIKE_META_ROOT_ipc_core}/src/ipc/test/test_config.cpp
-    ${FLOW_LIKE_META_ROOT_ipc_core}/src/ipc/test/test_file_util.cpp
     ${isal_root}/ipc/session/standalone/shm/arena_lend/jemalloc/test/shm_session_test.cpp
     ${isal_root}/ipc/session/standalone/shm/arena_lend/jemalloc/test/test_shm_session_server.cpp
     ${isal_root}/ipc/session/standalone/shm/arena_lend/jemalloc/test/test_shm_session_server_executor.cpp
@@ -163,16 +104,16 @@ set(CAPNP_SCHEMAS
 handle_binary(libipc_unit_test.exec)
 
 set(SRCS
-    ${FLOW_LIKE_META_ROOT_ipc_core}/src/ipc/test/test_common_util.cpp
-    ${FLOW_LIKE_META_ROOT_ipc_core}/src/ipc/test/test_config.cpp
+    ${FLOW_LIKE_META_ROOT_flow}/src/flow/test/test_common_util.cpp
     ${isal_root}/ipc/shm/arena_lend/test/test_borrower.cpp
     test_borrower_main.cpp)
 unset(CAPNP_SCHEMAS)
 handle_binary(libipc_test_borrower.exec)
 
 set(SRCS
+    ${FLOW_LIKE_META_ROOT_flow}/src/flow/test/test_common_util.cpp
+    ${FLOW_LIKE_META_ROOT_flow}/src/flow/test/test_file_util.cpp
     ${FLOW_LIKE_META_ROOT_ipc_core}/src/ipc/test/test_common_util.cpp
-    ${FLOW_LIKE_META_ROOT_ipc_core}/src/ipc/test/test_file_util.cpp
     ${isal_root}/ipc/session/standalone/shm/arena_lend/jemalloc/test/test_shm_session_server_executor.cpp
     ${isal_root}/ipc/session/standalone/shm/arena_lend/jemalloc/test/test_shm_session_server.cpp
     ${isal_root}/ipc/shm/arena_lend/test/test_shm_object.cpp

ipc_session

@@ -20,6 +20,9 @@
 # Had some issues matching ^ and $ in this one; leaving them out at times; these are very unlikely to match something
 # unintentional.
 
+# Maintenance note: The below suppression is similarly in Flow's flow/.../unit_test/sanitize/....
+# If this is changed, then consider the other one; and vice versa.
+
 # This suppression eliminates a rather large (in our context) number of warnings.  Each warning can be, as of this
 # writing, classified as type A and type B, where type A is by far more common (e.g., 10:1 or so).
 #
@@ -48,7 +51,7 @@
 # the test code is (when it comes down to it) accessing std::cout concurrently from multiple threads.
 # Formally speaking this is documented in Flow to be allowed, in the sense that it won't lead to undefined behavior
 # (crashing, etc.); but also recommended-against, because concurrent access to an ostream is liable to result in
-# qualtitatively unpleasant output: interleaved text, sometimes confusing formatting, etc.  Indeed this is a known
+# qualitatively unpleasant output: interleaved text, sometimes confusing formatting, etc.  Indeed this is a known
 # problem as of this writing; I have noticed that during parallelization-involving tests, the logs can be
 # (in spots) quite unpleasant to read; and I've made a @todo to that effect (also read on).  (I speculate that
 # my colleague is aware of it too; it just was not a top-priority concern, as the related unit tests did their