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