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::MockAnalysisDataModule;
60 using gmx::test::MockAnalysisDataModulePointer;
65 /********************************************************************
66 * Tests for gmx::AnalysisData.
70 * Tests that simple initialization works.
72 TEST(AnalysisDataInitializationTest, BasicInitialization)
74 gmx::AnalysisData data;
75 EXPECT_EQ(0, data.columnCount());
76 EXPECT_FALSE(data.isMultipoint());
77 EXPECT_EQ(0, data.frameCount());
79 data.setColumnCount(1);
80 EXPECT_EQ(1, data.columnCount());
81 EXPECT_FALSE(data.isMultipoint());
83 data.setColumnCount(3);
84 data.setMultipoint(true);
85 EXPECT_EQ(3, data.columnCount());
86 EXPECT_TRUE(data.isMultipoint());
88 data.setColumnCount(1);
89 EXPECT_EQ(1, data.columnCount());
90 EXPECT_TRUE(data.isMultipoint());
94 * Tests that checking for compatibility of modules with multicolumn data
97 TEST(AnalysisDataInitializationTest, ChecksMultiColumnModules)
99 gmx::AnalysisData data;
100 data.setColumnCount(2);
102 MockAnalysisDataModulePointer mod1(new MockAnalysisDataModule(0));
103 EXPECT_THROW_GMX(data.addModule(mod1), gmx::APIError);
105 MockAnalysisDataModulePointer mod2(
106 new MockAnalysisDataModule(gmx::AnalysisDataModuleInterface::efAllowMulticolumn));
107 EXPECT_NO_THROW_GMX(data.addModule(mod2));
111 * Tests that checking for compatibility of modules with multipoint data
114 TEST(AnalysisDataInitializationTest, ChecksMultiPointModules)
116 gmx::AnalysisData data;
117 data.setColumnCount(1);
118 data.setMultipoint(true);
120 MockAnalysisDataModulePointer mod1(new MockAnalysisDataModule(0));
121 EXPECT_THROW_GMX(data.addModule(mod1), gmx::APIError);
123 MockAnalysisDataModulePointer mod2(
124 new MockAnalysisDataModule(gmx::AnalysisDataModuleInterface::efAllowMultipoint));
125 EXPECT_NO_THROW_GMX(data.addModule(mod2));
129 //! Test fixture for gmx::AnalysisData.
130 typedef gmx::test::AnalysisDataTestFixture AnalysisDataTest;
132 using gmx::test::END_OF_FRAME;
133 using gmx::test::MPSTOP;
134 //! Input data for gmx::AnalysisData tests.
135 const real inputdata[] = {
136 1.0, 0.0, 1.0, 2.0, END_OF_FRAME,
137 2.0, 1.0, 1.0, 1.0, END_OF_FRAME,
138 3.0, 2.0, 0.0, 0.0, END_OF_FRAME
142 * Tests that data is forwarded correctly to modules using two independent
145 TEST_F(AnalysisDataTest, CallsModuleCorrectly)
147 gmx::test::AnalysisDataTestInput input(inputdata);
148 gmx::AnalysisData data;
149 data.setColumnCount(input.columnCount());
151 ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
152 ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
153 ASSERT_NO_THROW_GMX(presentAllData(input, &data));
157 * Tests that data is forwarded correctly to modules that are added using
159 * Uses two independent modules.
161 TEST_F(AnalysisDataTest, CallsColumnModuleCorrectly)
163 gmx::test::AnalysisDataTestInput input(inputdata);
164 gmx::AnalysisData data;
165 data.setColumnCount(input.columnCount());
167 ASSERT_NO_THROW_GMX(addStaticColumnCheckerModule(input, 0, 2, &data));
168 ASSERT_NO_THROW_GMX(addStaticColumnCheckerModule(input, 2, 1, &data));
169 ASSERT_NO_THROW_GMX(presentAllData(input, &data));
173 * Tests that data is forwarded correctly (in frame order) to modules when the
174 * data is added through multiple handles in non-increasing order.
176 TEST_F(AnalysisDataTest, CallsModuleCorrectlyWithOutOfOrderFrames)
178 gmx::test::AnalysisDataTestInput input(inputdata);
179 gmx::AnalysisData data;
180 data.setColumnCount(input.columnCount());
182 ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
183 ASSERT_NO_THROW_GMX(addStaticColumnCheckerModule(input, 1, 2, &data));
184 gmx::AnalysisDataHandle handle1;
185 gmx::AnalysisDataHandle handle2;
186 gmx::AnalysisDataParallelOptions options(2);
187 ASSERT_NO_THROW_GMX(handle1 = data.startData(options));
188 ASSERT_NO_THROW_GMX(handle2 = data.startData(options));
189 ASSERT_NO_THROW_GMX(presentDataFrame(input, 1, handle1));
190 ASSERT_NO_THROW_GMX(presentDataFrame(input, 0, handle2));
191 ASSERT_NO_THROW_GMX(presentDataFrame(input, 2, handle1));
192 ASSERT_NO_THROW_GMX(handle1.finishData());
193 ASSERT_NO_THROW_GMX(handle2.finishData());
197 * Tests that data can be accessed correctly from a module that requests
198 * storage using AbstractAnalysisData::requestStorage() with parameter -1.
200 TEST_F(AnalysisDataTest, FullStorageWorks)
202 gmx::test::AnalysisDataTestInput input(inputdata);
203 gmx::AnalysisData data;
204 data.setColumnCount(input.columnCount());
206 ASSERT_NO_THROW_GMX(addStaticStorageCheckerModule(input, -1, &data));
207 ASSERT_NO_THROW_GMX(presentAllData(input, &data));
211 * Tests that a data module can be added to an AnalysisData object after data
212 * has been added if all data is still available in storage.
214 TEST_F(AnalysisDataTest, CanAddModuleAfterStoredData)
216 gmx::test::AnalysisDataTestInput input(inputdata);
217 gmx::AnalysisData data;
218 data.setColumnCount(input.columnCount());
219 ASSERT_TRUE(data.requestStorage(-1));
221 ASSERT_NO_THROW_GMX(presentAllData(input, &data));
222 ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
226 * Tests that data can be accessed correctly from a module that requests
227 * storage using AbstractAnalysisData::requestStorage() only for one frame.
229 TEST_F(AnalysisDataTest, LimitedStorageWorks)
231 gmx::test::AnalysisDataTestInput input(inputdata);
232 gmx::AnalysisData data;
233 data.setColumnCount(input.columnCount());
235 ASSERT_NO_THROW_GMX(addStaticStorageCheckerModule(input, 1, &data));
236 ASSERT_NO_THROW_GMX(presentAllData(input, &data));
239 //! Input data for multipoint gmx::AnalysisData tests.
240 const real multipointinputdata[] = {
241 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,
242 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,
243 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
247 * Tests that multipoint data is forwarded correctly to modules using two
248 * independent modules.
250 TEST_F(AnalysisDataTest, MultipointCallsModuleCorrectly)
252 gmx::test::AnalysisDataTestInput input(multipointinputdata);
253 gmx::AnalysisData data;
254 data.setColumnCount(input.columnCount());
255 data.setMultipoint(true);
257 ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
258 ASSERT_NO_THROW_GMX(addStaticCheckerModule(input, &data));
259 ASSERT_NO_THROW_GMX(presentAllData(input, &data));
263 * Tests that multipoint data is forwarded correctly to modules that are added
264 * using addColumnModule().
265 * Uses two independent modules.
267 TEST_F(AnalysisDataTest, MultipointCallsColumnModuleCorrectly)
269 gmx::test::AnalysisDataTestInput input(multipointinputdata);
270 gmx::AnalysisData data;
271 data.setColumnCount(input.columnCount());
272 data.setMultipoint(true);
274 ASSERT_NO_THROW_GMX(addStaticColumnCheckerModule(input, 0, 2, &data));
275 ASSERT_NO_THROW_GMX(addStaticColumnCheckerModule(input, 2, 1, &data));
276 ASSERT_NO_THROW_GMX(presentAllData(input, &data));