src/testutils/testinit.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016,2017,2018,2019, 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  * Functions for initialing \Gromacs unit test executables.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_testutils
  41  */
  42 #ifndef GMX_TESTUTILS_TESTINIT_H
  43 #define GMX_TESTUTILS_TESTINIT_H
  44
  45 namespace gmx
  46 {
  47
  48 namespace test
  49 {
  50
  51 //! \cond internal
  52 /*! \internal
  53  * \brief
  54  * Initializes the test utilities library.
  55  *
  56  * Does not throw.  Terminates the program with a non-zero error code if an
  57  * error occurs.
  58  *
  59  * This function is automatically called by unittest_main.cpp.
  60  *
  61  * \param[in] dataPath Filepath to input files.
  62  * \param[in] tempPath Filepath to temporary files.
  63  * \param[in] usesMpi  If the test is run with MPI or not.
  64  * \param[in] usesHardwareDetection If hardwaredetection is enabled.
  65  * \param[in] argc Number of cmdline options
  66  * \param[in] argv Cmdline options.
  67  *
  68  * \ingroup module_testutils
  69  */
  70 void initTestUtils(const char* dataPath,
  71                    const char* tempPath,
  72                    bool        usesMpi,
  73                    bool        usesHardwareDetection,
  74                    int*        argc,
  75                    char***     argv);
  76
  77 /*! \internal
  78  * \brief
  79  * Finalizes the test utilities library.
  80  *
  81  * Does not throw.  Terminates the program with a non-zero error code if an
  82  * error occurs.
  83  *
  84  * This function is automatically called by unittest_main.cpp.
  85  *
  86  * \ingroup module_testutils
  87  */
  88 void finalizeTestUtils();
  89 //! \endcond
  90
  91 /*! \brief Declare a function that all unit test implementations can use
  92  * to set up any environment that they need.
  93  *
  94  * When registering the unit test in CMake, the HARDWARE_DETECTION
  95  * flag requires that the code for that unit test implements this
  96  * function.  Otherwise, a default stub implementation is provided.
  97  *
  98  * This approach conforms to the recommendation by GoogleTest to
  99  * arrange for the code that sets up the global test environment to be
 100  * called from main, rather than potentially rely on brittle static
 101  * initialization order. */
 102 void callAddGlobalTestEnvironment();
 103
 104 } // namespace test
 105 } // namespace gmx
 106
 107 #endif