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/fatalerror/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.setColumns(1);
  75     EXPECT_EQ(1, data.columnCount());
  76     EXPECT_FALSE(data.isMultipoint());
  77
  78     data.setColumns(3, true);
  79     EXPECT_EQ(3, data.columnCount());
  80     EXPECT_TRUE(data.isMultipoint());
  81
  82     data.setColumns(1);
  83     EXPECT_EQ(1, data.columnCount());
  84     EXPECT_FALSE(data.isMultipoint());
  85 }
  86
  87 /*
  88  * Tests that checking for compatibility of modules with multicolumn data
  89  * works.
  90  */
  91 TEST(AnalysisDataInitializationTest, ChecksMultiColumnModules)
  92 {
  93     gmx::AnalysisData data;
  94     data.setColumns(2);
  95
  96     MockAnalysisModulePointer mod1(new MockAnalysisModule(0));
  97     EXPECT_THROW(data.addModule(mod1), gmx::APIError);
  98
  99     MockAnalysisModulePointer mod2(
 100             new MockAnalysisModule(gmx::AnalysisDataModuleInterface::efAllowMulticolumn));
 101     EXPECT_NO_THROW(data.addModule(mod2));
 102 }
 103
 104 /*
 105  * Tests that checking for compatibility of modules with multipoint data
 106  * works.
 107  */
 108 TEST(AnalysisDataInitializationTest, ChecksMultiPointModules)
 109 {
 110     gmx::AnalysisData data;
 111     data.setColumns(1, true);
 112
 113     MockAnalysisModulePointer mod1(new MockAnalysisModule(0));
 114     EXPECT_THROW(data.addModule(mod1), gmx::APIError);
 115
 116     MockAnalysisModulePointer mod2(
 117             new MockAnalysisModule(gmx::AnalysisDataModuleInterface::efAllowMultipoint));
 118     EXPECT_NO_THROW(data.addModule(mod2));
 119 }
 120
 121
 122 typedef gmx::test::AnalysisDataTestFixture AnalysisDataTest;
 123
 124 // Input data for the tests below.
 125 using gmx::test::END_OF_DATA;
 126 using gmx::test::END_OF_FRAME;
 127 using gmx::test::MPSTOP;
 128 static const real inputdata[] = {
 129     1.0,  0.0, 1.0, 2.0, END_OF_FRAME,
 130     2.0,  1.0, 1.0, 1.0, END_OF_FRAME,
 131     3.0,  2.0, 0.0, 0.0, END_OF_FRAME,
 132     END_OF_DATA
 133 };
 134
 135 /*
 136  * Tests that data is forwarded correctly to modules using two independent
 137  * modules.
 138  */
 139 TEST_F(AnalysisDataTest, CallsModuleCorrectly)
 140 {
 141     gmx::test::AnalysisDataTestInput input(inputdata);
 142     gmx::AnalysisData data;
 143     data.setColumns(input.columnCount());
 144
 145     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 146     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 147     ASSERT_NO_THROW(presentAllData(input, &data));
 148 }
 149
 150 /*
 151  * Tests that data is forwarded correctly to modules that are added using
 152  * addColumnModule().
 153  * Uses two independent modules.
 154  */
 155 TEST_F(AnalysisDataTest, CallsColumnModuleCorrectly)
 156 {
 157     gmx::test::AnalysisDataTestInput input(inputdata);
 158     gmx::AnalysisData data;
 159     data.setColumns(input.columnCount());
 160
 161     ASSERT_NO_THROW(addStaticColumnCheckerModule(input, 0, 2, &data));
 162     ASSERT_NO_THROW(addStaticColumnCheckerModule(input, 2, 1, &data));
 163     ASSERT_NO_THROW(presentAllData(input, &data));
 164 }
 165
 166 /*
 167  * Tests that data is forwarded correctly (in frame order) to modules when the
 168  * data is added through multiple handles in non-increasing order.
 169  */
 170 TEST_F(AnalysisDataTest, CallsModuleCorrectlyWithOutOfOrderFrames)
 171 {
 172     gmx::test::AnalysisDataTestInput input(inputdata);
 173     gmx::AnalysisData data;
 174     data.setColumns(input.columnCount());
 175
 176     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 177     ASSERT_NO_THROW(addStaticColumnCheckerModule(input, 1, 2, &data));
 178     gmx::AnalysisDataHandle handle1;
 179     gmx::AnalysisDataHandle handle2;
 180     gmx::AnalysisDataParallelOptions options(2);
 181     ASSERT_NO_THROW(handle1 = data.startData(options));
 182     ASSERT_NO_THROW(handle2 = data.startData(options));
 183     ASSERT_NO_THROW(presentDataFrame(input, 1, handle1));
 184     ASSERT_NO_THROW(presentDataFrame(input, 0, handle2));
 185     ASSERT_NO_THROW(presentDataFrame(input, 2, handle1));
 186     ASSERT_NO_THROW(handle1.finishData());
 187     ASSERT_NO_THROW(handle2.finishData());
 188 }
 189
 190 /*
 191  * Tests that data can be accessed correctly from a module that requests
 192  * storage using AbstractAnalysisData::requestStorage() with parameter -1.
 193  */
 194 TEST_F(AnalysisDataTest, FullStorageWorks)
 195 {
 196     gmx::test::AnalysisDataTestInput input(inputdata);
 197     gmx::AnalysisData data;
 198     data.setColumns(input.columnCount());
 199
 200     ASSERT_NO_THROW(addStaticStorageCheckerModule(input, -1, &data));
 201     ASSERT_NO_THROW(presentAllData(input, &data));
 202 }
 203
 204 /*
 205  * Tests that a data module can be added to an AnalysisData object after data
 206  * has been added if all data is still available in storage.
 207  */
 208 TEST_F(AnalysisDataTest, CanAddModuleAfterStoredData)
 209 {
 210     gmx::test::AnalysisDataTestInput input(inputdata);
 211     gmx::AnalysisData data;
 212     data.setColumns(input.columnCount());
 213     ASSERT_TRUE(data.requestStorage(-1));
 214
 215     ASSERT_NO_THROW(presentAllData(input, &data));
 216     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 217 }
 218
 219 /*
 220  * Tests that data can be accessed correctly from a module that requests
 221  * storage using AbstractAnalysisData::requestStorage() only for one frame.
 222  */
 223 TEST_F(AnalysisDataTest, LimitedStorageWorks)
 224 {
 225     gmx::test::AnalysisDataTestInput input(inputdata);
 226     gmx::AnalysisData data;
 227     data.setColumns(input.columnCount());
 228
 229     ASSERT_NO_THROW(addStaticStorageCheckerModule(input, 1, &data));
 230     ASSERT_NO_THROW(presentAllData(input, &data));
 231 }
 232
 233 // Input data for the tests below.
 234 static const real multipointinputdata[] = {
 235     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,
 236     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,
 237     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,
 238     END_OF_DATA
 239 };
 240
 241 /*
 242  * Tests that multipoint data is forwarded correctly to modules using two
 243  * independent modules.
 244  */
 245 TEST_F(AnalysisDataTest, MultipointCallsModuleCorrectly)
 246 {
 247     gmx::test::AnalysisDataTestInput input(multipointinputdata);
 248     gmx::AnalysisData data;
 249     data.setColumns(input.columnCount(), true);
 250
 251     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 252     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 253     ASSERT_NO_THROW(presentAllData(input, &data));
 254 }
 255
 256 /*
 257  * Tests that multipoint data is forwarded correctly to modules that are added
 258  * using addColumnModule().
 259  * Uses two independent modules.
 260  */
 261 TEST_F(AnalysisDataTest, MultipointCallsColumnModuleCorrectly)
 262 {
 263     gmx::test::AnalysisDataTestInput input(multipointinputdata);
 264     gmx::AnalysisData data;
 265     data.setColumns(input.columnCount(), true);
 266
 267     ASSERT_NO_THROW(addStaticColumnCheckerModule(input, 0, 2, &data));
 268     ASSERT_NO_THROW(addStaticColumnCheckerModule(input, 2, 1, &data));
 269     ASSERT_NO_THROW(presentAllData(input, &data));
 270 }
 271
 272 } // namespace