2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2011,2012,2013, 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.
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.
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.
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.
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.
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.
37 * Tests for analysis data functionality.
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.
45 * \author Teemu Murtola <teemu.murtola@gmail.com>
46 * \ingroup module_analysisdata
48 #include <gmock/gmock.h>
49 #include <gtest/gtest.h>
51 #include "gromacs/analysisdata/analysisdata.h"
52 #include "gromacs/analysisdata/paralleloptions.h"
53 #include "gromacs/utility/exceptions.h"
55 #include "testutils/datatest.h"
56 #include "testutils/mock_datamodule.h"
57 #include "testutils/testasserts.h"
59 using gmx::test::AnalysisDataTestInput;
60 using gmx::test::MockAnalysisDataModule;
61 using gmx::test::MockAnalysisDataModulePointer;
66 /********************************************************************
67 * Tests for gmx::AnalysisData without any actual data.
71 * Tests that simple initialization works.
73 TEST(AnalysisDataInitializationTest, BasicInitialization)
75 gmx::AnalysisData data;
76 EXPECT_EQ(0, data.columnCount());
77 EXPECT_FALSE(data.isMultipoint());
78 EXPECT_EQ(0, data.frameCount());
80 data.setColumnCount(1);
81 EXPECT_EQ(1, data.columnCount());
82 EXPECT_FALSE(data.isMultipoint());
84 data.setColumnCount(3);
85 data.setMultipoint(true);
86 EXPECT_EQ(3, data.columnCount());
87 EXPECT_TRUE(data.isMultipoint());
89 data.setColumnCount(1);
90 EXPECT_EQ(1, data.columnCount());
91 EXPECT_TRUE(data.isMultipoint());
95 * Tests that checking for compatibility of modules with multicolumn data
98 TEST(AnalysisDataInitializationTest, ChecksMultiColumnModules)
100 gmx::AnalysisData data;
101 data.setColumnCount(2);
103 MockAnalysisDataModulePointer mod1(new MockAnalysisDataModule(0));
104 EXPECT_THROW_GMX(data.addModule(mod1), gmx::APIError);
106 MockAnalysisDataModulePointer mod2(
107 new MockAnalysisDataModule(gmx::AnalysisDataModuleInterface::efAllowMulticolumn));
108 EXPECT_NO_THROW_GMX(data.addModule(mod2));
112 * Tests that checking for compatibility of modules with multipoint data
115 TEST(AnalysisDataInitializationTest, ChecksMultiPointModules)
117 gmx::AnalysisData data;
118 data.setColumnCount(1);
119 data.setMultipoint(true);
121 MockAnalysisDataModulePointer mod1(new MockAnalysisDataModule(0));
122 EXPECT_THROW_GMX(data.addModule(mod1), gmx::APIError);
124 MockAnalysisDataModulePointer mod2(
125 new MockAnalysisDataModule(gmx::AnalysisDataModuleInterface::efAllowMultipoint));
126 EXPECT_NO_THROW_GMX(data.addModule(mod2));
130 /********************************************************************
131 * Input data for tests below.
134 // Basic input data for gmx::AnalysisData tests.
135 class SimpleInputData
138 static const AnalysisDataTestInput &get()
140 static SimpleInputData singleton;
141 return singleton.data_;
144 SimpleInputData() : data_(3, false)
146 data_.addFrameWithValues(1.0, 0.0, 1.0, 2.0);
147 data_.addFrameWithValues(2.0, 1.0, 1.0, 1.0);
148 data_.addFrameWithValues(3.0, 2.0, 0.0, 0.0);
152 AnalysisDataTestInput data_;
155 // Input data for multipoint gmx::AnalysisData tests.
156 class MultipointInputData
159 static const AnalysisDataTestInput &get()
161 static MultipointInputData singleton;
162 return singleton.data_;
165 MultipointInputData() : data_(3, true)
167 using gmx::test::AnalysisDataTestInputFrame;
168 AnalysisDataTestInputFrame &frame1 = data_.addFrame(1.0);
169 frame1.addPointSetWithValues(0, 0.0, 1.0, 2.0);
170 frame1.addPointSetWithValues(0, 1.1, 2.1, 1.1);
171 frame1.addPointSetWithValues(0, 2.2, 1.2, 0.2);
172 AnalysisDataTestInputFrame &frame2 = data_.addFrame(2.0);
173 frame2.addPointSetWithValues(1, 1.0, 1.0);
174 frame2.addPointSetWithValues(0, 2.1, 1.1, 0.1);
175 frame2.addPointSetWithValues(2, 1.2);
176 AnalysisDataTestInputFrame &frame3 = data_.addFrame(3.0);
177 frame3.addPointSetWithValues(0, 2.0, 0.0, 0.0);
178 frame3.addPointSetWithValues(0, 3.1, 2.1);
179 frame3.addPointSetWithValues(1, 2.2, 1.2);
183 AnalysisDataTestInput data_;
186 /********************************************************************
187 * Tests for gmx::AnalysisData that require data.
190 using gmx::test::AnalysisDataTestFixture;
192 class AnalysisDataTest : public AnalysisDataTestFixture
195 explicit AnalysisDataTest(const AnalysisDataTestInput &input)
202 ASSERT_NO_THROW_GMX(setupDataObject(input_, &data_));
205 void addStaticCheckerModule()
207 AnalysisDataTestFixture::addStaticCheckerModule(input_, &data_);
209 void addStaticColumnCheckerModule(int firstColumn, int columnCount)
211 AnalysisDataTestFixture::addStaticColumnCheckerModule(
212 input_, firstColumn, columnCount, &data_);
214 void addStaticStorageCheckerModule(int storageCount)
216 AnalysisDataTestFixture::addStaticStorageCheckerModule(
217 input_, storageCount, &data_);
219 void presentAllData()
221 AnalysisDataTestFixture::presentAllData(input_, &data_);
224 const AnalysisDataTestInput &input_;
225 gmx::AnalysisData data_;
228 template <class InputDataType>
229 class AnalysisDataCommonTest : public AnalysisDataTest
232 AnalysisDataCommonTest() : AnalysisDataTest(InputDataType::get())
237 //! Test fixture for tests that are only applicable to simple data.
238 typedef AnalysisDataCommonTest<SimpleInputData> AnalysisDataSimpleTest;
239 //! Test fixture for tests that are only applicable to multipoint data.
240 typedef AnalysisDataCommonTest<MultipointInputData> AnalysisDataMultipointTest;
241 //! List of input data types for tests applicable to all types of data.
242 typedef ::testing::Types<SimpleInputData, MultipointInputData> AllInputDataTypes;
243 TYPED_TEST_CASE(AnalysisDataCommonTest, AllInputDataTypes);
246 * Tests that data is forwarded correctly to modules using two independent
249 TYPED_TEST(AnalysisDataCommonTest, CallsModuleCorrectly)
251 ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticCheckerModule());
252 ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticCheckerModule());
253 ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
257 * Tests that data is forwarded correctly to modules that are added using
259 * Uses two independent modules.
261 TYPED_TEST(AnalysisDataCommonTest, CallsColumnModuleCorrectly)
263 ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticColumnCheckerModule(0, 2));
264 ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticColumnCheckerModule(2, 1));
265 ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
269 * Tests that data is forwarded correctly (in frame order) to modules when the
270 * data is added through multiple handles in non-increasing order.
272 TYPED_TEST(AnalysisDataCommonTest, CallsModuleCorrectlyWithOutOfOrderFrames)
274 ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticCheckerModule());
275 ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticColumnCheckerModule(1, 2));
276 gmx::AnalysisDataHandle handle1;
277 gmx::AnalysisDataHandle handle2;
278 gmx::AnalysisDataParallelOptions options(2);
279 ASSERT_NO_THROW_GMX(handle1 = this->data_.startData(options));
280 ASSERT_NO_THROW_GMX(handle2 = this->data_.startData(options));
281 ASSERT_NO_THROW_GMX(AnalysisDataTest::presentDataFrame(this->input_, 1, handle1));
282 ASSERT_NO_THROW_GMX(AnalysisDataTest::presentDataFrame(this->input_, 0, handle2));
283 ASSERT_NO_THROW_GMX(AnalysisDataTest::presentDataFrame(this->input_, 2, handle1));
284 ASSERT_NO_THROW_GMX(handle1.finishData());
285 ASSERT_NO_THROW_GMX(handle2.finishData());
289 * Tests that data can be accessed correctly from a module that requests
290 * storage using AbstractAnalysisData::requestStorage() with parameter -1.
292 TYPED_TEST(AnalysisDataCommonTest, FullStorageWorks)
294 ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticStorageCheckerModule(-1));
295 ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
299 * Tests that a data module can be added to an AnalysisData object after data
300 * has been added if all data is still available in storage.
302 TYPED_TEST(AnalysisDataCommonTest, CanAddModuleAfterStoredData)
304 ASSERT_TRUE(this->data_.requestStorage(-1));
306 ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());
307 ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticCheckerModule());
311 * Tests that data can be accessed correctly from a module that requests
312 * storage using AbstractAnalysisData::requestStorage() only for one frame.
314 TYPED_TEST(AnalysisDataCommonTest, LimitedStorageWorks)
316 ASSERT_NO_THROW_GMX(AnalysisDataTest::addStaticStorageCheckerModule(1));
317 ASSERT_NO_THROW_GMX(AnalysisDataTest::presentAllData());