src/testutils/testexceptions.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2011,2012,2015,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 /*! \libinternal \file
  36  * \brief
  37  * Exception classes for errors in tests.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_testutils
  42  */
  43 #ifndef GMX_TESTUTILS_TESTEXCEPTIONS_H
  44 #define GMX_TESTUTILS_TESTEXCEPTIONS_H
  45
  46 #include <string>
  47
  48 #include "gromacs/utility/exceptions.h"
  49
  50 namespace gmx
  51 {
  52 namespace test
  53 {
  54
  55 /*! \libinternal \brief
  56  * Exception class for reporting errors in tests.
  57  *
  58  * This exception should be used for error conditions that are internal to the
  59  * test, i.e., do not indicate errors in the tested code.
  60  *
  61  * \ingroup module_testutils
  62  */
  63 class TestException : public GromacsException
  64 {
  65 public:
  66     /*! \brief
  67      * Creates a test exception object with the provided detailed reason.
  68      *
  69      * \param[in] reason Detailed reason for the exception.
  70      */
  71     explicit TestException(const std::string& reason) : GromacsException(reason) {}
  72     /*! \brief
  73      * Creates a test exception based on another GromacsException object.
  74      *
  75      * \param[in] base  Exception to wrap.
  76      *
  77      * \see GMX_THROW_WRAPPER_TESTEXCEPTION
  78      */
  79     explicit TestException(const GromacsException& base) : GromacsException(base) {}
  80
  81     int errorCode() const override { return -1; }
  82 };
  83
  84 /*! \brief
  85  * Macro for throwing a TestException that wraps another exception.
  86  *
  87  * \param[in] e    Exception object to wrap.
  88  *
  89  * This macro is intended for wrapping exceptions thrown by Gromacs methods
  90  * that are called from a test for the test's internal purposes.  It wraps the
  91  * exception in a TestException to make it possible to tell from the type of
  92  * the exception whether the exception was thrown by the code under test, or by
  93  * the test code itself.
  94  *
  95  * \p e should evaluate to an instance of an object derived from
  96  * GromacsException.
  97  *
  98  * Typical usage in test code:
  99  * \code
 100    try
 101    {
 102        // some code that may throw a GromacsException
 103    }
 104    catch (const GromacsException &ex)
 105    {
 106        GMX_THROW_WRAPPER_TESTEXCEPTION(ex);
 107    }
 108  * \endcode
 109  */
 110 #define GMX_THROW_WRAPPER_TESTEXCEPTION(e) throw ::gmx::test::TestException(e)
 111
 112 } // namespace test
 113 } // namespace gmx
 114
 115 #endif