Doc: Consolidate documentation of functional test parameters. #17380

issue jachiang opened this issue on November 5, 2019
  1. jachiang commented at 3:20 PM on November 5, 2019: contributor

    Context:

    The BitcoinTestFramework test parameters are set in set_test_params(), but there are additional test run-time settings which can be passed in through the command-line. The latter are documented with the command-line help strings. Note that there are command-line arguments which differ in naming compared to the class member where they are set:

    - `--tracerpc` vs `BitcoinTestFramework.options.trace_rpc`
    - `--portseed` vs `BitcoinTestFramework.options.port_seed`

    The TestShell is a BitcoinTestFramework child class, and allows all test parameters to be passed in setup(**test_args). The keys for test_args are identical to the respective parent class members to simplify argument forwarding.

    - `TestShell.setup(trace_rpc= …)` vs. `BitcoinTestFramework.options.trace_rpc`
    - `TestShell.setup(port_seed= …)` vs. `BitcoinTestFramework.options.port_seed`

    However, by extension, test_args are now inconsistent with the command-line args of its parent class.

    Issue:

    The TestShell documentation currently covers TestShell-specific argument keys, which don’t entirely translate to the BitcoinTestFramework documentation as mentioned above. It would be nice to find a way to neatly consolidate both in one place.

  2. jachiang added the label Feature on Nov 5, 2019
  3. fanquake added the label Docs on Nov 5, 2019
  4. jonatack commented at 11:14 AM on December 4, 2019: member

    Hi @jachiang, I have a few test runner improvement PRs written last July that I was thinking of opening at some point, and one of those PRs did this. Will try to remember to link to this issue when it's open.

  5. jachiang commented at 5:30 AM on December 5, 2019: contributor

    Thanks @jonatack!

  6. maflcko added the label Tests on Dec 1, 2022
  7. pinheadmz commented at 7:33 PM on March 8, 2023: member

    Hi @jachiang, I have a few test runner improvement PRs written last July that I was thinking of opening at some point @jonatack did this happen? ;-)

  8. jonatack commented at 7:53 PM on March 8, 2023: member

    @jonatack did this happen? ;-)

    No, they are still in my local git. I don't propose most of the things I write to not have dozens of open unmerged PRs. It's hard to assess which ones to open, though :)

  9. pinheadmz assigned pinheadmz on Jun 2, 2023
  10. willcl-ark commented at 3:14 PM on October 14, 2024: member

    Are you still working on this @jonatack ?

    cc @pinheadmz

  11. jonatack commented at 3:27 PM on October 14, 2024: member

    Oh my, memory lane -- will look.

  12. willcl-ark commented at 3:22 PM on October 21, 2025: member

    This issue hasn’t attracted much interest from other contributors in quite some time.

    Given that, it doesn’t seem important enough to keep open indefinitely. I’m going to close it for now due to lack of activity, but pull requests or renewed discussion are always welcome.

    Comment here if you think this should be re-opened.

  13. willcl-ark closed this on Oct 21, 2025


github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-18 12:14 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me