folly/test/DynamicConverterTest.cpp

   1 /*
   2  * Copyright 2016 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 // @author Nicholas Ormrod <njormrod@fb.com>
  18
  19 #include <folly/DynamicConverter.h>
  20
  21 #include <algorithm>
  22 #include <gtest/gtest.h>
  23 #include <map>
  24 #include <vector>
  25
  26 using namespace folly;
  27 using namespace folly::dynamicconverter_detail;
  28
  29 TEST(DynamicConverter, template_metaprogramming) {
  30   struct A {};
  31
  32   bool c1f = is_container<int>::value;
  33   bool c2f = is_container<std::pair<int, int>>::value;
  34   bool c3f = is_container<A>::value;
  35   bool c4f = class_is_container<A>::value;
  36
  37   bool c1t = is_container<std::vector<int>>::value;
  38   bool c2t = is_container<std::set<int>>::value;
  39   bool c3t = is_container<std::map<int, int>>::value;
  40   bool c4t = class_is_container<std::vector<A>>::value;
  41
  42   EXPECT_EQ(c1f, false);
  43   EXPECT_EQ(c2f, false);
  44   EXPECT_EQ(c3f, false);
  45   EXPECT_EQ(c4f, false);
  46   EXPECT_EQ(c1t, true);
  47   EXPECT_EQ(c2t, true);
  48   EXPECT_EQ(c3t, true);
  49   EXPECT_EQ(c4t, true);
  50
  51
  52   bool m1f = is_map<int>::value;
  53   bool m2f = is_map<std::set<int>>::value;
  54
  55   bool m1t = is_map<std::map<int, int>>::value;
  56
  57   EXPECT_EQ(m1f, false);
  58   EXPECT_EQ(m2f, false);
  59   EXPECT_EQ(m1t, true);
  60
  61
  62   bool r1f = is_range<int>::value;
  63
  64   bool r1t = is_range<std::set<int>>::value;
  65   bool r2t = is_range<std::vector<int>>::value;
  66
  67   EXPECT_EQ(r1f, false);
  68   EXPECT_EQ(r1t, true);
  69   EXPECT_EQ(r2t, true);
  70 }
  71
  72 TEST(DynamicConverter, arithmetic_types) {
  73   dynamic d1 = 12;
  74   auto i1 = convertTo<int>(d1);
  75   EXPECT_EQ(i1, 12);
  76
  77   dynamic d2 = 123456789012345;
  78   auto i2 = convertTo<int64_t>(d2);
  79   EXPECT_EQ(i2, 123456789012345);
  80
  81   dynamic d4 = 3.141;
  82   auto i4 = convertTo<float>(d4);
  83   EXPECT_EQ((int)(i4*100), 314);
  84
  85   dynamic d5 = true;
  86   auto i5 = convertTo<bool>(d5);
  87   EXPECT_EQ(i5, true);
  88
  89   dynamic d6 = 15;
  90   const auto i6 = convertTo<const int>(d6);
  91   EXPECT_EQ(i6, 15);
  92
  93   dynamic d7 = "87";
  94   auto i7 = convertTo<int>(d7);
  95   EXPECT_EQ(i7, 87);
  96
  97   dynamic d8 = "false";
  98   auto i8 = convertTo<bool>(d8);
  99   EXPECT_EQ(i8, false);
 100 }
 101
 102 TEST(DynamicConverter, simple_builtins) {
 103   dynamic d1 = "Haskell";
 104   auto i1 = convertTo<folly::fbstring>(d1);
 105   EXPECT_EQ(i1, "Haskell");
 106
 107   dynamic d2 = 13;
 108   auto i2 = convertTo<std::string>(d2);
 109   EXPECT_EQ(i2, "13");
 110
 111   dynamic d3 = { 12, "Scala" };
 112   auto i3 = convertTo<std::pair<int, std::string>>(d3);
 113   EXPECT_EQ(i3.first, 12);
 114   EXPECT_EQ(i3.second, "Scala");
 115
 116   dynamic d4 = dynamic::object("C", "C++");
 117   auto i4 = convertTo<std::pair<std::string, folly::fbstring>>(d4);
 118   EXPECT_EQ(i4.first, "C");
 119   EXPECT_EQ(i4.second, "C++");
 120 }
 121
 122 TEST(DynamicConverter, simple_fbvector) {
 123   dynamic d1 = { 1, 2, 3 };
 124   auto i1 = convertTo<folly::fbvector<int>>(d1);
 125   decltype(i1) i1b = { 1, 2, 3 };
 126   EXPECT_EQ(i1, i1b);
 127 }
 128
 129 TEST(DynamicConverter, simple_container) {
 130   dynamic d1 = { 1, 2, 3 };
 131   auto i1 = convertTo<std::vector<int>>(d1);
 132   decltype(i1) i1b = { 1, 2, 3 };
 133   EXPECT_EQ(i1, i1b);
 134
 135   dynamic d2 = { 1, 3, 5, 2, 4 };
 136   auto i2 = convertTo<std::set<int>>(d2);
 137   decltype(i2) i2b = { 1, 2, 3, 5, 4 };
 138   EXPECT_EQ(i2, i2b);
 139 }
 140
 141 TEST(DynamicConverter, simple_map) {
 142   dynamic d1 = dynamic::object(1, "one")(2, "two");
 143   auto i1 = convertTo<std::map<int, std::string>>(d1);
 144   decltype(i1) i1b = { { 1, "one" }, { 2, "two" } };
 145   EXPECT_EQ(i1, i1b);
 146
 147   dynamic d2 = { { 3, "three" }, { 4, "four" } };
 148   auto i2 = convertTo<std::unordered_map<int, std::string>>(d2);
 149   decltype(i2) i2b = { { 3, "three" }, { 4, "four" } };
 150   EXPECT_EQ(i2, i2b);
 151 }
 152
 153 TEST(DynamicConverter, map_keyed_by_string) {
 154   dynamic d1 = dynamic::object("1", "one")("2", "two");
 155   auto i1 = convertTo<std::map<std::string, std::string>>(d1);
 156   decltype(i1) i1b = { { "1", "one" }, { "2", "two" } };
 157   EXPECT_EQ(i1, i1b);
 158
 159   dynamic d2 = { { "3", "three" }, { "4", "four" } };
 160   auto i2 = convertTo<std::unordered_map<std::string, std::string>>(d2);
 161   decltype(i2) i2b = { { "3", "three" }, { "4", "four" } };
 162   EXPECT_EQ(i2, i2b);
 163 }
 164
 165 TEST(DynamicConverter, map_to_vector_of_pairs) {
 166   dynamic d1 = dynamic::object("1", "one")("2", "two");
 167   auto i1 = convertTo<std::vector<std::pair<std::string, std::string>>>(d1);
 168   std::sort(i1.begin(), i1.end());
 169   decltype(i1) i1b = { { "1", "one" }, { "2", "two" } };
 170   EXPECT_EQ(i1, i1b);
 171 }
 172
 173 TEST(DynamicConverter, nested_containers) {
 174   dynamic d1 = { { 1 }, { }, { 2, 3 } };
 175   auto i1 = convertTo<folly::fbvector<std::vector<uint8_t>>>(d1);
 176   decltype(i1) i1b = { { 1 }, { }, { 2, 3 } };
 177   EXPECT_EQ(i1, i1b);
 178
 179   dynamic h2a = { "3", ".", "1", "4" };
 180   dynamic h2b = { "2", ".", "7", "2" };
 181   dynamic d2 = dynamic::object(3.14, h2a)(2.72, h2b);
 182   auto i2 = convertTo<std::map<double, std::vector<folly::fbstring>>>(d2);
 183   decltype(i2) i2b =
 184     { { 3.14, { "3", ".", "1", "4" } },
 185       { 2.72, { "2", ".", "7", "2" } } };
 186   EXPECT_EQ(i2, i2b);
 187 }
 188
 189 struct A {
 190   int i;
 191   bool operator==(const A & o) const { return i == o.i; }
 192 };
 193 namespace folly {
 194 template <> struct DynamicConverter<A> {
 195   static A convert(const dynamic & d) {
 196     return { convertTo<int>(d["i"]) };
 197   }
 198 };
 199 }
 200 TEST(DynamicConverter, custom_class) {
 201   dynamic d1 = dynamic::object("i", 17);
 202   auto i1 = convertTo<A>(d1);
 203   EXPECT_EQ(i1.i, 17);
 204
 205   dynamic d2 = { dynamic::object("i", 18), dynamic::object("i", 19) };
 206   auto i2 = convertTo<std::vector<A>>(d2);
 207   decltype(i2) i2b = { { 18 }, { 19 } };
 208   EXPECT_EQ(i2, i2b);
 209 }
 210
 211 TEST(DynamicConverter, crazy) {
 212   // we are going to create a vector<unordered_map<bool, T>>
 213   // we will construct some of the maps from dynamic objects,
 214   //   some from a vector of KV pairs.
 215   // T will be vector<set<string>>
 216
 217   std::set<std::string>
 218     s1 = { "a", "e", "i", "o", "u" },
 219     s2 = { "2", "3", "5", "7" },
 220     s3 = { "Hello", "World" };
 221
 222   std::vector<std::set<std::string>>
 223     v1 = {},
 224     v2 = { s1, s2 },
 225     v3 = { s3 };
 226
 227   std::unordered_map<bool, std::vector<std::set<std::string>>>
 228     m1 = { { true, v1 }, { false, v2 } },
 229     m2 = { { true, v3 } };
 230
 231   std::vector<std::unordered_map<bool, std::vector<std::set<std::string>>>>
 232     f1 = { m1, m2 };
 233
 234
 235   dynamic
 236     ds1 = { "a", "e", "i", "o", "u" },
 237     ds2 = { "2", "3", "5", "7" },
 238     ds3 = { "Hello", "World" };
 239
 240   dynamic
 241     dv1 = {},
 242     dv2 = { ds1, ds2 },
 243     dv3({ ds3 });
 244
 245   dynamic
 246     dm1 = dynamic::object(true, dv1)(false, dv2),
 247     dm2 = { { true, dv3 } };
 248
 249   dynamic
 250     df1 = { dm1, dm2 };
 251
 252
 253   auto i = convertTo<std::vector<std::unordered_map<bool, std::vector<
 254           std::set<std::string>>>>>(df1); // yes, that is 5 close-chevrons
 255
 256   EXPECT_EQ(f1, i);
 257 }
 258
 259 TEST(DynamicConverter, consts) {
 260   dynamic d1 = 7.5;
 261   auto i1 = convertTo<const double>(d1);
 262   EXPECT_EQ(7.5, i1);
 263
 264   dynamic d2 = "Hello";
 265   auto i2 = convertTo<const std::string>(d2);
 266   decltype(i2) i2b = "Hello";
 267   EXPECT_EQ(i2b, i2);
 268
 269   dynamic d3 = true;
 270   auto i3 = convertTo<const bool>(d3);
 271   EXPECT_EQ(true, i3);
 272
 273   dynamic d4 = "true";
 274   auto i4 = convertTo<const bool>(d4);
 275   EXPECT_EQ(true, i4);
 276
 277   dynamic d5 = { 1, 2 };
 278   auto i5 = convertTo<const std::pair<const int, const int>>(d5);
 279   decltype(i5) i5b = { 1, 2 };
 280   EXPECT_EQ(i5b, i5);
 281 }
 282
 283 struct Token {
 284   int kind_;
 285   fbstring lexeme_;
 286
 287   explicit Token(int kind, const fbstring& lexeme)
 288     : kind_(kind), lexeme_(lexeme) {}
 289 };
 290
 291 namespace folly {
 292 template <> struct DynamicConverter<Token> {
 293   static Token convert(const dynamic& d) {
 294     int k = convertTo<int>(d["KIND"]);
 295     fbstring lex = convertTo<fbstring>(d["LEXEME"]);
 296     return Token(k, lex);
 297   }
 298 };
 299 }
 300
 301 TEST(DynamicConverter, example) {
 302   dynamic d1 = dynamic::object("KIND", 2)("LEXEME", "a token");
 303   auto i1 = convertTo<Token>(d1);
 304   EXPECT_EQ(i1.kind_, 2);
 305   EXPECT_EQ(i1.lexeme_, "a token");
 306 }
 307
 308 TEST(DynamicConverter, construct) {
 309   using std::vector;
 310   using std::map;
 311   using std::pair;
 312   using std::string;
 313   {
 314     vector<int> c { 1, 2, 3 };
 315     dynamic d = { 1, 2, 3 };
 316     EXPECT_EQ(d, toDynamic(c));
 317   }
 318
 319   {
 320     map<int, int> c { { 2, 4 }, { 3, 9 } };
 321     dynamic d = dynamic::object(2, 4)(3, 9);
 322     EXPECT_EQ(d, toDynamic(c));
 323   }
 324
 325   {
 326     map<string, string> c { { "a", "b" } };
 327     dynamic d = dynamic::object("a", "b");
 328     EXPECT_EQ(d, toDynamic(c));
 329   }
 330
 331   {
 332     map<string, pair<string, int>> c { { "a", { "b", 3 } } };
 333     dynamic d = dynamic::object("a", dynamic { "b", 3 });
 334     EXPECT_EQ(d, toDynamic(c));
 335   }
 336
 337   {
 338     map<string, pair<string, int>> c { { "a", { "b", 3 } } };
 339     dynamic d = dynamic::object("a", dynamic { "b", 3 });
 340     EXPECT_EQ(d, toDynamic(c));
 341   }
 342
 343   {
 344     vector<int> vi { 2, 3, 4, 5 };
 345     auto c = std::make_pair(range(vi.begin(), vi.begin() + 3),
 346                             range(vi.begin() + 1, vi.begin() + 4));
 347     dynamic d = { { 2, 3, 4 }, { 3, 4, 5 } };
 348     EXPECT_EQ(d, toDynamic(c));
 349   }
 350 }
 351
 352 TEST(DynamicConverter, errors) {
 353   const auto int32Over =
 354     static_cast<int64_t>(std::numeric_limits<int32_t>().max()) + 1;
 355   const auto floatOver =
 356     static_cast<double>(std::numeric_limits<float>().max()) * 2;
 357
 358   dynamic d1 = int32Over;
 359   EXPECT_THROW(convertTo<int32_t>(d1), std::range_error);
 360
 361   dynamic d2 = floatOver;
 362   EXPECT_THROW(convertTo<float>(d2), std::range_error);
 363 }