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(1, data.dataSetCount());
  77     EXPECT_EQ(0, data.columnCount(0));
  78     EXPECT_EQ(0, data.columnCount());
  79     EXPECT_FALSE(data.isMultipoint());
  80     EXPECT_EQ(0, data.frameCount());
  81
  82     data.setColumnCount(0, 1);
  83     EXPECT_EQ(1, data.columnCount(0));
  84     EXPECT_EQ(1, data.columnCount());
  85     EXPECT_FALSE(data.isMultipoint());
  86
  87     data.setDataSetCount(2);
  88     EXPECT_EQ(2, data.dataSetCount());
  89     data.setColumnCount(0, 3);
  90     EXPECT_EQ(3, data.columnCount(0));
  91     EXPECT_EQ(0, data.columnCount(1));
  92     data.setColumnCount(1, 2);
  93     EXPECT_EQ(3, data.columnCount(0));
  94     EXPECT_EQ(2, data.columnCount(1));
  95
  96     data.setDataSetCount(1);
  97     EXPECT_EQ(1, data.dataSetCount());
  98     data.setMultipoint(true);
  99     EXPECT_EQ(3, data.columnCount());
 100     EXPECT_TRUE(data.isMultipoint());
 101
 102     data.setColumnCount(0, 1);
 103     EXPECT_EQ(1, data.columnCount());
 104     EXPECT_TRUE(data.isMultipoint());
 105 }
 106
 107 /*
 108  * Tests that checking for compatibility of modules with multicolumn data
 109  * works.
 110  */
 111 TEST(AnalysisDataInitializationTest, ChecksMultiColumnModules)
 112 {
 113     gmx::AnalysisData data;
 114     data.setColumnCount(0, 2);
 115
 116     MockAnalysisDataModulePointer mod1(new MockAnalysisDataModule(0));
 117     EXPECT_THROW_GMX(data.addModule(mod1), gmx::APIError);
 118
 119     MockAnalysisDataModulePointer mod2(
 120             new MockAnalysisDataModule(gmx::AnalysisDataModuleInterface::efAllowMulticolumn));
 121     EXPECT_NO_THROW_GMX(data.addModule(mod2));
 122 }
 123
 124 /*
 125  * Tests that checking for compatibility of modules with multipoint data
 126  * works.
 127  */
 128 TEST(AnalysisDataInitializationTest, ChecksMultipointModules)
 129 {
 130     gmx::AnalysisData data;
 131     data.setColumnCount(0, 1);
 132     data.setMultipoint(true);
 133
 134     MockAnalysisDataModulePointer mod1(new MockAnalysisDataModule(0));
 135     EXPECT_THROW_GMX(data.addModule(mod1), gmx::APIError);
 136
 137     MockAnalysisDataModulePointer mod2(
 138             new MockAnalysisDataModule(gmx::AnalysisDataModuleInterface::efAllowMultipoint));
 139     EXPECT_NO_THROW_GMX(data.addModule(mod2));
 140 }
 141
 142
 143 /********************************************************************
 144  * Input data for tests below.
 145  */
 146
 147 // Basic input data for gmx::AnalysisData tests.
 148 class SimpleInputData
 149 {
 150     public:
 151         static const AnalysisDataTestInput &get()
 152         {
 153             static SimpleInputData singleton;
 154             return singleton.data_;
 155         }
 156
 157         SimpleInputData() : data_(1, false)
 158         {
 159             data_.setColumnCount(0, 3);
 160             data_.addFrameWithValues(1.0,  0.0, 1.0, 2.0);
 161             data_.addFrameWithValues(2.0,  1.0, 1.0, 1.0);
 162             data_.addFrameWithValues(3.0,  2.0, 0.0, 0.0);
 163         }
 164
 165     private:
 166         AnalysisDataTestInput  data_;
 167 };
 168
 169 // Input data with multiple data sets for gmx::AnalysisData tests.
 170 class DataSetsInputData
 171 {
 172     public:
 173         static const AnalysisDataTestInput &get()
 174         {
 175             static DataSetsInputData singleton;
 176             return singleton.data_;
 177         }
 178
 179         DataSetsInputData() : data_(2, false)
 180         {
 181             using gmx::test::AnalysisDataTestInputFrame;
 182             data_.setColumnCount(0, 3);
 183             data_.setColumnCount(1, 2);
 184             AnalysisDataTestInputFrame &frame1 = data_.addFrame(1.0);
 185             frame1.addPointSetWithValues(0, 0, 0.0, 1.0, 2.0);
 186             frame1.addPointSetWithValues(1, 0, 2.1, 1.1);
 187             AnalysisDataTestInputFrame &frame2 = data_.addFrame(2.0);
 188             frame2.addPointSetWithValues(0, 0, 1.0, 1.0, 1.0);
 189             frame2.addPointSetWithValues(1, 0, 0.1, 2.1);
 190             AnalysisDataTestInputFrame &frame3 = data_.addFrame(3.0);
 191             frame3.addPointSetWithValues(0, 0, 2.0, 0.0, 0.0);
 192             frame3.addPointSetWithValues(1, 0, 1.1, 1.1);
 193         }
 194
 195     private:
 196         AnalysisDataTestInput  data_;
 197 };
 198
 199 // Input data for multipoint gmx::AnalysisData tests.
 200 class MultipointInputData
 201 {
 202     public:
 203         static const AnalysisDataTestInput &get()
 204         {
 205             static MultipointInputData singleton;
 206             return singleton.data_;
 207         }
 208
 209         MultipointInputData() : data_(1, true)
 210         {
 211             using gmx::test::AnalysisDataTestInputFrame;
 212             data_.setColumnCount(0, 3);
 213             AnalysisDataTestInputFrame &frame1 = data_.addFrame(1.0);
 214             frame1.addPointSetWithValues(0, 0, 0.0, 1.0, 2.0);
 215             frame1.addPointSetWithValues(0, 0, 1.1, 2.1, 1.1);
 216             frame1.addPointSetWithValues(0, 0, 2.2, 1.2, 0.2);
 217             AnalysisDataTestInputFrame &frame2 = data_.addFrame(2.0);
 218             frame2.addPointSetWithValues(0, 1, 1.0, 1.0);
 219             frame2.addPointSetWithValues(0, 0, 2.1, 1.1, 0.1);
 220             frame2.addPointSetWithValues(0, 2, 1.2);
 221             AnalysisDataTestInputFrame &frame3 = data_.addFrame(3.0);
 222             frame3.addPointSetWithValues(0, 0, 2.0, 0.0, 0.0);
 223             frame3.addPointSetWithValues(0, 0, 3.1, 2.1);
 224             frame3.addPointSetWithValues(0, 1, 2.2, 1.2);
 225         }
 226
 227     private:
 228         AnalysisDataTestInput  data_;
 229 };
 230
 231 // Input data with multiple multipoint data sets for gmx::AnalysisData tests.
 232 class MultipointDataSetsInputData
 233 {
 234     public:
 235         static const AnalysisDataTestInput &get()
 236         {
 237             static MultipointDataSetsInputData singleton;
 238             return singleton.data_;
 239         }
 240
 241         MultipointDataSetsInputData() : data_(2, true)
 242         {
 243             using gmx::test::AnalysisDataTestInputFrame;
 244             data_.setColumnCount(0, 3);
 245             data_.setColumnCount(1, 2);
 246             AnalysisDataTestInputFrame &frame1 = data_.addFrame(1.0);
 247             frame1.addPointSetWithValues(0, 0, 0.0, 1.0, 2.0);
 248             frame1.addPointSetWithValues(0, 1, 2.1, 1.1);
 249             frame1.addPointSetWithValues(1, 0, 2.01, 1.01);
 250             frame1.addPointSetWithValues(1, 1, 0.11);
 251             AnalysisDataTestInputFrame &frame2 = data_.addFrame(2.0);
 252             frame2.addPointSetWithValues(0, 0, 1.0, 1.0, 1.0);
 253             frame2.addPointSetWithValues(0, 0, 0.1, 2.1);
 254             frame2.addPointSetWithValues(1, 1, 1.01);
 255             AnalysisDataTestInputFrame &frame3 = data_.addFrame(3.0);
 256             frame3.addPointSetWithValues(0, 0, 2.0, 0.0, 0.0);
 257             frame3.addPointSetWithValues(0, 1, 1.1);
 258         }
 259
 260     private:
 261         AnalysisDataTestInput  data_;
 262 };
 263
 264 /********************************************************************
 265  * Tests for gmx::AnalysisData that require data.
 266  */
 267
 268 using gmx::test::AnalysisDataTestFixture;
 269
 270 class AnalysisDataTest : public AnalysisDataTestFixture
 271 {
 272     public:
 273         explicit AnalysisDataTest(const AnalysisDataTestInput &input)
 274             : input_(input)
 275         {
 276         }
 277
 278         void SetUp()
 279         {
 280             ASSERT_NO_THROW_GMX(setupDataObject(input_, &data_));
 281         }
 282
 283         void addStaticCheckerModule()
 284         {
 285             AnalysisDataTestFixture::addStaticCheckerModule(input_, &data_);
 286         }
 287         void addStaticColumnCheckerModule(int firstColumn, int columnCount)
 288         {
 289             AnalysisDataTestFixture::addStaticColumnCheckerModule(
 290                     input_, firstColumn, columnCount, &data_);
 291         }
 292         void addStaticStorageCheckerModule(int storageCount)
 293         {
 294             AnalysisDataTestFixture::addStaticStorageCheckerModule(
 295                     input_, storageCount, &data_);
 296         }
 297         void presentAllData()
 298         {
 299             AnalysisDataTestFixture::presentAllData(input_, &data_);
 300         }
 301
 302         const AnalysisDataTestInput &input_;
 303         gmx::AnalysisData            data_;
 304 };
 305
 306 template <class InputDataType>
 307 class AnalysisDataCommonTest : public AnalysisDataTest
 308 {
 309     public:
 310         AnalysisDataCommonTest() : AnalysisDataTest(InputDataType::get())
 311         {
 312         }
 313 };
 314
 315 //! Test fixture for tests that are only applicable to simple data.
 316 typedef AnalysisDataCommonTest<SimpleInputData>     AnalysisDataSimpleTest;
 317 //! Test fixture for tests that are only applicable to multipoint data.
 318 typedef AnalysisDataCommonTest<MultipointInputData> AnalysisDataMultipointTest;
 319 //! List of input data types for tests applicable to all types of data.
 320 typedef ::testing::Types<SimpleInputData,
 321                          DataSetsInputData,
 322                          MultipointInputData,
 323                          MultipointDataSetsInputData>
 324     AllInputDataTypes;
 325 TYPED_TEST_CASE(AnalysisDataCommonTest, AllInputDataTypes);
 326
 327 /*
 328  * Tests that data is forwarded correctly to modules using two independent
 329  * modules.
 330  */
 331 TYPED_TEST(AnalysisDataCommonTest, CallsModuleCorrectly)
 332 {
 333     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticCheckerModule());
 334     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticCheckerModule());
 335     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
 336 }
 337
 338 /*
 339  * Tests that data is forwarded correctly to modules that are added using
 340  * addColumnModule().
 341  * Uses two independent modules.
 342  */
 343 TYPED_TEST(AnalysisDataCommonTest, CallsColumnModuleCorrectly)
 344 {
 345     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticColumnCheckerModule(0, 2));
 346     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticColumnCheckerModule(2, 1));
 347     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
 348 }
 349
 350 /*
 351  * Tests that data is forwarded correctly (in frame order) to modules when the
 352  * data is added through multiple handles in non-increasing order.
 353  */
 354 TYPED_TEST(AnalysisDataCommonTest, CallsModuleCorrectlyWithOutOfOrderFrames)
 355 {
 356     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticCheckerModule());
 357     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticColumnCheckerModule(1, 2));
 358     gmx::AnalysisDataHandle          handle1;
 359     gmx::AnalysisDataHandle          handle2;
 360     gmx::AnalysisDataParallelOptions options(2);
 361     ASSERT_NO_THROW_GMX(handle1 = this->data_.startData(options));
 362     ASSERT_NO_THROW_GMX(handle2 = this->data_.startData(options));
 363     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentDataFrame(this->input_, 1, handle1));
 364     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentDataFrame(this->input_, 0, handle2));
 365     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentDataFrame(this->input_, 2, handle1));
 366     ASSERT_NO_THROW_GMX(handle1.finishData());
 367     ASSERT_NO_THROW_GMX(handle2.finishData());
 368 }
 369
 370 /*
 371  * Tests that data can be accessed correctly from a module that requests
 372  * storage using AbstractAnalysisData::requestStorage() with parameter -1.
 373  */
 374 TYPED_TEST(AnalysisDataCommonTest, FullStorageWorks)
 375 {
 376     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticStorageCheckerModule(-1));
 377     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
 378 }
 379
 380 /*
 381  * Tests that a data module can be added to an AnalysisData object after data
 382  * has been added if all data is still available in storage.
 383  */
 384 TYPED_TEST(AnalysisDataCommonTest, CanAddModuleAfterStoredData)
 385 {
 386     ASSERT_TRUE(this->data_.requestStorage(-1));
 387
 388     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
 389     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticCheckerModule());
 390 }
 391
 392 /*
 393  * Tests that data can be accessed correctly from a module that requests
 394  * storage using AbstractAnalysisData::requestStorage() only for one frame.
 395  */
 396 TYPED_TEST(AnalysisDataCommonTest, LimitedStorageWorks)
 397 {
 398     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticStorageCheckerModule(1));
 399     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
 400 }
 401
 402 } // namespace