src/testutils/testmatchers.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018, 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 /*! \internal \file
  37  * \brief Implements floating-point matchers from testmatchers.h for
  38  * use with Google Mock.
  39  *
  40  * \author Mark Abraham <mark.j.abraham@gmail.com>
  41  * \ingroup module_testutils
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "testmatchers.h"
  46
  47 #include <memory>
  48
  49 #include <gmock/gmock.h>
  50
  51 #include "testutils/testasserts.h"
  52
  53 namespace gmx
  54 {
  55 namespace test
  56 {
  57
  58 /*! \brief Implementation class for RealEq matcher.
  59  *
  60  * See RealEq().
  61  *
  62  * The implementation is templated so that we can support all of real,
  63  * float and double in the same build without duplication.
  64  */
  65 template <typename FloatType>
  66 class FloatTypeMatcher : public testing::MatcherInterface < std::tuple < FloatType, FloatType>>
  67 {
  68     public:
  69         //! Constructor
  70         FloatTypeMatcher(const FloatingPointTolerance &tolerance)
  71             : tolerance_(tolerance) {}
  72         //! Compare the two elements of \c arg, return whether they are equal, and comment on \c listener when they are not.
  73         bool MatchAndExplain(std::tuple<FloatType, FloatType> arg,
  74                              testing::MatchResultListener* listener) const override
  75         {
  76             const FloatType        &value1 = std::get<0>(arg);
  77             const FloatType        &value2 = std::get<1>(arg);
  78             FloatingPointDifference diff(value1, value2);
  79             if (tolerance_.isWithin(diff))
  80             {
  81                 return true;
  82             }
  83             *listener->stream()
  84             << "  Actual value: " << value2 << std::endl
  85             << "Expected value: " << value1 << std::endl
  86             << "    Difference: " << diff.toString() << std::endl
  87             << "     Tolerance: " << tolerance_.toString(diff);
  88             return false;
  89         }
  90         //! Describe to a human what matching means.
  91         void DescribeTo(::std::ostream* os) const override
  92         {
  93             *os << "matches within tolerance";
  94         }
  95         //! Describe to a human what failing to match means.
  96         void DescribeNegationTo(::std::ostream* os) const override
  97         {
  98             *os << "does not match within tolerance";
  99         }
 100     private:
 101         //! Tolerance used in matching
 102         FloatingPointTolerance tolerance_;
 103 };
 104
 105 testing::Matcher < std::tuple < float, float>>
 106 FloatEq(const FloatingPointTolerance &tolerance)
 107 {
 108     return testing::MakeMatcher(new FloatTypeMatcher<float>(tolerance));
 109 }
 110
 111 testing::Matcher < std::tuple < double, double>>
 112 DoubleEq(const FloatingPointTolerance &tolerance)
 113 {
 114     return testing::MakeMatcher(new FloatTypeMatcher<double>(tolerance));
 115 }
 116
 117 testing::Matcher < std::tuple < real, real>>
 118 RealEq(const FloatingPointTolerance &tolerance)
 119 {
 120     return testing::MakeMatcher(new FloatTypeMatcher<real>(tolerance));
 121 }
 122
 123 /*! \brief Implementation class for RvecEq matcher
 124  *
 125  * See RvecEq().
 126  */
 127 template <typename FloatType>
 128 class RVecMatcher :
 129     public testing::MatcherInterface < std::tuple < BasicVector<FloatType>, BasicVector<FloatType>>>
 130 {
 131     public:
 132         //! Convenience type
 133         using VectorType = BasicVector<FloatType>;
 134         //! Constructor
 135         RVecMatcher(const FloatingPointTolerance &tolerance)
 136             : tolerance_(tolerance) {}
 137         //! Compare the two elements of \c arg, return whether they are equal, and comment on \c listener when they are not.
 138         bool MatchAndExplain(std::tuple<VectorType, VectorType> arg,
 139                              testing::MatchResultListener* listener) const override
 140         {
 141             const VectorType           &lhs = std::get<0>(arg);
 142             const VectorType           &rhs = std::get<1>(arg);
 143             FloatTypeMatcher<FloatType> floatTypeMatcher(tolerance_);
 144             bool matches = true;
 145             for (int d = 0; d < DIM; ++d)
 146             {
 147                 auto floatTuple = std::make_tuple<FloatType, FloatType>(lhs[d], rhs[d]);
 148                 matches = matches && floatTypeMatcher.MatchAndExplain(floatTuple, listener);
 149             }
 150             return matches;
 151         }
 152         //! Describe to a human what matching means.
 153         void DescribeTo(::std::ostream* os) const override
 154         {
 155             *os << "matches all elements within tolerance";
 156         }
 157         //! Describe to a human what failing to match means.
 158         void DescribeNegationTo(::std::ostream* os) const override
 159         {
 160             *os << "does not match all elements within tolerance";
 161         }
 162     private:
 163         //! Tolerance used in matching
 164         FloatingPointTolerance tolerance_;
 165 };
 166
 167 // Currently there's no need for explicit float or double flavours of
 168 // RVec comparison, but those would be simple to add later.
 169 testing::Matcher < std::tuple < RVec, RVec>>
 170 RVecEq(const FloatingPointTolerance &tolerance)
 171 {
 172     return testing::MakeMatcher(new RVecMatcher<real>(tolerance));
 173 }
 174
 175 }  // namespace test
 176 }  // namespace gmx