src/testutils/mock_datamodule.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2011,2012,2013, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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::AnalysisDataModuleInterface.
  38  *
  39  * Requires Google Mock.
  40  *
  41  * \author Teemu Murtola <teemu.murtola@gmail.com>
  42  * \inlibraryapi
  43  * \ingroup module_testutils
  44  */
  45 #ifndef GMX_TESTUTILS_MOCK_DATAMODULE_H
  46 #define GMX_TESTUTILS_MOCK_DATAMODULE_H
  47
  48 #include <boost/shared_ptr.hpp>
  49 #include <gmock/gmock.h>
  50
  51 #include "gromacs/analysisdata/dataframe.h"
  52 #include "gromacs/analysisdata/datamodule.h"
  53 #include "gromacs/analysisdata/paralleloptions.h"
  54 #include "gromacs/utility/common.h"
  55
  56 namespace gmx
  57 {
  58 namespace test
  59 {
  60
  61 class AnalysisDataTestInput;
  62 class TestReferenceChecker;
  63
  64 class MockAnalysisDataModule : public AnalysisDataModuleInterface
  65 {
  66     public:
  67         explicit MockAnalysisDataModule(int flags);
  68         virtual ~MockAnalysisDataModule();
  69
  70         virtual int flags() const;
  71
  72         MOCK_METHOD2(parallelDataStarted,
  73                      bool(AbstractAnalysisData              *data,
  74                           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_METHOD0(dataFinished, void());
  80
  81         void setupStaticCheck(const AnalysisDataTestInput &data,
  82                               AbstractAnalysisData        *source,
  83                               bool                         bParallel);
  84         void setupStaticColumnCheck(const AnalysisDataTestInput &data,
  85                                     int firstcol, int n,
  86                                     AbstractAnalysisData *source);
  87         void setupStaticStorageCheck(const AnalysisDataTestInput &data,
  88                                      int                          storageCount,
  89                                      AbstractAnalysisData        *source);
  90         void setupReferenceCheck(const TestReferenceChecker &checker,
  91                                  AbstractAnalysisData       *source);
  92
  93     private:
  94         class Impl;
  95
  96         PrivateImplPointer<Impl> impl_;
  97 };
  98
  99 //! Smart pointer to manage an MockAnalysisDataModule object.
 100 typedef boost::shared_ptr<MockAnalysisDataModule>
 101     MockAnalysisDataModulePointer;
 102
 103 } // namespace test
 104 } // namespace gmx
 105
 106 #endif