[CMake] Track test dependencies with add_lldb_test_dependency

[JDevlieghere]

Summary

I often use ninja lldb-test-deps to build all the test dependencies before running a subset of the tests with lit --filter. This functionality seems to break relatively often because test dependencies are tracked in an ad-hoc way in different cmake files. This patch adds a helper function add_lldb_test_dependency to unify test dependency tracking by adding dependencies to lldb-test-deps.

[xiaobai]

Looks good to me. I find it interesting that we had an lldb-test-deps custom target before but most things were depending on ${LLDB_TEST_DEPS} anyway.

[JDevlieghere]

In D68612#1698614, @xiaobai wrote:

Looks good to me. I find it interesting that we had an lldb-test-deps custom target before but most things were depending on ${LLDB_TEST_DEPS} anyway.

Yep. IIRC the main motivation was Swift's build-script that would build the test dependencies before running a subset of them (the swift tests) for PR testing.

[jankratochvil]

On Linux OS (Fedora 30 x86_64) with GIT monorepo:
After rL374000:

#rm -rf *
cmake ~/redhat/llvm-monorepo2/llvm/ -DCMAKE_BUILD_TYPE=Release  -DLLVM_USE_LINKER=gold -DLLVM_ENABLE_PROJECTS="lldb;clang;lld"  -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DLLVM_ENABLE_ASSERTIONS=ON
make check-lldb
...
llvm-lit: /home/jkratoch/redhat/llvm-monorepo2/llvm/utils/lit/lit/llvm/subst.py:134: fatal: Did not find count in /home/jkratoch/redhat/llvm-monorepo2-clangassert/./bin

After rL373996 (this patch):

llvm-lit: llvm-monorepo2/llvm/utils/lit/lit/llvm/subst.py:127: note: Did not find obj2yaml in llvm-monorepo2-clangassert/./bin:llvm-monorepo2-clangassert/./bin
llvm-lit: llvm-monorepo2/llvm/utils/lit/lit/llvm/subst.py:127: note: Did not find llvm-pdbutil in llvm-monorepo2-clangassert/./bin:llvm-monorepo2-clangassert/./bin
llvm-lit: llvm-monorepo2/llvm/utils/lit/lit/llvm/subst.py:127: note: Did not find llvm-mc in llvm-monorepo2-clangassert/./bin:llvm-monorepo2-clangassert/./bin
llvm-lit: llvm-monorepo2/llvm/utils/lit/lit/llvm/subst.py:127: note: Did not find llvm-readobj in llvm-monorepo2-clangassert/./bin:llvm-monorepo2-clangassert/./bin
llvm-lit: llvm-monorepo2/llvm/utils/lit/lit/llvm/subst.py:127: note: Did not find llvm-objdump in llvm-monorepo2-clangassert/./bin:llvm-monorepo2-clangassert/./bin
llvm-lit: llvm-monorepo2/llvm/utils/lit/lit/llvm/subst.py:127: note: Did not find llvm-objcopy in llvm-monorepo2-clangassert/./bin:llvm-monorepo2-clangassert/./bin
llvm-lit: llvm-monorepo2/llvm/utils/lit/lit/llvm/subst.py:127: note: Did not find lli in llvm-monorepo2-clangassert/./bin:llvm-monorepo2-clangassert/./bin
llvm-lit: llvm-monorepo2/llvm/utils/lit/lit/llvm/config.py:169: fatal: Could not run process ['llvm-monorepo2-clangassert/./bin/llvm-config', '--assertion-mode', '--build-mode', '--targets-built']

Surprisingly a Fedora buildbot does not have this problem.

lldb/CMakeLists.txt

if(LLDB_INCLUDE_TESTS)
   set(LLDB_TEST_DSYMUTIL "${LLDB_DEFAULT_TEST_DSYMUTIL}" CACHE PATH "dsymutil used for generating dSYM bundles")
   set(LLDB_TEST_FILECHECK "${LLDB_DEFAULT_TEST_FILECHECK}" CACHE PATH "FileCheck used for testing purposes")
 
   if (("${LLDB_TEST_C_COMPILER}" STREQUAL "") OR
       ("${LLDB_TEST_CXX_COMPILER}" STREQUAL ""))
     message(FATAL_ERROR "LLDB test compilers not specified. Tests will not run.")
   endif()
 
-  set(LLDB_TEST_DEPS lldb)
+  add_custom_target(lldb-test-deps)
+  set_target_properties(lldb-test-deps PROPERTIES FOLDER "lldb misc")
+  add_lldb_test_dependency(lldb)
+
+  # lldb-test is an hard dependency for the testsuite.
+  add_lldb_test_dependency(lldb-test)
 
   # darwin-debug is an hard dependency for the testsuite.
   if (CMAKE_SYSTEM_NAME MATCHES "Darwin")
-    list(APPEND LLDB_TEST_DEPS darwin-debug)
+    add_lldb_test_dependency(darwin-debug)
   endif()
 
-  # lldb-test is an hard dependency for the testsuite.
-  list(APPEND LLDB_TEST_DEPS lldb-test)
-
   if(TARGET lldb-server)
-    list(APPEND LLDB_TEST_DEPS lldb-server)
+    add_lldb_test_dependency(lldb-server)
   endif()
 
   if(TARGET lldb-vscode)
-    list(APPEND LLDB_TEST_DEPS lldb-vscode)
+    add_lldb_test_dependency(lldb-vscode)
   endif()
 
   if(TARGET lldb-instr)
-    list(APPEND LLDB_TEST_DEPS lldb-instr)
+    add_lldb_test_dependency(lldb-instr)
   endif()
 
   if(NOT LLDB_BUILT_STANDALONE)
-    list(APPEND LLDB_TEST_DEPS yaml2obj)
+    add_lldb_test_dependency(yaml2obj)
+  endif()
+
+  if(TARGET dsymutil)
+    add_lldb_test_dependency(dsymutil)
   endif()
 
   if(TARGET liblldb)
-    list(APPEND LLDB_TEST_DEPS liblldb)
+    add_lldb_test_dependency(liblldb)
+  endif()
+
+  if(TARGET lldb-framework)
+    add_lldb_test_dependency(lldb-framework)
   endif()
 
   # Add dependencies if we test with the in-tree clang.
   # This works with standalone builds as they import the clang target.
   if(TARGET clang)
-    list(APPEND LLDB_TEST_DEPS clang)
+    add_lldb_test_dependency(clang)
     if(APPLE)
       # If we build clang, we should build libcxx.
       # FIXME: Standalone builds should import the cxx target as well.
       if(LLDB_BUILT_STANDALONE)
         # For now check that the include directory exists.
         set(cxx_dir "${LLVM_BINARY_DIR}/include/c++")
         if(NOT EXISTS ${cxx_dir})
           message(WARNING "LLDB test suite requires libc++ in llvm/projects/libcxx or an existing build symlinked to ${cxx_dir}")
if(APPLE)
           else()
             # If `LLVM_ENABLE_PROJECTS` is being used, suggest adding it.
             message(FATAL_ERROR
               "LLDB test suite requires libc++, but it is currently disabled. "
               "Please add `libcxx` to `LLVM_ENABLE_PROJECTS` or disable tests "
               "via `LLDB_INCLUDE_TESTS=OFF`.")
           endif()
         endif()
-        list(APPEND LLDB_TEST_DEPS cxx)
-      endif()
-    endif()
+        add_lldb_test_dependency(cxx)
       endif()
-
-  if(TARGET dsymutil)
-    list(APPEND LLDB_TEST_DEPS dsymutil)
     endif()
-
-  if(TARGET lldb-framework)
-    list(APPEND LLDB_TEST_DEPS lldb-framework)
   endif()
 
-  add_custom_target(lldb-test-deps)
-  add_dependencies(lldb-test-deps ${LLDB_TEST_DEPS})
-  set_target_properties(lldb-test-deps PROPERTIES FOLDER "lldb misc")
-
   add_subdirectory(test)
   add_subdirectory(unittests)
   add_subdirectory(lit)
   add_subdirectory(utils/lit-cpuid)
   add_subdirectory(utils/lldb-dotest)
 endif()
 
 if (NOT LLDB_DISABLE_PYTHON)

lldb/cmake/modules/AddLLDB.cmake

function(lldb_tablegen)
 
   if(LTG_TARGET)
     add_public_tablegen_target(${LTG_TARGET})
     set_target_properties( ${LTG_TARGET} PROPERTIES FOLDER "LLDB tablegenning")
     set_property(GLOBAL APPEND PROPERTY LLDB_TABLEGEN_TARGETS ${LTG_TARGET})
   endif()
 endfunction(lldb_tablegen)
 
+function(add_lldb_test_dependency name)
+  add_dependencies(lldb-test-deps ${name})
+endfunction(add_lldb_test_dependency)
+
 function(add_lldb_library name)
   include_directories(BEFORE
     ${CMAKE_CURRENT_BINARY_DIR}
 )
 
   # only supported parameters to this macro are the optional
   # MODULE;SHARED;STATIC library type and source files
   cmake_parse_arguments(PARAM

lldb/lit/CMakeLists.txt

else()
     set(dotest_args_replacement ".")
   endif()
 endif()
 
 string(REPLACE ${CMAKE_CFG_INTDIR} ${dotest_args_replacement} LLDB_DOTEST_ARGS "${LLDB_DOTEST_ARGS}")
 string(REPLACE ${CMAKE_CFG_INTDIR} ${LLVM_BUILD_MODE} LLDB_LIBS_DIR ${LLVM_LIBRARY_OUTPUT_INTDIR})
 string(REPLACE ${CMAKE_CFG_INTDIR} ${LLVM_BUILD_MODE} LLDB_TOOLS_DIR ${LLVM_RUNTIME_OUTPUT_INTDIR})
 
-list(APPEND LLDB_TEST_DEPS
-  LLDBUnitTests
-  dsymutil
+add_lldb_test_dependency(
   lit-cpuid
   llc
-  lldb
-  lldb-test
   lli
   llvm-config
   llvm-dwarfdump
   llvm-nm
   llvm-mc
   llvm-objcopy
   llvm-readobj
   llvm-strip
   )
 
 if(TARGET lld)
-  list(APPEND LLDB_TEST_DEPS lld)
+  add_lldb_test_dependency(lld)
 endif()
 
 # the value is not canonicalized within LLVM
 llvm_canonicalize_cmake_booleans(
   LLDB_DISABLE_PYTHON
   LLVM_ENABLE_ZLIB
   LLVM_ENABLE_SHARED_LIBS
   LLDB_IS_64_BITS)
configure_lit_site_cfg(
   ${CMAKE_CURRENT_SOURCE_DIR}/Suite/lit.site.cfg.in
   ${CMAKE_CURRENT_BINARY_DIR}/Suite/lit.site.cfg)
 
 configure_file(
   ${CMAKE_CURRENT_SOURCE_DIR}/lit-lldb-init.in
   ${CMAKE_CURRENT_BINARY_DIR}/lit-lldb-init)
 
 if(NOT LLDB_BUILT_STANDALONE)
-  list(APPEND LLDB_TEST_DEPS
+  add_dependencies(lldb-test-deps
     FileCheck
     count
     not
   )
 endif()
 
 add_lit_testsuite(check-lldb-lit "Running lldb lit test suite"
   ${CMAKE_CURRENT_BINARY_DIR}
-  DEPENDS ${LLDB_TEST_DEPS}
+  DEPENDS lldb-test-deps
   )
 
 set_target_properties(check-lldb-lit PROPERTIES FOLDER "lldb tests")
 
 # If we're building with an in-tree clang, then list clang as a dependency
 # to run tests.
 if (TARGET clang)
   add_dependencies(check-lldb-lit clang)
 endif()
 
 add_lit_testsuites(LLDB
   ${CMAKE_CURRENT_SOURCE_DIR}
-  DEPENDS ${LLDB_TEST_DEPS}
+  DEPENDS lldb-test-deps
   )

lldb/test/CMakeLists.txt

 function(add_python_test_target name test_script args comment)
   set(PYTHON_TEST_COMMAND
     ${PYTHON_EXECUTABLE}
     ${test_script}
     ${args}
     )
 
   add_custom_target(${name}
     COMMAND ${PYTHON_TEST_COMMAND} ${ARG_DEFAULT_ARGS}
     COMMENT "${comment}"
     USES_TERMINAL
     )
-  add_dependencies(${name} ${LLDB_TEST_DEPS})
+  add_dependencies(${name} lldb-test-deps)
 endfunction()
 
 # The default architecture with which to compile test executables is the default LLVM target
 # architecture, which itself defaults to the host architecture.
 string(TOLOWER "${LLVM_TARGET_ARCH}" LLDB_DEFAULT_TEST_ARCH)
 if( LLDB_DEFAULT_TEST_ARCH STREQUAL "host" )
   string(REGEX MATCH "^[^-]*" LLDB_DEFAULT_TEST_ARCH ${LLVM_HOST_TRIPLE})
 endif ()
if(LLDB_USE_SYSTEM_DEBUGSERVER)
     # The custom target for the system debugserver has no install target, so we
     # need to remove it from the LLVM_DISTRIBUTION_COMPONENTS list.
     if (LLVM_DISTRIBUTION_COMPONENTS)
       list(REMOVE_ITEM LLVM_DISTRIBUTION_COMPONENTS debugserver)
       set(LLVM_DISTRIBUTION_COMPONENTS ${LLVM_DISTRIBUTION_COMPONENTS} PARENT_SCOPE)
     endif()
     message(STATUS "LLDB tests use out-of-tree debugserver: ${system_debugserver_path}")
     list(APPEND LLDB_TEST_COMMON_ARGS --out-of-tree-debugserver)
-    add_dependencies(lldb-test-deps debugserver)
+    add_lldb_test_dependency(debugserver)
   elseif(TARGET debugserver)
     set(debugserver_path ${LLVM_RUNTIME_OUTPUT_INTDIR}/debugserver)
     message(STATUS "LLDB Tests use just-built debugserver: ${debugserver_path}")
     list(APPEND LLDB_TEST_COMMON_ARGS --server ${debugserver_path})
-    add_dependencies(lldb-test-deps debugserver)
+    add_lldb_test_dependency(debugserver)
   elseif(TARGET lldb-server)
     set(lldb_server_path ${LLVM_RUNTIME_OUTPUT_INTDIR}/lldb-server)
     message(STATUS "LLDB Tests use just-built lldb-server: ${lldb_server_path}")
     list(APPEND LLDB_TEST_COMMON_ARGS --server ${lldb_server_path})
-    add_dependencies(lldb-test-deps lldb-server)
+    add_lldb_test_dependency(lldb-server)
   else()
     message(WARNING "LLDB Tests enabled, but no server available")
   endif()
 endif()
 
 set(LLDB_DOTEST_ARGS ${LLDB_TEST_COMMON_ARGS};${LLDB_TEST_USER_ARGS})
 set_property(GLOBAL PROPERTY LLDB_DOTEST_ARGS_PROPERTY ${LLDB_DOTEST_ARGS})
 

lldb/unittests/CMakeLists.txt

 add_custom_target(LLDBUnitTests)
 set_target_properties(LLDBUnitTests PROPERTIES FOLDER "lldb tests")
+add_dependencies(lldb-test-deps LLDBUnitTests)
 
 include_directories(${LLDB_SOURCE_ROOT})
 include_directories(${LLDB_PROJECT_ROOT}/unittests)
 
 set(LLDB_GTEST_COMMON_INCLUDE ${CMAKE_CURRENT_SOURCE_DIR}/gtest_common.h)
 if (MSVC)
   list(APPEND LLVM_COMPILE_FLAGS /FI ${LLDB_GTEST_COMMON_INCLUDE})
 else ()

lldb/utils/lldb-dotest/CMakeLists.txt

 # Make lldb-dotest a custom target.
 add_custom_target(lldb-dotest)
-add_dependencies(lldb-dotest ${LLDB_TEST_DEPS})
+add_dependencies(lldb-dotest lldb-test-deps)
 set_target_properties(lldb-dotest PROPERTIES FOLDER "lldb utils")
 
 get_property(LLDB_DOTEST_ARGS GLOBAL PROPERTY LLDB_DOTEST_ARGS_PROPERTY)
 
 # Generate lldb-dotest Python driver script for each build mode.
 if(LLDB_BUILT_STANDALONE)
   set(config_types ".")
   if(CMAKE_CONFIGURATION_TYPES)