src/gromacs/analysisdata/tests/analysisdata.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2011,2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 "testutils/datatest.h"
  56 #include "testutils/mock_datamodule.h"
  57
  58 using gmx::test::MockAnalysisDataModule;
  59 using gmx::test::MockAnalysisDataModulePointer;
  60
  61 namespace
  62 {
  63
  64 /********************************************************************
  65  * Tests for gmx::AnalysisData.
  66  */
  67
  68 /*
  69  * Tests that simple initialization works.
  70  */
  71 TEST(AnalysisDataInitializationTest, BasicInitialization)
  72 {
  73     gmx::AnalysisData data;
  74     EXPECT_EQ(0, data.columnCount());
  75     EXPECT_FALSE(data.isMultipoint());
  76     EXPECT_EQ(0, data.frameCount());
  77
  78     data.setColumnCount(1);
  79     EXPECT_EQ(1, data.columnCount());
  80     EXPECT_FALSE(data.isMultipoint());
  81
  82     data.setColumnCount(3);
  83     data.setMultipoint(true);
  84     EXPECT_EQ(3, data.columnCount());
  85     EXPECT_TRUE(data.isMultipoint());
  86
  87     data.setColumnCount(1);
  88     EXPECT_EQ(1, data.columnCount());
  89     EXPECT_TRUE(data.isMultipoint());
  90 }
  91
  92 /*
  93  * Tests that checking for compatibility of modules with multicolumn data
  94  * works.
  95  */
  96 TEST(AnalysisDataInitializationTest, ChecksMultiColumnModules)
  97 {
  98     gmx::AnalysisData data;
  99     data.setColumnCount(2);
 100
 101     MockAnalysisDataModulePointer mod1(new MockAnalysisDataModule(0));
 102     EXPECT_THROW(data.addModule(mod1), gmx::APIError);
 103
 104     MockAnalysisDataModulePointer mod2(
 105             new MockAnalysisDataModule(gmx::AnalysisDataModuleInterface::efAllowMulticolumn));
 106     EXPECT_NO_THROW(data.addModule(mod2));
 107 }
 108
 109 /*
 110  * Tests that checking for compatibility of modules with multipoint data
 111  * works.
 112  */
 113 TEST(AnalysisDataInitializationTest, ChecksMultiPointModules)
 114 {
 115     gmx::AnalysisData data;
 116     data.setColumnCount(1);
 117     data.setMultipoint(true);
 118
 119     MockAnalysisDataModulePointer mod1(new MockAnalysisDataModule(0));
 120     EXPECT_THROW(data.addModule(mod1), gmx::APIError);
 121
 122     MockAnalysisDataModulePointer mod2(
 123             new MockAnalysisDataModule(gmx::AnalysisDataModuleInterface::efAllowMultipoint));
 124     EXPECT_NO_THROW(data.addModule(mod2));
 125 }
 126
 127
 128 //! Test fixture for gmx::AnalysisData.
 129 typedef gmx::test::AnalysisDataTestFixture AnalysisDataTest;
 130
 131 using gmx::test::END_OF_FRAME;
 132 using gmx::test::MPSTOP;
 133 //! Input data for gmx::AnalysisData tests.
 134 const real inputdata[] = {
 135     1.0,  0.0, 1.0, 2.0, END_OF_FRAME,
 136     2.0,  1.0, 1.0, 1.0, END_OF_FRAME,
 137     3.0,  2.0, 0.0, 0.0, END_OF_FRAME
 138 };
 139
 140 /*
 141  * Tests that data is forwarded correctly to modules using two independent
 142  * modules.
 143  */
 144 TEST_F(AnalysisDataTest, CallsModuleCorrectly)
 145 {
 146     gmx::test::AnalysisDataTestInput input(inputdata);
 147     gmx::AnalysisData                data;
 148     data.setColumnCount(input.columnCount());
 149
 150     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 151     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 152     ASSERT_NO_THROW(presentAllData(input, &data));
 153 }
 154
 155 /*
 156  * Tests that data is forwarded correctly to modules that are added using
 157  * addColumnModule().
 158  * Uses two independent modules.
 159  */
 160 TEST_F(AnalysisDataTest, CallsColumnModuleCorrectly)
 161 {
 162     gmx::test::AnalysisDataTestInput input(inputdata);
 163     gmx::AnalysisData                data;
 164     data.setColumnCount(input.columnCount());
 165
 166     ASSERT_NO_THROW(addStaticColumnCheckerModule(input, 0, 2, &data));
 167     ASSERT_NO_THROW(addStaticColumnCheckerModule(input, 2, 1, &data));
 168     ASSERT_NO_THROW(presentAllData(input, &data));
 169 }
 170
 171 /*
 172  * Tests that data is forwarded correctly (in frame order) to modules when the
 173  * data is added through multiple handles in non-increasing order.
 174  */
 175 TEST_F(AnalysisDataTest, CallsModuleCorrectlyWithOutOfOrderFrames)
 176 {
 177     gmx::test::AnalysisDataTestInput input(inputdata);
 178     gmx::AnalysisData                data;
 179     data.setColumnCount(input.columnCount());
 180
 181     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 182     ASSERT_NO_THROW(addStaticColumnCheckerModule(input, 1, 2, &data));
 183     gmx::AnalysisDataHandle          handle1;
 184     gmx::AnalysisDataHandle          handle2;
 185     gmx::AnalysisDataParallelOptions options(2);
 186     ASSERT_NO_THROW(handle1 = data.startData(options));
 187     ASSERT_NO_THROW(handle2 = data.startData(options));
 188     ASSERT_NO_THROW(presentDataFrame(input, 1, handle1));
 189     ASSERT_NO_THROW(presentDataFrame(input, 0, handle2));
 190     ASSERT_NO_THROW(presentDataFrame(input, 2, handle1));
 191     ASSERT_NO_THROW(handle1.finishData());
 192     ASSERT_NO_THROW(handle2.finishData());
 193 }
 194
 195 /*
 196  * Tests that data can be accessed correctly from a module that requests
 197  * storage using AbstractAnalysisData::requestStorage() with parameter -1.
 198  */
 199 TEST_F(AnalysisDataTest, FullStorageWorks)
 200 {
 201     gmx::test::AnalysisDataTestInput input(inputdata);
 202     gmx::AnalysisData                data;
 203     data.setColumnCount(input.columnCount());
 204
 205     ASSERT_NO_THROW(addStaticStorageCheckerModule(input, -1, &data));
 206     ASSERT_NO_THROW(presentAllData(input, &data));
 207 }
 208
 209 /*
 210  * Tests that a data module can be added to an AnalysisData object after data
 211  * has been added if all data is still available in storage.
 212  */
 213 TEST_F(AnalysisDataTest, CanAddModuleAfterStoredData)
 214 {
 215     gmx::test::AnalysisDataTestInput input(inputdata);
 216     gmx::AnalysisData                data;
 217     data.setColumnCount(input.columnCount());
 218     ASSERT_TRUE(data.requestStorage(-1));
 219
 220     ASSERT_NO_THROW(presentAllData(input, &data));
 221     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 222 }
 223
 224 /*
 225  * Tests that data can be accessed correctly from a module that requests
 226  * storage using AbstractAnalysisData::requestStorage() only for one frame.
 227  */
 228 TEST_F(AnalysisDataTest, LimitedStorageWorks)
 229 {
 230     gmx::test::AnalysisDataTestInput input(inputdata);
 231     gmx::AnalysisData                data;
 232     data.setColumnCount(input.columnCount());
 233
 234     ASSERT_NO_THROW(addStaticStorageCheckerModule(input, 1, &data));
 235     ASSERT_NO_THROW(presentAllData(input, &data));
 236 }
 237
 238 //! Input data for multipoint gmx::AnalysisData tests.
 239 const real multipointinputdata[] = {
 240     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,
 241     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,
 242     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
 243 };
 244
 245 /*
 246  * Tests that multipoint data is forwarded correctly to modules using two
 247  * independent modules.
 248  */
 249 TEST_F(AnalysisDataTest, MultipointCallsModuleCorrectly)
 250 {
 251     gmx::test::AnalysisDataTestInput input(multipointinputdata);
 252     gmx::AnalysisData                data;
 253     data.setColumnCount(input.columnCount());
 254     data.setMultipoint(true);
 255
 256     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 257     ASSERT_NO_THROW(addStaticCheckerModule(input, &data));
 258     ASSERT_NO_THROW(presentAllData(input, &data));
 259 }
 260
 261 /*
 262  * Tests that multipoint data is forwarded correctly to modules that are added
 263  * using addColumnModule().
 264  * Uses two independent modules.
 265  */
 266 TEST_F(AnalysisDataTest, MultipointCallsColumnModuleCorrectly)
 267 {
 268     gmx::test::AnalysisDataTestInput input(multipointinputdata);
 269     gmx::AnalysisData                data;
 270     data.setColumnCount(input.columnCount());
 271     data.setMultipoint(true);
 272
 273     ASSERT_NO_THROW(addStaticColumnCheckerModule(input, 0, 2, &data));
 274     ASSERT_NO_THROW(addStaticColumnCheckerModule(input, 2, 1, &data));
 275     ASSERT_NO_THROW(presentAllData(input, &data));
 276 }
 277
 278 } // namespace