src/testutils/unittest_main.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014,2015,2016,2017, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source 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 /*! \internal \file
  36  * \brief
  37  * main() for unit tests that use \ref module_testutils.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_testutils
  41  */
  42 #include "gmxpre.h"
  43
  44 #include <gtest/gtest.h>
  45
  46 #include "testutils/testinit.h"
  47
  48 #ifndef TEST_DATA_PATH
  49 //! Path to test input data directory (needs to be set by the build system).
  50 #define TEST_DATA_PATH 0
  51 #endif
  52
  53 #ifndef TEST_TEMP_PATH
  54 //! Path to test output temporary directory (needs to be set by the build system).
  55 #define TEST_TEMP_PATH 0
  56 #endif
  57
  58 #ifndef TEST_USES_MPI
  59 //! Whether the test expects/supports running with multiple MPI ranks.
  60 #define TEST_USES_MPI false
  61 #endif
  62
  63 #ifndef TEST_USES_HARDWARE_DETECTION
  64 //! Whether the test expects/supports running with knowledge of the hardware.
  65 #define TEST_USES_HARDWARE_DETECTION false
  66 namespace gmx
  67 {
  68 namespace test
  69 {
  70 //! Implement a stub definition for tests that don't ask for a real one.
  71 void callAddGlobalTestEnvironment() {};
  72 }
  73 }
  74 #endif
  75
  76 /*! \brief
  77  * Initializes unit testing for \ref module_testutils.
  78  */
  79 int main(int argc, char *argv[])
  80 {
  81     // Calls ::testing::InitGoogleMock()
  82     ::gmx::test::initTestUtils(TEST_DATA_PATH, TEST_TEMP_PATH,
  83                                TEST_USES_MPI, TEST_USES_HARDWARE_DETECTION,
  84                                &argc, &argv);
  85     int errcode = RUN_ALL_TESTS();
  86     ::gmx::test::finalizeTestUtils();
  87     return errcode;
  88 }