-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
completion: fix broken completion generation for zsh
`dvc commit --help` was also completely broken, which is also fixed. This adds unit tests for completion generation for both zsh/bash, and tests that --help works for all commands.
- Loading branch information
Showing
4 changed files
with
71 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
import logging | ||
|
||
import pytest | ||
|
||
from dvc.cli import main | ||
from dvc.commands.completion import SUPPORTED_SHELLS | ||
|
||
|
||
@pytest.mark.parametrize("shell", SUPPORTED_SHELLS) | ||
def test_completion(caplog, capsys, shell): | ||
with caplog.at_level(logging.INFO): | ||
assert main(["completion", "-s", shell]) == 0 | ||
assert not caplog.text | ||
|
||
out, err = capsys.readouterr() | ||
assert not err | ||
assert out |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
import logging | ||
from argparse import SUPPRESS, ArgumentParser | ||
from typing import Tuple | ||
|
||
import pytest | ||
import shtab | ||
|
||
from dvc.cli import main | ||
from dvc.cli.parser import get_main_parser | ||
|
||
|
||
def command_tuples(): | ||
root: Tuple[str, ...] = () | ||
commands = [root] | ||
|
||
def recurse_parser(parser: ArgumentParser, parents: Tuple[str, ...] = root) -> None: | ||
for positional in parser._get_positional_actions(): | ||
if positional.help != SUPPRESS and isinstance(positional.choices, dict): | ||
public_cmds = shtab.get_public_subcommands(positional) | ||
for subcmd, subparser in positional.choices.items(): | ||
if subcmd in public_cmds: | ||
cmd = (*parents, subcmd) | ||
commands.append(cmd) | ||
recurse_parser(subparser, cmd) | ||
|
||
main_parser = get_main_parser() | ||
recurse_parser(main_parser) | ||
return sorted(commands) | ||
|
||
|
||
def pytest_generate_tests(metafunc): | ||
def ids(values): | ||
if values: | ||
return "-".join(values) | ||
return "dvc" | ||
|
||
metafunc.parametrize("command_tuples", command_tuples(), ids=ids) | ||
|
||
|
||
def test_help(caplog, capsys, command_tuples): | ||
with caplog.at_level(logging.INFO), pytest.raises(SystemExit) as e: | ||
main([*command_tuples, "--help"]) | ||
assert e.value.code == 0 | ||
assert not caplog.text | ||
|
||
out, err = capsys.readouterr() | ||
assert not err | ||
assert out |