-
Notifications
You must be signed in to change notification settings - Fork 2
Use CMLIB validated TEST.cmake and test_var.cmake #13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,7 +10,7 @@ on: | |
| workflow_dispatch: | ||
|
|
||
| env: | ||
| CMLIB_VERSION: 1.1.0 | ||
| CMLIB_VERSION: 1.2.0 | ||
|
|
||
| jobs: | ||
| examples-linux: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,7 +10,7 @@ on: | |
| workflow_dispatch: | ||
|
|
||
| env: | ||
| CMLIB_VERSION: 1.1.0 | ||
| CMLIB_VERSION: 1.2.0 | ||
|
|
||
| jobs: | ||
| test_linux: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,253 +1,12 @@ | ||
| ## Main | ||
| # | ||
| # Test macros for CMDEF tests | ||
| # | ||
|
|
||
| # Find CMLIB package which provides CMLIB_PARSE_ARGUMENTS | ||
| FIND_PACKAGE(CMLIB REQUIRED) | ||
|
|
||
| # | ||
| # var - varialbe name of value | ||
| # | ||
| MACRO(TEST_VAR_DEFINED var) | ||
| IF(NOT DEFINED ${var}) | ||
| MESSAGE(FATAL_ERROR "Variable ${var} is not defined") | ||
| ENDIF() | ||
| ENDMACRO() | ||
|
|
||
| # | ||
| # var - varialbe name of value | ||
| # | ||
| MACRO(TEST_VAR_NOT_DEFINED var) | ||
| IF(DEFINED ${var}) | ||
| MESSAGE(FATAL_ERROR "Variable ${var} is defined") | ||
| ENDIF() | ||
| ENDMACRO() | ||
|
|
||
| # | ||
| # var - varialbe name of value | ||
| # | ||
| MACRO(TEST_VAR_TRUE var) | ||
| IF(NOT ${var}) | ||
| MESSAGE(FATAL_ERROR "var '${var}' is not true") | ||
| ENDIF() | ||
| ENDMACRO() | ||
|
|
||
| # | ||
| # var - varialbe name of first value | ||
| # | ||
| MACRO(TEST_VAR_FALSE var) | ||
| IF(${var}) | ||
| MESSAGE(FATAL_ERROR "var '${var}' is not false") | ||
| ENDIF() | ||
| ENDMACRO() | ||
|
|
||
| # | ||
| # var_a - varialbe name of first value | ||
| # var_b - varialbe name of second value | ||
| # | ||
| MACRO(TEST_VAR_EQUAL var_a var_b) | ||
| IF(NOT ("${${var_a}}" STREQUAL "${${var_b}}")) | ||
| MESSAGE(FATAL_ERROR "Variable ${var_a}(${${var_a}}) is not equal to ${var_b}(${${var_b}})") | ||
| ENDIF() | ||
| ENDMACRO() | ||
|
|
||
| # | ||
| # var_a - varialbe name of first value | ||
| # var_b - varialbe name of second value | ||
| # | ||
| MACRO(TEST_VAR_NOT_EQUAL var_a var_b) | ||
| IF(("${${var_a}}" STREQUAL "${${var_b}}")) | ||
| MESSAGE(FATAL_ERROR "Variable ${var_a}(${${var_a}}) is not equal to ${var_b}(${${var_b}})") | ||
| ENDIF() | ||
| ENDMACRO() | ||
|
|
||
| # | ||
| # var - variable name to check | ||
| # expected_value - expected value to compare against | ||
| # | ||
| MACRO(TEST_VAR_VALUE_EQUAL var expected_value) | ||
| TEST_VAR_DEFINED(${var}) | ||
| IF(NOT "${${var}}" STREQUAL "${expected_value}") | ||
| MESSAGE(FATAL_ERROR "Variable ${var} should be '${expected_value}' but is '${${var}}'") | ||
| ENDIF() | ||
| ENDMACRO() | ||
|
|
||
| # | ||
| # test - Path to the test directory containing a CMakeLists.txt file | ||
| # | ||
| # Runs a test by executing its CMakeLists.txt file. In script mode, runs the file directly. | ||
| # In normal mode, creates a build directory and configures the test there. | ||
| # Fails with a detailed error message if the test fails. | ||
| # | ||
| FUNCTION(TEST_RUN test) | ||
| MESSAGE(STATUS "TEST ${test}") | ||
| SET(result_variable 0) | ||
| SET(error_variable "") | ||
| FILE(TO_CMAKE_PATH "${test}" working_dir) | ||
| IF(NOT IS_ABSOLUTE "${working_dir}") | ||
| SET(working_dir "${CMAKE_CURRENT_LIST_DIR}/${working_dir}") | ||
| ENDIF() | ||
| IF(NOT EXISTS "${working_dir}") | ||
| MESSAGE(FATAL_ERROR "test does not exist: ${working_dir}") | ||
| ENDIF() | ||
|
|
||
| IF(DEFINED CMAKE_SCRIPT_MODE_FILE) | ||
| EXECUTE_PROCESS( | ||
| COMMAND "${CMAKE_COMMAND}" -P "${working_dir}/CMakeLists.txt" | ||
| WORKING_DIRECTORY "${working_dir}" | ||
| RESULT_VARIABLE result_variable | ||
| ERROR_VARIABLE error_variable | ||
| OUTPUT_VARIABLE output_variable | ||
| ) | ||
| ELSE() | ||
| EXECUTE_PROCESS( | ||
| COMMAND "${CMAKE_COMMAND}" -E make_directory "${working_dir}/build" | ||
| RESULT_VARIABLE mkdir_result | ||
| ) | ||
| IF(NOT mkdir_result EQUAL 0) | ||
| MESSAGE(FATAL_ERROR "Failed to create build directory for test: ${test}") | ||
| ENDIF() | ||
|
|
||
| EXECUTE_PROCESS( | ||
| COMMAND "${CMAKE_COMMAND}" "${working_dir}" | ||
| WORKING_DIRECTORY "${working_dir}/build" | ||
| RESULT_VARIABLE result_variable | ||
| ERROR_VARIABLE error_variable | ||
| OUTPUT_VARIABLE output_variable | ||
| ) | ||
| ENDIF() | ||
|
|
||
| IF(result_variable GREATER 0) | ||
| MESSAGE(FATAL_ERROR "Test '${test}' failed with '${result_variable}'\nError: ${error_variable}\nOutput: ${output_variable}") | ||
| ENDIF() | ||
| ENDFUNCTION() | ||
|
|
||
| # | ||
| # Function to run a test and check its output | ||
| # Usage: | ||
| # <function>(<test> | ||
| # WARNING_MESSAGE <wrn_message_str> # Check warning in stdout | ||
| # FATAL_ERROR_MESSAGE <fatal_message_str> # Check fatal error in stderr | ||
| # ) | ||
| FUNCTION(TEST_RUN_AND_CHECK_OUTPUT test_name) | ||
| MESSAGE(STATUS "TEST FAIL ${test_name}") | ||
| CMLIB_PARSE_ARGUMENTS( | ||
| PREFIX TEST_RUN | ||
| ONE_VALUE WARNING_MESSAGE WARNING_ERROR_MESSAGE FATAL_ERROR_MESSAGE | ||
| P_ARGN ${ARGN} | ||
| ) | ||
| GET_FILENAME_COMPONENT(_file_name "${test_name}" NAME) | ||
| GET_FILENAME_COMPONENT(_dir_name "${test_name}" DIRECTORY) | ||
| IF(_dir_name STREQUAL _file_name) | ||
| MESSAGE(FATAL_ERROR "Only name of the test could be there!") | ||
| ENDIF() | ||
|
|
||
| SET(working_dir "${CMAKE_CURRENT_LIST_DIR}") | ||
| FILE(MAKE_DIRECTORY "${working_dir}/build") | ||
| EXECUTE_PROCESS( | ||
| COMMAND ${CMAKE_COMMAND} "../${test_name}" | ||
| WORKING_DIRECTORY "${working_dir}/build" | ||
| OUTPUT_VARIABLE output | ||
| ERROR_VARIABLE error | ||
| RESULT_VARIABLE result | ||
| ) | ||
| FILE(REMOVE_RECURSE "${working_dir}/build") | ||
|
|
||
| IF(DEFINED TEST_RUN_WARNING_MESSAGE) | ||
| IF(NOT error MATCHES "${TEST_RUN_WARNING_MESSAGE}") | ||
| MESSAGE(FATAL_ERROR "Expected WARNING message not found in output: ${TEST_RUN_WARNING_MESSAGE}") | ||
| ENDIF() | ||
|
|
||
| IF(NOT result EQUAL 0) | ||
| MESSAGE(FATAL_ERROR "Expected process to succeed but it failed") | ||
| ENDIF() | ||
| ENDIF() | ||
|
|
||
| IF(DEFINED TEST_RUN_FATAL_ERROR_MESSAGE) | ||
| IF(NOT error MATCHES "${TEST_RUN_FATAL_ERROR_MESSAGE}") | ||
| MESSAGE(FATAL_ERROR "Expected FATAL_ERROR message not found in output: ${TEST_RUN_FATAL_ERROR_MESSAGE}") | ||
| ENDIF() | ||
|
|
||
| IF(result EQUAL 0) | ||
| MESSAGE(FATAL_ERROR "Expected process to fail but it succeeded") | ||
| ENDIF() | ||
| ENDIF() | ||
| ENDFUNCTION() | ||
|
|
||
|
|
||
| ## | ||
| # Verify target has specific property set. | ||
| # | ||
| # Checks that a target has the specified property defined (not empty/unset). | ||
| # This is used to verify property dependencies in CMDEF_INSTALL. | ||
| # TEST.cmake are shared with CMLIB to avoid unnecesssary dependencies. | ||
| # TESTS.cmake is properly validated. | ||
| # | ||
| # <macro>( | ||
| # <target> // Target name to check | ||
| # <property> // Property name that should be set | ||
| # ) | ||
| # | ||
| MACRO(TEST_CHECK_TARGET_HAS_PROPERTY target property) | ||
| GET_TARGET_PROPERTY(prop_value ${target} ${property}) | ||
| IF(NOT prop_value) | ||
| MESSAGE(FATAL_ERROR "Target ${target} should have property ${property} set but it is not set or empty") | ||
| ENDIF() | ||
| ENDMACRO() | ||
|
|
||
| FIND_PACKAGE(CMLIB) | ||
|
|
||
| ## | ||
| # Verify target does NOT have specific property set. | ||
| # | ||
| # Checks that a target does not have the specified property defined or it is empty. | ||
| # This is used to verify conditional behavior in CMDEF_INSTALL. | ||
| # | ||
| # <macro>( | ||
| # <target> // Target name to check | ||
| # <property> // Property name that should NOT be set | ||
| # ) | ||
| # | ||
| MACRO(TEST_CHECK_TARGET_LACKS_PROPERTY target property) | ||
| GET_TARGET_PROPERTY(prop_value ${target} ${property}) | ||
| IF(prop_value) | ||
| MESSAGE(FATAL_ERROR "Target ${target} should NOT have property ${property} set but it is set to: ${prop_value}") | ||
| ENDIF() | ||
| ENDMACRO() | ||
|
|
||
|
|
||
| ## | ||
| # Verify target property has exact expected value. | ||
| # | ||
| # Checks that a target's property matches the expected value exactly using string comparison. | ||
| # This is used for precise property validation in CMDEF tests. | ||
| # | ||
| # <function>( | ||
| # <target> // Target name to check | ||
| # <property> // Property name to verify | ||
| # <expected_value> // Exact value the property should have | ||
| # ) | ||
| # | ||
| FUNCTION(TEST_CHECK_TARGET_PROPERTY target property expected_value) | ||
| GET_PROPERTY(actual_value TARGET ${target} PROPERTY ${property}) | ||
| IF(NOT actual_value STREQUAL "${expected_value}") | ||
| MESSAGE(FATAL_ERROR "${property} property is not set correctly for target ${target}. Expected '${expected_value}', got '${actual_value}'") | ||
| ENDIF() | ||
| ENDFUNCTION() | ||
| IF(NOT EXISTS "${CMLIB_DIR}") | ||
| MESSAGE(FATAL_ERROR "Cannot find CMLIB_DIR '${CMLIB_DIR}'") | ||
| ENDIF() | ||
|
|
||
| ## | ||
| # Verify target property contains expected pattern. | ||
| # | ||
| # Checks that a target's property contains the expected pattern using regex matching. | ||
| # This is used for flexible property validation when exact matching is not required. | ||
| # | ||
| # <function>( | ||
| # <target> // Target name to check | ||
| # <property> // Property name to verify | ||
| # <expected_value> // Pattern/regex that the property should contain | ||
| # ) | ||
| # | ||
| FUNCTION(TEST_CHECK_TARGET_PROPERTY_CONTAINS target property expected_value) | ||
| GET_PROPERTY(actual_value TARGET ${target} PROPERTY ${property}) | ||
| IF(NOT actual_value MATCHES "${expected_value}") | ||
| MESSAGE(FATAL_ERROR "${property} property is not set correctly for target ${target}. Expected to contain '${expected_value}', got '${actual_value}'") | ||
| ENDIF() | ||
| ENDFUNCTION() | ||
| INCLUDE("${CMLIB_DIR}/test/TEST.cmake") | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,79 +1,12 @@ | ||
| ## | ||
| # Cache Variable Management Functions for CMDEF Tests | ||
| # | ||
| # This file provides utilities for safely manipulating CMake cache variables | ||
| # in test environments with proper backup and restoration capabilities. | ||
| # cache_var.cmake are shared with CMLIB to avoid unnecesssary dependencies. | ||
| # cache_var.cmake is properly validated. | ||
| # | ||
|
|
||
| ## | ||
| # Force set a cache variable and store original value for restoration. | ||
| # | ||
| # Stores the current cache variable value (if exists) in a global property | ||
| # and then force sets the cache variable to the new value. The original | ||
| # state can be restored later using CACHE_VAR_RESTORE. | ||
| # | ||
| # <function>(var_name, value) | ||
| # | ||
| FUNCTION(CACHE_VAR_FORCE_SET var_name value) | ||
| GET_PROPERTY(was_defined CACHE ${var_name} PROPERTY VALUE SET) | ||
| SET_PROPERTY(GLOBAL PROPERTY CACHE_VAR_WAS_DEFINED_${var_name} ${was_defined}) | ||
|
|
||
| IF(was_defined) | ||
| GET_PROPERTY(original_value CACHE ${var_name} PROPERTY VALUE) | ||
| SET_PROPERTY(GLOBAL PROPERTY CACHE_VAR_ORIGINAL_${var_name} "${original_value}") | ||
| ENDIF() | ||
|
|
||
| SET(${var_name} "${value}" CACHE STRING "Test override" FORCE) | ||
| ENDFUNCTION() | ||
| FIND_PACKAGE(CMLIB REQUIRED) | ||
|
|
||
| ## | ||
| # Unset a cache variable and store original value for restoration. | ||
| # | ||
| # Stores the current cache variable value (if exists) in a global property | ||
| # and then unsets the cache variable. The original state can be restored | ||
| # later using CACHE_VAR_RESTORE. | ||
| # | ||
| # Note: This function only handles cache variables, not normal variables. | ||
| # | ||
| # <function>(var_name) | ||
| # | ||
| FUNCTION(CACHE_VAR_FORCE_UNSET var_name) | ||
| GET_PROPERTY(was_defined CACHE ${var_name} PROPERTY VALUE SET) | ||
| SET_PROPERTY(GLOBAL PROPERTY CACHE_VAR_WAS_DEFINED_${var_name} ${was_defined}) | ||
|
|
||
| IF(was_defined) | ||
| GET_PROPERTY(original_value CACHE ${var_name} PROPERTY VALUE) | ||
| SET_PROPERTY(GLOBAL PROPERTY CACHE_VAR_ORIGINAL_${var_name} "${original_value}") | ||
| ENDIF() | ||
|
|
||
| UNSET(${var_name} CACHE) | ||
| ENDFUNCTION() | ||
| IF(NOT EXISTS "${CMLIB_DIR}") | ||
| MESSAGE(FATAL_ERROR "Cannot find CMLIB_DIR '${CMLIB_DIR}'") | ||
| ENDIF() | ||
|
|
||
| ## | ||
| # Restore a cache variable to its original state. | ||
| # | ||
| # Restores a cache variable that was previously modified using | ||
| # CACHE_VAR_FORCE_SET or CACHE_VAR_FORCE_UNSET to its original state. | ||
| # Cleans up the global properties used for storage. | ||
| # | ||
| # <function>(var_name) | ||
| # | ||
| FUNCTION(CACHE_VAR_RESTORE var_name) | ||
| GET_PROPERTY(was_defined GLOBAL PROPERTY CACHE_VAR_WAS_DEFINED_${var_name} SET) | ||
| IF(NOT was_defined) | ||
| MESSAGE(FATAL_ERROR "No stored information found for cache variable '${var_name}'. Cannot restore.") | ||
| RETURN() | ||
| ENDIF() | ||
|
|
||
| GET_PROPERTY(originally_defined GLOBAL PROPERTY CACHE_VAR_WAS_DEFINED_${var_name}) | ||
|
|
||
| IF(originally_defined) | ||
| GET_PROPERTY(original_value GLOBAL PROPERTY CACHE_VAR_ORIGINAL_${var_name}) | ||
| SET(${var_name} "${original_value}" CACHE STRING "Restored after test" FORCE) | ||
| ELSE() | ||
| UNSET(${var_name} CACHE) | ||
| ENDIF() | ||
|
|
||
| SET_PROPERTY(GLOBAL PROPERTY CACHE_VAR_WAS_DEFINED_${var_name}) | ||
| SET_PROPERTY(GLOBAL PROPERTY CACHE_VAR_ORIGINAL_${var_name}) | ||
| ENDFUNCTION() | ||
| INCLUDE("${CMLIB_DIR}/test/cache_var.cmake") |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.