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