Improve option support & tests for key-value trees
[alexxy/gromacs.git] / src / gromacs / utility / tests / keyvaluetreeserializer.cpp
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2016,2017, by the GROMACS development team, led by
5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6  * and including many others, as listed in the AUTHORS file in the
7  * top-level source 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 #include "gmxpre.h"
36
37 #include "gromacs/utility/keyvaluetreeserializer.h"
38
39 #include <gtest/gtest.h>
40
41 #include "gromacs/utility/inmemoryserializer.h"
42 #include "gromacs/utility/iserializer.h"
43 #include "gromacs/utility/keyvaluetreebuilder.h"
44
45 #include "testutils/refdata.h"
46
47 namespace
48 {
49
50 class RefDataSerializer : public gmx::ISerializer
51 {
52     public:
53         RefDataSerializer(gmx::test::TestReferenceChecker *parentChecker,
54                           const char                      *id)
55             : checker_(parentChecker->checkCompound("SerializedData", id))
56         {
57         }
58
59         virtual bool reading() const { return false; }
60
61         virtual void doUChar(unsigned char *value)
62         {
63             checker_.checkUChar(*value, nullptr);
64         }
65         virtual void doInt(int *value)
66         {
67             checker_.checkInteger(*value, nullptr);
68         }
69         virtual void doInt64(gmx_int64_t *value)
70         {
71             checker_.checkInt64(*value, nullptr);
72         }
73         virtual void doFloat(float *value)
74         {
75             checker_.checkFloat(*value, nullptr);
76         }
77         virtual void doDouble(double *value)
78         {
79             checker_.checkDouble(*value, nullptr);
80         }
81         virtual void doString(std::string *value)
82         {
83             checker_.checkString(*value, nullptr);
84         }
85
86     private:
87         gmx::test::TestReferenceChecker checker_;
88 };
89
90 class KeyValueTreeSerializerTest : public ::testing::Test
91 {
92     public:
93         void runTest()
94         {
95             gmx::KeyValueTreeObject           input(builder_.build());
96             gmx::test::TestReferenceData      data;
97             gmx::test::TestReferenceChecker   checker(data.rootChecker());
98             checker.checkKeyValueTreeObject(input, "Input");
99             {
100                 RefDataSerializer             serializer(&checker, "Stream");
101                 gmx::serializeKeyValueTree(input, &serializer);
102             }
103             std::vector<char>                 buffer = serializeTree(input);
104             {
105                 gmx::InMemoryDeserializer     deserializer(buffer);
106                 gmx::KeyValueTreeObject       output
107                     = gmx::deserializeKeyValueTree(&deserializer);
108                 checker.checkKeyValueTreeObject(output, "Input");
109             }
110         }
111
112         gmx::KeyValueTreeBuilder builder_;
113
114     private:
115         std::vector<char> serializeTree(const gmx::KeyValueTreeObject &tree)
116         {
117             gmx::InMemorySerializer serializer;
118             gmx::serializeKeyValueTree(tree, &serializer);
119             return serializer.finishAndGetBuffer();
120         }
121 };
122
123 TEST_F(KeyValueTreeSerializerTest, EmptyTree)
124 {
125     runTest();
126 }
127
128 TEST_F(KeyValueTreeSerializerTest, SimpleObject)
129 {
130     builder_.rootObject().addValue<int>("foo", 1);
131     builder_.rootObject().addValue<std::string>("bar", "a");
132     builder_.rootObject().addValue<float>("f", 1.5);
133     builder_.rootObject().addValue<double>("d", 2.5);
134     runTest();
135 }
136
137 TEST_F(KeyValueTreeSerializerTest, ObjectWithArrays)
138 {
139     auto arr1 = builder_.rootObject().addUniformArray<int>("a");
140     arr1.addValue(1);
141     arr1.addValue(2);
142     auto arr2 = builder_.rootObject().addUniformArray<std::string>("b");
143     arr2.addValue("foo");
144     arr2.addValue("bar");
145     runTest();
146 }
147
148 TEST_F(KeyValueTreeSerializerTest, ObjectWithObjects)
149 {
150     auto obj1 = builder_.rootObject().addObject("obj");
151     obj1.addValue<int>("a", 1);
152     obj1.addValue<std::string>("b", "foo");
153     auto obj2 = builder_.rootObject().addObject("obj2");
154     obj2.addValue<int>("c", 2);
155     obj2.addValue<std::string>("d", "bar");
156     builder_.rootObject().addValue<int>("foo", 3);
157     runTest();
158 }
159
160 } // namespace