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