//------------------------------------------------------------------------------ /* This file is part of clio: https://github.com/XRPLF/clio Copyright (c) 2025, 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/config/Array.hpp" #include "util/config/ConfigDefinition.hpp" #include "util/config/ConfigFileJson.hpp" #include "util/config/ConfigValue.hpp" #include "util/config/Types.hpp" #include "web/dosguard/Weights.hpp" #include #include #include #include #include #include #include #include using namespace web::dosguard; struct TestParams { std::string testName; std::string requestJson; size_t expectedWeight; }; class WeightsTest : public ::testing::TestWithParam { protected: size_t const defaultWeight_{10}; std::unordered_map weightsMap_{ {"only_weight", {.weight = 20, .weightLedgerCurrent = std::nullopt, .weightLedgerValidated = std::nullopt}}, {"with_current_weight", {.weight = 30, .weightLedgerCurrent = 35, .weightLedgerValidated = std::nullopt}}, {"with_validated_weight", {.weight = 40, .weightLedgerCurrent = std::nullopt, .weightLedgerValidated = 45}}, {"with_both_weights", {.weight = 50, .weightLedgerCurrent = 55, .weightLedgerValidated = 60}}, }; Weights weights_{defaultWeight_, weightsMap_}; }; TEST_P(WeightsTest, RequestWeight) { auto const& params = GetParam(); auto request = boost::json::parse(params.requestJson).as_object(); EXPECT_EQ(weights_.requestWeight(request), params.expectedWeight); } INSTANTIATE_TEST_SUITE_P( WeightsTests, WeightsTest, ::testing::Values( TestParams{.testName = "EmptyObject", .requestJson = "{}", .expectedWeight = 10}, TestParams{.testName = "NonStringMethod", .requestJson = R"JSON({"method": 123})JSON", .expectedWeight = 10}, TestParams{.testName = "NonStringCommand", .requestJson = R"JSON({"command": 123})JSON", .expectedWeight = 10}, TestParams{ .testName = "UnknownMethodName", .requestJson = R"JSON({"method": "unknown_method"})JSON", .expectedWeight = 10 }, TestParams{ .testName = "UnknownCommandName", .requestJson = R"JSON({"command": "unknown_command"})JSON", .expectedWeight = 10 }, TestParams{ .testName = "OnlyWeight_NoLedgerIndex", .requestJson = R"JSON({"method": "only_weight"})JSON", .expectedWeight = 20 }, TestParams{ .testName = "OnlyWeight_CurrentLedgerIndex", .requestJson = R"JSON({"method": "only_weight", "ledger_index": "current"})JSON", .expectedWeight = 20 }, TestParams{ .testName = "OnlyWeight_ValidatedLedgerIndex", .requestJson = R"JSON({"method": "only_weight", "ledger_index": "validated"})JSON", .expectedWeight = 20 }, TestParams{ .testName = "OnlyWeight_ClosedLedgerIndex", .requestJson = R"JSON({"method": "only_weight", "ledger_index": "closed"})JSON", .expectedWeight = 20 }, TestParams{ .testName = "OnlyWeight_NumericLedgerIndex", .requestJson = R"JSON({"method": "only_weight", "ledger_index": "123"})JSON", .expectedWeight = 20 }, TestParams{ .testName = "OnlyWeight_OtherStringLedgerIndex", .requestJson = R"JSON({"method": "only_weight", "ledger_index": "some_string"})JSON", .expectedWeight = 20 }, // With Current Weight TestParams{ .testName = "WithCurrentWeight_NoLedgerIndex", .requestJson = R"JSON({"method": "with_current_weight"})JSON", .expectedWeight = 30 }, TestParams{ .testName = "WithCurrentWeight_CurrentLedgerIndex", .requestJson = R"JSON({"method": "with_current_weight", "ledger_index": "current"})JSON", .expectedWeight = 35 }, TestParams{ .testName = "WithCurrentWeight_ValidatedLedgerIndex", .requestJson = R"JSON({"method": "with_current_weight", "ledger_index": "validated"})JSON", .expectedWeight = 30 }, // With Validated Weight TestParams{ .testName = "WithValidatedWeight_NoLedgerIndex", .requestJson = R"JSON({"method": "with_validated_weight"})JSON", .expectedWeight = 40 }, TestParams{ .testName = "WithValidatedWeight_CurrentLedgerIndex", .requestJson = R"JSON({"method": "with_validated_weight", "ledger_index": "current"})JSON", .expectedWeight = 40 }, TestParams{ .testName = "WithValidatedWeight_ValidatedLedgerIndex", .requestJson = R"JSON({"method": "with_validated_weight", "ledger_index": "validated"})JSON", .expectedWeight = 45 }, // With Both Weights TestParams{ .testName = "WithBothWeights_NoLedgerIndex", .requestJson = R"JSON({"method": "with_both_weights"})JSON", .expectedWeight = 50 }, TestParams{ .testName = "WithBothWeights_CurrentLedgerIndex", .requestJson = R"JSON({"method": "with_both_weights", "ledger_index": "current"})JSON", .expectedWeight = 55 }, TestParams{ .testName = "WithBothWeights_ValidatedLedgerIndex", .requestJson = R"JSON({"method": "with_both_weights", "ledger_index": "validated"})JSON", .expectedWeight = 60 }, // Using Command TestParams{ .testName = "UsingCommand_NoLedgerIndex", .requestJson = R"JSON({"command": "with_both_weights"})JSON", .expectedWeight = 50 }, TestParams{ .testName = "UsingCommand_CurrentLedgerIndex", .requestJson = R"JSON({"command": "with_both_weights", "ledger_index": "current"})JSON", .expectedWeight = 55 }, TestParams{ .testName = "UsingCommand_ValidatedLedgerIndex", .requestJson = R"JSON({"command": "with_both_weights", "ledger_index": "validated"})JSON", .expectedWeight = 60 }, // With Params Array TestParams{ .testName = "WithParamsArray_CurrentLedgerIndex", .requestJson = R"JSON({"method": "with_both_weights", "params": [{"ledger_index": "current"}]})JSON", .expectedWeight = 55 }, TestParams{ .testName = "WithParamsArray_ValidatedLedgerIndex", .requestJson = R"JSON({"method": "with_both_weights", "params": [{"ledger_index": "validated"}]})JSON", .expectedWeight = 60 }, TestParams{ .testName = "WithParamsArray_WithCommand", .requestJson = R"JSON({"command": "with_both_weights", "params": [{"ledger_index": "current"}]})JSON", .expectedWeight = 55 } ), [](::testing::TestParamInfo const& info) { return info.param.testName; } ); TEST(WeightsMakeTest, CreateFromConfig) { util::config::ClioConfigDefinition mockConfig{ {"dos_guard.__ng_default_weight", util::config::ConfigValue{util::config::ConfigType::Integer}.defaultValue(10)}, {"dos_guard.__ng_weights.[].method", util::config::Array{util::config::ConfigValue{util::config::ConfigType::String}}}, {"dos_guard.__ng_weights.[].weight", util::config::Array{util::config::ConfigValue{util::config::ConfigType::Integer}}}, {"dos_guard.__ng_weights.[].weight_ledger_current", util::config::Array{util::config::ConfigValue{util::config::ConfigType::Integer}.optional()}}, {"dos_guard.__ng_weights.[].weight_ledger_validated", util::config::Array{util::config::ConfigValue{util::config::ConfigType::Integer}.optional()}} }; std::string const configStr = R"JSON( { "dos_guard": { "__ng_default_weight": 15, "__ng_weights": [ { "method": "method1", "weight": 25, "weight_ledger_current": 30 }, { "method": "method2", "weight": 35, "weight_ledger_validated": 40 }, { "method": "method3", "weight": 45, "weight_ledger_current": 50, "weight_ledger_validated": 55 } ] } } )JSON"; auto const configJson = boost::json::parse(configStr).as_object(); ASSERT_FALSE(mockConfig.parse(util::config::ConfigFileJson(configJson)).has_value()); Weights const weights = Weights::make(mockConfig); auto request = boost::json::parse(R"JSON({"method": "unknown_method"})JSON").as_object(); EXPECT_EQ(weights.requestWeight(request), 15); request = boost::json::parse(R"JSON({"method": "method1"})JSON").as_object(); EXPECT_EQ(weights.requestWeight(request), 25); request = boost::json::parse(R"JSON({"method": "method1", "ledger_index": "current"})JSON").as_object(); EXPECT_EQ(weights.requestWeight(request), 30); request = boost::json::parse(R"JSON({"method": "method1", "ledger_index": "validated"})JSON").as_object(); EXPECT_EQ(weights.requestWeight(request), 25); request = boost::json::parse(R"JSON({"method": "method2"})JSON").as_object(); EXPECT_EQ(weights.requestWeight(request), 35); request = boost::json::parse(R"JSON({"method": "method2", "ledger_index": "current"})JSON").as_object(); EXPECT_EQ(weights.requestWeight(request), 35); request = boost::json::parse(R"JSON({"method": "method2", "ledger_index": "validated"})JSON").as_object(); EXPECT_EQ(weights.requestWeight(request), 40); request = boost::json::parse(R"JSON({"method": "method3"})JSON").as_object(); EXPECT_EQ(weights.requestWeight(request), 45); request = boost::json::parse(R"JSON({"method": "method3", "ledger_index": "current"})JSON").as_object(); EXPECT_EQ(weights.requestWeight(request), 50); request = boost::json::parse(R"JSON({"method": "method3", "ledger_index": "validated"})JSON").as_object(); EXPECT_EQ(weights.requestWeight(request), 55); }