From 46d83dfd1f4757961c52267963848d52cb878e74 Mon Sep 17 00:00:00 2001
From: Matthias Maier <tamiko@kyomu.43-1.org>
Date: Mon, 16 Sep 2013 09:25:43 +0000
Subject: [PATCH] Bugfixes and last documentation update

git-svn-id: https://svn.dealii.org/branches/branch_port_the_testsuite@30726 0785d39b-7218-0410-832d-ea1e28bc413d
---
 tests/README                            | 43 +++++++++++++++++++++----
 tests/all-headers/CMakeLists.txt        |  2 +-
 tests/build_tests/CMakeLists.txt        |  2 +-
 tests/cmake/macros/macro_add_test.cmake |  6 ++--
 tests/cmake/setup_testsuite.cmake       |  4 +--
 5 files changed, 43 insertions(+), 14 deletions(-)

diff --git a/tests/README b/tests/README
index c72e7785e8..349a7c47c1 100644
--- a/tests/README
+++ b/tests/README
@@ -135,12 +135,41 @@ tests as discussed below.
 CMake configuration variables for the testsuite
 -----------------------------------------------
 
-TODO: Document the following options:
-  # TODO: Describe and document the following:
-  # TEST_DIFF
-  # TEST_TIME_LIMIT
-  # TEST_PICKUP_REGEX
-  # NUMDIFF_DIR
+The testsuite has the following options:
+
+  TEST_DIFF
+    - the diff tool and command line to use for comparison. If numdiff is
+      available it defaults to "numdiff -a 1e-6 -q", otherwise plain diff
+      is used.
+
+  TEST_TIME_LIMIT
+    - The time limit (in seconds) a single test is allowed to run. Defaults
+      to 180 seconds
+
+  TEST_PICKUP_REGEX
+    - A regular expression to filter tests. If this is a nonempty string
+      only tests that match the regular expression will be set up. An empty
+      string is interpreted as a catchall.
+
+These options can be set as environment variables prior to the call to the
+setup_test target:
+
+  TEST_PICKUP_REGEX="build_tests/" TEST_TIME_LIMIT="120" make setup_test
+
+Note: Specifying these options via environment variables is volatile, i.e.
+if $ make setup_test is invoked a second time without the variables set in
+environment, the option will be reset to the default value.
+
+If you want to set these options permanently, set them via cmake as CMake
+variable in the build directory:
+
+  # cmake -DTEST_PICKUP_REGEX="<regular expression" .
+
+Please note that a variable set via cmake always _overrides_ one set via
+environment. If you wish to reset such a variable again, undefine it in the
+cache:
+
+  # cmake -UTEST_PICKUP_REGEX .
 
 
 Setup only a subset of tests
@@ -153,7 +182,7 @@ expression during test setup.
 
 Alternatively, you can specify TEST_PICKUP_REGEX upon configuration:
 
-  # cmake -DTEST_PICKUP_REGEX="<regular expression"
+  # cmake -DTEST_PICKUP_REGEX="<regular expression" .
 
 Note: A TEST_PICKUP_REGEX set via cmake always _overrides_ one set via
 environment. If you wish to disable this filter again, undefine
diff --git a/tests/all-headers/CMakeLists.txt b/tests/all-headers/CMakeLists.txt
index 2d025428c6..ce2e06f898 100644
--- a/tests/all-headers/CMakeLists.txt
+++ b/tests/all-headers/CMakeLists.txt
@@ -71,7 +71,7 @@ FOREACH(_full_file ${_header})
           -DTRGT=${_target}
           -DTEST=${_test}
           -DDEAL_II_BINARY_DIR=${CMAKE_BINARY_DIR}
-          -P ${TEST_CMAKE_DIR}/scripts/run_test.cmake
+          -P ${TEST_DIR}/cmake/scripts/run_test.cmake
         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
         )
       SET_TESTS_PROPERTIES(${_test} PROPERTIES
diff --git a/tests/build_tests/CMakeLists.txt b/tests/build_tests/CMakeLists.txt
index 311e38fd08..8be854afe6 100644
--- a/tests/build_tests/CMakeLists.txt
+++ b/tests/build_tests/CMakeLists.txt
@@ -148,7 +148,7 @@ FOREACH(_step_full ${_steps})
           -DTRGT=${_target}
           -DTEST=${_test}
           -DDEAL_II_BINARY_DIR=${CMAKE_BINARY_DIR}
-          -P ${TEST_CMAKE_DIR}/scripts/run_test.cmake
+          -P ${TEST_DIR}/cmake/scripts/run_test.cmake
         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
         )
       SET_TESTS_PROPERTIES(${_test} PROPERTIES
diff --git a/tests/cmake/macros/macro_add_test.cmake b/tests/cmake/macros/macro_add_test.cmake
index 7f29062b18..08588b7db2 100644
--- a/tests/cmake/macros/macro_add_test.cmake
+++ b/tests/cmake/macros/macro_add_test.cmake
@@ -136,13 +136,13 @@ MACRO(DEAL_II_ADD_TEST _category _test_name _comparison_file _n_cpu)
               && exit 1)
         COMMAND
           ${PERL_EXECUTABLE} -pi
-          ${TEST_DIR}/scripts/normalize.pl
+          ${TEST_DIR}/cmake/scripts/normalize.pl
           ${_test_directory}/output
         WORKING_DIRECTORY
           ${_test_directory}
         DEPENDS
           ${_target}
-          ${TEST_DIR}/scripts/normalize.pl
+          ${TEST_DIR}/cmake/scripts/normalize.pl
         )
       ADD_CUSTOM_COMMAND(OUTPUT ${_test_directory}/diff
         COMMAND
@@ -180,7 +180,7 @@ MACRO(DEAL_II_ADD_TEST _category _test_name _comparison_file _n_cpu)
           -DTRGT=${_diff_target}
           -DTEST=${_test_full}
           -DDEAL_II_BINARY_DIR=${CMAKE_BINARY_DIR}
-          -P ${TEST_DIR}/scripts/run_test.cmake
+          -P ${TEST_DIR}/cmake/scripts/run_test.cmake
         WORKING_DIRECTORY ${_test_directory}
         )
       SET_TESTS_PROPERTIES(${_test_full} PROPERTIES
diff --git a/tests/cmake/setup_testsuite.cmake b/tests/cmake/setup_testsuite.cmake
index 4dc59a9321..34d3d8587b 100644
--- a/tests/cmake/setup_testsuite.cmake
+++ b/tests/cmake/setup_testsuite.cmake
@@ -107,10 +107,10 @@ ENDIF()
 SEPARATE_ARGUMENTS(TEST_DIFF UNIX_COMMAND ${TEST_DIFF})
 
 #
-# Set a default time limit of 120 seconds:
+# Set a default time limit of 180 seconds:
 #
 
-SET_IF_EMPTY(TEST_TIME_LIMIT 120)
+SET_IF_EMPTY(TEST_TIME_LIMIT 180)
 
 #
 # And finally, enable testing:
-- 
2.39.5