proxygen-cli 2.0.16__tar.gz → 2.0.17__tar.gz

{proxygen_cli-2.0.16 → proxygen_cli-2.0.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: proxygen-cli
-Version: 2.0.16
+Version: 2.0.17
 Summary: CLI for interacting with NHSD APIM's proxygen service
 Home-page: https://github.com/NHSDigital/proxygen-cli
 Author: Ben Strutt

{proxygen_cli-2.0.16 → proxygen_cli-2.0.17}/proxygen_cli/cli/command_main.py

@@ -1,10 +1,7 @@
-import sys
-from typing import get_args
-from urllib import parse
 import click
 from proxygen_cli.lib.settings import SETTINGS
 
-from proxygen_cli.lib import constants, proxygen_api, settings, output, version
+from proxygen_cli.lib import proxygen_api, output
 from proxygen_cli.cli import (
     command_credentials,
     command_settings,
@@ -23,7 +20,7 @@ def main():
 main.add_command(command_settings.settings)
 main.add_command(command_credentials.credentials)
 main.add_command(command_instance.instance)
-main.add_command(command_spec.spec_cmd, name="spec")
+main.add_command(command_spec.spec)
 main.add_command(command_secret.secret)
 main.add_command(command_docker.docker)
 

{proxygen_cli-2.0.16 → proxygen_cli-2.0.17}/proxygen_cli/cli/command_spec.py

@@ -3,34 +3,58 @@ from typing import get_args
 import click
 from yaspin import yaspin
 
-from proxygen_cli.lib import output, proxygen_api, spec, spec_server
+from proxygen_cli.lib import output, proxygen_api, spec as lib_spec, \
+      spec_server
 from proxygen_cli.lib.constants import LITERAL_ENVS
 from proxygen_cli.lib.settings import SETTINGS
 
 CHOICE_OF_ENVS = click.Choice(get_args(LITERAL_ENVS))
 PUBLISH_SPEC_POP_KEYS = ["x-nhsd-apim"]  # Don't publish deployment information
 
+HELP_NO_CONFIRM = "Do not prompt for confirmation."
+HELP_UAT = "Target the UAT instance of API catalogue."
+
+UAT_KWARGS = {
+    'default': False,
+    'help': HELP_UAT,
+    'is_flag': True
+}
+
+NO_CONFIRM_KWARGS = {
+    'is_flag': True,
+    'show_default': True,
+    'help': HELP_NO_CONFIRM,
+}
+
 
 @click.group()
 @click.option(
-    "--api", default=SETTINGS.api, help="Override the default API", show_default=True
+    "--api",
+    default=SETTINGS.api,
+    help="Override the default API",
+    show_default=True
+)
+@click.option(
+    "--uat",
+    **UAT_KWARGS
 )
 @click.pass_context
-def spec_cmd(ctx, api):
+def spec(ctx, api, uat):
+    """Publish/update/delete specifications on the API catalogue."""
     ctx.ensure_object(dict)
     ctx.obj["api"] = api
+    ctx.obj['uat'] = uat
 
 
-@spec_cmd.command()
+@spec.command()
 @click.argument("spec_file")
 @click.option(
     "--no-confirm",
-    is_flag=True,
-    show_default=True,
-    help="Do not prompt for confirmation.",
+    **NO_CONFIRM_KWARGS
 )
 @click.option(
-    "--uat", default=False, help="Spec for UAT environment", is_flag=True
+    "--uat",
+    **UAT_KWARGS
 )
 @click.pass_context
 def publish(ctx, spec_file, no_confirm, uat):
@@ -39,7 +63,7 @@ def publish(ctx, spec_file, no_confirm, uat):
     """
 
     api = ctx.obj["api"]
-    paas_open_api = spec.resolve(spec_file, pop_keys=PUBLISH_SPEC_POP_KEYS)
+    paas_open_api = lib_spec.resolve(spec_file, pop_keys=PUBLISH_SPEC_POP_KEYS)
 
     if not no_confirm:
         output.print_spec(paas_open_api)
@@ -69,9 +93,10 @@ def serve(spec_file):
     spec_server.serve(spec_file, pop_keys=PUBLISH_SPEC_POP_KEYS)
 
 
-@spec_cmd.command()
+@spec.command()
 @click.option(
-    "--uat", default=False, help="Spec for UAT environment", is_flag=True
+    "--uat",
+    **UAT_KWARGS
 )
 @click.pass_context
 def get(ctx, uat):
@@ -83,15 +108,14 @@ def get(ctx, uat):
     output.print_spec(result)
 
 
-@spec_cmd.command()
+@spec.command()
 @click.option(
     "--no-confirm",
-    is_flag=True,
-    show_default=True,
-    help="Do not prompt for confirmation.",
+    **NO_CONFIRM_KWARGS
 )
 @click.option(
-    "--uat", default=False, help="Spec for UAT environment", is_flag=True
+    "--uat",
+    **UAT_KWARGS
 )
 @click.pass_context
 def delete(ctx, no_confirm, uat):

{proxygen_cli-2.0.16 → proxygen_cli-2.0.17}/proxygen_cli/test/command_spec_test.py

@@ -3,9 +3,11 @@ Tests around the spec CLI command.
 """
 from urllib.parse import urlparse
 from click.testing import CliRunner
+import pytest
 
 from proxygen_cli.cli.command_spec import get as spec_get, \
-    delete as spec_delete, publish as spec_publish
+    delete as spec_delete, publish as spec_publish, spec as spec_base, \
+    serve as spec_serve
 
 
 def test_publish_spec_std(patch_request, patch_access_token,
@@ -15,7 +17,7 @@ def test_publish_spec_std(patch_request, patch_access_token,
     """
 
     runner = CliRunner()
-    with patch_access_token(), patch_request(200, "TEST") as patched_request,\
+    with patch_access_token(), patch_request(200, "TEST") as patched_request, \
             patch_spec_resolver(), patch_click_confirm():
 
         runner.invoke(spec_publish, ["NoFile"], obj={"api": "mock-api"})
@@ -32,7 +34,7 @@ def test_publish_spec_uat(patch_request, patch_access_token,
     """
 
     runner = CliRunner()
-    with patch_access_token(), patch_request(200, "TEST") as patched_request,\
+    with patch_access_token(), patch_request(200, "TEST") as patched_request, \
             patch_spec_resolver(), patch_click_confirm():
 
         runner.invoke(
@@ -110,6 +112,30 @@ def test_delete_spec_uat(patch_request, patch_access_token,
         assert path == "/apis/mock-api/spec/uat"
 
 
+@pytest.mark.parametrize("cmd, uat_expected", [
+    (spec_get, True),
+    (spec_delete, True),
+    (spec_publish, True),
+    (spec_serve, False),
+    (spec_base, True)
+])
+def test_uat_option_in_expected_command_help(cmd, uat_expected):
+    """
+    Ensure the --uat option is only available for the appropriate spec
+    commands.
+    """
+
+    runner = CliRunner()
+    result = runner.invoke(cmd, ["--help"])
+
+    if uat_expected:
+        assert "--uat" in result.output, \
+            f"--uat option was expected but not found for command {cmd}"
+    else:
+        assert "--uat" not in result.output, \
+            f"--uat option was not expected but found for command {cmd}"
+
+
 def _extract_request_path(mocked_request, method='GET'):
     """
     Extract the path from the first mocked call to .get() in the provided

{proxygen_cli-2.0.16 → proxygen_cli-2.0.17}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "proxygen-cli"
-version = "2.0.16"
+version = "2.0.17"
 description = "CLI for interacting with NHSD APIM's proxygen service"
 authors = ["Ben Strutt <ben.strutt1@nhs.net>"]
 readme = "README.md"