1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cmake: Allow skipping build tests via environment variable

Browse Source 
On setups where the tests are built as part of the build phase, and then
copied over/mounted on a test nodes an run as a separate step, the test
node may not have the build tools installed.

In that setup we may want to skip the build tests, instead of seeing
them fail.

Ideally this would be possible as a combination of FIXTURES_REQUIRED
and a skipped FIXTURES_SETUP, but that combination does not result in
skipping the FIXTURES_REQUIRED tests:

 https://gitlab.kitware.com/cmake/cmake/-/issues/26125

Instead we ensure that all build tests are run via a wrapper script,
that emit a skip message if the test should be skipped. The CMake
tests then uses SKIP_REGULAR_EXPRESSION to skip the test. We prefer
this approach over SKIP_RETURN_CODE as the latter requires CMake
API, cmake_language(EXIT), that's only available in CMake 3.29.

For now the condition to skip the test is a hard-coded environment
variable, but in the future we could do detection of prerequisites.

Change-Id: Ie8ac4b7a74c264eac8bcc1e432c94510dd0f3a9c
Reviewed-by:  Alexey Edelev <alexey.edelev@qt.io>
This commit is contained in:
Tor Arne Vestbø 2024-09-18 12:17:41 +02:00 committed by Alexey Edelev
parent ba09bec5ec
commit bc5b7e218f
1 changed files with 72 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
src/corelib/Qt6CTestMacros.cmake
View File

@ -11,6 +11,19 @@
#
# We mean it.
set(_qt_internal_skip_build_test_env_var
"QT_CMAKE_SKIP_BUILD_TESTS")
set(_qt_internal_skip_build_test_message
"Skipping build test as requested by ${_qt_internal_skip_build_test_env_var}")
set(_qt_internal_skip_build_test_regex
"^${_qt_internal_skip_build_test_message}\n$")
set(_qt_internal_skip_build_test_pre_run
"if(DEFINED ENV{${_qt_internal_skip_build_test_env_var}})"
"message(\"${_qt_internal_skip_build_test_message}\")"
"return()"
"endif()"
)
message(STATUS "CMAKE_VERSION: ${CMAKE_VERSION}")
message(STATUS "CMAKE_PREFIX_PATH: ${CMAKE_PREFIX_PATH}")
message(STATUS "CMAKE_MODULES_UNDER_TEST: ${CMAKE_MODULES_UNDER_TEST}")
@ -447,7 +460,20 @@ macro(_qt_internal_test_expect_pass _dir)
"${_ARGS_BUILD_OPTIONS}" ${additional_configure_args}
${test_command}
)
add_test(${testname} ${CMAKE_CTEST_COMMAND} ${ctest_command_args})
set(wrapper_file "${CMAKE_CURRENT_BINARY_DIR}/build_and_test_${testname}.cmake")
_qt_internal_create_command_script(
COMMAND ${CMAKE_CTEST_COMMAND} ${ctest_command_args}
COMMAND_ECHO STDOUT
OUTPUT_FILE "${wrapper_file}"
WORKING_DIRECTORY "${build_dir}"
PRE_RUN ${_qt_internal_skip_build_test_pre_run}
)
add_test(${testname} "${CMAKE_COMMAND}" "-P" "${wrapper_file}")
set_tests_properties(${testname} PROPERTIES
SKIP_REGULAR_EXPRESSION "${_qt_internal_skip_build_test_regex}")
if(_ARGS_SIMULATE_IN_SOURCE)
set_tests_properties(${testname} PROPERTIES
FIXTURES_REQUIRED "${testname}SIMULATE_IN_SOURCE_FIXTURE"
@ -570,9 +596,12 @@ function(_qt_internal_add_qmake_test dir_name)
COMMAND_ECHO STDOUT
OUTPUT_FILE "${qmake_wrapper_file}"
WORKING_DIRECTORY "${build_dir}"
PRE_RUN ${_qt_internal_skip_build_test_pre_run}
)
add_test(${testname}_qmake "${CMAKE_COMMAND}" "-P" "${qmake_wrapper_file}")
set_tests_properties(${testname}_qmake PROPERTIES
SKIP_REGULAR_EXPRESSION "${_qt_internal_skip_build_test_regex}")
set_tests_properties(${testname}_qmake PROPERTIES
DEPENDS ${testname}_create_build_dir
@ -588,9 +617,12 @@ function(_qt_internal_add_qmake_test dir_name)
OUTPUT_FILE "${build_tool_wrapper_file}"
WORKING_DIRECTORY "${build_dir}"
ENVIRONMENT ${arg_BUILD_ENVIRONMENT}
PRE_RUN ${_qt_internal_skip_build_test_pre_run}
)
add_test(${testname} "${CMAKE_COMMAND}" "-P" "${build_tool_wrapper_file}")
set_tests_properties(${testname} PROPERTIES
SKIP_REGULAR_EXPRESSION "${_qt_internal_skip_build_test_regex}")
set_tests_properties(${testname} PROPERTIES
DEPENDS ${testname}_qmake
@ -650,16 +682,27 @@ list(APPEND CMAKE_PREFIX_PATH \"${__expect_fail_prefixes}\")
set(make_program "${CMAKE_MAKE_PROGRAM}")
endif()
add_test(${testname} ${CMAKE_CTEST_COMMAND}
--build-and-test
"${CMAKE_CURRENT_BINARY_DIR}/failbuild/${_dir}"
"${CMAKE_CURRENT_BINARY_DIR}/failbuild/${_dir}/build"
--build-config "${CMAKE_BUILD_TYPE}"
--build-generator "${CMAKE_GENERATOR}"
--build-makeprogram "${make_program}"
--build-project "${_dir}"
--build-options ${option_list}
set(wrapper_file "${CMAKE_CURRENT_BINARY_DIR}/build_and_test_${testname}.cmake")
_qt_internal_create_command_script(
COMMAND ${CMAKE_CTEST_COMMAND}
--build-and-test
"${CMAKE_CURRENT_BINARY_DIR}/failbuild/${_dir}"
"${CMAKE_CURRENT_BINARY_DIR}/failbuild/${_dir}/build"
--build-config "${CMAKE_BUILD_TYPE}"
--build-generator "${CMAKE_GENERATOR}"
--build-makeprogram "${make_program}"
--build-project "${_dir}"
--build-options ${option_list}
COMMAND_ECHO STDOUT
OUTPUT_FILE "${wrapper_file}"
WORKING_DIRECTORY "${build_dir}"
PRE_RUN ${_qt_internal_skip_build_test_pre_run}
)
add_test(${testname} "${CMAKE_COMMAND}" "-P" "${wrapper_file}")
set_tests_properties(${testname} PROPERTIES
SKIP_REGULAR_EXPRESSION "${_qt_internal_skip_build_test_regex}")
unset(__expect_fail_prefixes)
endmacro()
@ -763,14 +806,24 @@ function(_qt_internal_test_module_includes)
set(make_program "${CMAKE_MAKE_PROGRAM}")
endif()
add_test(module_includes ${CMAKE_CTEST_COMMAND}
--build-and-test
"${CMAKE_CURRENT_BINARY_DIR}/module_includes/"
"${CMAKE_CURRENT_BINARY_DIR}/module_includes/build"
--build-config "${CMAKE_BUILD_TYPE}"
--build-generator "${CMAKE_GENERATOR}"
--build-makeprogram "${make_program}"
--build-project module_includes
--build-options ${option_list}
set(wrapper_file "${CMAKE_CURRENT_BINARY_DIR}/build_and_test_module_includes.cmake")
_qt_internal_create_command_script(
COMMAND ${CMAKE_CTEST_COMMAND}
--build-and-test
"${CMAKE_CURRENT_BINARY_DIR}/module_includes/"
"${CMAKE_CURRENT_BINARY_DIR}/module_includes/build"
--build-config "${CMAKE_BUILD_TYPE}"
--build-generator "${CMAKE_GENERATOR}"
--build-makeprogram "${make_program}"
--build-project module_includes
--build-options ${option_list}
COMMAND_ECHO STDOUT
OUTPUT_FILE "${wrapper_file}"
WORKING_DIRECTORY "${build_dir}"
PRE_RUN ${_qt_internal_skip_build_test_pre_run}
)
add_test(module_includes "${CMAKE_COMMAND}" "-P" "${wrapper_file}")
set_tests_properties(module_includes PROPERTIES
SKIP_REGULAR_EXPRESSION "${_qt_internal_skip_build_test_regex}")
endfunction()