src/testutils/loggertest.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,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  * Declares gmx::test::LoggerTestHelper.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_testutils
  42  */
  43 #ifndef GMX_TESTUTILS_LOGGERTEST_H
  44 #define GMX_TESTUTILS_LOGGERTEST_H
  45
  46 #include "gromacs/utility/classhelpers.h"
  47 #include "gromacs/utility/logger.h"
  48
  49 namespace gmx
  50 {
  51
  52 namespace test
  53 {
  54
  55 /*! \libinternal \brief
  56  * Helper class for tests to check output written to a logger.
  57  *
  58  * \inlibraryapi
  59  * \ingroup module_testutils
  60  */
  61 class LoggerTestHelper
  62 {
  63 public:
  64     LoggerTestHelper();
  65     ~LoggerTestHelper();
  66
  67     //! Returns the logger to pass to code under test.
  68     const MDLogger& logger();
  69
  70     /*! \brief
  71      * Expects a log entry at a given level matching a given regex.
  72      *
  73      * Currently, the order of the entries is not checked, and if this
  74      * method is called once for a log level, then it needs to be called
  75      * for all entries produced by the test.
  76      *
  77      * If not called for a log level, all entries for that level are
  78      * accepted.
  79      */
  80     void expectEntryMatchingRegex(gmx::MDLogger::LogLevel level, const char* re);
  81
  82 private:
  83     class Impl;
  84
  85     PrivateImplPointer<Impl> impl_;
  86 };
  87
  88 } // namespace test
  89 } // namespace gmx
  90
  91 #endif