fix(zebrad): accept default subcommand arguments and print consistent usage information for top-level 'help' subcommand #6801

arya2 · 2023-05-31T18:13:58Z

Motivation

This PR is needed to avoid a compilation error that is likely to be added to the Rust 2024 edition, to make our dependency tree smaller.

Related: This makes the output of zebrad --help consistent with that of zebrad help.

Closes #5502
Closes #5707
Closes #5624

Breaking Changes

Major

The version subcommand has been replaced with a --version/-V flag
Zebra now accepts filters for the start command when no subcommand is provided

Minor

Zebra now ignores unrecognized arguments passed after a --version flag

Solution

Bumps abscissa_core from 0.5 to 0.7.0 in zebrad/Cargo.toml
Replaces gumdrop with the latest version of clap
Updates ZebradApp's impl of Application to match new method signatures
Updates commands to use clap::Parser instead of gumdrop::Options
Uses ColorChoice::Never when initializing the updated Terminal component to avoid panicking when color_spantrace::set_theme() is called after it's been set
Adds a EntryPoint::process_cli_args() method for inserting the default subcommand if one is not provided
Moves EntryPoint from the application module to commands now that it's been excluded from abscissa_core
Reverts fix(clippy): Silence future-incompat warnings until we upgrade Abscissa #6024

Review

Anyone can review.

Reviewer Checklist

Will the PR name make sense to users?
- Does it need extra CHANGELOG info? (new features, breaking changes, large changes)
Are the PR labels correct?
Does the code do what the ticket and PR says?
- Does it change concurrent code, unsafe code, or consensus rules?
How do you know it works? Does it have tests?

Follow Up Work

Add snapshot tests for zebrad command-line interface #6809

Adds -V to process_cli_args match case

…e Abscissa (#6024)" This reverts commit dd90f79.

teor2345 · 2023-06-05T23:21:33Z

I opened this PR in case other reviewers wanted a smaller diff for entry_point.rs:
#6826

zebrad/src/commands/entry_point.rs

Co-authored-by: teor <teor@riseup.net>

This reverts commit 3f73979.

zebrad/src/commands/entry_point.rs

Co-authored-by: teor <teor@riseup.net>

zebrad/src/commands/entry_point.rs

teor2345

This seems to be working well enough for now.

arya2 · 2023-06-07T00:44:25Z

In the merge queue:

process didn't exit successfully: /home/runner/work/zebra/zebra/target/release/deps/zebrad-4d9e827350fddfd8 (signal: 11, SIGSEGV: invalid memory reference)
Error: Process completed with exit code 101.

https://github.com/ZcashFoundation/zebra/actions/runs/5194379481/jobs/9365975834#step:15:3531

zebrad/src/commands/tests.rs

teor2345

Conditional approval: if we see any memory errors in the zebrad lib tests, we should revert this PR.

* Bump semvers * Update zebra-utils/README.md * Updated mainnet checkpoints against commit b7029b8 * Add testnet checkpoints from b7029b8 * Bump zebrad rust-version to 1.70 * rust-version 1.68 Co-authored-by: teor <teor@riseup.net> * Add CHANGELOG for 1.0.0-rc.9 * Bump estimated release height to within june 7th 2023 utc-4 * Add #6801 to CHANGELOG in anticipation * Update CHANGELOG.md Co-authored-by: teor <teor@riseup.net> * Update CHANGELOG.md Co-authored-by: teor <teor@riseup.net> * Update CHANGELOG.md Co-authored-by: teor <teor@riseup.net> * Update CHANGELOG.md Co-authored-by: teor <teor@riseup.net> * Update CHANGELOG.md Co-authored-by: teor <teor@riseup.net> * Update breaking changes in 1.0.0-rc.9 changelog * changelog: move #6801 to Fix * Update CHANGELOG.md Co-authored-by: teor <teor@riseup.net> * Include #6832 in the changelog * Add missing changes to changelog * Remove #6801 from known issues in the README * Use the latest bug template link --------- Co-authored-by: teor <teor@riseup.net>

arya2 added 16 commits May 31, 2023 03:13

updates Cargo.toml

84aebe7

Migrate to abscissa 0.7.0

4544ba1

Avoid panic from calling color_eyre::install twice

3f97470

Uses 'start' as the default subcommand

87e921a

updates default cmd logic

f30b632

Fixes minor cli issues

f1dee1d

removes outdated check in acceptance test

65b2431

Adds a test for process_cli_args, fixes version_args test.

9394845

Adds -V to process_cli_args match case

Revert "fix(clippy): Silence future-incompat warnings until we upgrad…

c910172

…e Abscissa (#6024)" This reverts commit dd90f79.

Drops the worker guard to flush logs when zebra shuts down

e8af17e

Adds cargo feature to clap

2ab7477

restores process_cli_args

835e790

updates deny.toml

9217cce

Updates EntryPoint help template

80ffb18

Updates subcommand help msgs

17d8a21

removes trailing whitespace, capitalizes sentences

f8979b3

arya2 added A-dependencies Area: Dependency file updates C-enhancement Category: This is an improvement P-Medium ⚡ C-security Category: Security issues labels May 31, 2023

arya2 requested a review from a team as a code owner May 31, 2023 18:13

arya2 self-assigned this May 31, 2023

arya2 requested review from a team as code owners May 31, 2023 18:13

arya2 requested review from dconnolly and upbqdn and removed request for a team May 31, 2023 18:13

github-actions bot added the C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG label May 31, 2023

arya2 force-pushed the bump-abscissa branch from fef676b to c910172 Compare May 31, 2023 18:16

teor2345 reviewed Jun 5, 2023

View reviewed changes

zebrad/src/commands/entry_point.rs Outdated Show resolved Hide resolved

teor2345 reviewed Jun 5, 2023

View reviewed changes

zebrad/src/commands/entry_point.rs Outdated Show resolved Hide resolved

arya2 and others added 2 commits June 5, 2023 22:02

Apply suggestions from code review

4c9664a

Co-authored-by: teor <teor@riseup.net>

Revert "Prunes redundant test cases"

6a6f641

This reverts commit 3f73979.

teor2345 reviewed Jun 6, 2023

View reviewed changes

zebrad/src/commands/entry_point.rs Show resolved Hide resolved

arya2 and others added 2 commits June 6, 2023 13:41

Update zebrad/src/commands/entry_point.rs

ef2f340

Co-authored-by: teor <teor@riseup.net>

Merge branch 'main' into bump-abscissa

f50e611

teor2345 reviewed Jun 6, 2023

View reviewed changes

zebrad/src/commands/entry_point.rs Show resolved Hide resolved

teor2345 and others added 2 commits June 7, 2023 06:07

Add missing import

da18670

Updates process_cli_args to return a result

85b2614

teor2345 previously approved these changes Jun 6, 2023

View reviewed changes

teor2345 mentioned this pull request Jun 6, 2023

Release 1.0.0-rc.9 #6821

Merged

41 tasks

mergify bot added a commit that referenced this pull request Jun 6, 2023

Merge of #6801

75b0396

mergify bot mentioned this pull request Jun 6, 2023

merge queue: embarking main (d7b9055) and #6801 together #6841

Closed

teor2345 reviewed Jun 7, 2023

View reviewed changes

zebrad/src/commands/tests.rs Show resolved Hide resolved

arya2 dismissed teor2345’s stale review via 85b2614 June 7, 2023 01:16

arya2 requested a review from teor2345 June 7, 2023 01:35

teor2345 approved these changes Jun 7, 2023

View reviewed changes

teor2345 mentioned this pull request Jun 7, 2023

[rc.9] cargo update #6844

Merged

7 tasks

dconnolly added a commit that referenced this pull request Jun 7, 2023

Add #6801 to CHANGELOG in anticipation

3aa38f8

mergify bot added a commit that referenced this pull request Jun 7, 2023

Merge of #6801

07d521c

mergify bot mentioned this pull request Jun 7, 2023

merge queue: embarking main (428493e) and [#6801 + #6814] together #6845

Closed

mergify bot merged commit 59086c7 into main Jun 7, 2023

mergify bot deleted the bump-abscissa branch June 7, 2023 06:03

teor2345 mentioned this pull request Jun 7, 2023

release(docs): Refactor bug report template #6858

Merged

6 tasks

dconnolly added a commit that referenced this pull request Jun 7, 2023

changelog: move #6801 to Fix

aa0ebe6

dconnolly added a commit that referenced this pull request Jun 7, 2023

Remove #6801 from known issues in the README

e5c6bd3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(zebrad): accept default subcommand arguments and print consistent usage information for top-level 'help' subcommand #6801

fix(zebrad): accept default subcommand arguments and print consistent usage information for top-level 'help' subcommand #6801

arya2 commented May 31, 2023 •

edited

Loading

teor2345 commented Jun 5, 2023 •

edited

Loading

teor2345 left a comment

arya2 commented Jun 7, 2023

teor2345 left a comment

fix(zebrad): accept default subcommand arguments and print consistent usage information for top-level 'help' subcommand #6801

fix(zebrad): accept default subcommand arguments and print consistent usage information for top-level 'help' subcommand #6801

Conversation

arya2 commented May 31, 2023 • edited Loading

Motivation

Breaking Changes

Major

Minor

Solution

Review

Reviewer Checklist

Follow Up Work

teor2345 commented Jun 5, 2023 • edited Loading

teor2345 left a comment

Choose a reason for hiding this comment

arya2 commented Jun 7, 2023

teor2345 left a comment

Choose a reason for hiding this comment

arya2 commented May 31, 2023 •

edited

Loading

teor2345 commented Jun 5, 2023 •

edited

Loading