src/gromacs/analysisdata/tests/analysisdata.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  * 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 /*! \internal \file
  36  * \brief
  37  * Tests for analysis data functionality.
  38  *
  39  * These tests check the functionality of gmx::AnalysisData, as well as classes
  40  * used in its implementation: gmx::AbstractAnalysisData and
  41  * gmx::AnalysisDataStorage.
  42  * Most checking is done using gmx::test::AnalysisDataTestFixture and mock
  43  * modules that implement gmx::AnalysisDataModuleInterface.
  44  *
  45  * \author Teemu Murtola <teemu.murtola@gmail.com>
  46  * \ingroup module_analysisdata
  47  */
  48 #include <gmock/gmock.h>
  49 #include <gtest/gtest.h>
  50
  51 #include "gromacs/analysisdata/analysisdata.h"
  52 #include "gromacs/analysisdata/paralleloptions.h"
  53 #include "gromacs/utility/exceptions.h"
  54
  55 #include "testutils/datatest.h"
  56 #include "testutils/mock_datamodule.h"
  57 #include "testutils/testasserts.h"
  58
  59 using gmx::test::AnalysisDataTestInput;
  60 using gmx::test::MockAnalysisDataModule;
  61 using gmx::test::MockAnalysisDataModulePointer;
  62
  63 namespace
  64 {
  65
  66 /********************************************************************
  67  * Tests for gmx::AnalysisData without any actual data.
  68  */
  69
  70 /*
  71  * Tests that simple initialization works.
  72  */
  73 TEST(AnalysisDataInitializationTest, BasicInitialization)
  74 {
  75     gmx::AnalysisData data;
  76     EXPECT_EQ(0, data.columnCount());
  77     EXPECT_FALSE(data.isMultipoint());
  78     EXPECT_EQ(0, data.frameCount());
  79
  80     data.setColumnCount(1);
  81     EXPECT_EQ(1, data.columnCount());
  82     EXPECT_FALSE(data.isMultipoint());
  83
  84     data.setColumnCount(3);
  85     data.setMultipoint(true);
  86     EXPECT_EQ(3, data.columnCount());
  87     EXPECT_TRUE(data.isMultipoint());
  88
  89     data.setColumnCount(1);
  90     EXPECT_EQ(1, data.columnCount());
  91     EXPECT_TRUE(data.isMultipoint());
  92 }
  93
  94 /*
  95  * Tests that checking for compatibility of modules with multicolumn data
  96  * works.
  97  */
  98 TEST(AnalysisDataInitializationTest, ChecksMultiColumnModules)
  99 {
 100     gmx::AnalysisData data;
 101     data.setColumnCount(2);
 102
 103     MockAnalysisDataModulePointer mod1(new MockAnalysisDataModule(0));
 104     EXPECT_THROW_GMX(data.addModule(mod1), gmx::APIError);
 105
 106     MockAnalysisDataModulePointer mod2(
 107             new MockAnalysisDataModule(gmx::AnalysisDataModuleInterface::efAllowMulticolumn));
 108     EXPECT_NO_THROW_GMX(data.addModule(mod2));
 109 }
 110
 111 /*
 112  * Tests that checking for compatibility of modules with multipoint data
 113  * works.
 114  */
 115 TEST(AnalysisDataInitializationTest, ChecksMultiPointModules)
 116 {
 117     gmx::AnalysisData data;
 118     data.setColumnCount(1);
 119     data.setMultipoint(true);
 120
 121     MockAnalysisDataModulePointer mod1(new MockAnalysisDataModule(0));
 122     EXPECT_THROW_GMX(data.addModule(mod1), gmx::APIError);
 123
 124     MockAnalysisDataModulePointer mod2(
 125             new MockAnalysisDataModule(gmx::AnalysisDataModuleInterface::efAllowMultipoint));
 126     EXPECT_NO_THROW_GMX(data.addModule(mod2));
 127 }
 128
 129
 130 /********************************************************************
 131  * Input data for tests below.
 132  */
 133
 134 // Basic input data for gmx::AnalysisData tests.
 135 class SimpleInputData
 136 {
 137     public:
 138         static const AnalysisDataTestInput &get()
 139         {
 140             static SimpleInputData singleton;
 141             return singleton.data_;
 142         }
 143
 144         SimpleInputData() : data_(3, false)
 145         {
 146             data_.addFrameWithValues(1.0,  0.0, 1.0, 2.0);
 147             data_.addFrameWithValues(2.0,  1.0, 1.0, 1.0);
 148             data_.addFrameWithValues(3.0,  2.0, 0.0, 0.0);
 149         }
 150
 151     private:
 152         AnalysisDataTestInput  data_;
 153 };
 154
 155 // Input data for multipoint gmx::AnalysisData tests.
 156 class MultipointInputData
 157 {
 158     public:
 159         static const AnalysisDataTestInput &get()
 160         {
 161             static MultipointInputData singleton;
 162             return singleton.data_;
 163         }
 164
 165         MultipointInputData() : data_(3, true)
 166         {
 167             using gmx::test::AnalysisDataTestInputFrame;
 168             AnalysisDataTestInputFrame &frame1 = data_.addFrame(1.0);
 169             frame1.addPointSetWithValues(0, 0.0, 1.0, 2.0);
 170             frame1.addPointSetWithValues(0, 1.1, 2.1, 1.1);
 171             frame1.addPointSetWithValues(0, 2.2, 1.2, 0.2);
 172             AnalysisDataTestInputFrame &frame2 = data_.addFrame(2.0);
 173             frame2.addPointSetWithValues(1, 1.0, 1.0);
 174             frame2.addPointSetWithValues(0, 2.1, 1.1, 0.1);
 175             frame2.addPointSetWithValues(2, 1.2);
 176             AnalysisDataTestInputFrame &frame3 = data_.addFrame(3.0);
 177             frame3.addPointSetWithValues(0, 2.0, 0.0, 0.0);
 178             frame3.addPointSetWithValues(0, 3.1, 2.1);
 179             frame3.addPointSetWithValues(1, 2.2, 1.2);
 180         }
 181
 182     private:
 183         AnalysisDataTestInput  data_;
 184 };
 185
 186 /********************************************************************
 187  * Tests for gmx::AnalysisData that require data.
 188  */
 189
 190 using gmx::test::AnalysisDataTestFixture;
 191
 192 class AnalysisDataTest : public AnalysisDataTestFixture
 193 {
 194     public:
 195         explicit AnalysisDataTest(const AnalysisDataTestInput &input)
 196             : input_(input)
 197         {
 198         }
 199
 200         void SetUp()
 201         {
 202             ASSERT_NO_THROW_GMX(setupDataObject(input_, &data_));
 203         }
 204
 205         void addStaticCheckerModule()
 206         {
 207             AnalysisDataTestFixture::addStaticCheckerModule(input_, &data_);
 208         }
 209         void addStaticColumnCheckerModule(int firstColumn, int columnCount)
 210         {
 211             AnalysisDataTestFixture::addStaticColumnCheckerModule(
 212                     input_, firstColumn, columnCount, &data_);
 213         }
 214         void presentAllData()
 215         {
 216             AnalysisDataTestFixture::presentAllData(input_, &data_);
 217         }
 218
 219         const AnalysisDataTestInput &input_;
 220         gmx::AnalysisData            data_;
 221 };
 222
 223 template <class InputDataType>
 224 class AnalysisDataCommonTest : public AnalysisDataTest
 225 {
 226     public:
 227         AnalysisDataCommonTest() : AnalysisDataTest(InputDataType::get())
 228         {
 229         }
 230 };
 231
 232 //! Test fixture for tests that are only applicable to simple data.
 233 typedef AnalysisDataCommonTest<SimpleInputData>     AnalysisDataSimpleTest;
 234 //! Test fixture for tests that are only applicable to multipoint data.
 235 typedef AnalysisDataCommonTest<MultipointInputData> AnalysisDataMultipointTest;
 236 //! List of input data types for tests applicable to all types of data.
 237 typedef ::testing::Types<SimpleInputData, MultipointInputData> AllInputDataTypes;
 238 TYPED_TEST_CASE(AnalysisDataCommonTest, AllInputDataTypes);
 239
 240 /*
 241  * Tests that data is forwarded correctly to modules using two independent
 242  * modules.
 243  */
 244 TYPED_TEST(AnalysisDataCommonTest, CallsModuleCorrectly)
 245 {
 246     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticCheckerModule());
 247     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticCheckerModule());
 248     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
 249 }
 250
 251 /*
 252  * Tests that data is forwarded correctly to modules that are added using
 253  * addColumnModule().
 254  * Uses two independent modules.
 255  */
 256 TYPED_TEST(AnalysisDataCommonTest, CallsColumnModuleCorrectly)
 257 {
 258     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticColumnCheckerModule(0, 2));
 259     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticColumnCheckerModule(2, 1));
 260     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
 261 }
 262
 263 /*
 264  * Tests that data is forwarded correctly (in frame order) to modules when the
 265  * data is added through multiple handles in non-increasing order.
 266  */
 267 TEST_F(AnalysisDataSimpleTest, CallsModuleCorrectlyWithOutOfOrderFrames)
 268 {
 269     ASSERT_NO_THROW_GMX(addStaticCheckerModule());
 270     ASSERT_NO_THROW_GMX(addStaticColumnCheckerModule(1, 2));
 271     gmx::AnalysisDataHandle          handle1;
 272     gmx::AnalysisDataHandle          handle2;
 273     gmx::AnalysisDataParallelOptions options(2);
 274     ASSERT_NO_THROW_GMX(handle1 = data_.startData(options));
 275     ASSERT_NO_THROW_GMX(handle2 = data_.startData(options));
 276     ASSERT_NO_THROW_GMX(presentDataFrame(input_, 1, handle1));
 277     ASSERT_NO_THROW_GMX(presentDataFrame(input_, 0, handle2));
 278     ASSERT_NO_THROW_GMX(presentDataFrame(input_, 2, handle1));
 279     ASSERT_NO_THROW_GMX(handle1.finishData());
 280     ASSERT_NO_THROW_GMX(handle2.finishData());
 281 }
 282
 283 /*
 284  * Tests that data can be accessed correctly from a module that requests
 285  * storage using AbstractAnalysisData::requestStorage() with parameter -1.
 286  */
 287 TEST_F(AnalysisDataSimpleTest, FullStorageWorks)
 288 {
 289     ASSERT_NO_THROW_GMX(addStaticStorageCheckerModule(input_, -1, &data_));
 290     ASSERT_NO_THROW_GMX(presentAllData());
 291 }
 292
 293 /*
 294  * Tests that a data module can be added to an AnalysisData object after data
 295  * has been added if all data is still available in storage.
 296  */
 297 TEST_F(AnalysisDataSimpleTest, CanAddModuleAfterStoredData)
 298 {
 299     ASSERT_TRUE(data_.requestStorage(-1));
 300
 301     ASSERT_NO_THROW_GMX(presentAllData());
 302     ASSERT_NO_THROW_GMX(addStaticCheckerModule());
 303 }
 304
 305 /*
 306  * Tests that data can be accessed correctly from a module that requests
 307  * storage using AbstractAnalysisData::requestStorage() only for one frame.
 308  */
 309 TEST_F(AnalysisDataSimpleTest, LimitedStorageWorks)
 310 {
 311     ASSERT_NO_THROW_GMX(addStaticStorageCheckerModule(input_, 1, &data_));
 312     ASSERT_NO_THROW_GMX(presentAllData());
 313 }
 314
 315 } // namespace