forked from bitcoin/bitcoin
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge bitcoin#15382: util: add RunCommandParseJSON
31cf68a [util] add RunCommandParseJSON (Sjors Provoost) c17f54e [ci] use boost::process (Sjors Provoost) 32128ba [doc] include Doxygen comments for HAVE_BOOST_PROCESS (Sjors Provoost) 3c84d85 [build] msvc: add boost::process (Sjors Provoost) c47e4bb [build] make boost-process opt-in (Sjors Provoost) 929cda5 configure: add ax_boost_process (Sjors Provoost) 8314c23 [depends] boost: patch unused variable in boost_process (Sjors Provoost) Pull request description: Prerequisite for external signer support in bitcoin#16546. Big picture overview in [this gist](https://gist.github.com/Sjors/29d06728c685e6182828c1ce9b74483d). This adds a new dependency [boost process](https://github.com/boostorg/process/tree/boost-1.64.0). This is part of Boost since 1.64 which is part of `depends`. Because the minimum Boost version is 1.47, this functionality is skipped for older versions of Boost. Use `./configure --with-boost-process` to opt in, which checks for the presence of Boost::Process. We add `UniValue runCommandParseJSON(const std::string& strCommand)` to `system.{h,cpp}` which calls an arbitrary command and processes the JSON returned by it. This is currently only called by the test suite. ~For testing purposes this adds a new regtest-only RPC method `runcommand`, as well as `test/mocks/command.py` used by functional tests.~ (this is no longer the case) TODO: - [ ] review boost process in bitcoin#15440 ACKs for top commit: achow101: ACK 31cf68a hebasto: re-ACK 31cf68a, only rebased (verified with `git range-diff`) and removed an unintentional tab character since the [previous](bitcoin#15382 (review)) review. meshcollider: Very light utACK 31cf68a, although I am not very confident with build stuff. promag: Code review ACK 31cf68a, don't mind the nit. ryanofsky: Code review ACK 31cf68a. I left some comments below that could be ignored or followed up later. The current change is clean and comprehensive. Tree-SHA512: c506e747014b263606e1f538ed4624a8ad7bcf4e025cb700c12cc5739964e254dc04a2bbb848996b170e2ccec3fbfa4fe9e2b3976b191222cfb82fc3e6ab182d
- Loading branch information
Showing
24 changed files
with
295 additions
and
15 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| # =========================================================================== | ||
| # https://www.gnu.org/software/autoconf-archive/ax_boost_process.html | ||
| # =========================================================================== | ||
| # | ||
| # SYNOPSIS | ||
| # | ||
| # AX_BOOST_PROCESS | ||
| # | ||
| # DESCRIPTION | ||
| # | ||
| # Test for Process library from the Boost C++ libraries. The macro | ||
| # requires a preceding call to AX_BOOST_BASE. Further documentation is | ||
| # available at <http://randspringer.de/boost/index.html>. | ||
| # | ||
| # This macro calls: | ||
| # | ||
| # AC_SUBST(BOOST_PROCESS_LIB) | ||
| # | ||
| # And sets: | ||
| # | ||
| # HAVE_BOOST_PROCESS | ||
| # | ||
| # LICENSE | ||
| # | ||
| # Copyright (c) 2008 Thomas Porschberg <thomas@randspringer.de> | ||
| # Copyright (c) 2008 Michael Tindal | ||
| # Copyright (c) 2008 Daniel Casimiro <dan.casimiro@gmail.com> | ||
| # | ||
| # Copying and distribution of this file, with or without modification, are | ||
| # permitted in any medium without royalty provided the copyright notice | ||
| # and this notice are preserved. This file is offered as-is, without any | ||
| # warranty. | ||
|
|
||
| #serial 2 | ||
|
|
||
| AC_DEFUN([AX_BOOST_PROCESS], | ||
| [ | ||
| AC_ARG_WITH([boost-process], | ||
| AS_HELP_STRING([--with-boost-process@<:@=special-lib@:>@], | ||
| [use the Process library from boost - it is possible to specify a certain library for the linker | ||
| e.g. --with-boost-process=boost_process-gcc-mt ]), | ||
| [ | ||
| if test "$withval" = "no"; then | ||
| want_boost_process="no" | ||
| elif test "$withval" = "yes"; then | ||
| want_boost_process="yes" | ||
| ax_boost_user_process_lib="" | ||
| else | ||
| want_boost_process="yes" | ||
| ax_boost_user_process_lib="$withval" | ||
| fi | ||
| ], | ||
| [want_boost_process="yes"] | ||
| ) | ||
| if test "x$want_boost_process" = "xyes"; then | ||
| AC_REQUIRE([AC_PROG_CC]) | ||
| AC_REQUIRE([AC_CANONICAL_BUILD]) | ||
| CPPFLAGS_SAVED="$CPPFLAGS" | ||
| CPPFLAGS="$CPPFLAGS $BOOST_CPPFLAGS" | ||
| export CPPFLAGS | ||
| LDFLAGS_SAVED="$LDFLAGS" | ||
| LDFLAGS="$LDFLAGS $BOOST_LDFLAGS" | ||
| export LDFLAGS | ||
| AC_CACHE_CHECK(whether the Boost::Process library is available, | ||
| ax_cv_boost_process, | ||
| [AC_LANG_PUSH([C++]) | ||
| CXXFLAGS_SAVE=$CXXFLAGS | ||
| CXXFLAGS= | ||
| AC_COMPILE_IFELSE([AC_LANG_PROGRAM([[@%:@include <boost/process.hpp>]], | ||
| [[boost::process::child* child = new boost::process::child; delete child;]])], | ||
| ax_cv_boost_process=yes, ax_cv_boost_process=no) | ||
| CXXFLAGS=$CXXFLAGS_SAVE | ||
| AC_LANG_POP([C++]) | ||
| ]) | ||
| if test "x$ax_cv_boost_process" = "xyes"; then | ||
| AC_SUBST(BOOST_CPPFLAGS) | ||
| AC_DEFINE(HAVE_BOOST_PROCESS,,[define if the Boost::Process library is available]) | ||
| BOOSTLIBDIR=`echo $BOOST_LDFLAGS | sed -e 's/@<:@^\/@:>@*//'` | ||
| LDFLAGS_SAVE=$LDFLAGS | ||
| if test "x$ax_boost_user_process_lib" = "x"; then | ||
| for libextension in `ls -r $BOOSTLIBDIR/libboost_process* 2>/dev/null | sed 's,.*/lib,,' | sed 's,\..*,,'` ; do | ||
| ax_lib=${libextension} | ||
| AC_CHECK_LIB($ax_lib, exit, | ||
| [BOOST_PROCESS_LIB="-l$ax_lib"; AC_SUBST(BOOST_PROCESS_LIB) link_process="yes"; break], | ||
| [link_process="no"]) | ||
| done | ||
| if test "x$link_process" != "xyes"; then | ||
| for libextension in `ls -r $BOOSTLIBDIR/boost_process* 2>/dev/null | sed 's,.*/,,' | sed -e 's,\..*,,'` ; do | ||
| ax_lib=${libextension} | ||
| AC_CHECK_LIB($ax_lib, exit, | ||
| [BOOST_PROCESS_LIB="-l$ax_lib"; AC_SUBST(BOOST_PROCESS_LIB) link_process="yes"; break], | ||
| [link_process="no"]) | ||
| done | ||
| fi | ||
| else | ||
| for ax_lib in $ax_boost_user_process_lib boost_process-$ax_boost_user_process_lib; do | ||
| AC_CHECK_LIB($ax_lib, exit, | ||
| [BOOST_PROCESS_LIB="-l$ax_lib"; AC_SUBST(BOOST_PROCESS_LIB) link_process="yes"; break], | ||
| [link_process="no"]) | ||
| done | ||
| fi | ||
| if test "x$ax_lib" = "x"; then | ||
| AC_MSG_ERROR(Could not find a version of the Boost::Process library!) | ||
| fi | ||
| if test "x$link_process" = "xno"; then | ||
| AC_MSG_ERROR(Could not link against $ax_lib !) | ||
| fi | ||
| fi | ||
| CPPFLAGS="$CPPFLAGS_SAVED" | ||
| LDFLAGS="$LDFLAGS_SAVED" | ||
| fi | ||
| ]) |
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 |
|---|---|---|
| @@ -1 +1 @@ | ||
| berkeleydb boost-filesystem boost-multi-index boost-signals2 boost-test boost-thread libevent[thread] zeromq double-conversion | ||
| berkeleydb boost-filesystem boost-multi-index boost-process boost-signals2 boost-test boost-thread libevent[thread] zeromq double-conversion |
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
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,95 @@ | ||
| // Copyright (c) 2019 The Bitcoin Core developers | ||
| // Distributed under the MIT software license, see the accompanying | ||
| // file COPYING or http://www.opensource.org/licenses/mit-license.php. | ||
| // | ||
| #include <test/util/setup_common.h> | ||
| #include <util/system.h> | ||
| #include <univalue.h> | ||
|
|
||
| #ifdef HAVE_BOOST_PROCESS | ||
| #include <boost/process.hpp> | ||
| #endif // HAVE_BOOST_PROCESS | ||
|
|
||
| #include <boost/test/unit_test.hpp> | ||
|
|
||
| BOOST_FIXTURE_TEST_SUITE(system_tests, BasicTestingSetup) | ||
|
|
||
| // At least one test is required (in case HAVE_BOOST_PROCESS is not defined). | ||
| // Workaround for https://github.com/bitcoin/bitcoin/issues/19128 | ||
| BOOST_AUTO_TEST_CASE(dummy) | ||
| { | ||
| BOOST_CHECK(true); | ||
| } | ||
|
|
||
| #ifdef HAVE_BOOST_PROCESS | ||
|
|
||
| bool checkMessage(const std::runtime_error& ex) | ||
| { | ||
| // On Linux & Mac: "No such file or directory" | ||
| // On Windows: "The system cannot find the file specified." | ||
| const std::string what(ex.what()); | ||
| BOOST_CHECK(what.find("file") != std::string::npos); | ||
| return true; | ||
| } | ||
|
|
||
| bool checkMessageFalse(const std::runtime_error& ex) | ||
| { | ||
| BOOST_CHECK_EQUAL(ex.what(), std::string("RunCommandParseJSON error: process(false) returned 1: \n")); | ||
| return true; | ||
| } | ||
|
|
||
| bool checkMessageStdErr(const std::runtime_error& ex) | ||
| { | ||
| const std::string what(ex.what()); | ||
| BOOST_CHECK(what.find("RunCommandParseJSON error:") != std::string::npos); | ||
| return checkMessage(ex); | ||
| } | ||
|
|
||
| BOOST_AUTO_TEST_CASE(run_command) | ||
| { | ||
| { | ||
| const UniValue result = RunCommandParseJSON(""); | ||
| BOOST_CHECK(result.isNull()); | ||
| } | ||
| { | ||
| #ifdef WIN32 | ||
| // Windows requires single quotes to prevent escaping double quotes from the JSON... | ||
| const UniValue result = RunCommandParseJSON("echo '{\"success\": true}'"); | ||
| #else | ||
| // ... but Linux and macOS echo a single quote if it's used | ||
| const UniValue result = RunCommandParseJSON("echo \"{\"success\": true}\""); | ||
| #endif | ||
| BOOST_CHECK(result.isObject()); | ||
| const UniValue& success = find_value(result, "success"); | ||
| BOOST_CHECK(!success.isNull()); | ||
| BOOST_CHECK_EQUAL(success.getBool(), true); | ||
| } | ||
| { | ||
| // An invalid command is handled by Boost | ||
| BOOST_CHECK_EXCEPTION(RunCommandParseJSON("invalid_command"), boost::process::process_error, checkMessage); // Command failed | ||
| } | ||
| { | ||
| // Return non-zero exit code, no output to stderr | ||
| BOOST_CHECK_EXCEPTION(RunCommandParseJSON("false"), std::runtime_error, checkMessageFalse); | ||
| } | ||
| { | ||
| // Return non-zero exit code, with error message for stderr | ||
| BOOST_CHECK_EXCEPTION(RunCommandParseJSON("ls nosuchfile"), std::runtime_error, checkMessageStdErr); | ||
| } | ||
| { | ||
| BOOST_REQUIRE_THROW(RunCommandParseJSON("echo \"{\""), std::runtime_error); // Unable to parse JSON | ||
| } | ||
| // Test std::in, except for Windows | ||
| #ifndef WIN32 | ||
| { | ||
| const UniValue result = RunCommandParseJSON("cat", "{\"success\": true}"); | ||
| BOOST_CHECK(result.isObject()); | ||
| const UniValue& success = find_value(result, "success"); | ||
| BOOST_CHECK(!success.isNull()); | ||
| BOOST_CHECK_EQUAL(success.getBool(), true); | ||
| } | ||
| #endif | ||
| } | ||
| #endif // HAVE_BOOST_PROCESS | ||
|
|
||
| BOOST_AUTO_TEST_SUITE_END() |
Oops, something went wrong.