src/gromacs/utility/tests/keyvaluetreeserializer.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,2018, 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         bool reading() const override { return false; }
  60
  61         void doBool(bool *value) override
  62         {
  63             checker_.checkBoolean(*value, nullptr);
  64         }
  65         void doUChar(unsigned char *value) override
  66         {
  67             checker_.checkUChar(*value, nullptr);
  68         }
  69         void doInt(int *value) override
  70         {
  71             checker_.checkInteger(*value, nullptr);
  72         }
  73         void doInt64(int64_t *value) override
  74         {
  75             checker_.checkInt64(*value, nullptr);
  76         }
  77         void doFloat(float *value) override
  78         {
  79             checker_.checkFloat(*value, nullptr);
  80         }
  81         void doDouble(double *value) override
  82         {
  83             checker_.checkDouble(*value, nullptr);
  84         }
  85         void doString(std::string *value) override
  86         {
  87             checker_.checkString(*value, nullptr);
  88         }
  89
  90     private:
  91         gmx::test::TestReferenceChecker checker_;
  92 };
  93
  94 class KeyValueTreeSerializerTest : public ::testing::Test
  95 {
  96     public:
  97         void runTest()
  98         {
  99             gmx::KeyValueTreeObject           input(builder_.build());
 100             gmx::test::TestReferenceData      data;
 101             gmx::test::TestReferenceChecker   checker(data.rootChecker());
 102             checker.checkKeyValueTreeObject(input, "Input");
 103             {
 104                 RefDataSerializer             serializer(&checker, "Stream");
 105                 gmx::serializeKeyValueTree(input, &serializer);
 106             }
 107             std::vector<char>                 buffer = serializeTree(input);
 108             {
 109                 gmx::InMemoryDeserializer     deserializer(buffer);
 110                 gmx::KeyValueTreeObject       output
 111                     = gmx::deserializeKeyValueTree(&deserializer);
 112                 checker.checkKeyValueTreeObject(output, "Input");
 113             }
 114         }
 115
 116         gmx::KeyValueTreeBuilder builder_;
 117
 118     private:
 119         std::vector<char> serializeTree(const gmx::KeyValueTreeObject &tree)
 120         {
 121             gmx::InMemorySerializer serializer;
 122             gmx::serializeKeyValueTree(tree, &serializer);
 123             return serializer.finishAndGetBuffer();
 124         }
 125 };
 126
 127 TEST_F(KeyValueTreeSerializerTest, EmptyTree)
 128 {
 129     runTest();
 130 }
 131
 132 TEST_F(KeyValueTreeSerializerTest, SimpleObject)
 133 {
 134     builder_.rootObject().addValue<int>("foo", 1);
 135     builder_.rootObject().addValue<std::string>("bar", "a");
 136     builder_.rootObject().addValue<float>("f", 1.5);
 137     builder_.rootObject().addValue<double>("d", 2.5);
 138     runTest();
 139 }
 140
 141 TEST_F(KeyValueTreeSerializerTest, ObjectWithArrays)
 142 {
 143     auto arr1 = builder_.rootObject().addUniformArray<int>("a");
 144     arr1.addValue(1);
 145     arr1.addValue(2);
 146     auto arr2 = builder_.rootObject().addUniformArray<std::string>("b");
 147     arr2.addValue("foo");
 148     arr2.addValue("bar");
 149     runTest();
 150 }
 151
 152 TEST_F(KeyValueTreeSerializerTest, ObjectWithObjects)
 153 {
 154     auto obj1 = builder_.rootObject().addObject("obj");
 155     obj1.addValue<int>("a", 1);
 156     obj1.addValue<std::string>("b", "foo");
 157     auto obj2 = builder_.rootObject().addObject("obj2");
 158     obj2.addValue<int>("c", 2);
 159     obj2.addValue<std::string>("d", "bar");
 160     builder_.rootObject().addValue<int>("foo", 3);
 161     runTest();
 162 }
 163
 164 } // namespace