Merge "Merge branch release-4-6 into master"
[alexxy/gromacs.git] / tests / CMakeLists.txt
1 #
2 # This file is part of the GROMACS molecular simulation package.
3 #
4 # Copyright (c) 2012,2013, by the GROMACS development team, led by
5 # David van der Spoel, Berk Hess, Erik Lindahl, and including many
6 # others, as listed in the AUTHORS file in the top-level source
7 # directory and at http://www.gromacs.org.
8 #
9 # GROMACS is free software; you can redistribute it and/or
10 # modify it under the terms of the GNU Lesser General Public License
11 # as published by the Free Software Foundation; either version 2.1
12 # of the License, or (at your option) any later version.
13 #
14 # GROMACS is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 # Lesser General Public License for more details.
18 #
19 # You should have received a copy of the GNU Lesser General Public
20 # License along with GROMACS; if not, see
21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
23 #
24 # If you want to redistribute modifications to GROMACS, please
25 # consider that scientific software is very special. Version
26 # control is crucial - bugs must be traceable. We will be happy to
27 # consider code for inclusion in the official distribution, but
28 # derived work must not be called official GROMACS. Details are found
29 # in the README & COPYING files - if they are missing, get the
30 # official version at http://www.gromacs.org.
31 #
32 # To help us fund GROMACS development, we humbly ask that you cite
33 # the research papers on the package. Check out http://www.gromacs.org.
34 #
35 set(REGRESSIONTEST_PATH "" CACHE PATH "Directory containing regressiontests")
36 mark_as_advanced(REGRESSIONTEST_PATH)
37 option(REGRESSIONTEST_DOWNLOAD
38     "Automatically download regressiontests. Tests can be run with ctest." no)
39 if(REGRESSIONTEST_DOWNLOAD AND CMAKE_VERSION VERSION_LESS "2.8.2")
40     message(WARNING "REGRESSIONTEST_DOWNLOAD requires cmake >=2.8.2. Please update cmake or manually download the regressiontests.")
41     set(REGRESSIONTEST_DOWNLOAD FALSE CACHE BOOL 
42         "REGRESSIONTEST_DOWNLOAD not supported with cmake ${CMAKE_VERSION}" FORCE)
43 endif()
44 if(REGRESSIONTEST_DOWNLOAD)
45     if("${PROJECT_VERSION}" MATCHES "-dev")
46        if("${PROJECT_VERSION}" MATCHES "^5[.]")
47           set(REGRESSIONTEST_URL http://gerrit.gromacs.org/snapshot/refs/heads/master)
48        else()
49           set(REGRESSIONTEST_URL http://gerrit.gromacs.org/snapshot/refs/heads/release-4-6)
50       endif()
51       set(REGRESSIONTEST_PATH "${CMAKE_CURRENT_BINARY_DIR}/regressiontests"
52            CACHE PATH "Path to auto-downloaded regressiontests" FORCE)
53     else()
54         if(NOT REGRESSIONTEST_VERSION)
55           message(FATAL_ERROR "The configuration files do not specify what regressiontests tarball is suitable for automated download and testing. Please obtain and use a suitable set of tests yourself.")
56         endif()
57         set(REGRESSIONTEST_URL http://gerrit.gromacs.org/download/regressiontests-${REGRESSIONTEST_VERSION}.tar.gz)
58         set(REGRESSIONTEST_PATH
59            "${CMAKE_CURRENT_BINARY_DIR}/regressiontests-${REGRESSIONTEST_VERSION}"
60            CACHE PATH "Path to auto-downloaded regressiontests" FORCE)
61     endif()
62     set(REGRESSIONTEST_FILE "${CMAKE_CURRENT_BINARY_DIR}/regressiontests.tgz")
63     message("Downloading: ${REGRESSIONTEST_URL}")
64     file(DOWNLOAD ${REGRESSIONTEST_URL} "${REGRESSIONTEST_FILE}" SHOW_PROGRESS STATUS status LOG log)
65     list(GET status 0 status_code)
66     list(GET status 1 status_string)
67
68     if(NOT status_code EQUAL 0)
69         message(FATAL_ERROR "error: downloading '${REGRESSIONTEST_URL}' failed
70 status_code: ${status_code}
71 status_string: ${status_string}
72 log: ${log}")
73     endif()
74
75     file(REMOVE_RECURSE "${REGRESSIONTEST_PATH}") #delete potential prior folder
76     execute_process(COMMAND ${CMAKE_COMMAND} -E tar xf "${REGRESSIONTEST_FILE}"
77         WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
78     if(NOT EXISTS ${REGRESSIONTEST_PATH}/gmxtest.pl)
79         message(FATAL_ERROR "Download incorrect. Doesn't contain required gmxtest.pl")
80     endif()
81     set(REGRESSIONTEST_DOWNLOAD OFF CACHE BOOL "Tests already downloaded. Set to yes to download again" FORCE)
82 endif()
83
84 if(REGRESSIONTEST_PATH AND (GMX_BLUEGENE OR CMAKE_CROSSCOMPILING OR CMAKE_CONFIGURATION_TYPES))
85     #Bluegene requires us to compile both front-end and back-end binaries (single build is insufficient)
86     message(WARNING 
87         "With cross-compiling or multi-configuration generators (e.g. Visual Studio), running regressiontests from build system is not supported. Please run gmxtest.pl directly.")
88     set(REGRESSIONTEST_PATH OFF CACHE BOOL 
89         "With cross-compiling or multi-configuration generators, running regressiontests from build system is not supported." FORCE)
90 endif()
91
92 if(REGRESSIONTEST_PATH)
93     if(NOT EXISTS ${REGRESSIONTEST_PATH}/gmxtest.pl)
94         message(FATAL_ERROR
95             "REGRESSIONTEST_PATH invalid. The path needs to contain gmxtest.pl.")
96     endif()
97     if(GMX_DOUBLE)
98         list(APPEND ARGS -double)
99     endif()
100     if(GMX_LIB_MPI AND NOT MPIEXEC) #autodetection failed or CC=mpicc was used
101         message(WARNING
102             "Please set MPIEXEC. Otherwise mpirun is assumed for runnings tests.")
103     endif()
104     if(GMX_LIB_MPI)
105         set(GMX_TEST_NUMBER_PROCS 8 CACHE STRING "Number of processors used for testing")
106         mark_as_advanced(GMX_TEST_NUMBER_PROCS)
107         list(APPEND ARGS -np ${GMX_TEST_NUMBER_PROCS})
108         if(MPIEXEC)
109             list(APPEND ARGS -mpirun ${MPIEXEC})
110         endif()
111         #We should use MPIEXEC_NUMPROC_FLAG but gmxtest.pl doesn't let us pass it
112     endif()
113     if(GMX_BINARY_SUFFIX)
114         list(APPEND ARGS -suffix ${GMX_BINARY_SUFFIX})
115     endif()
116     #crosscompile is only used to disable checking whether binaries work
117     #given that we know they are there and that mdrun might not be exectuable
118     #(e.g. Cray) we enable it.
119     list(APPEND ARGS -crosscompile)
120
121     set(REGRESSIONTEST_EXTRA_ARGS "" CACHE STRING 
122         "Extra arguments passed to gmxtest")
123     mark_as_advanced(REGRESSIONTEST_EXTRA_ARGS)
124     list(APPEND ARGS ${REGRESSIONTEST_EXTRA_ARGS})
125
126     list(APPEND ARGS -noverbose -nosuffix)
127
128     if(GMX_NATIVE_WINDOWS)
129         set(PATH_SEPARATOR "\\;")
130         #replacing \ with / shouldn't be neccessary. But otherwise "..\bin\;c:\.."
131         #gets turned into "...\bin\\c:\.." don't know why and don't have a better
132         #workaround. This workaround doesn't hurt.
133         string(REPLACE "\\" "/" PATH "$ENV{PATH}")
134         #protect ; (don't treat as list)
135         string(REPLACE ";" "\\;" PATH "${PATH}")
136     else()
137         set(PATH_SEPARATOR ":")
138         set(PATH "$ENV{PATH}")
139     endif()
140
141     foreach(FOLDER bin lib) #lib folders might be needed for
142         #e.g. DLLs. For GMX paths native ("\") is needed for GMXLIB detection
143         file(TO_NATIVE_PATH "${CMAKE_BINARY_DIR}/${FOLDER}" DIR)
144         set(PATH "${DIR}${PATH_SEPARATOR}${PATH}")
145     endforeach()
146
147     find_program(PERL_EXECUTABLE NAMES "perl")
148     mark_as_advanced(PERL_EXECUTABLE)
149
150     if (NOT PERL_EXECUTABLE)
151         message(FATAL_ERROR "Perl not found. Install perl, set PERL_EXECUTABLE to the perl location, or unset REGRESSIONTEST_PATH to disable testing.")
152     endif()
153
154     #currently not testing tools because they don't contain any useful tests
155     foreach(subtest simple complex kernel freeenergy pdb2gmx)
156         add_test(NAME regressiontests/${subtest}
157             #windows requires the command to be perl and not the script
158             COMMAND perl "${REGRESSIONTEST_PATH}/gmxtest.pl" ${subtest} ${ARGS})
159         set_tests_properties(regressiontests/${subtest} PROPERTIES
160             ENVIRONMENT "PATH=${PATH}")
161     endforeach()
162 endif()
163
164 include(CppCheck.cmake)