src/testutils/datatest.cpp

   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  * 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 classes in datatest.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_testutils
  41  */
  42 #include "datatest.h"
  43
  44 #include <gmock/gmock.h>
  45 #include <gtest/gtest.h>
  46
  47 #include "gromacs/analysisdata/analysisdata.h"
  48 #include "gromacs/analysisdata/paralleloptions.h"
  49 #include "gromacs/utility/gmxassert.h"
  50 #include "gromacs/utility/stringutil.h"
  51
  52 #include "testutils/mock_datamodule.h"
  53 #include "testutils/refdata.h"
  54
  55 namespace gmx
  56 {
  57
  58 namespace test
  59 {
  60
  61 /********************************************************************
  62  * AnalysisDataTestInputPointSet
  63  */
  64
  65 AnalysisDataTestInputPointSet::AnalysisDataTestInputPointSet(
  66         int index, int dataSetIndex, int firstColumn)
  67     : index_(index), dataSetIndex_(dataSetIndex), firstColumn_(firstColumn)
  68 {
  69 }
  70
  71
  72 /********************************************************************
  73  * AnalysisDataTestInputFrame
  74  */
  75
  76 AnalysisDataTestInputFrame::AnalysisDataTestInputFrame(int index, real x)
  77     : index_(index), x_(x)
  78 {
  79 }
  80
  81 AnalysisDataTestInputPointSet &
  82 AnalysisDataTestInputFrame::addPointSet(int dataSet, int firstColumn)
  83 {
  84     pointSets_.push_back(
  85             AnalysisDataTestInputPointSet(pointSets_.size(),
  86                                           dataSet, firstColumn));
  87     return pointSets_.back();
  88 }
  89
  90 void AnalysisDataTestInputFrame::addPointSetWithValues(
  91         int dataSet, int firstColumn, real y1)
  92 {
  93     AnalysisDataTestInputPointSet &pointSet = addPointSet(dataSet, firstColumn);
  94     pointSet.addValue(y1);
  95 }
  96
  97 void AnalysisDataTestInputFrame::addPointSetWithValues(
  98         int dataSet, int firstColumn, real y1, real y2)
  99 {
 100     AnalysisDataTestInputPointSet &pointSet = addPointSet(dataSet, firstColumn);
 101     pointSet.addValue(y1);
 102     pointSet.addValue(y2);
 103 }
 104
 105 void AnalysisDataTestInputFrame::addPointSetWithValues(
 106         int dataSet, int firstColumn, real y1, real y2, real y3)
 107 {
 108     AnalysisDataTestInputPointSet &pointSet = addPointSet(dataSet, firstColumn);
 109     pointSet.addValue(y1);
 110     pointSet.addValue(y2);
 111     pointSet.addValue(y3);
 112 }
 113
 114 void AnalysisDataTestInputFrame::addPointSetWithValueAndError(
 115         int dataSet, int firstColumn, real y1, real e1)
 116 {
 117     AnalysisDataTestInputPointSet &pointSet = addPointSet(dataSet, firstColumn);
 118     pointSet.addValueWithError(y1, e1);
 119 }
 120
 121
 122 /********************************************************************
 123  * AnalysisDataTestInput
 124  */
 125
 126 AnalysisDataTestInput::AnalysisDataTestInput(int dataSetCount, bool bMultipoint)
 127     : columnCounts_(dataSetCount), bMultipoint_(bMultipoint)
 128 {
 129 }
 130
 131
 132 AnalysisDataTestInput::~AnalysisDataTestInput()
 133 {
 134 }
 135
 136
 137 const AnalysisDataTestInputFrame &AnalysisDataTestInput::frame(int index) const
 138 {
 139     GMX_RELEASE_ASSERT(index >= 0 && index < frameCount(),
 140                        "Out-of-range frame index");
 141     return frames_[index];
 142 }
 143
 144
 145 void AnalysisDataTestInput::setColumnCount(int dataSet, int columnCount)
 146 {
 147     GMX_RELEASE_ASSERT(dataSet >= 0 && dataSet < dataSetCount(),
 148                        "Out-of-range data set index");
 149     columnCounts_[dataSet] = columnCount;
 150 }
 151
 152
 153 AnalysisDataTestInputFrame &AnalysisDataTestInput::addFrame(real x)
 154 {
 155     frames_.push_back(AnalysisDataTestInputFrame(frames_.size(), x));
 156     return frames_.back();
 157 }
 158
 159 void AnalysisDataTestInput::addFrameWithValues(real x, real y1)
 160 {
 161     AnalysisDataTestInputFrame &frame = addFrame(x);
 162     frame.addPointSetWithValues(0, 0, y1);
 163 }
 164
 165 void AnalysisDataTestInput::addFrameWithValues(real x, real y1, real y2)
 166 {
 167     AnalysisDataTestInputFrame &frame = addFrame(x);
 168     frame.addPointSetWithValues(0, 0, y1, y2);
 169 }
 170
 171 void AnalysisDataTestInput::addFrameWithValues(real x, real y1, real y2, real y3)
 172 {
 173     AnalysisDataTestInputFrame &frame = addFrame(x);
 174     frame.addPointSetWithValues(0, 0, y1, y2, y3);
 175 }
 176
 177 void AnalysisDataTestInput::addFrameWithValueAndError(real x, real y1, real e1)
 178 {
 179     AnalysisDataTestInputFrame &frame = addFrame(x);
 180     frame.addPointSetWithValueAndError(0, 0, y1, e1);
 181 }
 182
 183
 184 /********************************************************************
 185  * AnalysisDataTest
 186  */
 187
 188 AnalysisDataTestFixture::AnalysisDataTestFixture()
 189 {
 190 }
 191
 192
 193 void AnalysisDataTestFixture::setupDataObject(const AnalysisDataTestInput &input,
 194                                               AnalysisData                *data)
 195 {
 196     data->setDataSetCount(input.dataSetCount());
 197     for (int i = 0; i < input.dataSetCount(); ++i)
 198     {
 199         data->setColumnCount(i, input.columnCount(i));
 200     }
 201     data->setMultipoint(input.isMultipoint());
 202 }
 203
 204
 205 void AnalysisDataTestFixture::presentAllData(const AnalysisDataTestInput &input,
 206                                              AnalysisData                *data)
 207 {
 208     gmx::AnalysisDataParallelOptions options;
 209     gmx::AnalysisDataHandle          handle = data->startData(options);
 210     for (int row = 0; row < input.frameCount(); ++row)
 211     {
 212         presentDataFrame(input, row, handle);
 213         EXPECT_EQ(row + 1, data->frameCount());
 214     }
 215     handle.finishData();
 216 }
 217
 218
 219 void AnalysisDataTestFixture::presentDataFrame(const AnalysisDataTestInput &input,
 220                                                int row, AnalysisDataHandle handle)
 221 {
 222     const AnalysisDataTestInputFrame &frame = input.frame(row);
 223     handle.startFrame(row, frame.x(), frame.dx());
 224     for (int i = 0; i < frame.pointSetCount(); ++i)
 225     {
 226         const AnalysisDataTestInputPointSet &points = frame.pointSet(i);
 227         handle.selectDataSet(points.dataSetIndex());
 228         for (int j = 0; j < points.size(); ++j)
 229         {
 230             if (points.hasError(j))
 231             {
 232                 handle.setPoint(j + points.firstColumn(),
 233                                 points.y(j), points.error(j), points.present(j));
 234             }
 235             else
 236             {
 237                 handle.setPoint(j + points.firstColumn(),
 238                                 points.y(j), points.present(j));
 239             }
 240         }
 241         if (input.isMultipoint())
 242         {
 243             handle.finishPointSet();
 244         }
 245     }
 246     handle.finishFrame();
 247 }
 248
 249
 250 void
 251 AnalysisDataTestFixture::addStaticCheckerModule(const AnalysisDataTestInput &data,
 252                                                 AbstractAnalysisData        *source)
 253 {
 254     MockAnalysisDataModulePointer module(new MockAnalysisDataModule(0));
 255     module->setupStaticCheck(data, source, false);
 256     source->addModule(module);
 257 }
 258
 259
 260 void
 261 AnalysisDataTestFixture::addStaticParallelCheckerModule(
 262         const AnalysisDataTestInput &data,
 263         AbstractAnalysisData        *source)
 264 {
 265     MockAnalysisDataModulePointer module(new MockAnalysisDataModule(0));
 266     module->setupStaticCheck(data, source, true);
 267     source->addModule(module);
 268 }
 269
 270
 271 void
 272 AnalysisDataTestFixture::addStaticColumnCheckerModule(const AnalysisDataTestInput &data,
 273                                                       int firstcol, int n,
 274                                                       AbstractAnalysisData *source)
 275 {
 276     MockAnalysisDataModulePointer module(new MockAnalysisDataModule(0));
 277     module->setupStaticColumnCheck(data, firstcol, n, source);
 278     source->addColumnModule(firstcol, n, module);
 279 }
 280
 281
 282 void
 283 AnalysisDataTestFixture::addStaticStorageCheckerModule(const AnalysisDataTestInput &data,
 284                                                        int                          storageCount,
 285                                                        AbstractAnalysisData        *source)
 286 {
 287     MockAnalysisDataModulePointer module(new MockAnalysisDataModule(0));
 288     module->setupStaticStorageCheck(data, storageCount, source);
 289     source->addModule(module);
 290 }
 291
 292
 293 void
 294 AnalysisDataTestFixture::addReferenceCheckerModule(TestReferenceChecker  checker,
 295                                                    const char           *id,
 296                                                    AbstractAnalysisData *source)
 297 {
 298     MockAnalysisDataModulePointer module(new MockAnalysisDataModule(0));
 299     module->setupReferenceCheck(checker.checkCompound("AnalysisData", id), source);
 300     source->addModule(module);
 301 }
 302
 303
 304 void
 305 AnalysisDataTestFixture::addReferenceCheckerModule(const char           *id,
 306                                                    AbstractAnalysisData *source)
 307 {
 308     addReferenceCheckerModule(data_.rootChecker(), id, source);
 309 }
 310
 311 } // namespace test
 312 } // namespace gmx