Skip to content

Commit

Permalink
Skip required options when using help option
Browse files Browse the repository at this point in the history
This lets users use `cve list -h` without having to also specify
auth-related options (user, org, api key) that are required for non-help
actions.
  • Loading branch information
mprpic committed Jun 6, 2023
1 parent 192de96 commit 37914e0
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 1 deletion.
20 changes: 19 additions & 1 deletion cvelib/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,25 @@ def init_cve_api(self) -> CveApi:
)


@click.group(context_settings=CONTEXT_SETTINGS)
class SkipRequiredOnHelp(click.Group):
def parse_args(self, ctx: click.Context, args: list) -> list:
"""If any help options are used, mark global required options as not required.
That way, we can skip directly to showing the help without requiring users to specify
values that don't end up getting used anyway.
"""
if any(arg in ctx.help_option_names for arg in args):
# Iterate over all options and flip them to not required and not to prompt for input.
for param in self.params:
if isinstance(param, click.Option):
param.required = False
# Type ignored due to `"Option" has no attribute "prompt_required"` error:
# https://github.com/pallets/click/blob/d0af32d8/src/click/core.py#L2455
param.prompt_required = False # type: ignore
return super(SkipRequiredOnHelp, self).parse_args(ctx, args)


@click.group(context_settings=CONTEXT_SETTINGS, cls=SkipRequiredOnHelp)
@click.option(
"-u", "--username", envvar="CVE_USER", required=True, help="Your username (env var: CVE_USER)"
)
Expand Down
19 changes: 19 additions & 0 deletions tests/test_cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -559,3 +559,22 @@ def test_show_org():
"├─ Created:\tWed Apr 21 02:09:07 2021 +0000\n"
"└─ Modified:\tWed Apr 21 02:09:07 2021 +0000\n"
)


class TestSubcommandHelp:
def test_required_opts(self):
with mock.patch("cvelib.cli.CveApi.show_org") as show_org:
show_org.return_value = {}
runner = CliRunner()
result = runner.invoke(cli, ["org"])
assert result.exit_code == 2, result.output
assert "Error: Missing option" in result.output

def test_exit_on_help(self):
with mock.patch("cvelib.cli.CveApi.show_org") as show_org:
show_org.return_value = {}
runner = CliRunner()
result = runner.invoke(cli, ["org", "--help"])
assert result.exit_code == 0, result.output
# The command is named after the function that is called.
assert result.output.startswith("Usage: cli org")

0 comments on commit 37914e0

Please sign in to comment.