ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2025-11-04 03:45:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
9c92a2b51b37746608542cebc3553c23705cae93
clio/tests/unit/ConfigTests.cpp
Ayaz Salikhov 9c92a2b51b style: Use pre-commit tool and add simple config (#2029) 
I started with really simple pre-commit hooks and will add more on top.

Important files:
- `.pre-commit-config.yaml` - the config for pre-commit
- `.github/workflows/pre-commit.yml` - runs pre-commit hooks in branches
and `develop`
- `.github/workflows/pre-commit-autoupdate.yml` - autoupdates pre-commit
hooks once in a month
2025-04-24 17:59:43 +01:00

247 lines
7.9 KiB
C++
Raw Blame History

//------------------------------------------------------------------------------
/*
This file is part of clio: https://github.com/XRPLF/clio
Copyright (c) 2022, 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/Assert.hpp"
#include "util/LoggerFixtures.hpp"
#include "util/TmpFile.hpp"
#include "util/config/Config.hpp"
#include <boost/json/conversion.hpp>
#include <boost/json/parse.hpp>
#include <boost/json/value.hpp>
#include <boost/json/value_to.hpp>
#include <gtest/gtest.h>
#include <cstdint>
#include <optional>
#include <stdexcept>
#include <string>
#include <vector>
using namespace util;
using namespace boost::log;
using namespace std;
namespace json = boost::json;
namespace {
constexpr auto kJSON_DATA = R"JSON(
{
"arr": [
{ "first": 1234 },
{ "second": true },
{ "inner_section": [{ "inner": "works" }] },
["127.0.0.1", "192.168.0.255"]
],
"section": {
"test": {
"str": "hello",
"int": 9042,
"bool": true,
"double": 3.14,
"float": 42.0
}
},
"top": 420
}
)JSON";
} // namespace
class ConfigTest : public NoLoggerFixture {
protected:
Config cfg_{json::parse(kJSON_DATA)};
};
TEST_F(ConfigTest, SanityCheck)
{
// throw on wrong key format etc.:
ASSERT_ANY_THROW((void)cfg_.value<bool>(""));
ASSERT_ANY_THROW((void)cfg_.value<bool>("a."));
ASSERT_ANY_THROW((void)cfg_.value<bool>(".a"));
ASSERT_ANY_THROW((void)cfg_.valueOr<bool>("", false));
ASSERT_ANY_THROW((void)cfg_.valueOr<bool>("a.", false));
ASSERT_ANY_THROW((void)cfg_.valueOr<bool>(".a", false));
ASSERT_ANY_THROW((void)cfg_.maybeValue<bool>(""));
ASSERT_ANY_THROW((void)cfg_.maybeValue<bool>("a."));
ASSERT_ANY_THROW((void)cfg_.maybeValue<bool>(".a"));
ASSERT_ANY_THROW((void)cfg_.valueOrThrow<bool>("", "custom"));
ASSERT_ANY_THROW((void)cfg_.valueOrThrow<bool>("a.", "custom"));
ASSERT_ANY_THROW((void)cfg_.valueOrThrow<bool>(".a", "custom"));
ASSERT_ANY_THROW((void)cfg_.contains(""));
ASSERT_ANY_THROW((void)cfg_.contains("a."));
ASSERT_ANY_THROW((void)cfg_.contains(".a"));
ASSERT_ANY_THROW((void)cfg_.section(""));
ASSERT_ANY_THROW((void)cfg_.section("a."));
ASSERT_ANY_THROW((void)cfg_.section(".a"));
// valid path, value does not exists -> optional functions should not throw
ASSERT_ANY_THROW((void)cfg_.value<bool>("b"));
ASSERT_EQ(cfg_.valueOr<bool>("b", false), false);
ASSERT_EQ(cfg_.maybeValue<bool>("b"), std::nullopt);
ASSERT_ANY_THROW((void)cfg_.valueOrThrow<bool>("b", "custom"));
}
TEST_F(ConfigTest, Access)
{
ASSERT_EQ(cfg_.value<int64_t>("top"), 420);
ASSERT_EQ(cfg_.value<string>("section.test.str"), "hello");
ASSERT_EQ(cfg_.value<int64_t>("section.test.int"), 9042);
ASSERT_EQ(cfg_.value<bool>("section.test.bool"), true);
ASSERT_ANY_THROW((void)cfg_.value<uint64_t>("section.test.bool")); // wrong type requested
ASSERT_ANY_THROW((void)cfg_.value<bool>("section.doesnotexist"));
ASSERT_EQ(cfg_.valueOr<string>("section.test.str", "fallback"), "hello");
ASSERT_EQ(cfg_.valueOr<string>("section.test.nonexistent", "fallback"), "fallback");
ASSERT_EQ(cfg_.valueOr("section.test.bool", false), true);
ASSERT_EQ(cfg_.valueOr("section.test.double", 0.42), 3.14);
ASSERT_EQ(cfg_.valueOr<float>("section.test.double", 0.42f), 3.14f);
ASSERT_EQ(cfg_.valueOr("section.test.float", 0.42f), 42.0f);
ASSERT_EQ(cfg_.valueOr<double>("section.test.float", 0.42), 42.0);
ASSERT_ANY_THROW((void)cfg_.valueOr("section.test.bool", 1234)); // wrong type requested
}
TEST_F(ConfigTest, ErrorHandling)
{
try {
(void)cfg_.valueOrThrow<bool>("section.test.int", "msg");
ASSERT_FALSE(true); // should not get here
} catch (std::runtime_error const& e) {
ASSERT_STREQ(e.what(), "msg");
}
ASSERT_EQ(cfg_.valueOrThrow<bool>("section.test.bool", ""), true);
auto arr = cfg_.array("arr");
try {
(void)arr[3].array()[1].valueOrThrow<int>("msg"); // wrong type
ASSERT_FALSE(true); // should not get here
} catch (std::runtime_error const& e) {
ASSERT_STREQ(e.what(), "msg");
}
ASSERT_EQ(arr[3].array()[1].valueOrThrow<string>(""), "192.168.0.255");
try {
(void)cfg_.arrayOrThrow("nonexisting.key", "msg");
ASSERT_FALSE(true); // should not get here
} catch (std::runtime_error const& e) {
ASSERT_STREQ(e.what(), "msg");
}
ASSERT_EQ(cfg_.arrayOrThrow("arr", "")[0].value<int>("first"), 1234);
}
TEST_F(ConfigTest, Section)
{
auto sub = cfg_.section("section.test");
ASSERT_EQ(sub.value<string>("str"), "hello");
ASSERT_EQ(sub.value<int64_t>("int"), 9042);
ASSERT_EQ(sub.value<bool>("bool"), true);
}
TEST_F(ConfigTest, SectionOr)
{
{
auto sub = cfg_.sectionOr("section.test", {}); // exists
ASSERT_EQ(sub.value<string>("str"), "hello");
ASSERT_EQ(sub.value<int64_t>("int"), 9042);
ASSERT_EQ(sub.value<bool>("bool"), true);
}
{
auto sub = cfg_.sectionOr("section.doesnotexist", {{"int", 9043}}); // does not exist
ASSERT_EQ(sub.value<int64_t>("int"), 9043); // default from fallback
}
}
TEST_F(ConfigTest, Array)
{
auto arr = cfg_.array("arr");
ASSERT_EQ(arr.size(), 4);
ASSERT_EQ(arr[0].value<int64_t>("first"), 1234);
// check twice to verify that previous array(key) access did not destroy the
// store by using move
ASSERT_EQ(arr[2].array("inner_section")[0].value<string>("inner"), "works");
ASSERT_EQ(arr[2].array("inner_section")[0].value<string>("inner"), "works");
ASSERT_EQ(arr[3].array()[1].value<string>(), "192.168.0.255");
vector exp{"192.168.0.255", "127.0.0.1"};
for (auto inner = arr[3].array(); auto const& el : inner) {
ASSERT_EQ(el.value<string>(), exp.back());
exp.pop_back();
}
ASSERT_TRUE(exp.empty());
}
TEST_F(ConfigTest, toMilliseconds)
{
EXPECT_EQ(Config::toMilliseconds(0.0f).count(), 0);
EXPECT_EQ(Config::toMilliseconds(0.123f).count(), 123);
EXPECT_EQ(Config::toMilliseconds(3.45f).count(), 3450);
}
/**
* @brief Simple custom data type with json parsing support
*/
struct Custom {
string a;
int b;
bool c;
friend Custom
tag_invoke(json::value_to_tag<Custom>, json::value const& value)
{
ASSERT(value.is_object(), "Value must be an object");
auto const& obj = value.as_object();
return {
.a = boost::json::value_to<std::string>(obj.at("str")),
.b = obj.at("int").as_int64(),
.c = obj.at("bool").as_bool()
};
}
};
TEST_F(ConfigTest, Extend)
{
auto custom = cfg_.value<Custom>("section.test");
ASSERT_EQ(custom.a, "hello");
ASSERT_EQ(custom.b, 9042);
ASSERT_EQ(custom.c, true);
}
TEST_F(ConfigTest, File)
{
auto tmp = TmpFile(kJSON_DATA);
auto conf = ConfigReader::open(tmp.path);
ASSERT_EQ(conf.value<int64_t>("top"), 420);
auto doesntexist = ConfigReader::open("nope");
ASSERT_EQ(doesntexist.valueOr<bool>("found", false), false);
}
Reference in New Issue View Git Blame Copy Permalink