//------------------------------------------------------------------------------ /* This file is part of clio: https://github.com/XRPLF/clio Copyright (c) 2024, the clio developers. Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ //============================================================================== #include "util/MockAssert.hpp" #include "util/config/ArrayView.hpp" #include "util/config/ConfigDefinition.hpp" #include "util/config/ConfigFileJson.hpp" #include "util/config/FakeConfigData.hpp" #include "util/config/ObjectView.hpp" #include "util/config/Types.hpp" #include "util/config/ValueView.hpp" #include #include #include #include using namespace util::config; struct ArrayViewTest : virtual testing::Test { ArrayViewTest() { ConfigFileJson const jsonFileObj{boost::json::parse(kJSON_DATA).as_object()}; auto const errors = configData.parse(jsonFileObj); EXPECT_TRUE(!errors.has_value()); } ClioConfigDefinition configData = generateConfig(); }; // Array View tests can only be tested after the values are populated from user Config // into ConfigClioDefinition TEST_F(ArrayViewTest, ArrayGetValueDouble) { auto const precision = 1e-9; ArrayView const arrVals = configData.getArray("array.[].sub"); auto const firstVal = arrVals.valueAt(0); EXPECT_EQ(firstVal.type(), ConfigType::Double); EXPECT_TRUE(firstVal.hasValue()); EXPECT_FALSE(firstVal.isOptional()); EXPECT_NEAR(111.11, firstVal.asDouble(), precision); EXPECT_NEAR(4321.55, arrVals.valueAt(1).asDouble(), precision); } TEST_F(ArrayViewTest, ArrayGetValueString) { ArrayView const arrVals = configData.getArray("array.[].sub2"); ValueView const firstVal = arrVals.valueAt(0); EXPECT_EQ(firstVal.type(), ConfigType::String); EXPECT_EQ("subCategory", firstVal.asString()); EXPECT_EQ("london", arrVals.valueAt(2).asString()); } TEST_F(ArrayViewTest, IterateValuesDouble) { auto const precision = 1e-9; ArrayView const arrVals = configData.getArray("array.[].sub"); auto valIt = arrVals.begin(); EXPECT_NEAR((*valIt++).asDouble(), 111.11, precision); EXPECT_NEAR((*valIt++).asDouble(), 4321.55, precision); EXPECT_NEAR((*valIt++).asDouble(), 5555.44, precision); EXPECT_EQ(valIt, arrVals.end()); } TEST_F(ArrayViewTest, IterateValuesString) { ArrayView const arrVals = configData.getArray("array.[].sub2"); auto val2It = arrVals.begin(); EXPECT_EQ((*val2It++).asString(), "subCategory"); EXPECT_EQ((*val2It++).asString(), "temporary"); EXPECT_EQ((*val2It++).asString(), "london"); EXPECT_EQ(val2It, arrVals.end()); } TEST_F(ArrayViewTest, ArrayWithObj) { ArrayView const arrVals = configData.getArray("array.[]"); ArrayView const arrValAlt = configData.getArray("array"); auto const precision = 1e-9; auto const obj1 = arrVals.objectAt(0); auto const obj2 = arrValAlt.objectAt(0); EXPECT_NEAR(obj1.get("sub"), obj2.get("sub"), precision); EXPECT_NEAR(obj1.get("sub"), 111.11, precision); } TEST_F(ArrayViewTest, IterateArray) { auto arr = configData.getArray("dosguard.whitelist"); EXPECT_EQ(2, arr.size()); EXPECT_EQ(arr.valueAt(0).asString(), "125.5.5.1"); EXPECT_EQ(arr.valueAt(1).asString(), "204.2.2.1"); auto it = arr.begin(); EXPECT_EQ((*it++).asString(), "125.5.5.1"); EXPECT_EQ((*it++).asString(), "204.2.2.1"); EXPECT_EQ((it), arr.end()); } TEST_F(ArrayViewTest, CompareDifferentArrayIterators) { auto const subArray = configData.getArray("array.[].sub"); auto const dosguardArray = configData.getArray("dosguard.whitelist.[]"); auto itArray = subArray.begin(); auto itDosguard = dosguardArray.begin(); for (std::size_t i = 0; i < subArray.size(); i++) EXPECT_NE(itArray++, itDosguard++); } TEST_F(ArrayViewTest, IterateObject) { auto arr = configData.getArray("array"); EXPECT_EQ(3, arr.size()); auto it = arr.begin(); EXPECT_EQ(111.11, (*it).get("sub")); EXPECT_EQ("subCategory", (*it++).get("sub2")); EXPECT_EQ(4321.55, (*it).get("sub")); EXPECT_EQ("temporary", (*it++).get("sub2")); EXPECT_EQ(5555.44, (*it).get("sub")); EXPECT_EQ("london", (*it++).get("sub2")); EXPECT_EQ(it, arr.end()); } struct ArrayViewAssertTest : common::util::WithMockAssert, ArrayViewTest {}; TEST_F(ArrayViewAssertTest, AccessArrayOutOfBounce) { // dies because higher only has 1 object (trying to access 2nd element) EXPECT_CLIO_ASSERT_FAIL({ [[maybe_unused]] auto _ = configData.getArray("higher").objectAt(1); }); } TEST_F(ArrayViewAssertTest, AccessIndexOfWrongType) { auto const& arrVals2 = configData.getArray("array.[].sub2"); auto const& tempVal = arrVals2.valueAt(0); // dies as value is not of type int EXPECT_CLIO_ASSERT_FAIL({ [[maybe_unused]] auto _ = tempVal.asIntType(); }); } TEST_F(ArrayViewAssertTest, GetValueWhenItIsObject) { ArrayView const arr = configData.getArray("higher"); EXPECT_CLIO_ASSERT_FAIL({ [[maybe_unused]] auto _ = arr.begin(); }); } TEST_F(ArrayViewAssertTest, GetObjectWhenItIsValue) { ArrayView const dosguardWhitelist = configData.getArray("dosguard.whitelist"); EXPECT_CLIO_ASSERT_FAIL({ [[maybe_unused]] auto _ = dosguardWhitelist.begin(); }); }