4f348c2d73
89af67d79ftests: Add some fuzz test coverage for command-specific args (Anthony Towns)92df785859tests: Add some test coverage for ArgsManager::AddCommand (Anthony Towns)33c8090be9ArgsManager: automate checking for correct command options (Anthony Towns)186354a0d8bitcoin-wallet: use command-specific options (Anthony Towns)d21e82b7d6ArgsManager: support command-specific options (Anthony Towns) Pull request description: Adds the ability to link particular options to one or more (`OptionsCategory::COMMANDS`) commands, and uses this feature in `bitcoin-wallet`. Separates out the help information for these command-specific options (duplicating it if an option applies to multiple commands), and provides a function for checking at runtime if some options have been specified by the user that only apply to other commands. #### Motivation Currently, `ArgsManager` supports commands like `bitcoin-wallet dump` but while some of the options are command-specific (like `-dumpfile`), `ArgsManager` itself doesn't know that. As a result, `-dumpfile` is listed in the global help rather than under the relevant commands, and if you use `-dumpfile` with a different command that doesn't support it, `ArgsManager` cannot automatically report that as an error, resulting in the commands that don't support the option having to have error-handling specific to all the options they don't support. #### Changes Help output moves command-specific options under their associated commands: Before: ``` Options: -dumpfile=<file name> When used with 'dump', writes out the records to this file. When used with 'createfromdump', loads the records into a new wallet. ... Commands: createfromdump Create new wallet file from dumped records dump Print out all of the wallet key-value records ``` After: ``` Commands: createfromdump Create new wallet file from dumped records -dumpfile=<file name> When used with 'dump', writes out the records to this file. When used with 'createfromdump', loads the records into a new wallet. dump Print out all of the wallet key-value records -dumpfile=<file name> When used with 'dump', writes out the records to this file. When used with 'createfromdump', loads the records into a new wallet. ``` Error messages are now generated automatically by `ArgsManager` rather than ad-hoc wallet code for each option: Before: ```c++ if (args.IsArgSet("-dumpfile") && command != "dump" && command != "createfromdump") { tfm::format(std::cerr, "The -dumpfile option can only be used with the \"dump\" and \"createfromdump\" commands.\n"); return false; } ``` After: ```c++ std::vector<std::string> details; if (!args.CheckCommandOptions(command, &details)) { tfm::format(std::cerr, "Error: Invalid arguments provided:\n%s\n", util::MakeUnorderedList(details)); return false; } ``` #### Limitations - If an option applies to multiple commands, it shares the same help text. There's no way to provide per-command descriptions. - Option parsing rules are unchanged — options still cannot appear after the command. ACKs for top commit: achow101: ACK89af67d79fsedited: Re-ACK89af67d79fryanofsky: Code review ACK89af67d79f. Since last review: rebase, integration with ClearArgs and fuzz test, and Assume -> Assert switch Tree-SHA512: 7ae7c3b74d0c8c4db8459e9f0b9c7498b2fa4758954ec49983decbba177877b039779f0f7b55e60c3a0ed74c5e9e4ac4734ba9e049bf3a7743280ef8300869fa
Bitcoin Core integration/staging tree
For an immediately usable, binary version of the Bitcoin Core software, see https://bitcoincore.org/en/download/.
What is Bitcoin Core?
Bitcoin Core connects to the Bitcoin peer-to-peer network to download and fully validate blocks and transactions. It also includes a wallet and graphical user interface, which can be optionally built.
Further information about Bitcoin Core is available in the doc folder.
License
Bitcoin Core is released under the terms of the MIT license. See COPYING for more information or see https://opensource.org/license/MIT.
Development Process
The master branch is regularly built (see doc/build-*.md for instructions) and tested, but it is not guaranteed to be
completely stable. Tags are created
regularly from release branches to indicate new official, stable release versions of Bitcoin Core.
The https://github.com/bitcoin-core/gui repository is used exclusively for the development of the GUI. Its master branch is identical in all monotree repositories. Release branches and tags do not exist, so please do not fork that repository unless it is for development reasons.
The contribution workflow is described in CONTRIBUTING.md and useful hints for developers can be found in doc/developer-notes.md.
Testing
Testing and code review is the bottleneck for development; we get more pull requests than we can review and test on short notice. Please be patient and help out by testing other people's pull requests, and remember this is a security-critical project where any mistake might cost people lots of money.
Automated Testing
Developers are strongly encouraged to write unit tests for new code, and to
submit new unit tests for old code. Unit tests can be compiled and run
(assuming they weren't disabled during the generation of the build system) with: ctest. Further details on running
and extending unit tests can be found in /src/test/README.md.
There are also regression and integration tests, written
in Python.
These tests can be run (if the test dependencies are installed) with: build/test/functional/test_runner.py
(assuming build is your build directory).
The CI (Continuous Integration) systems make sure that every pull request is tested on Windows, Linux, and macOS. The CI must pass on all commits before merge to avoid unrelated CI failures on new pull requests.
Manual Quality Assurance (QA) Testing
Changes should be tested by somebody other than the developer who wrote the code. This is especially important for large or high-risk changes. It is useful to add a test plan to the pull request description if testing the changes is not straightforward.
Translations
Changes to translations as well as new translations can be submitted to Bitcoin Core's Transifex page.
Translations are periodically pulled from Transifex and merged into the git repository. See the translation process for details on how this works.
Important: We do not accept translation changes as GitHub pull requests because the next pull from Transifex would automatically overwrite them again.