src/gromacs/analysisdata/tests/mock_datamodule.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2011,2012,2013,2014,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  * Declares mock implementation of gmx::IAnalysisDataModule.
  38  *
  39  * Requires Google Mock.
  40  *
  41  * \author Teemu Murtola <teemu.murtola@gmail.com>
  42  * \inlibraryapi
  43  * \ingroup module_analysisdata
  44  */
  45 #ifndef GMX_ANALYSISDATA_TESTS_MOCK_DATAMODULE_H
  46 #define GMX_ANALYSISDATA_TESTS_MOCK_DATAMODULE_H
  47
  48 #include <memory>
  49
  50 #include <gmock/gmock.h>
  51
  52 #include "gromacs/analysisdata/dataframe.h"
  53 #include "gromacs/analysisdata/datamodule.h"
  54 #include "gromacs/analysisdata/paralleloptions.h"
  55 #include "gromacs/utility/classhelpers.h"
  56
  57 namespace gmx
  58 {
  59 namespace test
  60 {
  61
  62 class AnalysisDataTestInput;
  63 class TestReferenceChecker;
  64
  65 class MockAnalysisDataModule : public IAnalysisDataModule
  66 {
  67 public:
  68     explicit MockAnalysisDataModule(int flags);
  69     ~MockAnalysisDataModule() override;
  70
  71     int flags() const override;
  72
  73     MOCK_METHOD2(parallelDataStarted,
  74                  bool(AbstractAnalysisData* data, const AnalysisDataParallelOptions& options));
  75     MOCK_METHOD1(dataStarted, void(AbstractAnalysisData* data));
  76     MOCK_METHOD1(frameStarted, void(const AnalysisDataFrameHeader& header));
  77     MOCK_METHOD1(pointsAdded, void(const AnalysisDataPointSetRef& points));
  78     MOCK_METHOD1(frameFinished, void(const AnalysisDataFrameHeader& header));
  79     MOCK_METHOD1(frameFinishedSerial, void(int frameIndex));
  80     MOCK_METHOD0(dataFinished, void());
  81
  82     void setupStaticCheck(const AnalysisDataTestInput& data, AbstractAnalysisData* source, bool bParallel);
  83     void setupStaticColumnCheck(const AnalysisDataTestInput& data, int firstcol, int n, AbstractAnalysisData* source);
  84     void setupStaticStorageCheck(const AnalysisDataTestInput& data,
  85                                  int                          storageCount,
  86                                  AbstractAnalysisData*        source);
  87     void setupReferenceCheck(const TestReferenceChecker& checker, AbstractAnalysisData* source);
  88
  89 private:
  90     class Impl;
  91
  92     PrivateImplPointer<Impl> impl_;
  93 };
  94
  95 //! Smart pointer to manage an MockAnalysisDataModule object.
  96 typedef std::shared_ptr<MockAnalysisDataModule> MockAnalysisDataModulePointer;
  97
  98 } // namespace test
  99 } // namespace gmx
 100
 101 #endif