Files
CMake/Modules/Dart.cmake
Matthew Woehlke 763cfbcac8 Diagnostics: "Fix" policy warnings in modules
Introduce a mechanism (via the private and undocumented `ISSUE_WARNING`
option to the `cmake_policy` command) to allow built-in modules to issue
policy warnings. Update modules to use this.

This allows modules to issue policy warnings with the `CMD_POLICY`
diagnostic type, which is consistent with internally issued diagnostics.
This also tends to simplify the logic for issuing such warnings in much
the way the helpers introduced in the previous commit did for the C++
code.
2026-05-20 15:32:57 -04:00

143 lines
4.4 KiB
CMake

# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file LICENSE.rst or https://cmake.org/licensing for details.
#[=======================================================================[.rst:
Dart
----
.. deprecated:: 3.27
This module is available only if policy :policy:`CMP0145`
is not set to ``NEW``. Do not use it in new code.
Use the :module:`CTest` module instead.
Configure a project for testing with CTest or old Dart Tcl Client
This file is the backwards-compatibility version of the CTest module.
It supports using the old Dart 1 Tcl client for driving dashboard
submissions as well as testing with CTest. This module should be
included in the CMakeLists.txt file at the top of a project. Typical
usage:
.. code-block:: cmake
include(Dart)
if(BUILD_TESTING)
# ... testing related CMake code ...
endif()
The BUILD_TESTING option is created by the Dart module to determine
whether testing support should be enabled. The default is ON.
#]=======================================================================]
# This file configures a project to use the Dart testing/dashboard process.
# It is broken into 3 sections.
#
# Section #1: Locate programs on the client and determine site and build name
# Section #2: Configure or copy Tcl scripts from the source tree to build tree
# Section #3: Custom targets for performing dashboard builds.
#
#
# include(Dart) already warns about CMP0145, but back when this module was in
# common use, it was often loaded via include(${CMAKE_ROOT}/Modules/Dart.cmake)
# which will not warn. Warn again just in case.
cmake_policy(GET CMP0145 cmp0145)
if(cmp0145 STREQUAL "")
cmake_policy(ISSUE_WARNING CMP0145)
endif()
option(BUILD_TESTING "Build the testing tree." ON)
if(BUILD_TESTING)
# We only get here if a project already ran include(Dart),
# so avoid warning about CMP0145 again.
cmake_policy(PUSH)
cmake_policy(SET CMP0145 OLD)
find_package(Dart QUIET)
cmake_policy(POP)
#
# Section #1:
#
# CMake commands that will not vary from project to project. Locates programs
# on the client and configure site name and build name.
#
set(RUN_FROM_DART 1)
include(CTest)
set(RUN_FROM_DART)
find_program(COMPRESSIONCOMMAND NAMES gzip compress zip
DOC "Path to program used to compress files for transfer to the dart server")
find_program(GUNZIPCOMMAND gunzip DOC "Path to gunzip executable")
find_program(JAVACOMMAND java DOC "Path to java command, used by the Dart server to create html.")
option(DART_VERBOSE_BUILD "Show the actual output of the build, or if off show a . for each 1024 bytes."
OFF)
option(DART_BUILD_ERROR_REPORT_LIMIT "Limit of reported errors, -1 reports all." -1 )
option(DART_BUILD_WARNING_REPORT_LIMIT "Limit of reported warnings, -1 reports all." -1 )
set(VERBOSE_BUILD ${DART_VERBOSE_BUILD})
set(BUILD_ERROR_REPORT_LIMIT ${DART_BUILD_ERROR_REPORT_LIMIT})
set(BUILD_WARNING_REPORT_LIMIT ${DART_BUILD_WARNING_REPORT_LIMIT})
set (DELIVER_CONTINUOUS_EMAIL "Off" CACHE BOOL "Should Dart server send email when build errors are found in Continuous builds?")
mark_as_advanced(
COMPRESSIONCOMMAND
DART_BUILD_ERROR_REPORT_LIMIT
DART_BUILD_WARNING_REPORT_LIMIT
DART_TESTING_TIMEOUT
DART_VERBOSE_BUILD
DELIVER_CONTINUOUS_EMAIL
GUNZIPCOMMAND
JAVACOMMAND
)
set(HAVE_DART)
if(EXISTS "${DART_ROOT}/Source/Client/Dart.conf.in")
set(HAVE_DART 1)
endif()
#
# Section #2:
#
# Make necessary directories and configure testing scripts
#
# find a tcl shell command
if(HAVE_DART)
find_package(Tclsh)
endif()
if (HAVE_DART)
# make directories in the binary tree
file(MAKE_DIRECTORY "${PROJECT_BINARY_DIR}/Testing/HTML/TestingResults/Dashboard"
"${PROJECT_BINARY_DIR}/Testing/HTML/TestingResults/Sites/${SITE}/${BUILDNAME}")
# configure files
configure_file(
"${DART_ROOT}/Source/Client/Dart.conf.in"
"${PROJECT_BINARY_DIR}/DartConfiguration.tcl" )
#
# Section 3:
#
# Custom targets to perform dashboard builds and submissions.
# These should NOT need to be modified from project to project.
#
# add testing targets
set(DART_EXPERIMENTAL_NAME Experimental)
if(DART_EXPERIMENTAL_USE_PROJECT_NAME)
string(APPEND DART_EXPERIMENTAL_NAME "${PROJECT_NAME}")
endif()
endif ()
set(RUN_FROM_CTEST_OR_DART 1)
include(CTestTargets)
set(RUN_FROM_CTEST_OR_DART)
endif()
#
# End of Dart.cmake
#