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.
  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 //! Test fixture for gmx::AnalysisData.
 131 typedef gmx::test::AnalysisDataTestFixture AnalysisDataTest;
 132
 133 // Basic input data for gmx::AnalysisData tests.
 134 class SimpleInputData
 135 {
 136     public:
 137         static const AnalysisDataTestInput &get()
 138         {
 139             static SimpleInputData singleton;
 140             return singleton.data_;
 141         }
 142
 143         SimpleInputData() : data_(3, false)
 144         {
 145             data_.addFrameWithValues(1.0,  0.0, 1.0, 2.0);
 146             data_.addFrameWithValues(2.0,  1.0, 1.0, 1.0);
 147             data_.addFrameWithValues(3.0,  2.0, 0.0, 0.0);
 148         }
 149
 150     private:
 151         AnalysisDataTestInput  data_;
 152 };
 153
 154 // Input data for multipoint gmx::AnalysisData tests.
 155 class MultipointInputData
 156 {
 157     public:
 158         static const AnalysisDataTestInput &get()
 159         {
 160             static MultipointInputData singleton;
 161             return singleton.data_;
 162         }
 163
 164         MultipointInputData() : data_(3, true)
 165         {
 166             using gmx::test::AnalysisDataTestInputFrame;
 167             AnalysisDataTestInputFrame &frame1 = data_.addFrame(1.0);
 168             frame1.addPointSetWithValues(0, 0.0, 1.0, 2.0);
 169             frame1.addPointSetWithValues(0, 1.1, 2.1, 1.1);
 170             frame1.addPointSetWithValues(0, 2.2, 1.2, 0.2);
 171             AnalysisDataTestInputFrame &frame2 = data_.addFrame(2.0);
 172             frame2.addPointSetWithValues(1, 1.0, 1.0);
 173             frame2.addPointSetWithValues(0, 2.1, 1.1, 0.1);
 174             frame2.addPointSetWithValues(2, 1.2);
 175             AnalysisDataTestInputFrame &frame3 = data_.addFrame(3.0);
 176             frame3.addPointSetWithValues(0, 2.0, 0.0, 0.0);
 177             frame3.addPointSetWithValues(0, 3.1, 2.1);
 178             frame3.addPointSetWithValues(1, 2.2, 1.2);
 179         }
 180
 181     private:
 182         AnalysisDataTestInput  data_;
 183 };
 184
 185 /*
 186  * Tests that data is forwarded correctly to modules using two independent
 187  * modules.
 188  */
 189 TEST_F(AnalysisDataTest, CallsModuleCorrectly)
 190 {
 191     const AnalysisDataTestInput &input = SimpleInputData::get();
 192     gmx::AnalysisData            data;
 193     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 194
 195     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 196     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 197     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 198 }
 199
 200 /*
 201  * Tests that data is forwarded correctly to modules that are added using
 202  * addColumnModule().
 203  * Uses two independent modules.
 204  */
 205 TEST_F(AnalysisDataTest, CallsColumnModuleCorrectly)
 206 {
 207     const AnalysisDataTestInput &input = SimpleInputData::get();
 208     gmx::AnalysisData            data;
 209     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 210
 211     ASSERT_NO_THROW_GMX(addStaticColumnCheckerModule(input, 0, 2, &data));
 212     ASSERT_NO_THROW_GMX(addStaticColumnCheckerModule(input, 2, 1, &data));
 213     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 214 }
 215
 216 /*
 217  * Tests that data is forwarded correctly (in frame order) to modules when the
 218  * data is added through multiple handles in non-increasing order.
 219  */
 220 TEST_F(AnalysisDataTest, CallsModuleCorrectlyWithOutOfOrderFrames)
 221 {
 222     const AnalysisDataTestInput &input = SimpleInputData::get();
 223     gmx::AnalysisData            data;
 224     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 225
 226     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 227     ASSERT_NO_THROW_GMX(addStaticColumnCheckerModule(input, 1, 2, &data));
 228     gmx::AnalysisDataHandle          handle1;
 229     gmx::AnalysisDataHandle          handle2;
 230     gmx::AnalysisDataParallelOptions options(2);
 231     ASSERT_NO_THROW_GMX(handle1 = data.startData(options));
 232     ASSERT_NO_THROW_GMX(handle2 = data.startData(options));
 233     ASSERT_NO_THROW_GMX(presentDataFrame(input, 1, handle1));
 234     ASSERT_NO_THROW_GMX(presentDataFrame(input, 0, handle2));
 235     ASSERT_NO_THROW_GMX(presentDataFrame(input, 2, handle1));
 236     ASSERT_NO_THROW_GMX(handle1.finishData());
 237     ASSERT_NO_THROW_GMX(handle2.finishData());
 238 }
 239
 240 /*
 241  * Tests that data can be accessed correctly from a module that requests
 242  * storage using AbstractAnalysisData::requestStorage() with parameter -1.
 243  */
 244 TEST_F(AnalysisDataTest, FullStorageWorks)
 245 {
 246     const AnalysisDataTestInput &input = SimpleInputData::get();
 247     gmx::AnalysisData            data;
 248     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 249
 250     ASSERT_NO_THROW_GMX(addStaticStorageCheckerModule(input, -1, &data));
 251     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 252 }
 253
 254 /*
 255  * Tests that a data module can be added to an AnalysisData object after data
 256  * has been added if all data is still available in storage.
 257  */
 258 TEST_F(AnalysisDataTest, CanAddModuleAfterStoredData)
 259 {
 260     const AnalysisDataTestInput &input = SimpleInputData::get();
 261     gmx::AnalysisData            data;
 262     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 263     ASSERT_TRUE(data.requestStorage(-1));
 264
 265     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 266     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 267 }
 268
 269 /*
 270  * Tests that data can be accessed correctly from a module that requests
 271  * storage using AbstractAnalysisData::requestStorage() only for one frame.
 272  */
 273 TEST_F(AnalysisDataTest, LimitedStorageWorks)
 274 {
 275     const AnalysisDataTestInput &input = SimpleInputData::get();
 276     gmx::AnalysisData            data;
 277     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 278
 279     ASSERT_NO_THROW_GMX(addStaticStorageCheckerModule(input, 1, &data));
 280     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 281 }
 282
 283 /*
 284  * Tests that multipoint data is forwarded correctly to modules using two
 285  * independent modules.
 286  */
 287 TEST_F(AnalysisDataTest, MultipointCallsModuleCorrectly)
 288 {
 289     const AnalysisDataTestInput &input = MultipointInputData::get();
 290     gmx::AnalysisData            data;
 291     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 292
 293     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 294     ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
 295     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 296 }
 297
 298 /*
 299  * Tests that multipoint data is forwarded correctly to modules that are added
 300  * using addColumnModule().
 301  * Uses two independent modules.
 302  */
 303 TEST_F(AnalysisDataTest, MultipointCallsColumnModuleCorrectly)
 304 {
 305     const AnalysisDataTestInput &input = MultipointInputData::get();
 306     gmx::AnalysisData            data;
 307     ASSERT_NO_THROW_GMX(setupDataObject(input, &data));
 308
 309     ASSERT_NO_THROW_GMX(addStaticColumnCheckerModule(input, 0, 2, &data));
 310     ASSERT_NO_THROW_GMX(addStaticColumnCheckerModule(input, 2, 1, &data));
 311     ASSERT_NO_THROW_GMX(presentAllData(input, &data));
 312 }
 313
 314 } // namespace