Fixes for util unit tests (#288)

Author: tsayukov

.github/actions/build/action.yaml

@@ -9,7 +9,7 @@ runs:
       run: |
         mkdir -p ../build
         rm -rf ../build/*
-        cmake -DYDB_SDK_TESTS=On -DYDB_SDK_EXAMPLES=On --preset release
+        cmake --preset release-test-with-ccache-basedir
     - name: Build
       shell: bash
       run: |

CMakeLists.txt

@@ -18,6 +18,18 @@ set(YDB-CPP-SDK_AVAILABLE_COMPONENTS "" CACHE INTERNAL "")
 set(YDB-CPP-SDK_COMPONENT_TARGETS "" CACHE INTERNAL "")
 file(READ "src/client/resources/ydb_sdk_version.txt" YDB_SDK_VERSION)
 
+#[=============================================================================[
+  NOTE: if `ccache` is used with the environment variable `CCACHE_BASEDIR`,
+  these cached variable should be set manually by passing them to `cmake` as
+  `-DARCADIA_ROOT=source/path/relative/to/build/dir` and
+  `-DARCADIA_BUILD_ROOT=.`, because in that case the macro `__FILE__` will be
+  expanded to a relative path, even if the source code file was specified as
+  an absolute path, and we have to know the proper prefix of that path.
+  See details: https://ccache.dev/manual/3.1.html#_compiling_in_different_directories
+#]=============================================================================]
+set(ARCADIA_ROOT ${YDB_SDK_SOURCE_DIR} CACHE INTERNAL "The source root directory")
+set(ARCADIA_BUILD_ROOT ${YDB_SDK_BINARY_DIR} CACHE INTERNAL "The build root directory")
+
 include(GNUInstallDirs)
 include(CMakePackageConfigHelpers)
 

CMakePresets.json

@@ -40,6 +40,26 @@
       "displayName": "Default Release Config",
       "description": "Default release build configuration using Ninja generator and Clang compiler",
       "binaryDir": "${sourceDir}/../build"
+    },
+    {
+      "name": "release-test",
+      "inherits": "release",
+      "displayName": "Default Release Test Config",
+      "description": "Default release build configuration with all tests and examples",
+      "cacheVariables": {
+        "YDB_SDK_TESTS": "TRUE",
+        "YDB_SDK_EXAMPLES": "TRUE"
+      }
+    },
+    {
+      "name": "release-test-with-ccache-basedir",
+      "inherits": "release-test",
+      "displayName": "Release Test Config CCACHE_BASEDIR Case",
+      "description": "Only for the case when using CCACHE_BASEDIR",
+      "cacheVariables": {
+        "ARCADIA_ROOT": "../ydb-cpp-sdk",
+        "ARCADIA_BUILD_ROOT": "."
+      }
     }
   ],
   "buildPresets": [
@@ -51,51 +71,46 @@
   ],
   "testPresets": [
     {
-      "name": "release",
-      "configurePreset": "release",
-      "displayName": "Default Release Tests",
+      "name": "common",
+      "hidden": true,
       "output": {
         "outputOnFailure": true
       },
       "execution": {
         "timeout": 1200
-      },
+      }
+    },
+    {
+      "name": "release",
+      "inherits": "common",
+      "configurePreset": "release-test",
+      "displayName": "Default Release Tests",
       "environment": {
         "YDB_ENDPOINT": "localhost:2136",
         "YDB_DATABASE": "/local"
       }
     },
     {
       "name": "release-unit",
-      "configurePreset": "release",
+      "inherits": "common",
+      "configurePreset": "release-test",
       "displayName": "Default Unit Release Tests",
       "filter" : {
         "include": {
           "label": "unit"
         }
-      },
-      "output": {
-        "outputOnFailure": true
-      },
-      "execution": {
-        "timeout": 1200
       }
     },
     {
       "name": "release-integration",
-      "configurePreset": "release",
+      "inherits": "common",
+      "configurePreset": "release-test",
       "displayName": "Default Integration Release Tests",
-      "output": {
-        "outputOnFailure": true
-      },
       "filter" : {
         "include": {
           "label": "integration"
         }
       },
-      "execution": {
-        "timeout": 1200
-      },
       "environment": {
         "YDB_ENDPOINT": "localhost:2136",
         "YDB_DATABASE": "/local"

README.md

@@ -138,4 +138,14 @@ Running integration tests only:
 
 ```bash
 ctest -j$(nproc) --preset release-integration
-```
+```
+
+Note that some tests use a legacy test library instead of GoogleTest, see `./<test_target> --help` for details. If you need to run only certain test cases, here is an alternative for `--gtest_filter` option:
+
+```bash
+cat <<EOF | ./<test_target> --filter-file /dev/fd/0
+-ExcludedTestCase
++IncludedTestCase
++IncludedTestCase::TestName
+EOF
+```

cmake/ccache.cmake

@@ -1,6 +1,4 @@
-if (NOT CCACHE_PATH)
-  find_program(CCACHE_PATH ccache)
-endif()
+find_program(CCACHE_PATH ccache)
 if (NOT CCACHE_PATH)
   message(AUTHOR_WARNING
     "Ccache is not found, that will increase the re-compilation time; "

cmake/testing.cmake

@@ -1,6 +1,6 @@
 function(add_yunittest)
   set(opts "")
-  set(oneval_args NAME TEST_TARGET)
+  set(oneval_args NAME TEST_TARGET WORKING_DIRECTORY)
   set(multival_args TEST_ARG)
   cmake_parse_arguments(YUNITTEST_ARGS
     "${opts}"
@@ -13,13 +13,19 @@ function(add_yunittest)
   get_property(SPLIT_TYPE TARGET ${YUNITTEST_ARGS_TEST_TARGET} PROPERTY SPLIT_TYPE)
 
   if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/run_testpack")
-    add_test(NAME ${YUNITTEST_ARGS_NAME} COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/run_testpack" ${YUNITTEST_ARGS_TEST_ARG})
+    add_test(NAME ${YUNITTEST_ARGS_NAME}
+      COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/run_testpack" ${YUNITTEST_ARGS_TEST_ARG}
+      WORKING_DIRECTORY ${YUNITTEST_ARGS_WORKING_DIRECTORY}
+    )
     set_property(TEST ${YUNITTEST_ARGS_NAME} PROPERTY ENVIRONMENT "source_root=${YDB_SDK_SOURCE_DIR};build_root=${YDB_SDK_BINARY_DIR};test_split_factor=${SPLIT_FACTOR};test_split_type=${SPLIT_TYPE}")
     return()
   endif()
 
   if (${SPLIT_FACTOR} EQUAL 1)
-  	add_test(NAME ${YUNITTEST_ARGS_NAME} COMMAND ${YUNITTEST_ARGS_TEST_TARGET} ${YUNITTEST_ARGS_TEST_ARG})
+  	add_test(NAME ${YUNITTEST_ARGS_NAME}
+      COMMAND ${YUNITTEST_ARGS_TEST_TARGET} ${YUNITTEST_ARGS_TEST_ARG}
+      WORKING_DIRECTORY ${YUNITTEST_ARGS_WORKING_DIRECTORY}
+    )
   	return()
   endif()
 
@@ -29,8 +35,12 @@ function(add_yunittest)
   math(EXPR LastIdx "${SPLIT_FACTOR} - 1")
   foreach(Idx RANGE ${LastIdx})
     add_test(NAME ${YUNITTEST_ARGS_NAME}_${Idx}
-      COMMAND Python3::Interpreter ${YDB_SDK_SOURCE_DIR}/scripts/split_unittest.py --split-factor ${SPLIT_FACTOR} ${FORK_MODE_ARG} --shard ${Idx}
-       $<TARGET_FILE:${YUNITTEST_ARGS_TEST_TARGET}> ${YUNITTEST_ARGS_TEST_ARG})
+      COMMAND Python3::Interpreter ${YDB_SDK_SOURCE_DIR}/scripts/split_unittest.py
+        --split-factor ${SPLIT_FACTOR} ${FORK_MODE_ARG}
+        --shard ${Idx}
+        $<TARGET_FILE:${YUNITTEST_ARGS_TEST_TARGET}> ${YUNITTEST_ARGS_TEST_ARG}
+      WORKING_DIRECTORY ${YUNITTEST_ARGS_WORKING_DIRECTORY}
+    )
   endforeach()
 endfunction()
 
@@ -59,15 +69,23 @@ endfunction()
 
 function(add_ydb_test)
   set(opts GTEST)
-  set(oneval_args NAME)
-  set(multival_args INCLUDE_DIRS SOURCES LINK_LIBRARIES LABELS)
+  set(oneval_args NAME WORKING_DIRECTORY OUTPUT_DIRECTORY)
+  set(multival_args INCLUDE_DIRS SOURCES LINK_LIBRARIES LABELS TEST_ARG)
   cmake_parse_arguments(YDB_TEST
     "${opts}"
     "${oneval_args}"
     "${multival_args}"
     ${ARGN}
   )
 
+  if (YDB_TEST_WORKING_DIRECTORY AND NOT EXISTS "${YDB_TEST_WORKING_DIRECTORY}")
+    file(MAKE_DIRECTORY "${YDB_TEST_WORKING_DIRECTORY}")
+  endif()
+
+  if (YDB_TEST_OUTPUT_DIRECTORY AND NOT EXISTS "${YDB_TEST_OUTPUT_DIRECTORY}")
+    file(MAKE_DIRECTORY "${YDB_TEST_OUTPUT_DIRECTORY}")
+  endif()
+
   add_executable(${YDB_TEST_NAME})
   target_include_directories(${YDB_TEST_NAME} PRIVATE ${YDB_TEST_INCLUDE_DIRS})
   target_link_libraries(${YDB_TEST_NAME} PRIVATE ${YDB_TEST_LINK_LIBRARIES})
@@ -96,56 +114,63 @@ function(add_ydb_test)
 
   set_property(
     TARGET
-    ${YDB_TEST_NAME}
+      ${YDB_TEST_NAME}
     PROPERTY
-    SPLIT_FACTOR
-    1
+      SPLIT_FACTOR
+      1
   )
   if (YDB_TEST_GTEST)
     add_yunittest(
       NAME
-      ${YDB_TEST_NAME}
+        ${YDB_TEST_NAME}
       TEST_TARGET
-      ${YDB_TEST_NAME}
+        ${YDB_TEST_NAME}
+      TEST_ARG
+        ${YDB_TEST_TEST_ARG}
+      WORKING_DIRECTORY
+        ${YDB_TEST_WORKING_DIRECTORY}
     )
   else()
     add_yunittest(
       NAME
-      ${YDB_TEST_NAME}
+        ${YDB_TEST_NAME}
       TEST_TARGET
-      ${YDB_TEST_NAME}
+        ${YDB_TEST_NAME}
       TEST_ARG
-      --print-before-suite
-      --print-before-test
-      --fork-tests
-      --print-times
-      --show-fails
+        --print-before-suite
+        --print-before-test
+        --fork-tests
+        --print-times
+        --show-fails
+        ${YDB_TEST_TEST_ARG}
+      WORKING_DIRECTORY
+        ${YDB_TEST_WORKING_DIRECTORY}
     )
   endif()
 
   set_yunittest_property(
     TEST
-    ${YDB_TEST_NAME}
+      ${YDB_TEST_NAME}
     PROPERTY
-    LABELS
-    MEDIUM
-    ${YDB_TEST_LABELS}
+      LABELS
+      MEDIUM
+      ${YDB_TEST_LABELS}
   )
 
   set_yunittest_property(
     TEST
-    ${YDB_TEST_NAME}
+      ${YDB_TEST_NAME}
     PROPERTY
-    PROCESSORS
-    1
+      PROCESSORS
+      1
   )
 
   set_yunittest_property(
     TEST
-    ${YDB_TEST_NAME}
+      ${YDB_TEST_NAME}
     PROPERTY
-    TIMEOUT
-    600
+      TIMEOUT
+      600
   )
 
   vcs_info(${YDB_TEST_NAME})