test: autogenerate bash completion #30860

BrandonOdiwuor · 2024-09-10T08:26:33Z

Fixes #17289, and follows up on #18606

Adds a functional test that parses available RPC commands, generates the associated bitcoin-cli autocomplete file and checks that the current autocomplete file matches.

An outdated autocomplete file can be updated via the --overwrite test parameter.

DrahtBot · 2024-09-10T08:26:36Z

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage & Benchmarks

For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/30860.

Reviews

See the guideline for information on the review process.
A summary of reviews will appear here.

Conflicts

Reviewers, this pull request conflicts with the following ones:

#32145 (test: Add functional test for bitcoin-chainstate by TheCharlatan)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

fanquake · 2024-09-10T15:44:25Z

https://github.com/bitcoin/bitcoin/actions/runs/10788681404/job/29919981336?pr=30860#step:7:3564:

Run rpc with args ['/Users/runner/work/bitcoin/bitcoin/ci/scratch/build-x86_64-apple-darwin/src/test/fuzz/fuzz', PosixPath('/Users/runner/work/bitcoin/bitcoin/ci/scratch/qa-assets/fuzz_corpora/rpc')]Error: RPC command "format" not found in RPC_COMMANDS_SAFE_FOR_FUZZING or RPC_COMMANDS_NOT_SAFE_FOR_FUZZING. Please update src/test/fuzz/rpc.cpp.
libc++abi: terminating

Error: RPC command "format" not found in RPC_COMMANDS_SAFE_FOR_FUZZING or RPC_COMMANDS_NOT_SAFE_FOR_FUZZING. Please update src/test/fuzz/rpc.cpp.
libc++abi: terminating

Target ['/Users/runner/work/bitcoin/bitcoin/ci/scratch/build-x86_64-apple-darwin/src/test/fuzz/fuzz', PosixPath('/Users/runner/work/bitcoin/bitcoin/ci/scratch/qa-assets/fuzz_corpora/rpc')] failed with exit code -6

DrahtBot · 2024-09-10T19:14:15Z

🚧 At least one of the CI tasks failed.
_{Debug: https://github.com/bitcoin/bitcoin/runs/29919986329}

Hints

Make sure to run all tests locally, according to the documentation.

The failure may happen due to a number of reasons, for example:

Possibly due to a silent merge conflict (the changes in this pull request being
incompatible with the current code in the target branch). If so, make sure to rebase on the latest
commit of the target branch.
A sanitizer issue, which can only be found by compiling with the sanitizer and running the
affected test.
An intermittent issue.

Leave a comment here, if you need help tracking down a confusing failure.

maflcko · 2024-10-01T12:35:30Z

Are you still working on this? (It looks like this has been opened as draft, with failing CI, which is fine. However, without any progress, it seems better to close this for now.)

test/functional/tool_cli_bash_completion.py

- add format command to get infos about commands via a particular format - add output format args_cli to get arguments type info of shown commands - refactor RPCArg::ToTypeString to be used accross multiple output formats - overload CRPCTable::execute to call != methods than in their request Co-authored-by: pierrenn <git@pnn.sh>

Adds a functional test which parses available RPC commands, generates the associated bitcoin-cli autcomplete file and checks that the current autocomplete matches the file An outdated autcomplete file can be updated using the --overwrite parameter Co-authored-by: pierrenn <git@pnn.sh>

tnndbtc · 2025-02-14T19:58:02Z

test/functional/tool_cli_bash_completion.py

+        if len(options) == 0:
+            return ""
+
+        generated = ""


Since there is a discussion (#17289 (comment)) on whether it will slow down when user hit TAB key to send request to bitcoind for auto completion, what about we add those cword==1 commands in contrib/completions/bash/bitcoin-cli.bash so that it will not rely on the startup of bitcoind?

The suggested code is pasted below and tested:

# create cword==1 block to avoid the calling of bitcoind to get auto complete commands = [] for command in options: commands.append(command.command) commands_str = " ".join(commands) cword_1_block = f""" if ((cword == 1)); then options=\"{commands_str}\" COMPREPLY=( $( compgen -W "$options" -- "$cur" ) ) return 0\n fi\n\n""" generated = cword_1_block

tnndbtc · 2025-02-14T20:21:27Z

I tested the code in mac(Apple M1 chip) and it worked fine. Steps are:
# run test and generate contrib/completions/bash/bitcoin-cli.bash:
% build/test/functional/test_runner.py test/functional/tool_cli_bash_completion.py --tmpdir /tmp --nocleanup --overwrite

# validate bash-completion on mac, first install bash-completion:
% brew install bash-completion

# switch to bash shell
% bash

# source the bash_completion script
% . /opt/homebrew/etc/profile.d/bash_completion.sh

# source bitcoin-cli bash
% source contrib/completions/bash/bitcoin-cli.bash

# then, without starting bitcoind
% bitcoin-cli con[TAB]

#this will auto complete to converttopsbt
% bitcoin-cli converttopsbt

#this will auto complete to converttopsbt
% bitcoin-cli converttopsbt somestring [TAB]
false true

% bitcoin-cli converttopsbt some t[TAB]

# it will auto complete true
% bitcoin-cli converttopsbt some true

% bitcoin-cli converttopsbt some true t[TAB]

# it will auto complete false
% bitcoin-cli converttopsbt some true f[TAB]

% bitcoin-cli converttopsbt some true false

Also, traced the code, especially in test/functional/tool_cli_bash_completion.py:
get_command_options
generate_completion_block
and they look good to me. Left an enhancement comment in the PR so that the author can review.

- add format command to get infos about commands via a particular format - add output format args_cli to get arguments type info of shown commands - refactor RPCArg::ToTypeString to be used accross multiple output formats - overload CRPCTable::execute to call != methods than in their request Co-authored-by: pierrenn <git@pnn.sh> Github-Pull: bitcoin#30860 Rebased-From: eb43862

Adds a functional test which parses available RPC commands, generates the associated bitcoin-cli autcomplete file and checks that the current autocomplete matches the file An outdated autcomplete file can be updated using the --overwrite parameter Co-authored-by: pierrenn <git@pnn.sh> Github-Pull: bitcoin#30860 Rebased-From: 7c8b021

DrahtBot · 2025-03-27T16:29:27Z

🐙 This pull request conflicts with the target branch and needs rebase.

DrahtBot · 2025-06-24T00:21:59Z

⌛ There hasn't been much activity lately and the patch still needs rebase. What is the status here?

Is it still relevant? ➡️ Please solve the conflicts to make it ready for review and to ensure the CI passes.
Is it no longer relevant? ➡️ Please close.
Did the author lose interest or time to work on this? ➡️ Please close it and mark it 'Up for grabs' with the label, so that it can be picked up in the future.

DrahtBot added the Tests label Sep 10, 2024

DrahtBot added the CI failed label Sep 10, 2024

DrahtBot mentioned this pull request Sep 11, 2024

Remove the legacy wallet and BDB dependency #28710

Merged

DrahtBot mentioned this pull request Sep 20, 2024

build: scripted-diff: drop config/ subdir for bitcoin-config.h #30937

Merged

BrandonOdiwuor force-pushed the bash-completion branch 3 times, most recently from 791096d to 6b6a721 Compare October 4, 2024 03:11

DrahtBot added the Needs rebase label Oct 10, 2024

BrandonOdiwuor force-pushed the bash-completion branch 2 times, most recently from 2f4b076 to 7c8b021 Compare October 23, 2024 08:51

DrahtBot removed Needs rebase CI failed labels Oct 23, 2024

DrahtBot mentioned this pull request Nov 7, 2024

wallet: Disable creating and loading legacy wallets #31250

Merged

luke-jr suggested changes Nov 15, 2024

View reviewed changes

test/functional/tool_cli_bash_completion.py Outdated Show resolved Hide resolved

DrahtBot added the CI failed label Dec 2, 2024

DrahtBot mentioned this pull request Dec 4, 2024

doc: Fix incorrect send RPC docs #31416

Merged

BrandonOdiwuor and others added 3 commits December 18, 2024 08:02

contrib: sync bitcoin-cli bash autocompletion

0392119

BrandonOdiwuor force-pushed the bash-completion branch from 7c8b021 to abf6ad4 Compare December 18, 2024 07:26

BrandonOdiwuor requested a review from luke-jr December 18, 2024 07:28

DrahtBot removed the CI failed label Dec 18, 2024

tnndbtc reviewed Feb 14, 2025

View reviewed changes

BrandonOdiwuor marked this pull request as ready for review March 5, 2025 10:23

DrahtBot mentioned this pull request Mar 26, 2025

test: Add functional test for bitcoin-chainstate #32145

Merged

DrahtBot added the Needs rebase label Mar 27, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

test: autogenerate bash completion #30860

test: autogenerate bash completion #30860

Uh oh!

BrandonOdiwuor commented Sep 10, 2024

Uh oh!

DrahtBot commented Sep 10, 2024 •

edited

Loading

Uh oh!

fanquake commented Sep 10, 2024

Uh oh!

DrahtBot commented Sep 10, 2024

Uh oh!

maflcko commented Oct 1, 2024

Uh oh!

Uh oh!

tnndbtc Feb 14, 2025

Uh oh!

tnndbtc commented Feb 14, 2025 •

edited

Loading

Uh oh!

DrahtBot commented Mar 27, 2025

Uh oh!

DrahtBot commented Jun 24, 2025

Uh oh!

Uh oh!

test: autogenerate bash completion #30860

Are you sure you want to change the base?

test: autogenerate bash completion #30860

Uh oh!

Conversation

BrandonOdiwuor commented Sep 10, 2024

Uh oh!

DrahtBot commented Sep 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage & Benchmarks

Reviews

Conflicts

Uh oh!

fanquake commented Sep 10, 2024

Uh oh!

DrahtBot commented Sep 10, 2024

Uh oh!

maflcko commented Oct 1, 2024

Uh oh!

Uh oh!

tnndbtc Feb 14, 2025

Choose a reason for hiding this comment

Uh oh!

tnndbtc commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DrahtBot commented Mar 27, 2025

Uh oh!

DrahtBot commented Jun 24, 2025

Uh oh!

Uh oh!

DrahtBot commented Sep 10, 2024 •

edited

Loading

tnndbtc commented Feb 14, 2025 •

edited

Loading