-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
test: Add RPC error checking support to unit tests (#4987)
- Loading branch information
Showing
10 changed files
with
230 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| //------------------------------------------------------------------------------ | ||
| /* | ||
| This file is part of rippled: https://github.com/ripple/rippled | ||
| Copyright (c) 2024 Ripple Labs Inc. | ||
| Permission to use, copy, modify, and/or 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. | ||
| */ | ||
| //============================================================================== | ||
|
|
||
| #ifndef RIPPLE_TEST_JTX_RPC_H_INCLUDED | ||
| #define RIPPLE_TEST_JTX_RPC_H_INCLUDED | ||
|
|
||
| #include <test/jtx/Env.h> | ||
| #include <tuple> | ||
|
|
||
| namespace ripple { | ||
| namespace test { | ||
| namespace jtx { | ||
|
|
||
| /** Set the expected result code for a JTx | ||
| The test will fail if the code doesn't match. | ||
| */ | ||
| class rpc | ||
| { | ||
| private: | ||
| std::optional<error_code_i> code_; | ||
| std::optional<std::string> errorMessage_; | ||
| std::optional<std::string> error_; | ||
| std::optional<std::string> errorException_; | ||
|
|
||
| public: | ||
| /// If there's an error code, we expect an error message | ||
| explicit rpc(error_code_i code, std::optional<std::string> m = {}) | ||
| : code_(code), errorMessage_(m) | ||
| { | ||
| } | ||
|
|
||
| /// If there is not a code, we expect an exception message | ||
| explicit rpc( | ||
| std::string error, | ||
| std::optional<std::string> exceptionMessage = {}) | ||
| : error_(error), errorException_(exceptionMessage) | ||
| { | ||
| } | ||
|
|
||
| void | ||
| operator()(Env&, JTx& jt) const | ||
| { | ||
| // The RPC request should fail. RPC errors result in telENV_RPC_FAILED. | ||
| jt.ter = telENV_RPC_FAILED; | ||
| if (code_) | ||
| { | ||
| auto const& errorInfo = RPC::get_error_info(*code_); | ||
| // When an RPC request returns an error code ('error_code'), it | ||
| // always includes an error message ('error_message'), and sometimes | ||
| // includes an error token ('error'). If it does, the error token is | ||
| // always obtained from the lookup into the ErrorInfo lookup table. | ||
| // | ||
| // Take advantage of that fact to populate jt.rpcException. The | ||
| // check will be aware of whether the rpcExcpetion can be safely | ||
| // ignored. | ||
| jt.rpcCode = { | ||
| *code_, | ||
| errorMessage_ ? *errorMessage_ : errorInfo.message.c_str()}; | ||
| jt.rpcException = {errorInfo.token.c_str(), std::nullopt}; | ||
| } | ||
| if (error_) | ||
| jt.rpcException = {*error_, errorException_}; | ||
| } | ||
| }; | ||
|
|
||
| } // namespace jtx | ||
| } // namespace test | ||
| } // namespace ripple | ||
|
|
||
| #endif |
Oops, something went wrong.