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, enums) {
 103   enum enum1 { foo = 1, bar = 2 };
 104
 105   dynamic d1 = 1;
 106   auto i1 = convertTo<enum1>(d1);
 107   EXPECT_EQ(i1, foo);
 108
 109   dynamic d2 = 2;
 110   auto i2 = convertTo<enum1>(d2);
 111   EXPECT_EQ(i2, bar);
 112
 113   enum class enum2 { FOO = 1, BAR = 2 };
 114
 115   dynamic d3 = 1;
 116   auto i3 = convertTo<enum2>(d3);
 117   EXPECT_EQ(i3, enum2::FOO);
 118
 119   dynamic d4 = 2;
 120   auto i4 = convertTo<enum2>(d4);
 121   EXPECT_EQ(i4, enum2::BAR);
 122 }
 123
 124 TEST(DynamicConverter, simple_builtins) {
 125   dynamic d1 = "Haskell";
 126   auto i1 = convertTo<folly::fbstring>(d1);
 127   EXPECT_EQ(i1, "Haskell");
 128
 129   dynamic d2 = 13;
 130   auto i2 = convertTo<std::string>(d2);
 131   EXPECT_EQ(i2, "13");
 132
 133   dynamic d3 = { 12, "Scala" };
 134   auto i3 = convertTo<std::pair<int, std::string>>(d3);
 135   EXPECT_EQ(i3.first, 12);
 136   EXPECT_EQ(i3.second, "Scala");
 137
 138   dynamic d4 = dynamic::object("C", "C++");
 139   auto i4 = convertTo<std::pair<std::string, folly::fbstring>>(d4);
 140   EXPECT_EQ(i4.first, "C");
 141   EXPECT_EQ(i4.second, "C++");
 142 }
 143
 144 TEST(DynamicConverter, simple_fbvector) {
 145   dynamic d1 = { 1, 2, 3 };
 146   auto i1 = convertTo<folly::fbvector<int>>(d1);
 147   decltype(i1) i1b = { 1, 2, 3 };
 148   EXPECT_EQ(i1, i1b);
 149 }
 150
 151 TEST(DynamicConverter, simple_container) {
 152   dynamic d1 = { 1, 2, 3 };
 153   auto i1 = convertTo<std::vector<int>>(d1);
 154   decltype(i1) i1b = { 1, 2, 3 };
 155   EXPECT_EQ(i1, i1b);
 156
 157   dynamic d2 = { 1, 3, 5, 2, 4 };
 158   auto i2 = convertTo<std::set<int>>(d2);
 159   decltype(i2) i2b = { 1, 2, 3, 5, 4 };
 160   EXPECT_EQ(i2, i2b);
 161 }
 162
 163 TEST(DynamicConverter, simple_map) {
 164   dynamic d1 = dynamic::object(1, "one")(2, "two");
 165   auto i1 = convertTo<std::map<int, std::string>>(d1);
 166   decltype(i1) i1b = { { 1, "one" }, { 2, "two" } };
 167   EXPECT_EQ(i1, i1b);
 168
 169   dynamic d2 = { { 3, "three" }, { 4, "four" } };
 170   auto i2 = convertTo<std::unordered_map<int, std::string>>(d2);
 171   decltype(i2) i2b = { { 3, "three" }, { 4, "four" } };
 172   EXPECT_EQ(i2, i2b);
 173 }
 174
 175 TEST(DynamicConverter, map_keyed_by_string) {
 176   dynamic d1 = dynamic::object("1", "one")("2", "two");
 177   auto i1 = convertTo<std::map<std::string, std::string>>(d1);
 178   decltype(i1) i1b = { { "1", "one" }, { "2", "two" } };
 179   EXPECT_EQ(i1, i1b);
 180
 181   dynamic d2 = { { "3", "three" }, { "4", "four" } };
 182   auto i2 = convertTo<std::unordered_map<std::string, std::string>>(d2);
 183   decltype(i2) i2b = { { "3", "three" }, { "4", "four" } };
 184   EXPECT_EQ(i2, i2b);
 185 }
 186
 187 TEST(DynamicConverter, map_to_vector_of_pairs) {
 188   dynamic d1 = dynamic::object("1", "one")("2", "two");
 189   auto i1 = convertTo<std::vector<std::pair<std::string, std::string>>>(d1);
 190   std::sort(i1.begin(), i1.end());
 191   decltype(i1) i1b = { { "1", "one" }, { "2", "two" } };
 192   EXPECT_EQ(i1, i1b);
 193 }
 194
 195 TEST(DynamicConverter, nested_containers) {
 196   dynamic d1 = { { 1 }, { }, { 2, 3 } };
 197   auto i1 = convertTo<folly::fbvector<std::vector<uint8_t>>>(d1);
 198   decltype(i1) i1b = { { 1 }, { }, { 2, 3 } };
 199   EXPECT_EQ(i1, i1b);
 200
 201   dynamic h2a = { "3", ".", "1", "4" };
 202   dynamic h2b = { "2", ".", "7", "2" };
 203   dynamic d2 = dynamic::object(3.14, h2a)(2.72, h2b);
 204   auto i2 = convertTo<std::map<double, std::vector<folly::fbstring>>>(d2);
 205   decltype(i2) i2b =
 206     { { 3.14, { "3", ".", "1", "4" } },
 207       { 2.72, { "2", ".", "7", "2" } } };
 208   EXPECT_EQ(i2, i2b);
 209 }
 210
 211 struct A {
 212   int i;
 213   bool operator==(const A & o) const { return i == o.i; }
 214 };
 215 namespace folly {
 216 template <> struct DynamicConverter<A> {
 217   static A convert(const dynamic & d) {
 218     return { convertTo<int>(d["i"]) };
 219   }
 220 };
 221 }
 222 TEST(DynamicConverter, custom_class) {
 223   dynamic d1 = dynamic::object("i", 17);
 224   auto i1 = convertTo<A>(d1);
 225   EXPECT_EQ(i1.i, 17);
 226
 227   dynamic d2 = { dynamic::object("i", 18), dynamic::object("i", 19) };
 228   auto i2 = convertTo<std::vector<A>>(d2);
 229   decltype(i2) i2b = { { 18 }, { 19 } };
 230   EXPECT_EQ(i2, i2b);
 231 }
 232
 233 TEST(DynamicConverter, crazy) {
 234   // we are going to create a vector<unordered_map<bool, T>>
 235   // we will construct some of the maps from dynamic objects,
 236   //   some from a vector of KV pairs.
 237   // T will be vector<set<string>>
 238
 239   std::set<std::string>
 240     s1 = { "a", "e", "i", "o", "u" },
 241     s2 = { "2", "3", "5", "7" },
 242     s3 = { "Hello", "World" };
 243
 244   std::vector<std::set<std::string>>
 245     v1 = {},
 246     v2 = { s1, s2 },
 247     v3 = { s3 };
 248
 249   std::unordered_map<bool, std::vector<std::set<std::string>>>
 250     m1 = { { true, v1 }, { false, v2 } },
 251     m2 = { { true, v3 } };
 252
 253   std::vector<std::unordered_map<bool, std::vector<std::set<std::string>>>>
 254     f1 = { m1, m2 };
 255
 256
 257   dynamic
 258     ds1 = { "a", "e", "i", "o", "u" },
 259     ds2 = { "2", "3", "5", "7" },
 260     ds3 = { "Hello", "World" };
 261
 262   dynamic
 263     dv1 = {},
 264     dv2 = { ds1, ds2 },
 265     dv3({ ds3 });
 266
 267   dynamic
 268     dm1 = dynamic::object(true, dv1)(false, dv2),
 269     dm2 = { { true, dv3 } };
 270
 271   dynamic
 272     df1 = { dm1, dm2 };
 273
 274
 275   auto i = convertTo<std::vector<std::unordered_map<bool, std::vector<
 276           std::set<std::string>>>>>(df1); // yes, that is 5 close-chevrons
 277
 278   EXPECT_EQ(f1, i);
 279 }
 280
 281 TEST(DynamicConverter, consts) {
 282   dynamic d1 = 7.5;
 283   auto i1 = convertTo<const double>(d1);
 284   EXPECT_EQ(7.5, i1);
 285
 286   dynamic d2 = "Hello";
 287   auto i2 = convertTo<const std::string>(d2);
 288   decltype(i2) i2b = "Hello";
 289   EXPECT_EQ(i2b, i2);
 290
 291   dynamic d3 = true;
 292   auto i3 = convertTo<const bool>(d3);
 293   EXPECT_EQ(true, i3);
 294
 295   dynamic d4 = "true";
 296   auto i4 = convertTo<const bool>(d4);
 297   EXPECT_EQ(true, i4);
 298
 299   dynamic d5 = { 1, 2 };
 300   auto i5 = convertTo<const std::pair<const int, const int>>(d5);
 301   decltype(i5) i5b = { 1, 2 };
 302   EXPECT_EQ(i5b, i5);
 303 }
 304
 305 struct Token {
 306   int kind_;
 307   fbstring lexeme_;
 308
 309   explicit Token(int kind, const fbstring& lexeme)
 310     : kind_(kind), lexeme_(lexeme) {}
 311 };
 312
 313 namespace folly {
 314 template <> struct DynamicConverter<Token> {
 315   static Token convert(const dynamic& d) {
 316     int k = convertTo<int>(d["KIND"]);
 317     fbstring lex = convertTo<fbstring>(d["LEXEME"]);
 318     return Token(k, lex);
 319   }
 320 };
 321 }
 322
 323 TEST(DynamicConverter, example) {
 324   dynamic d1 = dynamic::object("KIND", 2)("LEXEME", "a token");
 325   auto i1 = convertTo<Token>(d1);
 326   EXPECT_EQ(i1.kind_, 2);
 327   EXPECT_EQ(i1.lexeme_, "a token");
 328 }
 329
 330 TEST(DynamicConverter, construct) {
 331   using std::vector;
 332   using std::map;
 333   using std::pair;
 334   using std::string;
 335   {
 336     vector<int> c { 1, 2, 3 };
 337     dynamic d = { 1, 2, 3 };
 338     EXPECT_EQ(d, toDynamic(c));
 339   }
 340
 341   {
 342     map<int, int> c { { 2, 4 }, { 3, 9 } };
 343     dynamic d = dynamic::object(2, 4)(3, 9);
 344     EXPECT_EQ(d, toDynamic(c));
 345   }
 346
 347   {
 348     map<string, string> c { { "a", "b" } };
 349     dynamic d = dynamic::object("a", "b");
 350     EXPECT_EQ(d, toDynamic(c));
 351   }
 352
 353   {
 354     map<string, pair<string, int>> c { { "a", { "b", 3 } } };
 355     dynamic d = dynamic::object("a", dynamic { "b", 3 });
 356     EXPECT_EQ(d, toDynamic(c));
 357   }
 358
 359   {
 360     map<string, pair<string, int>> c { { "a", { "b", 3 } } };
 361     dynamic d = dynamic::object("a", dynamic { "b", 3 });
 362     EXPECT_EQ(d, toDynamic(c));
 363   }
 364
 365   {
 366     vector<int> vi { 2, 3, 4, 5 };
 367     auto c = std::make_pair(range(vi.begin(), vi.begin() + 3),
 368                             range(vi.begin() + 1, vi.begin() + 4));
 369     dynamic d = { { 2, 3, 4 }, { 3, 4, 5 } };
 370     EXPECT_EQ(d, toDynamic(c));
 371   }
 372 }
 373
 374 TEST(DynamicConverter, errors) {
 375   const auto int32Over =
 376     static_cast<int64_t>(std::numeric_limits<int32_t>().max()) + 1;
 377   const auto floatOver =
 378     static_cast<double>(std::numeric_limits<float>().max()) * 2;
 379
 380   dynamic d1 = int32Over;
 381   EXPECT_THROW(convertTo<int32_t>(d1), std::range_error);
 382
 383   dynamic d2 = floatOver;
 384   EXPECT_THROW(convertTo<float>(d2), std::range_error);
 385 }