//------------------------------------------------------------------------------ /* This file is part of clio: https://github.com/XRPLF/clio Copyright (c) 2023, 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. */ //============================================================================== #pragma once #include "rpc/Errors.hpp" #include "rpc/common/Specs.hpp" #include "rpc/common/Types.hpp" #include "rpc/common/Validators.hpp" #include #include #include #include #include #include #include #include namespace tests::common { // input data for the test handlers below struct TestInput { std::string hello; std::optional limit; }; // output data produced by the test handlers below struct TestOutput { std::string computed; }; // must be implemented as per rpc/common/Concepts.h inline TestInput tag_invoke(boost::json::value_to_tag, boost::json::value const& jv) { std::optional optLimit; if (jv.as_object().contains("limit")) optLimit = jv.at("limit").as_int64(); return {.hello = boost::json::value_to(jv.as_object().at("hello")), .limit = optLimit}; } // must be implemented as per rpc/common/Concepts.h inline void tag_invoke(boost::json::value_from_tag, boost::json::value& jv, TestOutput const& output) { jv = {{"computed", output.computed}}; } // example handler class HandlerFake { public: using Input = TestInput; using Output = TestOutput; using Result = rpc::HandlerReturnType; static rpc::RpcSpecConstRef spec([[maybe_unused]] uint32_t apiVersion) { using namespace rpc::validation; static auto const kRPC_SPEC = rpc::RpcSpec{ {"hello", Required{}, Type{}, EqualTo{"world"}}, {"limit", Type{}, Between{0, 100}}, // optional field }; return kRPC_SPEC; } static Result process(Input input, [[maybe_unused]] rpc::Context const& ctx) { return Output{input.hello + '_' + std::to_string(input.limit.value_or(0))}; } }; class NoInputHandlerFake { public: using Output = TestOutput; using Result = rpc::HandlerReturnType; static Result process([[maybe_unused]] rpc::Context const& ctx) { return Output{"test"}; } }; // example handler that returns custom error class FailingHandlerFake { public: using Input = TestInput; using Output = TestOutput; using Result = rpc::HandlerReturnType; static rpc::RpcSpecConstRef spec([[maybe_unused]] uint32_t apiVersion) { using namespace rpc::validation; static auto const kRPC_SPEC = rpc::RpcSpec{ {"hello", Required{}, Type{}, EqualTo{"world"}}, {"limit", Type{}, Between{0u, 100u}}, // optional field }; return kRPC_SPEC; } static Result process([[maybe_unused]] Input input, [[maybe_unused]] rpc::Context const& ctx) { // always fail return rpc::Error{rpc::Status{"Very custom error"}}; } }; struct InOutFake { std::string something; // Note: no spaceship comparison possible for std::string friend bool operator==(InOutFake const& lhs, InOutFake const& rhs) = default; }; // must be implemented as per rpc/common/Concepts.h inline InOutFake tag_invoke(boost::json::value_to_tag, boost::json::value const& jv) { return {boost::json::value_to(jv.as_object().at("something"))}; } // must be implemented as per rpc/common/Concepts.h inline void tag_invoke(boost::json::value_from_tag, boost::json::value& jv, InOutFake const& output) { jv = {{"something", output.something}}; } struct HandlerMock { using Input = InOutFake; using Output = InOutFake; using Result = rpc::HandlerReturnType; MOCK_METHOD(rpc::RpcSpecConstRef, spec, (uint32_t), (const)); MOCK_METHOD(Result, process, (Input, rpc::Context const&), (const)); }; struct HandlerWithoutInputMock { using Output = InOutFake; using Result = rpc::HandlerReturnType; MOCK_METHOD(Result, process, (rpc::Context const&), (const)); }; } // namespace tests::common