build: Improve googletest handling

Behavior is largely unchanged except that specifying BUILD_TESTS=ON
with googletest not present no longer quietly skips building the tests.

- Make inclusion of external directory unconditional.  We may someday
  put something there is not related to testing.
- Make default for BUILD_TEST dependent on googletest presence.
- Remove if() around entire contents of tests CMake file.
- Add CMake messaging to clarify googletest activity.
- Throw a CMake error if googletest not present and BUILD_TESTS=ON

diff --git a/BUILD.md b/BUILD.md
index 6d77ed28dab6b23a2a03eb730cff127ee90f7fa9..6f1d55f87c356e04b3447031fe38ae57fce9f62e 100644 (file)
--- a/BUILD.md
+++ b/BUILD.md
@@ -105,7 +105,7 @@ on/off options currently supported by this repository:
 | Option | Platform | Default | Description |
 | ------ | -------- | ------- | ----------- |
 | BUILD_LOADER | All | `ON` | Controls whether or not the loader is built. Setting this to `OFF` will allow building the tests against a loader that is installed to the system. |
-| BUILD_TESTS | All | `ON` | Controls whether or not the loader tests are built. This option is only available when a copy of Google Test is available in the "external" directory. |
+| BUILD_TESTS | All | `???` | Controls whether or not the loader tests are built. The default is `ON` when the Google Test repository is cloned into the `external` directory.  Otherwise, the default is `OFF`. |
 | BUILD_WSI_XCB_SUPPORT | Linux | `ON` | Build the loader with the XCB entry points enabled. Without this, the XCB headers should not be needed, but the extension `VK_KHR_xcb_surface` won't be available. |
 | BUILD_WSI_XLIB_SUPPORT | Linux | `ON` | Build the loader with the Xlib entry points enabled. Without this, the X11 headers should not be needed, but the extension `VK_KHR_xlib_surface` won't be available. |
 | BUILD_WSI_WAYLAND_SUPPORT | Linux | `ON` | Build the loader with the Wayland entry points enabled. Without this, the Wayland headers should not be needed, but the extension `VK_KHR_wayland_surface` won't be available. |

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 162dcb37bb19a09fd91c5e10d4dda8abfe17efa8..ee198490d2c0f8959babd142f3e5c0397f3a618d 100644 (file)
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -124,7 +124,11 @@ if(WIN32)
 endif()
 
 option(BUILD_LOADER "Build loader" ON)
-option(BUILD_TESTS "BUILD_TESTS" ON)
+if(IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/external/googletest)
+    option(BUILD_TESTS "Build Tests" ON)
+else()
+    option(BUILD_TESTS "Build Tests" OFF)
+endif()
 
 set (PYTHON_CMD ${PYTHON_EXECUTABLE})
 
@@ -189,7 +193,7 @@ if(BUILD_LOADER)
     add_subdirectory(loader)
 endif()
 
+add_subdirectory(external)
 if(BUILD_TESTS)
-    add_subdirectory(external)
     add_subdirectory(tests)
 endif()

diff --git a/external/CMakeLists.txt b/external/CMakeLists.txt
index 64f9be6112d04a19c4e74389cd1ce98a2932599f..d9034045e0fcd1bfe6ad93a871b106c57223ad98 100644 (file)
--- a/external/CMakeLists.txt
+++ b/external/CMakeLists.txt
@@ -1,16 +1,25 @@
 # Add all optional dependencies
 # Currently, the only optional project is googletest
 
-if(TARGET gtest_main)
-    message(STATUS "Google Test (googletest) already configured - use it")
-elseif(IS_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/googletest")
-    message(STATUS "Building gtest from ${CMAKE_CURRENT_SOURCE_DIR}/googletest")
-    set(BUILD_GTEST ON CACHE BOOL "Builds the googletest subproject")
-    set(BUILD_GMOCK OFF CACHE BOOL "Builds the googlemock subproject")
-    set(gtest_force_shared_crt ON CACHE BOOL "Link gtest runtimes dynamically")
-    set(BUILD_SHARED_LIBS ON CACHE BOOL "Build shared libraries")
-    # EXCLUDE_FROM_ALL keeps the install target from installing GTEST files.
-    add_subdirectory("${CMAKE_CURRENT_SOURCE_DIR}/googletest" EXCLUDE_FROM_ALL)
-else()
-    message(STATUS "Google Test was not found - tests based on that will not build")
+if(BUILD_TESTS)
+    # googletest is an external dependency for the tests in the ValidationLayers
+    # repo. Add googletest to the project if present and not already defined.
+    if(TARGET gtest_main)
+        # It is possible that a project enclosing this one has defined the gtest target
+        message(STATUS "Vulkan-Loader/external: "
+            "Google Test (googletest) already configured - use it")
+    elseif(IS_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/googletest")
+        message(STATUS "Vulkan-Loader/external: "
+            "googletests found - configuring it for tests")
+        set(BUILD_GTEST ON CACHE BOOL "Builds the googletest subproject")
+        set(BUILD_GMOCK OFF CACHE BOOL "Builds the googlemock subproject")
+        set(gtest_force_shared_crt ON CACHE BOOL "Link gtest runtimes dynamically")
+        set(BUILD_SHARED_LIBS ON CACHE BOOL "Build shared libraries")
+        # EXCLUDE_FROM_ALL keeps the install target from installing GTEST files.
+        add_subdirectory("${CMAKE_CURRENT_SOURCE_DIR}/googletest" EXCLUDE_FROM_ALL)
+    else()
+        message(SEND_ERROR
+            "Vulkan-Loader/external: Google Test was not found.  "
+            "Provide Google Test in external/googletest or set BUILD_TESTS=OFF")
+    endif()
 endif()

diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
index 9e8433c811a3d351990338903744f8b29de46209..b02bfc28d4e65fb579069d465e6f251a221cca09 100644 (file)
--- a/tests/CMakeLists.txt
+++ b/tests/CMakeLists.txt
@@ -1,145 +1,141 @@
-cmake_minimum_required(VERSION 2.8.11)
-
-if(TARGET gtest_main)
-    if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
-        add_definitions(-DVK_USE_PLATFORM_WIN32_KHR -DWIN32_LEAN_AND_MEAN)
-        # Workaround for TR1 deprecation in Visual Studio 15.5 until Google Test is updated
-        add_definitions(-D_SILENCE_TR1_NAMESPACE_DEPRECATION_WARNING)
-        set(DisplayServer Win32)
-    elseif(CMAKE_SYSTEM_NAME STREQUAL "Android")
-        add_definitions(-DVK_USE_PLATFORM_ANDROID_KHR)
-    elseif(CMAKE_SYSTEM_NAME STREQUAL "Linux")
-        if (BUILD_WSI_XCB_SUPPORT)
-            add_definitions(-DVK_USE_PLATFORM_XCB_KHR)
-        endif()
-
-        if (BUILD_WSI_XLIB_SUPPORT)
-            add_definitions(-DVK_USE_PLATFORM_XLIB_KHR)
-        endif()
-
-        if (BUILD_WSI_WAYLAND_SUPPORT)
-            add_definitions(-DVK_USE_PLATFORM_WAYLAND_KHR)
-        endif()
-
-        if (BUILD_WSI_MIR_SUPPORT)
-            add_definitions(-DVK_USE_PLATFORM_MIR_KHR)
-            include_directories(${MIR_INCLUDE_DIR})
-        endif()
-    elseif(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
-        add_definitions(-DVK_USE_PLATFORM_MACOS_MVK)
-    else()
-        message(FATAL_ERROR "Unsupported Platform!")
+if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
+    add_definitions(-DVK_USE_PLATFORM_WIN32_KHR -DWIN32_LEAN_AND_MEAN)
+    # Workaround for TR1 deprecation in Visual Studio 15.5 until Google Test is updated
+    add_definitions(-D_SILENCE_TR1_NAMESPACE_DEPRECATION_WARNING)
+    set(DisplayServer Win32)
+elseif(CMAKE_SYSTEM_NAME STREQUAL "Android")
+    add_definitions(-DVK_USE_PLATFORM_ANDROID_KHR)
+elseif(CMAKE_SYSTEM_NAME STREQUAL "Linux")
+    if (BUILD_WSI_XCB_SUPPORT)
+        add_definitions(-DVK_USE_PLATFORM_XCB_KHR)
     endif()
 
-    # On Windows, we must pair Debug and Release appropriately
-    if (WIN32)
-        # For Windows, since 32-bit and 64-bit items can co-exist, we build each in its own build directory.
-        # 32-bit target data goes in build32, and 64-bit target data goes into build.  So, include/link the
-        # appropriate data at build time.
-        if (CMAKE_CL_64)
-            set (BUILDTGT_DIR build)
-        else ()
-            set (BUILDTGT_DIR build32)
-        endif()
+    if (BUILD_WSI_XLIB_SUPPORT)
+        add_definitions(-DVK_USE_PLATFORM_XLIB_KHR)
     endif()
 
-    set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake")
-
-    if(WIN32)
-        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D_CRT_SECURE_NO_WARNINGS -D_USE_MATH_DEFINES")
+    if (BUILD_WSI_WAYLAND_SUPPORT)
+        add_definitions(-DVK_USE_PLATFORM_WAYLAND_KHR)
+    endif()
 
-        # If MSVC, disable some signed/unsigned mismatch warnings.
-        if (MSVC)
-            set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /wd4267")
-        endif()
+    if (BUILD_WSI_MIR_SUPPORT)
+        add_definitions(-DVK_USE_PLATFORM_MIR_KHR)
+        include_directories(${MIR_INCLUDE_DIR})
+    endif()
+elseif(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
+    add_definitions(-DVK_USE_PLATFORM_MACOS_MVK)
+else()
+    message(FATAL_ERROR "Unsupported Platform!")
+endif()
 
-    else()
-        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
+# On Windows, we must pair Debug and Release appropriately
+if (WIN32)
+    # For Windows, since 32-bit and 64-bit items can co-exist, we build each in its own build directory.
+    # 32-bit target data goes in build32, and 64-bit target data goes into build.  So, include/link the
+    # appropriate data at build time.
+    if (CMAKE_CL_64)
+        set (BUILDTGT_DIR build)
+    else ()
+        set (BUILDTGT_DIR build32)
     endif()
+endif()
 
-    set (LIBGLM_INCLUDE_DIR ${PROJECT_SOURCE_DIR}/libs)
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake")
 
-    include_directories(
-        ${PROJECT_SOURCE_DIR}/external
-        ${GTEST_SOURCE_DIR}/googletest/include
-        ${CMAKE_CURRENT_BINARY_DIR}
-        ${CMAKE_BINARY_DIR}
-        ${PROJECT_BINARY_DIR}
-    )
+if(WIN32)
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D_CRT_SECURE_NO_WARNINGS -D_USE_MATH_DEFINES")
 
-    if (NOT WIN32)
-        # extra setup for out-of-tree builds
-        if (NOT (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR))
-            add_custom_target(binary-dir-symlinks ALL
-                COMMAND ln -sf ${CMAKE_CURRENT_SOURCE_DIR}/run_wrap_objects_tests.sh
-                COMMAND ln -sf ${CMAKE_CURRENT_SOURCE_DIR}/run_loader_tests.sh
-                COMMAND ln -sf ${CMAKE_CURRENT_SOURCE_DIR}/run_extra_loader_tests.sh
-                COMMAND ln -sf ${CMAKE_CURRENT_SOURCE_DIR}/run_all_tests.sh
-                VERBATIM
-            )
-        endif()
-    else()
-        if (NOT (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR))
-            FILE(TO_NATIVE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/_run_all_tests.ps1 RUN_ALL)
-            add_custom_target(binary-dir-symlinks ALL
-                COMMAND ${CMAKE_COMMAND} -E copy_if_different ${RUN_ALL} run_all_tests.ps1
-                VERBATIM
-            )
-            set_target_properties(binary-dir-symlinks PROPERTIES FOLDER ${LOADER_HELPER_FOLDER})
-        endif()
+    # If MSVC, disable some signed/unsigned mismatch warnings.
+    if (MSVC)
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /wd4267")
+    endif()
+
+else()
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
+endif()
+
+set (LIBGLM_INCLUDE_DIR ${PROJECT_SOURCE_DIR}/libs)
+
+include_directories(
+    ${PROJECT_SOURCE_DIR}/external
+    ${GTEST_SOURCE_DIR}/googletest/include
+    ${CMAKE_CURRENT_BINARY_DIR}
+    ${CMAKE_BINARY_DIR}
+    ${PROJECT_BINARY_DIR}
+)
+
+if (NOT WIN32)
+    # extra setup for out-of-tree builds
+    if (NOT (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR))
+        add_custom_target(binary-dir-symlinks ALL
+            COMMAND ln -sf ${CMAKE_CURRENT_SOURCE_DIR}/run_wrap_objects_tests.sh
+            COMMAND ln -sf ${CMAKE_CURRENT_SOURCE_DIR}/run_loader_tests.sh
+            COMMAND ln -sf ${CMAKE_CURRENT_SOURCE_DIR}/run_extra_loader_tests.sh
+            COMMAND ln -sf ${CMAKE_CURRENT_SOURCE_DIR}/run_all_tests.sh
+            VERBATIM
+        )
+    endif()
+else()
+    if (NOT (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR))
+        FILE(TO_NATIVE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/_run_all_tests.ps1 RUN_ALL)
+        add_custom_target(binary-dir-symlinks ALL
+            COMMAND ${CMAKE_COMMAND} -E copy_if_different ${RUN_ALL} run_all_tests.ps1
+            VERBATIM
+        )
+        set_target_properties(binary-dir-symlinks PROPERTIES FOLDER ${LOADER_HELPER_FOLDER})
     endif()
+endif()
 
-    add_executable(vk_loader_validation_tests loader_validation_tests.cpp)
+add_executable(vk_loader_validation_tests loader_validation_tests.cpp)
+set_target_properties(vk_loader_validation_tests
+    PROPERTIES
+    COMPILE_DEFINITIONS "GTEST_LINKED_AS_SHARED_LIBRARY=1")
+if(NOT WIN32)
     set_target_properties(vk_loader_validation_tests
         PROPERTIES
-        COMPILE_DEFINITIONS "GTEST_LINKED_AS_SHARED_LIBRARY=1")
-    if(NOT WIN32)
-        set_target_properties(vk_loader_validation_tests
-            PROPERTIES
-            COMPILE_FLAGS "-Wno-sign-compare")
-    endif()
+        COMPILE_FLAGS "-Wno-sign-compare")
+endif()
 
-    if(TARGET vulkan)
-        set(LOADER_LIB vulkan)
-    elseif(WIN32 AND NOT $ENV{VULKAN_SDK} EQUAL "")
-        if(CMAKE_SIZEOF_VOID_P EQUAL 8)
-            set(LOADER_LIB "$ENV{VULKAN_SDK}/Lib/vulkan-1.lib")
-        else()
-            set(LOADER_LIB "$ENV{VULKAN_SDK}/Lib32/vulkan-1.lib")
-        endif()
+if(TARGET vulkan)
+    set(LOADER_LIB vulkan)
+elseif(WIN32 AND NOT $ENV{VULKAN_SDK} EQUAL "")
+    if(CMAKE_SIZEOF_VOID_P EQUAL 8)
+        set(LOADER_LIB "$ENV{VULKAN_SDK}/Lib/vulkan-1.lib")
     else()
-        set(LOADER_LIB vulkan)
+        set(LOADER_LIB "$ENV{VULKAN_SDK}/Lib32/vulkan-1.lib")
     endif()
+else()
+    set(LOADER_LIB vulkan)
+endif()
 
-    target_link_libraries(vk_loader_validation_tests "${LOADER_LIB}" gtest gtest_main)
-    if(BUILD_LOADER AND ENABLE_STATIC_LOADER)
-        set_target_properties(vk_loader_validation_tests PROPERTIES LINK_FLAGS "/ignore:4098")
-    endif()
-    if(WIN32)
-        file(COPY vk_loader_validation_tests.vcxproj.user DESTINATION "${CMAKE_CURRENT_BINARY_DIR}")
-    endif()
+target_link_libraries(vk_loader_validation_tests "${LOADER_LIB}" gtest gtest_main)
+if(BUILD_LOADER AND ENABLE_STATIC_LOADER)
+    set_target_properties(vk_loader_validation_tests PROPERTIES LINK_FLAGS "/ignore:4098")
+endif()
+if(WIN32)
+    file(COPY vk_loader_validation_tests.vcxproj.user DESTINATION "${CMAKE_CURRENT_BINARY_DIR}")
+endif()
 
-    # Copy loader and googletest (gtest) libs to test dir so the test executable can find them.
-    if(WIN32)
-        if (CMAKE_GENERATOR MATCHES "^Visual Studio.*")
-            file(TO_NATIVE_PATH ${PROJECT_BINARY_DIR}/external/googletest/googletest/$<CONFIG>/gtest_main$<$<CONFIG:Debug>:d>.dll GTEST_COPY_SRC1)
-            file(TO_NATIVE_PATH ${PROJECT_BINARY_DIR}/external/googletest/googletest/$<CONFIG>/gtest$<$<CONFIG:Debug>:d>.dll GTEST_COPY_SRC2)
-            file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG> GTEST_COPY_DEST)
-        else()
-            file(TO_NATIVE_PATH ${PROJECT_BINARY_DIR}/external/googletest/googeltest/gtest_main.dll GTEST_COPY_SRC1)
-            file(TO_NATIVE_PATH ${PROJECT_BINARY_DIR}/external/googletest/googletest/gtest.dll GTEST_COPY_SRC2)
-            file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR} GTEST_COPY_DEST)
-        endif()
+# Copy loader and googletest (gtest) libs to test dir so the test executable can find them.
+if(WIN32)
+    if (CMAKE_GENERATOR MATCHES "^Visual Studio.*")
+        file(TO_NATIVE_PATH ${PROJECT_BINARY_DIR}/external/googletest/googletest/$<CONFIG>/gtest_main$<$<CONFIG:Debug>:d>.dll GTEST_COPY_SRC1)
+        file(TO_NATIVE_PATH ${PROJECT_BINARY_DIR}/external/googletest/googletest/$<CONFIG>/gtest$<$<CONFIG:Debug>:d>.dll GTEST_COPY_SRC2)
+        file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR}/$<CONFIG> GTEST_COPY_DEST)
+    else()
+        file(TO_NATIVE_PATH ${PROJECT_BINARY_DIR}/external/googletest/googeltest/gtest_main.dll GTEST_COPY_SRC1)
+        file(TO_NATIVE_PATH ${PROJECT_BINARY_DIR}/external/googletest/googletest/gtest.dll GTEST_COPY_SRC2)
+        file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR} GTEST_COPY_DEST)
+    endif()
+    add_custom_command(TARGET vk_loader_validation_tests POST_BUILD
+        COMMAND xcopy /Y /I ${GTEST_COPY_SRC1} ${GTEST_COPY_DEST}
+        COMMAND xcopy /Y /I ${GTEST_COPY_SRC2} ${GTEST_COPY_DEST}
+    )
+    # Copy the loader shared lib (if built) to the test application directory so the test app finds it.
+    if((NOT ENABLE_STATIC_LOADER) AND TARGET vulkan)
         add_custom_command(TARGET vk_loader_validation_tests POST_BUILD
-            COMMAND xcopy /Y /I ${GTEST_COPY_SRC1} ${GTEST_COPY_DEST}
-            COMMAND xcopy /Y /I ${GTEST_COPY_SRC2} ${GTEST_COPY_DEST}
-        )
-        # Copy the loader shared lib (if built) to the test application directory so the test app finds it.
-        if((NOT ENABLE_STATIC_LOADER) AND TARGET vulkan)
-            add_custom_command(TARGET vk_loader_validation_tests POST_BUILD
-                COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:vulkan> $<TARGET_FILE_DIR:vk_loader_validation_tests>)
-        endif()
+            COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:vulkan> $<TARGET_FILE_DIR:vk_loader_validation_tests>)
     endif()
-
-    add_subdirectory(layers)
 endif()
+
+add_subdirectory(layers)