CMake: Conditionally pass PATHS to FindWrapHelper package lookup

The setup:
- build Qt with '-static -qt-zlib'
- configure a user project with plain cmake and -DQt6_DIR pointing to
  the Qt6 package

In this case, the implicit find_dependency(BundledZlib) call will
fail with:

CMake Error at lib/cmake/Qt6/QtFindWrapHelper.cmake:120 (message):
  Can't find Qt6::BundledZLIB.
Call Stack (most recent call first):
  lib/cmake/Qt6/FindWrapZLIB.cmake:6 (qt_find_package_system_or_bundled)
  cmake/share/cmake-3.31/Modules/CMakeFindDependencyMacro.cmake:76
    (find_package)
  lib/cmake/Qt6/QtPublicDependencyHelpers.cmake:36 (find_dependency)
  lib/cmake/Qt6Core/Qt6CoreDependencies.cmake:39
    (_qt_internal_find_third_party_dependencies)
  lib/cmake/Qt6Core/Qt6CoreConfig.cmake:42 (include)
  lib/cmake/Qt6/Qt6Config.cmake:233 (find_package)
  CMakeLists.txt:7 (find_package)

For example it would fail for the rasterwindow example configured with:
 cmake ~/qtbase/examples/gui/rasterwindow \
   -DQt6_DIR=$HOME/builds/dev-mac-static/qtbase/lib/cmake/Qt6

The failure happens because we don't pass any additional paths to the
find_package call that looks for BundledZlib, as opposed to how we do
it for module packages.

The project configuration does not fail if it is configured with any
of the following variables:
- Qt6_ROOT or
- CMAKE_PREFIX_PATH or
- the Qt generated toolchain file.

That's because these implicitly add relevant paths where to look for
Qt packages.

This came up in qtdeclarative RunCMake CI tests, where we only pass
Qt6_DIR to the test projects. It didn't come up in qtbase, because
none of the current qtbase RunCMake tests try to find Qt6Core.

To fix this particular case, conditionally pass the same paths that
Qt6Config.cmake uses when looking for module packages, to the
find_package call that looks for the bundled target.

We do it conditionally for bundled targets only, because for system
libraries we want to default looking for the module
FindWrapSystemFoo.cmake files.

Add a RunCMake test which will try to find a few Qt modules solely
based on having only Qt6_DIR set.

Pick-to: 6.8 6.9
Change-Id: I4d4e548f4c10370c4964ab8968b5772e26855dd4
Reviewed-by: Alexey Edelev <[email protected]>

1 files changed, 20 insertions, 1 deletions

diff --git a/cmake/QtFindWrapHelper.cmake b/cmake/QtFindWrapHelper.cmake
index 506bfc7fadb..c43824b8234 100644
--- a/cmake/QtFindWrapHelper.cmake
+++ b/cmake/QtFindWrapHelper.cmake
@@ -66,7 +66,26 @@ macro(qt_find_package_system_or_bundled _unique_prefix)
     endif()
 
     if(NOT TARGET "${${_unique_prefix}_qt_package_target_to_use}")
-        find_package("${${_unique_prefix}_qt_package_name_to_use}")
+        if(QT_USE_BUNDLED_${_qfwrap_${_unique_prefix}_BUNDLED_PACKAGE_TARGET})
+            set(${_unique_prefix}_qt_use_no_default_path_for_qt_packages "NO_DEFAULT_PATH")
+            if(QT_DISABLE_NO_DEFAULT_PATH_IN_QT_PACKAGES)
+                set(${_unique_prefix}_qt_use_no_default_path_for_qt_packages "")
+            endif()
+
+            # For bundled targets, we want to limit search paths to the relevant Qt search paths.
+            find_package("${${_unique_prefix}_qt_package_name_to_use}"
+                PATHS
+                    ${QT_BUILD_CMAKE_PREFIX_PATH}
+                    "${CMAKE_CURRENT_LIST_DIR}/.."
+                    ${_qt_cmake_dir}
+                    ${_qt_additional_packages_prefix_paths}
+                ${${_unique_prefix}_qt_use_no_default_path_for_qt_packages}
+            )
+        else()
+            # For the non-bundled case we will look for FindWrapSystemFoo.cmake module files,
+            # which means we should not specify any PATHS.
+            find_package("${${_unique_prefix}_qt_package_name_to_use}")
+        endif()
     endif()
 
     if(TARGET "${${_unique_prefix}_qt_package_target_to_use}")