FindBoost: Add policy to remove this module

Upstream Boost 1.70 and above provide a proper `BoostConfig.cmake`
package configuration file.  Packages for all major distros now
provide it in at least one LTS release.  Add a policy to pretend
that the `FindBoost` module does not exist so that projects calling
`find_package(Boost)` use the upstream package directly.

Closes: #19402

10 files changed, 45 insertions, 0 deletions

diff --git a/Tests/RunCMake/include/CMP0167-NEW-name-result.txt b/Tests/RunCMake/include/CMP0167-NEW-name-result.txt
new file mode 100644
index 0000000..d00491f
--- /dev/null
+++ b/Tests/RunCMake/include/CMP0167-NEW-name-result.txt
@@ -0,0 +1 @@
+1
diff --git a/Tests/RunCMake/include/CMP0167-NEW-name-stderr.txt b/Tests/RunCMake/include/CMP0167-NEW-name-stderr.txt
new file mode 100644
index 0000000..797b45b
--- /dev/null
+++ b/Tests/RunCMake/include/CMP0167-NEW-name-stderr.txt
@@ -0,0 +1,6 @@
+^CMake Error at CMP0167-NEW-name\.cmake:[0-9]+ \(include\):
+  include could not find requested file:
+
+    FindBoost
+Call Stack \(most recent call first\):
+  CMakeLists\.txt:[0-9]+ \(include\)$
diff --git a/Tests/RunCMake/include/CMP0167-NEW-name.cmake b/Tests/RunCMake/include/CMP0167-NEW-name.cmake
new file mode 100644
index 0000000..60eec25
--- /dev/null
+++ b/Tests/RunCMake/include/CMP0167-NEW-name.cmake
@@ -0,0 +1,2 @@
+cmake_policy(SET CMP0167 NEW)
+include(FindBoost)
diff --git a/Tests/RunCMake/include/CMP0167-NEW-path-result.txt b/Tests/RunCMake/include/CMP0167-NEW-path-result.txt
new file mode 100644
index 0000000..d00491f
--- /dev/null
+++ b/Tests/RunCMake/include/CMP0167-NEW-path-result.txt
@@ -0,0 +1 @@
+1
diff --git a/Tests/RunCMake/include/CMP0167-NEW-path-stderr.txt b/Tests/RunCMake/include/CMP0167-NEW-path-stderr.txt
new file mode 100644
index 0000000..0b91cac
--- /dev/null
+++ b/Tests/RunCMake/include/CMP0167-NEW-path-stderr.txt
@@ -0,0 +1,6 @@
+^CMake Error at [^
+]*/Modules/FindBoost.cmake:[0-9]+ \(message\):
+  The FindBoost module has been removed by policy CMP0167\.
+Call Stack \(most recent call first\):
+  CMP0167-NEW-path\.cmake:[0-9]+ \(include\)
+  CMakeLists\.txt:[0-9]+ \(include\)$
diff --git a/Tests/RunCMake/include/CMP0167-NEW-path.cmake b/Tests/RunCMake/include/CMP0167-NEW-path.cmake
new file mode 100644
index 0000000..e0fb5e0
--- /dev/null
+++ b/Tests/RunCMake/include/CMP0167-NEW-path.cmake
@@ -0,0 +1,2 @@
+cmake_policy(SET CMP0167 NEW)
+include(${CMAKE_ROOT}/Modules/FindBoost.cmake)
diff --git a/Tests/RunCMake/include/CMP0167-OLD.cmake b/Tests/RunCMake/include/CMP0167-OLD.cmake
new file mode 100644
index 0000000..09630cb
--- /dev/null
+++ b/Tests/RunCMake/include/CMP0167-OLD.cmake
@@ -0,0 +1,7 @@
+cmake_policy(SET CMP0167 OLD)
+set(_FindBoost_testing 1)
+include(FindBoost)
+
+if(NOT _FindBoost_included)
+  message(FATAL_ERROR "FindBoost.cmake not included")
+endif()
diff --git a/Tests/RunCMake/include/CMP0167-WARN-stderr.txt b/Tests/RunCMake/include/CMP0167-WARN-stderr.txt
new file mode 100644
index 0000000..41de30d
--- /dev/null
+++ b/Tests/RunCMake/include/CMP0167-WARN-stderr.txt
@@ -0,0 +1,8 @@
+^CMake Warning \(dev\) at CMP0167-WARN\.cmake:[0-9]+ \(include\):
+  Policy CMP0167 is not set: The FindBoost module is removed\.  Run "cmake
+  --help-policy CMP0167" for policy details\.  Use the cmake_policy command to
+  set the policy and suppress this warning\.
+
+Call Stack \(most recent call first\):
+  CMakeLists\.txt:[0-9]+ \(include\)
+This warning is for project developers\.  Use -Wno-dev to suppress it\.$
diff --git a/Tests/RunCMake/include/CMP0167-WARN.cmake b/Tests/RunCMake/include/CMP0167-WARN.cmake
new file mode 100644
index 0000000..85472d5
--- /dev/null
+++ b/Tests/RunCMake/include/CMP0167-WARN.cmake
@@ -0,0 +1,7 @@
+# Do not set CMP0167.
+set(_FindBoost_testing 1)
+include(FindBoost)
+
+if(NOT _FindBoost_included)
+  message(FATAL_ERROR "FindBoost.cmake not included")
+endif()
diff --git a/Tests/RunCMake/include/RunCMakeTest.cmake b/Tests/RunCMake/include/RunCMakeTest.cmake
index 685173e..f3b58c9 100644
--- a/Tests/RunCMake/include/RunCMakeTest.cmake
+++ b/Tests/RunCMake/include/RunCMakeTest.cmake
@@ -21,3 +21,8 @@ run_cmake(CMP0148-Libs-OLD)
 run_cmake(CMP0148-Libs-WARN)
 run_cmake(CMP0148-Libs-NEW-name)
 run_cmake(CMP0148-Libs-NEW-path)
+
+run_cmake(CMP0167-OLD)
+run_cmake(CMP0167-WARN)
+run_cmake(CMP0167-NEW-name)
+run_cmake(CMP0167-NEW-path)