CXX-2767 Add macro guards tests for bsoncxx and mongocxx #1043
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
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
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
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
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
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 |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| #[==[ | ||
| Define a build-time static library target whose compilation asserts that | ||
| header files are properly guarding config macros using inclusion of | ||
| prelude/postlude headers. | ||
|
|
||
| Usage: | ||
|
|
||
| add_macro_guard_test( | ||
| PROJECT_NAME <name> | ||
| PROJECT_TEST_PROPERTIES_TARGET <target> | ||
| INCLUDE_PATTERNS [pattern...] | ||
| [EXCLUDE_REGEXES [pattern...]] | ||
| GUARDED_MACROS [macro...] | ||
| ) | ||
|
|
||
| PROJECT_NAME | ||
| Either "bsoncxx" or "mongocxx". | ||
|
|
||
| PROJECT_TEST_PROPERTIES_TARGET | ||
| Either the bsoncxx_test_properties or mongocxx_test_properties target. | ||
|
|
||
| GUARDED_MACROS | ||
| List of macros that should be guarded by prelude/postlude headers. | ||
|
|
||
| INCLUDE_PATTERNS | ||
| List of regex filters for headers to be added to the tests. Must be | ||
| relative to PROJECT_SOURCE_DIR. | ||
|
|
||
| EXCLUDE_REGEXES | ||
| List of regex filters for headers to be excluded. Applied after | ||
| INCLUDE_PATTERNS. | ||
| ]==] | ||
| function(add_macro_guard_test) | ||
| set(opt_args "") | ||
| set(single_args "PROJECT_NAME;PROJECT_TEST_PROPERTIES_TARGET") | ||
| set(multi_args "GUARDED_MACROS;INCLUDE_PATTERNS;EXCLUDE_REGEXES") | ||
|
|
||
| cmake_parse_arguments(PARSED "${opt_args}" "${single_args}" "${multi_args}" ${ARGN}) | ||
|
|
||
| if(NOT "${PARSED_UNPARSED_ARGUMENTS}" STREQUAL "") | ||
| message(FATAL_ERROR "unrecognized argument: ${PARSED_UNPARSED_ARGUMENTS}") | ||
| endif() | ||
|
|
||
| foreach(required_arg PROJECT_NAME PROJECT_TEST_PROPERTIES_TARGET GUARDED_MACROS INCLUDE_PATTERNS) | ||
| if("${required_arg}" IN_LIST PARSED_KEYWORDS_MISSING_VALUES) | ||
| message(FATAL_ERROR "missing value for required argument ${required_arg}") | ||
| endif() | ||
| endforeach() | ||
|
|
||
| list(TRANSFORM PARSED_INCLUDE_PATTERNS PREPEND "${PROJECT_SOURCE_DIR}/") | ||
| file(GLOB_RECURSE GUARDED_HEADERS | ||
| LIST_DIRECTORIES false | ||
| RELATIVE ${PROJECT_SOURCE_DIR} | ||
| ${PARSED_INCLUDE_PATTERNS} | ||
| ) | ||
|
|
||
| foreach(filter ${PARSED_EXCLUDE_REGEXES}) | ||
| list(FILTER GUARDED_HEADERS EXCLUDE REGEX "${filter}") | ||
| endforeach() | ||
|
|
||
| set(MACRO_GUARD_TEST_PRELUDE "") | ||
|
|
||
| # Check and set initial state. | ||
| foreach(macro ${PARSED_GUARDED_MACROS}) | ||
| string(APPEND MACRO_GUARD_TEST_PRELUDE | ||
| "#if defined(${macro})\n" | ||
| "#error \"${macro} is already defined\"\n" | ||
| "#endif\n" | ||
| "#define ${macro} macro guard test\n" | ||
| "\n" | ||
| ) | ||
| endforeach() | ||
|
|
||
| # Implement as recursive algorithm for C++11 compatibility. | ||
| string(APPEND MACRO_GUARD_TEST_PRELUDE | ||
| "static constexpr bool compare_equal(const char* lhs, const char* rhs) {\n" | ||
| " return (*lhs == *rhs) && (*lhs == '\\0' || compare_equal(lhs + 1, rhs + 1));\n" | ||
| "}\n" | ||
| "\n" | ||
| "static_assert(compare_equal(\"abc\", \"abc\"), \"compare_equal() sanity check failed\");\n" | ||
| "static_assert(!compare_equal(\"abc\", \"def\"), \"compare_equal() sanity check failed\");\n" | ||
| "\n" | ||
| "#define _TO_STR(x) #x\n" | ||
| "#define TO_STR(x) _TO_STR(x)\n" | ||
| "\n" | ||
| ) | ||
|
Comment on lines
+75
to
+86
There was a problem hiding this comment. Use a There was a problem hiding this comment. I am preferential towards being consistent with the other quoted arguments that require variable expansions (incompatible with bracket arguments) rather than using a bracket argument that requires unusual indentation to avoid it being reflected in the generated source file: # Check and set initial state.
foreach(macro ${PARSED_GUARDED_MACROS})
string(APPEND MACRO_GUARD_TEST_PRELUDE
"#if defined(${macro})\n"
"#error \"${macro} is already defined\"\n"
"#endif\n"
"#define ${macro} macro guard test\n"
"\n"
)
endforeach()
# Implement as recursive algorithm for C++11 compatibility.
string(APPEND MACRO_GUARD_TEST_PRELUDE [[
static constexpr bool compare_equal(const char* lhs, const char* rhs) {
return (*lhs == *rhs) && (*lhs == '\0' || compare_equal(lhs + 1, rhs + 1));
}
static_assert(compare_equal("abc", "abc"), "compare_equal() sanity check failed");
static_assert(!compare_equal("abc", "def"), "compare_equal() sanity check failed");
#define _TO_STR(x) #x
#define TO_STR(x) _TO_STR(x)
]])Would you rather we still use a bracket argument here? There was a problem hiding this comment. I'll leave it up to you. In such cases I don't usually mind odd indentation in generated sources, and I use |
||
|
|
||
| add_library(test_${PARSED_PROJECT_NAME}_macro_guards STATIC EXCLUDE_FROM_ALL) | ||
| target_link_libraries(test_${PARSED_PROJECT_NAME}_macro_guards PRIVATE ${PARSED_PROJECT_TEST_PROPERTIES_TARGET}) | ||
|
|
||
| # Test each header individually. | ||
| foreach(header ${GUARDED_HEADERS}) | ||
| set(MACRO_GUARD_TEST "${MACRO_GUARD_TEST_PRELUDE}") | ||
|
|
||
| # Strip the subdir. | ||
| string(REGEX REPLACE "^(include|lib|test)/(.*)$" "\\1" subdir "${header}") | ||
| string(REGEX REPLACE "^(include|lib|test)/(.*)$" "\\2" header ${header}) | ||
|
|
||
| # Apply include prefix to test headers. | ||
| if("${subdir}" STREQUAL "test") | ||
| set(relheader "${PARSED_PROJECT_NAME}/test/${header}") | ||
| else() | ||
| set(relheader "${header}") | ||
| endif() | ||
|
|
||
| # CXX-2770: workaround missing postlude header includes. | ||
| string(TOUPPER "${PARSED_PROJECT_NAME}" project_name_upper) | ||
| string(APPEND MACRO_GUARD_TEST "#define ${project_name_upper}_TEST_MACRO_GUARDS_FIX_MISSING_POSTLUDE\n\n") | ||
|
|
||
| # The include directive. | ||
| string(APPEND MACRO_GUARD_TEST "#include <${relheader}>\n\n") | ||
|
|
||
| # Test all guarded macros have been properly restored. | ||
| foreach(macro ${PARSED_GUARDED_MACROS}) | ||
| string(APPEND MACRO_GUARD_TEST | ||
| "static_assert(\n" | ||
| " compare_equal(TO_STR(${macro}),\"macro guard test\"),\n" | ||
| " \"${macro} was not correctly restored by <${relheader}>\"\n" | ||
| ");\n" | ||
| "\n" | ||
| ) | ||
| endforeach() | ||
|
|
||
| # e.g. bsoncxx/v_noabi/bsoncxx/document/view.hpp -> bsoncxx-v_noabi-bsoncxx-document-view.cpp | ||
| string(REPLACE "/" "-" test_name "${header}") | ||
| string(REGEX REPLACE "^(.*)\\.(hh|hpp)$" "\\1" test_name "${test_name}") | ||
|
|
||
| # e.g. macro_guards/(include|lib|test)/bsoncxx-v_noabi-bsoncxx-document-view.cpp | ||
| configure_file(test_macro_guards.cpp.in macro_guards/${subdir}/${test_name}.cpp) | ||
|
|
||
| target_sources(test_${PARSED_PROJECT_NAME}_macro_guards PRIVATE | ||
| ${CMAKE_CURRENT_BINARY_DIR}/macro_guards/${subdir}/${test_name}.cpp | ||
| ) | ||
| endforeach() | ||
| endfunction() | ||
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
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
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
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
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
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
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.