-
Notifications
You must be signed in to change notification settings - Fork 95
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add ability to list user installed plugins from the CLI (#2891)
- Loading branch information
Showing
4 changed files
with
128 additions
and
2 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
from importlib.metadata import version | ||
|
||
import rich | ||
import typer | ||
from rich.table import Table | ||
|
||
from nebari.hookspecs import hookimpl | ||
|
||
|
||
@hookimpl | ||
def nebari_subcommand(cli: typer.Typer): | ||
plugin_cmd = typer.Typer( | ||
add_completion=False, | ||
no_args_is_help=True, | ||
rich_markup_mode="rich", | ||
context_settings={"help_option_names": ["-h", "--help"]}, | ||
) | ||
|
||
cli.add_typer( | ||
plugin_cmd, | ||
name="plugin", | ||
help="Interact with nebari plugins", | ||
rich_help_panel="Additional Commands", | ||
) | ||
|
||
@plugin_cmd.command() | ||
def list(ctx: typer.Context): | ||
""" | ||
List installed plugins | ||
""" | ||
from nebari.plugins import nebari_plugin_manager | ||
|
||
external_plugins = nebari_plugin_manager.get_external_plugins() | ||
|
||
table = Table(title="Plugins") | ||
table.add_column("name", justify="left", no_wrap=True) | ||
table.add_column("version", justify="left", no_wrap=True) | ||
|
||
for plugin in external_plugins: | ||
table.add_row(plugin, version(plugin)) | ||
|
||
rich.print(table) |
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,64 @@ | ||
from typing import List | ||
from unittest.mock import Mock, patch | ||
|
||
import pytest | ||
from typer.testing import CliRunner | ||
|
||
from _nebari.cli import create_cli | ||
|
||
runner = CliRunner() | ||
|
||
|
||
@pytest.mark.parametrize( | ||
"args, exit_code, content", | ||
[ | ||
# --help | ||
([], 0, ["Usage:"]), | ||
(["--help"], 0, ["Usage:"]), | ||
(["-h"], 0, ["Usage:"]), | ||
(["list", "--help"], 0, ["Usage:"]), | ||
(["list", "-h"], 0, ["Usage:"]), | ||
(["list"], 0, ["Plugins"]), | ||
], | ||
) | ||
def test_cli_plugin_stdout(args: List[str], exit_code: int, content: List[str]): | ||
app = create_cli() | ||
result = runner.invoke(app, ["plugin"] + args) | ||
assert result.exit_code == exit_code | ||
for c in content: | ||
assert c in result.stdout | ||
|
||
|
||
def mock_get_plugins(): | ||
mytestexternalplugin = Mock() | ||
mytestexternalplugin.__name__ = "mytestexternalplugin" | ||
|
||
otherplugin = Mock() | ||
otherplugin.__name__ = "otherplugin" | ||
|
||
return [mytestexternalplugin, otherplugin] | ||
|
||
|
||
def mock_version(pkg): | ||
pkg_version_map = { | ||
"mytestexternalplugin": "0.4.4", | ||
"otherplugin": "1.1.1", | ||
} | ||
return pkg_version_map.get(pkg) | ||
|
||
|
||
@patch( | ||
"nebari.plugins.NebariPluginManager.plugin_manager.get_plugins", mock_get_plugins | ||
) | ||
@patch("_nebari.subcommands.plugin.version", mock_version) | ||
def test_cli_plugin_list_external_plugins(): | ||
app = create_cli() | ||
result = runner.invoke(app, ["plugin", "list"]) | ||
assert result.exit_code == 0 | ||
expected_output = [ | ||
"Plugins", | ||
"mytestexternalplugin │ 0.4.4", | ||
"otherplugin │ 1.1.1", | ||
] | ||
for c in expected_output: | ||
assert c in result.stdout |