src/testutils/testmatchers.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,2020, 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
  36 /*! \libinternal \file
  37  * \brief Extra GoogleMock matchers for unit tests.
  38  *
  39  * This file provides the usual kind of GoogleMock matchers that
  40  * extend the usefulness of GoogleMock EXPECT_THAT constructs to the
  41  * kinds of containers of reals commonly used. This means that test
  42  * code can write one-liners rather than loops over whole containers.
  43  *
  44  * \author Mark Abraham <mark.j.abraham@gmail.com>
  45  * \inlibraryapi
  46  * \ingroup module_testutils
  47  */
  48 #ifndef GMX_TESTUTILS_TESTMATCHERS_H
  49 #define GMX_TESTUTILS_TESTMATCHERS_H
  50
  51 #include <memory>
  52 #include <ostream>
  53 #include <tuple>
  54
  55 #include <gmock/gmock.h>
  56
  57 #include "gromacs/utility/real.h"
  58
  59 namespace gmx
  60 {
  61 template<typename T>
  62 class BasicVector;
  63
  64 namespace test
  65 {
  66
  67 class FloatingPointTolerance;
  68
  69 /*! \brief Make matcher for floats for use with GoogleMock that compare
  70  * equal when \c tolerance is satisifed.
  71  *
  72  * Used like
  73  *
  74  *   EXPECT_THAT(testFloats, Pointwise(FloatEq(tolerance), referenceFloats));
  75  */
  76 testing::Matcher<std::tuple<float, float>> FloatEq(const FloatingPointTolerance& tolerance);
  77
  78 /*! \brief Make matcher for doubles for use with GoogleMock that compare
  79  * equal when \c tolerance is satisifed.
  80  *
  81  * Used like
  82  *
  83  *   EXPECT_THAT(testDoubles, Pointwise(DoubleEq(tolerance), referenceDoubles));
  84  */
  85 testing::Matcher<std::tuple<double, double>> DoubleEq(const FloatingPointTolerance& tolerance);
  86
  87 /*! \brief Make matcher for reals for use with GoogleMock that compare
  88  * equal when \c tolerance is satisifed.
  89  *
  90  * Used like
  91  *
  92  *   EXPECT_THAT(testReals, Pointwise(RealEq(tolerance), referenceReals));
  93  */
  94 testing::Matcher<std::tuple<real, real>> RealEq(const FloatingPointTolerance& tolerance);
  95
  96 /*! \brief Make matcher for RVecs for use with GoogleMock that compare
  97  * equal when \c tolerance is satisifed.
  98  *
  99  * Used like
 100  *
 101  *   EXPECT_THAT(testRVecs, Pointwise(RVecEq(tolerance), referenceRVecs));
 102  */
 103 testing::Matcher<std::tuple<BasicVector<real>, BasicVector<real>>> RVecEq(const FloatingPointTolerance& tolerance);
 104
 105 } // namespace test
 106 } // namespace gmx
 107
 108 #endif