src/gromacs/analysisdata/tests/analysisdata.cpp

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief
  33  * Tests for analysis data functionality.
  34  *
  35  * These tests check the functionality of gmx::AnalysisData, as well as classes
  36  * used in its implementation: gmx::AbstractAnalysisData and
  37  * gmx::AnalysisDataStorage.
  38  * Most checking is done using gmx::test::AnalysisDataTestFixture and mock
  39  * modules that implement gmx::AnalysisDataModuleInterface.
  40  *
  41  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  42  * \ingroup module_analysisdata
  43  */
  44 #include <gmock/gmock.h>
  45 #include <gtest/gtest.h>
  46
  47 #include "gromacs/analysisdata/analysisdata.h"
  48 #include "gromacs/analysisdata/paralleloptions.h"
  49 #include "gromacs/utility/exceptions.h"
  50
  51 #include "datatest.h"
  52 #include "mock_module.h"
  53
  54 using gmx::test::MockAnalysisModule;
  55 using gmx::test::MockAnalysisModulePointer;
  56
  57 namespace
  58 {
  59
  60 /********************************************************************
  61  * Tests for gmx::AnalysisData.
  62  */
  63
  64 /*
  65  * Tests that simple initialization works.
  66  */
  67 TEST(AnalysisDataInitializationTest, BasicInitialization)
  68 {
  69     gmx::AnalysisData data;
  70     EXPECT_EQ(0, data.columnCount());
  71     EXPECT_FALSE(data.isMultipoint());
  72     EXPECT_EQ(0, data.frameCount());
  73
  74     data.setColumnCount(1);
  75     EXPECT_EQ(1, data.columnCount());
  76     EXPECT_FALSE(data.isMultipoint());
  77
  78     data.setColumnCount(3);
  79     data.setMultipoint(true);
  80     EXPECT_EQ(3, data.columnCount());
  81     EXPECT_TRUE(data.isMultipoint());
  82
  83     data.setColumnCount(1);
  84     EXPECT_EQ(1, data.columnCount());
  85     EXPECT_TRUE(data.isMultipoint());
  86 }
  87
  88 /*
  89  * Tests that checking for compatibility of modules with multicolumn data
  90  * works.
  91  */
  92 TEST(AnalysisDataInitializationTest, ChecksMultiColumnModules)
  93 {
  94     gmx::AnalysisData data;
  95     data.setColumnCount(2);
  96
  97     MockAnalysisModulePointer mod1(new MockAnalysisModule(0));
  98     EXPECT_THROW(data.addModule(mod1), gmx::APIError);
  99
 100     MockAnalysisModulePointer mod2(
 101             new MockAnalysisModule(gmx::AnalysisDataModuleInterface::efAllowMulticolumn));
 102     EXPECT_NO_THROW(data.addModule(mod2));
 103 }
 104
 105 /*
 106  * Tests that checking for compatibility of modules with multipoint data
 107  * works.
 108  */
 109 TEST(AnalysisDataInitializationTest, ChecksMultiPointModules)
 110 {
 111     gmx::AnalysisData data;
 112     data.setColumnCount(1);
 113     data.setMultipoint(true);
 114
 115     MockAnalysisModulePointer mod1(new MockAnalysisModule(0));
 116     EXPECT_THROW(data.addModule(mod1), gmx::APIError);
 117
 118     MockAnalysisModulePointer mod2(
 119             new MockAnalysisModule(gmx::AnalysisDataModuleInterface::efAllowMultipoint));
 120     EXPECT_NO_THROW(data.addModule(mod2));
 121 }
 122
 123
 124 typedef gmx::test::AnalysisDataTestFixture AnalysisDataTest;
 125
 126 // Input data for the tests below.
 127 using gmx::test::END_OF_DATA;
 128 using gmx::test::END_OF_FRAME;
 129 using gmx::test::MPSTOP;
 130 static const real inputdata[] = {
 131     1.0,  0.0, 1.0, 2.0, END_OF_FRAME,
 132     2.0,  1.0, 1.0, 1.0, END_OF_FRAME,
 133     3.0,  2.0, 0.0, 0.0, END_OF_FRAME,
 134     END_OF_DATA
 135 };
 136
 137 /*
 138  * Tests that data is forwarded correctly to modules using two independent
 139  * modules.
 140  */
 141 TEST_F(AnalysisDataTest, CallsModuleCorrectly)
 142 {
 143     gmx::test::AnalysisDataTestInput input(inputdata);
 144     gmx::AnalysisData data;
 145     data.setColumnCount(input.columnCount());
 146
 147     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 148     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 149     ASSERT_NO_THROW(presentAllData(input, &data));
 150 }
 151
 152 /*
 153  * Tests that data is forwarded correctly to modules that are added using
 154  * addColumnModule().
 155  * Uses two independent modules.
 156  */
 157 TEST_F(AnalysisDataTest, CallsColumnModuleCorrectly)
 158 {
 159     gmx::test::AnalysisDataTestInput input(inputdata);
 160     gmx::AnalysisData data;
 161     data.setColumnCount(input.columnCount());
 162
 163     ASSERT_NO_THROW(addStaticColumnCheckerModule(input, 0, 2, &data));
 164     ASSERT_NO_THROW(addStaticColumnCheckerModule(input, 2, 1, &data));
 165     ASSERT_NO_THROW(presentAllData(input, &data));
 166 }
 167
 168 /*
 169  * Tests that data is forwarded correctly (in frame order) to modules when the
 170  * data is added through multiple handles in non-increasing order.
 171  */
 172 TEST_F(AnalysisDataTest, CallsModuleCorrectlyWithOutOfOrderFrames)
 173 {
 174     gmx::test::AnalysisDataTestInput input(inputdata);
 175     gmx::AnalysisData data;
 176     data.setColumnCount(input.columnCount());
 177
 178     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 179     ASSERT_NO_THROW(addStaticColumnCheckerModule(input, 1, 2, &data));
 180     gmx::AnalysisDataHandle handle1;
 181     gmx::AnalysisDataHandle handle2;
 182     gmx::AnalysisDataParallelOptions options(2);
 183     ASSERT_NO_THROW(handle1 = data.startData(options));
 184     ASSERT_NO_THROW(handle2 = data.startData(options));
 185     ASSERT_NO_THROW(presentDataFrame(input, 1, handle1));
 186     ASSERT_NO_THROW(presentDataFrame(input, 0, handle2));
 187     ASSERT_NO_THROW(presentDataFrame(input, 2, handle1));
 188     ASSERT_NO_THROW(handle1.finishData());
 189     ASSERT_NO_THROW(handle2.finishData());
 190 }
 191
 192 /*
 193  * Tests that data can be accessed correctly from a module that requests
 194  * storage using AbstractAnalysisData::requestStorage() with parameter -1.
 195  */
 196 TEST_F(AnalysisDataTest, FullStorageWorks)
 197 {
 198     gmx::test::AnalysisDataTestInput input(inputdata);
 199     gmx::AnalysisData data;
 200     data.setColumnCount(input.columnCount());
 201
 202     ASSERT_NO_THROW(addStaticStorageCheckerModule(input, -1, &data));
 203     ASSERT_NO_THROW(presentAllData(input, &data));
 204 }
 205
 206 /*
 207  * Tests that a data module can be added to an AnalysisData object after data
 208  * has been added if all data is still available in storage.
 209  */
 210 TEST_F(AnalysisDataTest, CanAddModuleAfterStoredData)
 211 {
 212     gmx::test::AnalysisDataTestInput input(inputdata);
 213     gmx::AnalysisData data;
 214     data.setColumnCount(input.columnCount());
 215     ASSERT_TRUE(data.requestStorage(-1));
 216
 217     ASSERT_NO_THROW(presentAllData(input, &data));
 218     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 219 }
 220
 221 /*
 222  * Tests that data can be accessed correctly from a module that requests
 223  * storage using AbstractAnalysisData::requestStorage() only for one frame.
 224  */
 225 TEST_F(AnalysisDataTest, LimitedStorageWorks)
 226 {
 227     gmx::test::AnalysisDataTestInput input(inputdata);
 228     gmx::AnalysisData data;
 229     data.setColumnCount(input.columnCount());
 230
 231     ASSERT_NO_THROW(addStaticStorageCheckerModule(input, 1, &data));
 232     ASSERT_NO_THROW(presentAllData(input, &data));
 233 }
 234
 235 // Input data for the tests below.
 236 static const real multipointinputdata[] = {
 237     1.0,  0.0, 1.0, 2.0, MPSTOP, 1.1, 2.1, 1.1, MPSTOP, 2.2, 1.2, 0.2, END_OF_FRAME,
 238     2.0,  1.0, 1.0, 1.0, MPSTOP, 2.1, 1.1, 0.1, MPSTOP, 1.2, 0.2, 1.2, END_OF_FRAME,
 239     3.0,  2.0, 0.0, 0.0, MPSTOP, 3.1, 2.1, 1.1, MPSTOP, 0.2, 2.2, 1.2, END_OF_FRAME,
 240     END_OF_DATA
 241 };
 242
 243 /*
 244  * Tests that multipoint data is forwarded correctly to modules using two
 245  * independent modules.
 246  */
 247 TEST_F(AnalysisDataTest, MultipointCallsModuleCorrectly)
 248 {
 249     gmx::test::AnalysisDataTestInput input(multipointinputdata);
 250     gmx::AnalysisData data;
 251     data.setColumnCount(input.columnCount());
 252     data.setMultipoint(true);
 253
 254     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 255     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 256     ASSERT_NO_THROW(presentAllData(input, &data));
 257 }
 258
 259 /*
 260  * Tests that multipoint data is forwarded correctly to modules that are added
 261  * using addColumnModule().
 262  * Uses two independent modules.
 263  */
 264 TEST_F(AnalysisDataTest, MultipointCallsColumnModuleCorrectly)
 265 {
 266     gmx::test::AnalysisDataTestInput input(multipointinputdata);
 267     gmx::AnalysisData data;
 268     data.setColumnCount(input.columnCount());
 269     data.setMultipoint(true);
 270
 271     ASSERT_NO_THROW(addStaticColumnCheckerModule(input, 0, 2, &data));
 272     ASSERT_NO_THROW(addStaticColumnCheckerModule(input, 2, 1, &data));
 273     ASSERT_NO_THROW(presentAllData(input, &data));
 274 }
 275
 276 } // namespace