CMake/Tests/CMakeTests/CheckSourceTreeTest.cmake.in
David Cole 806eaa290c Further refinements to the CheckSourceTree test.
Echo results of calling git status before exiting with
an error. Add one special case so that the test may pass
on the dashmacmini2 continuous dashboard, despite a 'git
status' non-zero return code. More logic like this may
be required. I will re-evaluate based on tomorrow's
nightly dashboard runs.
2010-05-27 16:43:28 -04:00

330 lines
9.4 KiB
CMake

# Check the CMake source tree and report anything suspicious...
#
message("=============================================================================")
message("CTEST_FULL_OUTPUT (Avoid ctest truncation of output)")
message("")
message("CMake_BINARY_DIR='${CMake_BINARY_DIR}'")
message("CMake_SOURCE_DIR='${CMake_SOURCE_DIR}'")
message("CVS_EXECUTABLE='${CVS_EXECUTABLE}'")
message("GIT_EXECUTABLE='${GIT_EXECUTABLE}'")
message("HOME='${HOME}'")
message("ENV{DASHBOARD_TEST_FROM_CTEST}='$ENV{DASHBOARD_TEST_FROM_CTEST}'")
message("")
string(REPLACE "\\" "\\\\" HOME "${HOME}")
# Is the build directory the same as or underneath the source directory?
# (i.e. - is it an "in source" build?)
#
set(in_source_build 0)
if(CMake_SOURCE_DIR STREQUAL "${CMake_BINARY_DIR}")
message("build dir *is* source dir")
set(in_source_build 1)
else()
string(LENGTH "${CMake_SOURCE_DIR}" src_len)
string(LENGTH "${CMake_BINARY_DIR}" bin_len)
if(bin_len GREATER src_len)
math(EXPR substr_len "${src_len}+1")
string(SUBSTRING "${CMake_BINARY_DIR}" 0 ${substr_len} bin_dir)
if(bin_dir STREQUAL "${CMake_SOURCE_DIR}/")
message("build dir is under source dir")
set(in_source_build 1)
endif()
endif()
endif()
message("src_len='${src_len}'")
message("bin_len='${bin_len}'")
message("substr_len='${substr_len}'")
message("bin_dir='${bin_dir}'")
message("in_source_build='${in_source_build}'")
message("")
# If this does not appear to be a git or CVS checkout, just pass the test here
# and now. (Do not let the test fail if it is run in a tree *exported* from a
# repository or unpacked from a .zip file source installer...)
#
set(is_git_checkout 0)
if(EXISTS "${CMake_SOURCE_DIR}/.git")
set(is_git_checkout 1)
endif()
set(is_cvs_checkout 0)
if(EXISTS "${CMake_SOURCE_DIR}/CVS/Root")
set(is_cvs_checkout 1)
endif()
message("is_git_checkout='${is_git_checkout}'")
message("is_cvs_checkout='${is_cvs_checkout}'")
message("")
if(NOT is_cvs_checkout)
if(NOT is_git_checkout)
message("source tree is neither git nor CVS checkout... test passes by early return...")
return()
endif()
endif()
if(is_cvs_checkout)
if(is_git_checkout)
message("warning: source tree has both git *and* CVS file system bits???")
# should this condition be a FATAL_ERROR test failure...?
endif()
endif()
# This test looks for the following types of changes in the source tree:
#
set(additions 0)
set(conflicts 0)
set(modifications 0)
set(nonadditions 0)
# ov == output variable... conditionally filled in by either cvs or git below:
#
set(cmd "")
set(ov "")
set(ev "")
set(rv "")
if(is_cvs_checkout AND CVS_EXECUTABLE)
# Check with "cvs -q -n up -dP" if there are any local modifications to the
# CMake source tree:
#
message("=============================================================================")
message("This is a cvs checkout, using cvs to verify source tree....")
message("")
execute_process(COMMAND ${CVS_EXECUTABLE} --version
WORKING_DIRECTORY ${CMake_SOURCE_DIR}
OUTPUT_VARIABLE version_output
OUTPUT_STRIP_TRAILING_WHITESPACE)
message("=== output of 'cvs --version' ===")
message("${version_output}")
message("=== end output ===")
message("")
file(READ "${CMake_SOURCE_DIR}/CVS/Root" contents)
message("=== content of CVS/Root ===")
message("${contents}")
message("=== end content ===")
message("")
file(READ "${CMake_SOURCE_DIR}/CVS/Repository" contents)
message("=== content of CVS/Repository ===")
message("${contents}")
message("=== end content ===")
message("")
message("Copy/paste this command to reproduce:")
message("cd \"${CMake_SOURCE_DIR}\" && \"${CVS_EXECUTABLE}\" -q -n up -dP")
message("")
set(cmd ${CVS_EXECUTABLE} -q -n up -dP)
endif()
if(is_git_checkout AND GIT_EXECUTABLE)
# Check with "git status" if there are any local modifications to the
# CMake source tree:
#
message("=============================================================================")
message("This is a git checkout, using git to verify source tree....")
message("")
execute_process(COMMAND ${GIT_EXECUTABLE} --version
WORKING_DIRECTORY ${CMake_SOURCE_DIR}
OUTPUT_VARIABLE version_output
OUTPUT_STRIP_TRAILING_WHITESPACE)
message("=== output of 'git --version' ===")
message("${version_output}")
message("=== end output ===")
message("")
execute_process(COMMAND ${GIT_EXECUTABLE} branch -a
WORKING_DIRECTORY ${CMake_SOURCE_DIR}
OUTPUT_VARIABLE git_branch_output
OUTPUT_STRIP_TRAILING_WHITESPACE)
message("=== output of 'git branch -a' ===")
message("${git_branch_output}")
message("=== end output ===")
message("")
message("Copy/paste this command to reproduce:")
message("cd \"${CMake_SOURCE_DIR}\" && \"${GIT_EXECUTABLE}\" status")
message("")
set(cmd ${GIT_EXECUTABLE} status)
endif()
if(cmd)
# Use the HOME value passed in to the script for calling cvs/git so it can
# find its .cvspass or user/global config settings...
#
set(original_ENV_HOME "$ENV{HOME}")
set(ENV{HOME} "${HOME}")
execute_process(COMMAND ${cmd}
WORKING_DIRECTORY ${CMake_SOURCE_DIR}
OUTPUT_VARIABLE ov
ERROR_VARIABLE ev
RESULT_VARIABLE rv)
set(ENV{HOME} "${original_ENV_HOME}")
message("Results of running ${cmd}")
message("rv='${rv}'")
message("ov='${ov}'")
message("ev='${ev}'")
message("")
if(NOT rv STREQUAL 0)
if(is_git_checkout AND (rv STREQUAL "1") AND ("${version_output}" STREQUAL "git version 1.5.5"))
# git 1.5.5 returns "1" from a "nothing is changed" git status call...
# (perhaps broader logic is required here... we'll see on tomorrow's dashboard...)
else()
message(FATAL_ERROR "error: ${cmd} attempt failed... (see output above)")
endif()
endif()
else()
message(FATAL_ERROR "error: no COMMAND to run to analyze source tree...")
endif()
# Analyze output:
#
if(NOT ov STREQUAL "")
string(REPLACE ";" "\\\\;" lines "${ov}")
string(REPLACE "\n" "E;" lines "${lines}")
foreach(line ${lines})
message("'${line}'")
# But do not consider files that exist just because some user poked around
# the file system with Windows Explorer or with the Finder from a Mac...
# ('Thumbs.db' and '.DS_Store' files...)
#
set(consider 1)
set(ignore_files_regex "^(. |.*(/|\\\\))(\\.DS_Store|Thumbs.db)E$")
if(line MATCHES "${ignore_files_regex}")
message(" line matches '${ignore_files_regex}' -- not considered")
set(consider 0)
endif()
if(consider)
if(is_cvs_checkout)
if(line MATCHES "^A ")
message(" locally added file/directory detected...")
set(additions 1)
endif()
if(line MATCHES "^C ")
message(" conflict detected...")
set(conflicts 1)
endif()
if(line MATCHES "^M ")
message(" locally modified file detected...")
set(modifications 1)
endif()
if(line MATCHES "^\\? ")
message(" locally non-added file/directory detected...")
set(nonadditions 1)
endif()
endif()
if(is_git_checkout)
if(line MATCHES "^#[ \t]*modified:")
message(" locally modified file detected...")
set(modifications 1)
endif()
if(line MATCHES "^# Untracked")
message(" locally non-added file/directory detected...")
set(nonadditions 1)
endif()
endif()
endif()
endforeach()
endif()
message("=============================================================================")
message("additions='${additions}'")
message("conflicts='${conflicts}'")
message("modifications='${modifications}'")
message("nonadditions='${nonadditions}'")
message("")
# Decide if the test passes or fails:
#
message("=============================================================================")
if("$ENV{DASHBOARD_TEST_FROM_CTEST}" STREQUAL "")
# developers are allowed to have local additions and modifications...
set(is_dashboard 0)
message("interactive test run")
message("")
else()
set(is_dashboard 1)
message("dashboard test run")
message("")
# but dashboard machines are not allowed to have local additions or modifications...
if(additions)
message(FATAL_ERROR "test fails: local source tree additions")
endif()
if(modifications)
message(FATAL_ERROR "test fails: local source tree modifications")
endif()
#
# It's a dashboard run if ctest was run with '-D ExperimentalTest' or some
# other -D arg on its command line or if ctest is running a -S script to run
# a dashboard... Running ctest like that sets the DASHBOARD_TEST_FROM_CTEST
# env var.
#
endif()
# ...and nobody is allowed to have local non-additions or conflicts...
# Not even developers.
#
if(nonadditions)
if(in_source_build AND is_dashboard)
message("
warning: test results confounded because this is an 'in-source' build - cannot
distinguish between non-added files that are in-source build products and
non-added source files that somebody forgot to 'git add'... - this is only ok
if this is intentionally an in-source dashboard build... Developers should
use out-of-source builds to verify a clean source tree with this test...
Allowing test to pass despite the warning message...
")
else()
message(FATAL_ERROR "test fails: local source tree non-additions: use git add before committing, or remove the files from the source tree")
endif()
endif()
if(conflicts)
message(FATAL_ERROR "test fails: local source tree conflicts: resolve before committing")
endif()
# Still here? Good then...
#
message("test passes")
message("")