src/testutils/unittest_main.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010-2017, The GROMACS development team.
   5  * Copyright (c) 2019,2020,2021, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \internal \file
  37  * \brief
  38  * main() for unit tests that use \ref module_testutils.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_testutils
  42  */
  43 #include "gmxpre.h"
  44
  45 #include <gtest/gtest.h>
  46
  47 #include "testutils/testinit.h"
  48
  49 #ifndef TEST_DATA_PATH
  50 //! Path to test input data directory (needs to be set by the build system).
  51 #    define TEST_DATA_PATH nullptr
  52 #endif
  53
  54 #ifndef TEST_TEMP_PATH
  55 //! Path to test output temporary directory (needs to be set by the build system).
  56 #    define TEST_TEMP_PATH nullptr
  57 #endif
  58
  59 #ifndef TEST_USES_MPI
  60 //! Whether the test expects/supports running with multiple MPI ranks.
  61 #    define TEST_USES_MPI false
  62 #endif
  63
  64 #ifndef TEST_USES_HARDWARE_DETECTION
  65 //! Whether the test expects/supports running with knowledge of the hardware.
  66 #    define TEST_USES_HARDWARE_DETECTION false
  67 #endif
  68
  69 /*! \brief
  70  * Initializes unit testing for \ref module_testutils.
  71  */
  72 int main(int argc, char* argv[])
  73 {
  74     // Calls ::testing::InitGoogleMock()
  75     ::gmx::test::initTestUtils(
  76             TEST_DATA_PATH, TEST_TEMP_PATH, TEST_USES_MPI, TEST_USES_HARDWARE_DETECTION, &argc, &argv);
  77     int errcode = RUN_ALL_TESTS();
  78     ::gmx::test::finalizeTestUtils();
  79     return errcode;
  80 }