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 <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 "gromacs/analysisdata/tests/datatest.h"
  56 #include "gromacs/analysisdata/tests/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 #ifndef INTEL_STATIC_ANON_NAMESPACE_BUG
 154             static SimpleInputData singleton;
 155             return singleton.data_;
 156 #else
 157             static SimpleInputData singleton_analysisdata;
 158             return singleton_analysisdata.data_;
 159 #endif
 160         }
 161
 162         SimpleInputData() : data_(1, false)
 163         {
 164             data_.setColumnCount(0, 3);
 165             data_.addFrameWithValues(1.0,  0.0, 1.0, 2.0);
 166             data_.addFrameWithValues(2.0,  1.0, 1.0, 1.0);
 167             data_.addFrameWithValues(3.0,  2.0, 0.0, 0.0);
 168         }
 169
 170     private:
 171         AnalysisDataTestInput  data_;
 172 };
 173
 174 // Input data with multiple data sets for gmx::AnalysisData tests.
 175 class DataSetsInputData
 176 {
 177     public:
 178         static const AnalysisDataTestInput &get()
 179         {
 180 #ifndef INTEL_STATIC_ANON_NAMESPACE_BUG
 181             static DataSetsInputData singleton;
 182             return singleton.data_;
 183 #else
 184             static DataSetsInputData singleton_analysisdata;
 185             return singleton_analysisdata.data_;
 186 #endif
 187         }
 188
 189         DataSetsInputData() : data_(2, false)
 190         {
 191             using gmx::test::AnalysisDataTestInputFrame;
 192             data_.setColumnCount(0, 3);
 193             data_.setColumnCount(1, 2);
 194             AnalysisDataTestInputFrame &frame1 = data_.addFrame(1.0);
 195             frame1.addPointSetWithValues(0, 0, 0.0, 1.0, 2.0);
 196             frame1.addPointSetWithValues(1, 0, 2.1, 1.1);
 197             AnalysisDataTestInputFrame &frame2 = data_.addFrame(2.0);
 198             frame2.addPointSetWithValues(0, 0, 1.0, 1.0, 1.0);
 199             frame2.addPointSetWithValues(1, 0, 0.1, 2.1);
 200             AnalysisDataTestInputFrame &frame3 = data_.addFrame(3.0);
 201             frame3.addPointSetWithValues(0, 0, 2.0, 0.0, 0.0);
 202             frame3.addPointSetWithValues(1, 0, 1.1, 1.1);
 203         }
 204
 205     private:
 206         AnalysisDataTestInput  data_;
 207 };
 208
 209 // Input data for multipoint gmx::AnalysisData tests.
 210 class MultipointInputData
 211 {
 212     public:
 213         static const AnalysisDataTestInput &get()
 214         {
 215 #ifndef INTEL_STATIC_ANON_NAMESPACE_BUG
 216             static MultipointInputData singleton;
 217             return singleton.data_;
 218 #else
 219             static MultipointInputData singleton_analysisdata;
 220             return singleton_analysisdata.data_;
 221 #endif
 222         }
 223
 224         MultipointInputData() : data_(1, true)
 225         {
 226             using gmx::test::AnalysisDataTestInputFrame;
 227             data_.setColumnCount(0, 3);
 228             AnalysisDataTestInputFrame &frame1 = data_.addFrame(1.0);
 229             frame1.addPointSetWithValues(0, 0, 0.0, 1.0, 2.0);
 230             frame1.addPointSetWithValues(0, 0, 1.1, 2.1, 1.1);
 231             frame1.addPointSetWithValues(0, 0, 2.2, 1.2, 0.2);
 232             AnalysisDataTestInputFrame &frame2 = data_.addFrame(2.0);
 233             frame2.addPointSetWithValues(0, 1, 1.0, 1.0);
 234             frame2.addPointSetWithValues(0, 0, 2.1, 1.1, 0.1);
 235             frame2.addPointSetWithValues(0, 2, 1.2);
 236             AnalysisDataTestInputFrame &frame3 = data_.addFrame(3.0);
 237             frame3.addPointSetWithValues(0, 0, 2.0, 0.0, 0.0);
 238             frame3.addPointSetWithValues(0, 0, 3.1, 2.1);
 239             frame3.addPointSetWithValues(0, 1, 2.2, 1.2);
 240         }
 241
 242     private:
 243         AnalysisDataTestInput  data_;
 244 };
 245
 246 // Input data with multiple multipoint data sets for gmx::AnalysisData tests.
 247 class MultipointDataSetsInputData
 248 {
 249     public:
 250         static const AnalysisDataTestInput &get()
 251         {
 252 #ifndef INTEL_STATIC_ANON_NAMESPACE_BUG
 253             static MultipointDataSetsInputData singleton;
 254             return singleton.data_;
 255 #else
 256             static MultipointDataSetsInputData singleton_analysisdata;
 257             return singleton_analysisdata.data_;
 258 #endif
 259         }
 260
 261         MultipointDataSetsInputData() : data_(2, true)
 262         {
 263             using gmx::test::AnalysisDataTestInputFrame;
 264             data_.setColumnCount(0, 3);
 265             data_.setColumnCount(1, 2);
 266             AnalysisDataTestInputFrame &frame1 = data_.addFrame(1.0);
 267             frame1.addPointSetWithValues(0, 0, 0.0, 1.0, 2.0);
 268             frame1.addPointSetWithValues(0, 1, 2.1, 1.1);
 269             frame1.addPointSetWithValues(1, 0, 2.01, 1.01);
 270             frame1.addPointSetWithValues(1, 1, 0.11);
 271             AnalysisDataTestInputFrame &frame2 = data_.addFrame(2.0);
 272             frame2.addPointSetWithValues(0, 0, 1.0, 1.0, 1.0);
 273             frame2.addPointSetWithValues(0, 0, 0.1, 2.1);
 274             frame2.addPointSetWithValues(1, 1, 1.01);
 275             AnalysisDataTestInputFrame &frame3 = data_.addFrame(3.0);
 276             frame3.addPointSetWithValues(0, 0, 2.0, 0.0, 0.0);
 277             frame3.addPointSetWithValues(0, 1, 1.1);
 278         }
 279
 280     private:
 281         AnalysisDataTestInput  data_;
 282 };
 283
 284 /********************************************************************
 285  * Tests for gmx::AnalysisData that require data.
 286  */
 287
 288 using gmx::test::AnalysisDataTestFixture;
 289
 290 class AnalysisDataTest : public AnalysisDataTestFixture
 291 {
 292     public:
 293         explicit AnalysisDataTest(const AnalysisDataTestInput &input)
 294             : input_(input)
 295         {
 296         }
 297
 298         void SetUp()
 299         {
 300             ASSERT_NO_THROW_GMX(setupDataObject(input_, &data_));
 301         }
 302
 303         void addStaticCheckerModule()
 304         {
 305             AnalysisDataTestFixture::addStaticCheckerModule(input_, &data_);
 306         }
 307         void addStaticParallelCheckerModule()
 308         {
 309             AnalysisDataTestFixture::addStaticParallelCheckerModule(input_, &data_);
 310         }
 311         void addStaticColumnCheckerModule(int firstColumn, int columnCount)
 312         {
 313             AnalysisDataTestFixture::addStaticColumnCheckerModule(
 314                     input_, firstColumn, columnCount, &data_);
 315         }
 316         void addStaticStorageCheckerModule(int storageCount)
 317         {
 318             AnalysisDataTestFixture::addStaticStorageCheckerModule(
 319                     input_, storageCount, &data_);
 320         }
 321         void presentAllData()
 322         {
 323             AnalysisDataTestFixture::presentAllData(input_, &data_);
 324         }
 325
 326         const AnalysisDataTestInput &input_;
 327         gmx::AnalysisData            data_;
 328 };
 329
 330 template <class InputDataType>
 331 class AnalysisDataCommonTest : public AnalysisDataTest
 332 {
 333     public:
 334         AnalysisDataCommonTest() : AnalysisDataTest(InputDataType::get())
 335         {
 336         }
 337 };
 338
 339 //! Test fixture for tests that are only applicable to simple data.
 340 typedef AnalysisDataCommonTest<SimpleInputData>     AnalysisDataSimpleTest;
 341 //! Test fixture for tests that are only applicable to multipoint data.
 342 typedef AnalysisDataCommonTest<MultipointInputData> AnalysisDataMultipointTest;
 343 //! List of input data types for tests applicable to all types of data.
 344 typedef ::testing::Types<SimpleInputData,
 345                          DataSetsInputData,
 346                          MultipointInputData,
 347                          MultipointDataSetsInputData>
 348     AllInputDataTypes;
 349 TYPED_TEST_CASE(AnalysisDataCommonTest, AllInputDataTypes);
 350
 351 /*
 352  * Tests that data is forwarded correctly to modules using two independent
 353  * modules.
 354  */
 355 TYPED_TEST(AnalysisDataCommonTest, CallsModuleCorrectly)
 356 {
 357     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticCheckerModule());
 358     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticCheckerModule());
 359     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
 360 }
 361
 362 /*
 363  * Tests that data is forwarded correctly to modules when there are only
 364  * parallel modules.
 365  */
 366 TYPED_TEST(AnalysisDataCommonTest, CallsParallelModuleCorrectly)
 367 {
 368     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticParallelCheckerModule());
 369     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticParallelCheckerModule());
 370     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
 371 }
 372
 373 /*
 374  * Tests that data is forwarded correctly to modules when there are both
 375  * parallel and serial modules.
 376  */
 377 TYPED_TEST(AnalysisDataCommonTest, CallsMixedModulesCorrectly)
 378 {
 379     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticCheckerModule());
 380     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticParallelCheckerModule());
 381     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
 382 }
 383
 384 /*
 385  * Tests that data is forwarded correctly to modules that are added using
 386  * addColumnModule().
 387  * Uses two independent modules.
 388  */
 389 TYPED_TEST(AnalysisDataCommonTest, CallsColumnModuleCorrectly)
 390 {
 391     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticColumnCheckerModule(0, 2));
 392     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticColumnCheckerModule(2, 1));
 393     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
 394 }
 395
 396 /*
 397  * Tests that data is forwarded correctly (in frame order) to modules when the
 398  * data is added through multiple handles in non-increasing order.
 399  */
 400 TYPED_TEST(AnalysisDataCommonTest, CallsModuleCorrectlyWithOutOfOrderFrames)
 401 {
 402     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticCheckerModule());
 403     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticParallelCheckerModule());
 404     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticColumnCheckerModule(1, 2));
 405     gmx::AnalysisDataHandle          handle1;
 406     gmx::AnalysisDataHandle          handle2;
 407     gmx::AnalysisDataParallelOptions options(2);
 408     ASSERT_NO_THROW_GMX(handle1 = this->data_.startData(options));
 409     ASSERT_NO_THROW_GMX(handle2 = this->data_.startData(options));
 410     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentDataFrame(this->input_, 1, handle1));
 411     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentDataFrame(this->input_, 0, handle2));
 412     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentDataFrame(this->input_, 2, handle1));
 413     ASSERT_NO_THROW_GMX(handle1.finishData());
 414     ASSERT_NO_THROW_GMX(handle2.finishData());
 415 }
 416
 417 /*
 418  * Tests that data can be accessed correctly from a module that requests
 419  * storage using AbstractAnalysisData::requestStorage() with parameter -1.
 420  */
 421 TYPED_TEST(AnalysisDataCommonTest, FullStorageWorks)
 422 {
 423     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticStorageCheckerModule(-1));
 424     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
 425 }
 426
 427 /*
 428  * Tests that a data module can be added to an AnalysisData object after data
 429  * has been added if all data is still available in storage.
 430  */
 431 TYPED_TEST(AnalysisDataCommonTest, CanAddModuleAfterStoredData)
 432 {
 433     ASSERT_TRUE(this->data_.requestStorage(-1));
 434
 435     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
 436     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticCheckerModule());
 437 }
 438
 439 /*
 440  * Tests that data can be accessed correctly from a module that requests
 441  * storage using AbstractAnalysisData::requestStorage() only for one frame.
 442  */
 443 TYPED_TEST(AnalysisDataCommonTest, LimitedStorageWorks)
 444 {
 445     ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticStorageCheckerModule(1));
 446     ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
 447 }
 448
 449 } // namespace