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,2019, 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 //! Dummy function to raise assert for use of unimplemented function.
  51 void raiseAssert()
  52 {
  53     GMX_RELEASE_ASSERT(false, "Unimplemented function");
  54 }
  55
  56 class RefDataSerializer : public gmx::ISerializer
  57 {
  58 public:
  59     RefDataSerializer(gmx::test::TestReferenceChecker* parentChecker, const char* id) :
  60         checker_(parentChecker->checkCompound("SerializedData", id))
  61     {
  62     }
  63
  64     bool reading() const override { return false; }
  65
  66     void doBool(bool* value) override { checker_.checkBoolean(*value, nullptr); }
  67     void doUChar(unsigned char* value) override { checker_.checkUChar(*value, nullptr); }
  68     void doChar(char* /* value */) override { raiseAssert(); }
  69     void doUShort(unsigned short* /* value */) override { raiseAssert(); }
  70     void doInt(int* value) override { checker_.checkInteger(*value, nullptr); }
  71     void doInt32(int32_t* value) override { checker_.checkInt32(*value, nullptr); }
  72     void doInt64(int64_t* value) override { checker_.checkInt64(*value, nullptr); }
  73     void doFloat(float* value) override { checker_.checkFloat(*value, nullptr); }
  74     void doDouble(double* value) override { checker_.checkDouble(*value, nullptr); }
  75     void doString(std::string* value) override { checker_.checkString(*value, nullptr); }
  76     void doReal(real* /* value */) override { raiseAssert(); }
  77     void doIvec(ivec* /* value */) override { raiseAssert(); }
  78     void doRvec(rvec* /* value */) override { raiseAssert(); }
  79
  80 private:
  81     gmx::test::TestReferenceChecker checker_;
  82 };
  83
  84 class KeyValueTreeSerializerTest : public ::testing::Test
  85 {
  86 public:
  87     void runTest()
  88     {
  89         gmx::KeyValueTreeObject         input(builder_.build());
  90         gmx::test::TestReferenceData    data;
  91         gmx::test::TestReferenceChecker checker(data.rootChecker());
  92         checker.checkKeyValueTreeObject(input, "Input");
  93         {
  94             RefDataSerializer serializer(&checker, "Stream");
  95             gmx::serializeKeyValueTree(input, &serializer);
  96         }
  97         std::vector<char> buffer = serializeTree(input);
  98         {
  99             gmx::InMemoryDeserializer deserializer(buffer, false);
 100             gmx::KeyValueTreeObject   output = gmx::deserializeKeyValueTree(&deserializer);
 101             checker.checkKeyValueTreeObject(output, "Input");
 102         }
 103     }
 104
 105     gmx::KeyValueTreeBuilder builder_;
 106
 107 private:
 108     std::vector<char> serializeTree(const gmx::KeyValueTreeObject& tree)
 109     {
 110         gmx::InMemorySerializer serializer;
 111         gmx::serializeKeyValueTree(tree, &serializer);
 112         return serializer.finishAndGetBuffer();
 113     }
 114 };
 115
 116 TEST_F(KeyValueTreeSerializerTest, EmptyTree)
 117 {
 118     runTest();
 119 }
 120
 121 TEST_F(KeyValueTreeSerializerTest, SimpleObject)
 122 {
 123     builder_.rootObject().addValue<int>("foo", 1);
 124     builder_.rootObject().addValue<int32_t>("foo32", 1);
 125     builder_.rootObject().addValue<int64_t>("foo64", 1);
 126     builder_.rootObject().addValue<std::string>("bar", "a");
 127     builder_.rootObject().addValue<float>("f", 1.5);
 128     builder_.rootObject().addValue<double>("d", 2.5);
 129     runTest();
 130 }
 131
 132 TEST_F(KeyValueTreeSerializerTest, ObjectWithArrays)
 133 {
 134     auto arr1 = builder_.rootObject().addUniformArray<int>("a");
 135     arr1.addValue(1);
 136     arr1.addValue(2);
 137     auto arr2 = builder_.rootObject().addUniformArray<std::string>("b");
 138     arr2.addValue("foo");
 139     arr2.addValue("bar");
 140     runTest();
 141 }
 142
 143 TEST_F(KeyValueTreeSerializerTest, ObjectWithObjects)
 144 {
 145     auto obj1 = builder_.rootObject().addObject("obj");
 146     obj1.addValue<int>("a", 1);
 147     obj1.addValue<std::string>("b", "foo");
 148     auto obj2 = builder_.rootObject().addObject("obj2");
 149     obj2.addValue<int>("c", 2);
 150     obj2.addValue<std::string>("d", "bar");
 151     builder_.rootObject().addValue<int>("foo", 3);
 152     runTest();
 153 }
 154
 155 } // namespace