Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

#1682: fix unit tests #1734

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

#1682: fix unit tests #1734

wants to merge 14 commits into from

Conversation

Ifropc
Copy link
Contributor

@Ifropc Ifropc commented Nov 18, 2024 •
edited
Loading

Part of #1682

Fixes unit tests, including restoring help tests

Why

Previously, we were using clap's get_matches_from that exits with code 0 (printing help message). This made our tests exit with code 0 as well (when calling --help).
As part of the change we handle DisplayError returning help message, and keeping existing behavior for all other clap errors.

Known limitations

Some win tests are failing

@Ifropc Ifropc mentioned this pull request Nov 18, 2024
Open
@leighmcculloch
Copy link
Member

This tests are fixed in other PRs (see #1682 )

What needs to merge before this PR can be merged?

@Ifropc
Copy link
Contributor Author

Ifropc commented Nov 26, 2024

@leighmcculloch we can either merge all listed PRs at the same time or merge all of them here first

@elizabethengelman
Copy link
Contributor

This is looking great! Thanks for digging into it - it was driving me crazy ;p

we can either merge all listed PRs at the same time or merge all of them here first

W/r/t when to merge this and the other PRs, i like the idea of merging those test fixing into this PR first.

@Ifropc @elizabethengelman
Update cmd/soroban-cli/src/commands/contract/arg_parsing.rs
19ae5ba 
Co-authored-by: Elizabeth Engelman <4752801+elizabethengelman@users.noreply.github.com>
leighmcculloch
leighmcculloch reviewed Dec 9, 2024
View reviewed changes
Copy link
Member

@leighmcculloch leighmcculloch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for figuring out why these tests were preventing from running. Great find and learning for us all.

For the solution, I'd like us to reconsider the approach here, see the inline comment. Please lmk if there's a reason we can't do the error approach.

cmd/soroban-cli/src/commands/contract/invoke.rs Outdated Show resolved Hide resolved
cmd/soroban-cli/src/commands/contract/arg_parsing.rs Outdated Show resolved Hide resolved
leighmcculloch
leighmcculloch reviewed Dec 10, 2024
View reviewed changes
Copy link
Member

@leighmcculloch leighmcculloch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One ask, otherwise this looks good, very easy to follow.

cmd/soroban-cli/src/commands/contract/deploy/wasm.rs
}
},
Err(ArgParse(HelpMessage(help))) => {
println!("{help}");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to do this at the top level, rather than inside the arg parsing, otherwise the exit codes will be incorrect when generating the help when no --help is passed. It's a small thing, but also I believe a small fix to keep passing the error as is up the chain, and at the top level doing as you do here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean we should handle HelpMessage error at the very top of the chain?

cmd/soroban-cli/src/commands/contract/invoke.rs
Comment on lines +145 to 147
Err(ArgParsing(HelpMessage(help))) => {
println!("{help}");
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment about doing this at the top level.

Ifropc and others added 3 commits December 20, 2024 11:19
@Ifropc
1682 fix init test (#1738)
a664025 
* Fix init test

* Update sdk version
@Ifropc @willemneal
1682 fix config/version tests (#1737)
b63a40b 
* fix config tests

* Fix version test

* fix: clippy

---------

Co-authored-by: Willem Wyndham <willem@ahalabs.dev>
@Ifropc
#1682: fix build tests (#1736)
2c215cd 
* Fix build tests

* revert implementation
@Ifropc Ifropc changed the title #1682: fix help tests #1682: fix unit tests Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elizabethengelman elizabethengelman elizabethengelman left review comments

@willemneal willemneal willemneal left review comments

@leighmcculloch leighmcculloch leighmcculloch left review comments

@fnando fnando Awaiting requested review from fnando

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
DevX
Status: Needs Review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Ifropc @leighmcculloch @elizabethengelman @willemneal