Skip to content

fix: allow CLI group help without config #4109

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

Closed
Saithej2k wants to merge 1 commit into from
Closed

fix: allow CLI group help without config #4109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 27 additions & 16 deletions app/connectors_service/connectors/connectors_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,21 @@ def load_config(ctx, config):
raise FileNotFoundError(msg)


def is_help_request(ctx):
return any(arg in ctx.help_option_names for arg in ctx.args)


def ensure_config(ctx):
ctx.ensure_object(dict)
try:
ctx.obj["config"] = load_config(ctx, ctx.obj.get("config_file"))
except FileNotFoundError as e:
click.echo(
f"{e} Run `connectors login` first, or pass a config via the '-c' or '--config' option."
)
ctx.exit(1)


# Main group
@click.group(
invoke_without_command=True,
Expand All @@ -55,18 +70,14 @@ def load_config(ctx, config):
@click.pass_context
def cli(ctx, config):
# print help page if no subcommands provided
ctx.ensure_object(dict)
ctx.obj["config_file"] = config

if ctx.invoked_subcommand is None:
click.echo(ctx.get_help())
return

ctx.ensure_object(dict)
try:
ctx.obj["config"] = load_config(ctx, config)
except FileNotFoundError as e:
click.echo(
f"{e} Make sure that the config is either present at the default location ({CONFIG_FILE_PATH}) or it's passed via the '-c' or '--config' option."
)
ctx.exit(1)
if ctx.invoked_subcommand == "login" or is_help_request(ctx):
return


@click.command(help="Authenticate Connectors CLI with an Elasticsearch instance")
Expand Down Expand Up @@ -114,7 +125,7 @@ def login(host, method):
@click.group(invoke_without_command=False, help="Connectors management")
@click.pass_context
def connector(ctx):
pass
ensure_config(ctx)


@click.command(name="list", help="List all existing connectors")
Expand Down Expand Up @@ -385,9 +396,9 @@ def prompt():

# Index group
@click.group(invoke_without_command=False, help="Search indices management")
@click.pass_obj
def index(obj):
pass
@click.pass_context
def index(ctx):
ensure_config(ctx)


@click.command(name="list", help="Show all indices")
Expand Down Expand Up @@ -471,9 +482,9 @@ def delete(obj, index):

# Job group
@click.group(invoke_without_command=False, help="Sync jobs management")
@click.pass_obj
def job(obj):
pass
@click.pass_context
def job(ctx):
ensure_config(ctx)


@click.command(help="Start a sync job.")
Expand Down
14 changes: 14 additions & 0 deletions app/connectors_service/tests/test_connectors_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,20 @@ def test_connector_help_page():
assert "Commands:" in result.output


@pytest.mark.parametrize(
"commands", [["connector", "--help"], ["index", "--help"], ["job", "--help"]]
)
def test_group_help_page_does_not_require_config(commands, mock_cli_config):
mock_cli_config.side_effect = FileNotFoundError(CONFIG_FILE_PATH)

runner = CliRunner()
result = runner.invoke(cli, commands)

assert result.exit_code == 0
assert "Usage:" in result.output
mock_cli_config.assert_not_called()


@patch("connectors.cli.connector.Connector.list_connectors", AsyncMock(return_value=[]))
def test_connector_list_no_connectors():
runner = CliRunner()
Expand Down