[vcpkg_cmake_config_test] Add function to test the exported cmake configurations

docs/maintainers/portfile-functions.md

@@ -76,6 +76,7 @@
 ### [vcpkg-cmake-config](ports/vcpkg-cmake-config.md)
 
 - [vcpkg\_cmake\_config\_fixup](ports/vcpkg-cmake-config/vcpkg_cmake_config_fixup.md)
+- [vcpkg\_cmake\_config\_test](ports/vcpkg-cmake-config/vcpkg_cmake_config_test.md)
 
 ### [vcpkg-pkgconfig-get-modules](ports/vcpkg-pkgconfig-get-modules.md)
 

docs/maintainers/ports/vcpkg-cmake-config.md

@@ -1,10 +1,15 @@
 # vcpkg-cmake-config
 
-`vcpkg-cmake-config` provides `vcpkg_cmake_config_fixup()`,
-a function which both:
+`vcpkg-cmake-config` provides `vcpkg_cmake_config_fixup()` and `vcpkg_cmake_config_test()`.
+The first function:
 
 - Fixes common mistakes in port build systems, like using absolute paths
 - Merges the debug and release config files.
 
 This function should almost always be used when a port has `*config.cmake` files,
 even when the buildsystem of the project is not CMake.
+
+The latter function tests the generated cmake config files;
+in general, any port that generates `*[Cc]onfig.cmake` should call this
+function to check whether the generated configuration is correct,
+after calling `vcpkg_cmake_config_fixup()`.

docs/maintainers/ports/vcpkg-cmake-config/vcpkg_cmake_config_test.md

@@ -0,0 +1,40 @@
+# vcpkg_cmake_config_test
+
+The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/ports/vcpkg-cmake-config/vcpkg_cmake_config_test.md).
+
+Automatically test the correctness of the configuration file exported by cmake
+
+```cmake
+vcpkg_cmake_config_test(
+    [TARGET_NAME <PORT_NAME>]
+    [TARGET_VARS <TARGETS>...]
+    [HEADERS <headername.h>...]
+    [FUNCTIONS <function1> ...]
+)
+```
+
+For most ports, `vcpkg_cmake_config_test` should work without passing any options,
+`vcpkg_cmake_config_test` will automatically detect the targets declared in the generated
+cmake configuration file which are used in `find_package`, and set the targets to `TARGET_NAME`.
+
+`TARGET_VARS` should use the target name in `target_link_libraries` and support namespace.
+
+For more advanced usage, `vcpkg_cmake_config_test` supports the use of reserved c/c++ code for testing.
+Please encapsulate the test code as one or more functions and save them to `vcpkg_test.c` or `vcpkg_test.cpp`,
+and pass the name of the system header file that needs to be included into the `HEADERS`.
+
+And, please use option `FUNCTIONS` to pass these test function names into `vcpkg_cmake_config_test`.
+
+More, you can implement the test cmake code by yourself to add additional compilation options
+or cmake options by writing them into `vcpkg_test.cmake`.
+
+Please note that `vcpkg_test.cmake` / `vcpkg_test.c` / `vcpkg_test.cpp` must be placed in the same directory
+as `portfile.cmake`.
+
+## Examples
+
+* [curl](https://github.com/Microsoft/vcpkg/blob/master/ports/curl/portfile.cmake)
+* [ptex](https://github.com/Microsoft/vcpkg/blob/master/ports/ptex/portfile.cmake)
+
+## Source
+[ports/vcpkg-cmake-config/vcpkg\_cmake\_config\_test.cmake](https://github.com/Microsoft/vcpkg/blob/master/ports/vcpkg-cmake-config/vcpkg_cmake_config_test.cmake)

ports/curl/portfile.cmake

@@ -140,5 +140,10 @@ if(EXISTS "${CURRENT_PACKAGES_DIR}/debug/lib/pkgconfig/libcurl.pc")
     vcpkg_replace_string("${CURRENT_PACKAGES_DIR}/debug/lib/pkgconfig/libcurl.pc" " -lcurl" " -lcurl-d")
 endif()
 
+vcpkg_cmake_config_test(
+    HEADERS     curl/curl.h
+    FUNCTIONS   curl_global_init
+)
+
 file(INSTALL "${CURRENT_PORT_DIR}/vcpkg-cmake-wrapper.cmake" DESTINATION "${CURRENT_PACKAGES_DIR}/share/${PORT}")
 file(INSTALL "${SOURCE_PATH}/COPYING" DESTINATION "${CURRENT_PACKAGES_DIR}/share/${PORT}" RENAME copyright)

ports/curl/vcpkg.json

@@ -1,6 +1,7 @@
 {
   "name": "curl",
   "version": "7.79.1",
+  "port-version": 1,
   "description": "A library for transferring data with URLs",
   "homepage": "https://github.com/curl/curl",
   "dependencies": [

ports/ptex/portfile.cmake

@@ -34,6 +34,8 @@ vcpkg_cmake_install()
 vcpkg_cmake_config_fixup(CONFIG_PATH share/cmake/Ptex)
 vcpkg_copy_pdbs()
 
+vcpkg_cmake_config_test()
+
 foreach(HEADER PtexHalf.h Ptexture.h)
     file(READ "${CURRENT_PACKAGES_DIR}/include/${HEADER}" PTEX_HEADER)
     if(VCPKG_LIBRARY_LINKAGE STREQUAL dynamic)

ports/ptex/vcpkg.json

@@ -1,7 +1,7 @@
 {
   "name": "ptex",
   "version": "2.3.2",
-  "port-version": 3,
+  "port-version": 4,
   "description": "Per-Face Texture Mapping for Production Rendering.",
   "homepage": "https://github.com/wdas/ptex",
   "supports": "!uwp",

ports/vcpkg-cmake-config/README.md

@@ -1,10 +1,15 @@
 # vcpkg-cmake-config
 
-`vcpkg-cmake-config` provides `vcpkg_cmake_config_fixup()`,
-a function which both:
+`vcpkg-cmake-config` provides `vcpkg_cmake_config_fixup()` and `vcpkg_cmake_config_test()`.
+The first function:
 
 - Fixes common mistakes in port build systems, like using absolute paths
 - Merges the debug and release config files.
 
 This function should almost always be used when a port has `*config.cmake` files,
 even when the buildsystem of the project is not CMake.
+
+The latter function tests the generated cmake config files;
+in general, any port that generates `*[Cc]onfig.cmake` should call this
+function to check whether the generated configuration is correct,
+after calling `vcpkg_cmake_config_fixup()`.

ports/vcpkg-cmake-config/portfile.cmake

@@ -5,6 +5,7 @@ endif()
 
 file(INSTALL
     "${CMAKE_CURRENT_LIST_DIR}/vcpkg_cmake_config_fixup.cmake"
+    "${CMAKE_CURRENT_LIST_DIR}/vcpkg_cmake_config_test.cmake"
     "${CMAKE_CURRENT_LIST_DIR}/vcpkg-port-config.cmake"
     "${CMAKE_CURRENT_LIST_DIR}/copyright"
     DESTINATION "${CURRENT_PACKAGES_DIR}/share/${PORT}")

ports/vcpkg-cmake-config/vcpkg-port-config.cmake

@@ -1 +1,2 @@
 include("${CMAKE_CURRENT_LIST_DIR}/vcpkg_cmake_config_fixup.cmake")
+include("${CMAKE_CURRENT_LIST_DIR}/vcpkg_cmake_config_test.cmake")

ports/vcpkg-cmake-config/vcpkg.json

@@ -1,4 +1,4 @@
 {
   "name": "vcpkg-cmake-config",
-  "version-date": "2021-09-27"
+  "version-date": "2021-10-19"
 }

ports/vcpkg-cmake-config/vcpkg_cmake_config_test.cmake

@@ -0,0 +1,223 @@
+#[===[.md:
+# vcpkg_cmake_config_test
+
+Automatically test the correctness of the configuration file exported by cmake
+
+```cmake
+vcpkg_cmake_config_test(
+    [TARGET_NAME <PORT_NAME>]
+    [TARGET_VARS <TARGETS>...]
+    [HEADERS <headername.h>...]
+    [FUNCTIONS <function1> ...]
+)
+```
+
+For most ports, `vcpkg_cmake_config_test` should work without passing any options,
+`vcpkg_cmake_config_test` will automatically detect the targets declared in the generated
+cmake configuration file which are used in `find_package`, and set the targets to `TARGET_NAME`.
+
+`TARGET_VARS` should use the target name in `target_link_libraries` and support namespace.
+
+For more advanced usage, `vcpkg_cmake_config_test` supports the use of reserved c/c++ code for testing.
+Please encapsulate the test code as one or more functions and save them to `vcpkg_test.c` or `vcpkg_test.cpp`,
+and pass the name of the system header file that needs to be included into the `HEADERS`.
+
+And, please use option `FUNCTIONS` to pass these test function names into `vcpkg_cmake_config_test`.
+
+More, you can implement the test cmake code by yourself to add additional compilation options
+or cmake options by writing them into `vcpkg_test.cmake`.
+
+Please note that `vcpkg_test.cmake` / `vcpkg_test.c` / `vcpkg_test.cpp` must be placed in the same directory
+as `portfile.cmake`.
+
+## Examples
+
+* [curl](https://github.com/Microsoft/vcpkg/blob/master/ports/curl/portfile.cmake)
+* [ptex](https://github.com/Microsoft/vcpkg/blob/master/ports/ptex/portfile.cmake)
+#]===]
+
+macro(z_get_cmake_targets)
+    set(target_names )
+    set(target_folders )
+
+    file(GLOB_RECURSE cmake_files "${CURRENT_PACKAGES_DIR}/*/*.cmake")
+    foreach(cmake_file IN ITEMS cmake_files)
+        get_filename_component(target_folder ${cmake_file} DIRECTORY)
+        get_filename_component(target_folder ${target_folder} NAME)
+        vcpkg_list(APPEND target_folders "${target_folder}")
+        file(READ "${cmake_file}" CMAKE_CONTENT)
+        string(REGEX MATCH "add_library.([^\ ]+)\ " target_name "${CMAKE_CONTENT}")
+        string(REPLACE "add_library(" "" target_name "${target_name}")
+        string(REPLACE " " "" target_name "${target_name}")
+        if (NOT target_name)
+            continue()
+        endif()
+        list(APPEND target_names ${target_name})
+        debug_message("target_name: ${target_name}")
+    endforeach()
+    unset(target_name)
+    vcpkg_list(REMOVE_DUPLICATES target_names)
+    vcpkg_list(REMOVE_DUPLICATES target_folders)
+
+    list(LENGTH target_names target_size)
+    list(LENGTH target_folders folder_size)
+
+    if (target_size EQUAL 0 OR folder_size EQUAL 0)
+        return()
+    endif()
+
+    if (NOT folder_size EQUAL 1 AND NOT arg_TARGET_NAME)
+        message(FATAL_ERROR "More than one folder contains cmake configuration files, please set \"target_name\" to select the certain target name")
+    endif()
+
+    #set(target_names ${target_names} PARENT_SCOPE)
+    #set(target_folder ${target_folders} PARENT_SCOPE)
+endmacro()
+
+macro(z_write_sample_code current_target)
+    set(test_dir "${CURRENT_BUILDTREES_DIR}/test_cmake")
+    file(REMOVE_RECURSE "${test_dir}")
+    file(MAKE_DIRECTORY "${test_dir}")
+
+    # c/cxx test file
+    if (EXISTS "${CURRENT_PORT_DIR}/vcpkg_test.c")
+        set(test_source cmake_test.c)
+        configure_file("${CURRENT_PORT_DIR}/vcpkg_test.c" "${test_dir}/cmake_test.c" COPYONLY)
+    elseif (EXISTS "${CURRENT_PORT_DIR}/vcpkg_test.cpp")
+        set(test_source cmake_test.cpp)
+        configure_file("${CURRENT_PORT_DIR}/vcpkg_test.c" "${test_dir}/cmake_test.cpp" COPYONLY)
+    else()
+        set(src_content
+[[
+#include <stdio.h>
+@extern_header_checks@
+@extern_symbol_checks_base@
+int main(void)
+{@extern_symbol_check_symbol@}
+]]
+        )
+
+        file(WRITE "${test_dir}/cmake_test.cpp.in" "${src_content}")
+        configure_file("${test_dir}/cmake_test.cpp.in" "${test_dir}/cmake_test.cpp" @ONLY)
+        set(test_source cmake_test.cpp)
+    endif()
+
+    # CMakeLists.txt
+    if (EXISTS "${CURRENT_PORT_DIR}/vcpkg_test.cmake")
+        configure_file("${CURRENT_PORT_DIR}/vcpkg_test.cmake" "${test_dir}/CMakeLists.txt" COPYONLY)
+    else()
+        set(CMAKE_LISTS_CONTENT
+[[
+cmake_minimum_required (VERSION 3.19)
+project (cmake_test)
+
+find_package(@target_folder@ CONFIG REQUIRED)
+
+add_executable(cmake_test @test_source@)
+
+target_link_libraries(cmake_test PRIVATE @current_target@)
+]]
+    )
+
+        set(current_target ${current_target})
+        file(WRITE "${test_dir}/CMakeLists.txt.in" "${CMAKE_LISTS_CONTENT}")
+        configure_file("${test_dir}/CMakeLists.txt.in" "${test_dir}/CMakeLists.txt" @ONLY)
+    endif()
+endmacro()
+
+macro(z_build_with_toolchain)
+    foreach(build_type IN ITEMS "Debug" "Release")
+        set(config_cmd ${CMAKE_COMMAND} -G Ninja
+            -DCMAKE_BUILD_TYPE=${build_type}
+            -DCMAKE_PREFIX_PATH="${CURRENT_PACKAGES_DIR}/share/${target_folder}"
+            -DCMAKE_SOURCE_DIR="${test_dir}"
+            -DCMAKE_BINARY_DIR="${test_dir}"
+            -DCMAKE_TOOLCHAIN_FILE="${VCPKG_ROOT_DIR}/scripts/buildsystems/vcpkg.cmake"
+            -DVCPKG_TARGET_TRIPLET=${TARGET_TRIPLET}
+        )
+        set(build_cmd "${CMAKE_COMMAND} --build . --config ${build_type} -- -v")
+
+        execute_process(
+            COMMAND "${config_cmd}"
+            WORKING_DIRECTORY "${test_dir}"
+            RESULT_VARIABLE error_code
+            OUTPUT_FILE "${CURRENT_BUILDTREES_DIR}/config-test-cmake-out.log"
+            ERROR_FILE "${CURRENT_BUILDTREES_DIR}/config-test-cmake-err.log"
+        )
+
+        if (error_code)
+            message(FATAL_ERROR
+                "Test cmake configuration failed, please check cmake configuration file!"
+                "See log: ${CURRENT_BUILDTREES_DIR}/config-test-cmake-err.log"
+            )
+        endif()
+
+        execute_process(
+            COMMAND "${build_cmd}"
+            WORKING_DIRECTORY "${test_dir}"
+            RESULT_VARIABLE error_code
+            OUTPUT_FILE "${CURRENT_BUILDTREES_DIR}/build-test-cmake-out.log"
+            ERROR_FILE "${CURRENT_BUILDTREES_DIR}/build-test-cmake-err.log"
+        )
+
+        if (error_code)
+            message(FATAL_ERROR
+                "Test cmake configuration failed, please check cmake configuration file!"
+                "See log: ${CURRENT_BUILDTREES_DIR}/config-test-cmake-err.log"
+            )
+        endif()
+    endforeach()
+endmacro()
+
+function(vcpkg_cmake_config_test)
+    if (NOT _VCPKG_EDITABLE)
+        # Skip cmake test
+        return()
+    endif()
+
+    cmake_parse_arguments(PARSE_ARGV 0 arg "" "TARGET_NAME" "TARGET_VARS;HEADERS;FUNCTIONS")
+    # First, we should get the cmake targets automanticlly
+    if ((arg_TARGET_NAME AND NOT arg_TARGET_VARS) OR (NOT arg_TARGET_NAME AND arg_TARGET_VARS))
+        message(FATAL_ERROR "TARGET_NAME and TARGET_VARS must be declared at same time!")
+    endif()
+
+    if (NOT arg_TARGET_NAME)
+        z_get_cmake_targets()
+    endif()
+
+    if (arg_TARGET_NAME)
+        set(target_folder "${arg_TARGET_NAME}")
+        set(target_names ${arg_TARGET_VARS})
+    elseif (NOT target_folder OR NOT target_names)
+        # Skip cmake test because the cmake configuration is not exported
+        message(STATUS "Could not find the cmake configuration file, skip test the cmake configuration.")
+        return()
+    endif()
+
+
+    set(extern_header_checks )
+    set(extern_symbol_checks_base )
+    set(extern_symbol_check_symbol )
+    if (arg_HEADERS)
+        foreach(header IN LISTS arg_HEADERS)
+            string(APPEND extern_header_checks ${extern_header_checks} "#include <${header}>\n")
+        endforeach()
+    endif()
+
+    if (arg_FUNCTIONS)
+        set(extern_symbol_checks_base "typedef int (*symbol_func)(void);\n\n")
+        foreach(symbol ${arg_FUNCTIONS})
+            set(extern_symbol_check_symbol "symbol_func func = (symbol_func)&${symbol};\nreturn func();\n")
+        endforeach()
+    endif()
+
+    foreach(target_name IN LISTS target_names)
+        # Write a sample CMakeLists.txt and source file
+        z_write_sample_code(${target_name})
+        # Build
+        z_build_with_toolchain()
+    endforeach()
+    unset(extern_symbol_check_symbol)
+    unset(extern_symbol_checks_base)
+    unset(extern_header_checks)
+endfunction()

versions/baseline.json

@@ -1678,7 +1678,7 @@
     },
     "curl": {
       "baseline": "7.79.1",
-      "port-version": 0
+      "port-version": 1
     },
     "curlpp": {
       "baseline": "2018-06-15",
@@ -5334,7 +5334,7 @@
     },
     "ptex": {
       "baseline": "2.3.2",
-      "port-version": 3
+      "port-version": 4
     },
     "pthread": {
       "baseline": "3.0.0",
@@ -6949,7 +6949,7 @@
       "port-version": 0
     },
     "vcpkg-cmake-config": {
-      "baseline": "2021-09-27",
+      "baseline": "2021-10-19",
       "port-version": 0
     },
     "vcpkg-gfortran": {