src/testutils/loggertest.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,2019,2020,2021, 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  * Implements gmx::test::LoggerTestHelper.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_testutils
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "testutils/loggertest.h"
  45
  46 #include <gmock/gmock.h>
  47
  48 #include "gromacs/utility/basedefinitions.h"
  49 #include "gromacs/utility/logger.h"
  50
  51 namespace gmx
  52 {
  53 namespace test
  54 {
  55
  56 using ::testing::NiceMock;
  57
  58 namespace
  59 {
  60 class MockLogTarget : public ILogTarget
  61 {
  62 public:
  63     MOCK_METHOD1(writeEntry, void(const LogEntry&));
  64 };
  65 } // namespace
  66
  67 /********************************************************************
  68  * LoggerTestHelper::Impl
  69  */
  70
  71 class LoggerTestHelper::Impl
  72 {
  73 public:
  74     Impl()
  75     {
  76         // TODO: Add support for -stdout for echoing the log to stdout.
  77         logger_.warning = LogLevelHelper(&getTarget(MDLogger::LogLevel::Warning));
  78         logger_.info    = LogLevelHelper(&getTarget(MDLogger::LogLevel::Info));
  79     }
  80
  81     NiceMock<MockLogTarget>& getTarget(MDLogger::LogLevel level)
  82     {
  83         return targets_[static_cast<int>(level)];
  84     }
  85
  86     NiceMock<MockLogTarget> targets_[MDLogger::LogLevelCount];
  87     MDLogger                logger_;
  88 };
  89
  90 /********************************************************************
  91  * LoggerTestHelper
  92  */
  93
  94 LoggerTestHelper::LoggerTestHelper() : impl_(new Impl) {}
  95
  96 LoggerTestHelper::~LoggerTestHelper() {}
  97
  98 const MDLogger& LoggerTestHelper::logger()
  99 {
 100     return impl_->logger_;
 101 }
 102
 103 void LoggerTestHelper::expectEntryMatchingRegex(gmx::MDLogger::LogLevel level, const char* re)
 104 {
 105     using ::testing::ContainsRegex;
 106     using ::testing::Field;
 107     auto& target = impl_->getTarget(level);
 108     EXPECT_CALL(target, writeEntry(Field(&LogEntry::text, ContainsRegex(re))));
 109 }
 110
 111 void LoggerTestHelper::expectNoEntries(gmx::MDLogger::LogLevel level)
 112 {
 113     auto& target = impl_->getTarget(level);
 114     EXPECT_CALL(target, writeEntry(testing::_)).Times(0);
 115 }
 116
 117 } // namespace test
 118 } // namespace gmx