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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: proxygen-cli
-Version: 2.0.15
+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
@@ -10,6 +10,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: click (>=8.1.3,<9.0.0)
 Requires-Dist: cryptography (>=36.0.1,<37.0.0)
 Requires-Dist: lxml (>=4.7.1,<5.0.0)
@@ -38,19 +39,19 @@ Type `proxygen` to see a list of available commands.
 
 ### Credentials
 
-All users should have individual credentials.
-`proxygen-cli` needs to know about them.
+The CLI has its own client credentials, which need to be input.
+Contact `deathstar` squad or the `platforms-api-producer-support` slack channel to find out what they are.
+
+All users should also have individual credentials. `proxygen-cli` needs to know about them.
 
+Simply execute the following command which will prompt you to enter your `client_id`, `client_secret`, `username`, and `password`:
 ```
-proxygen credentials set username <USERNAME>
-proxygen credentials set password <PASSWORD>
+proxygen credentials set
 ```
 
-The CLI has its own client credentials, which need to be input.
-Contact `deathstar` squad or the `platforms-api-producer-support` slack channel to find out what they are.
+If you need to update any credentials in the future, use the following command:
 ```
-proxgen credentials set client_id <CLIENT_ID>
-proxgen credentials set client_secret <CLIENT_SECRET>
+proxygen credentials set <KEY> <VALUE>
 ```
 
 

{proxygen_cli-2.0.15 → proxygen_cli-2.0.17}/README.md

@@ -14,19 +14,19 @@ Type `proxygen` to see a list of available commands.
 
 ### Credentials
 
-All users should have individual credentials.
-`proxygen-cli` needs to know about them.
+The CLI has its own client credentials, which need to be input.
+Contact `deathstar` squad or the `platforms-api-producer-support` slack channel to find out what they are.
+
+All users should also have individual credentials. `proxygen-cli` needs to know about them.
 
+Simply execute the following command which will prompt you to enter your `client_id`, `client_secret`, `username`, and `password`:
 ```
-proxygen credentials set username <USERNAME>
-proxygen credentials set password <PASSWORD>
+proxygen credentials set
 ```
 
-The CLI has its own client credentials, which need to be input.
-Contact `deathstar` squad or the `platforms-api-producer-support` slack channel to find out what they are.
+If you need to update any credentials in the future, use the following command:
 ```
-proxgen credentials set client_id <CLIENT_ID>
-proxgen credentials set client_secret <CLIENT_SECRET>
+proxygen credentials set <KEY> <VALUE>
 ```
 
 

proxygen_cli-2.0.17/proxygen_cli/cli/command_credentials.py

@@ -0,0 +1,101 @@
+import json
+import click
+import yaml
+import pydantic
+
+from proxygen_cli.lib import output
+from proxygen_cli.lib.credentials import (
+    Credentials, get_credentials, _yaml_credentials_file_source, create_yaml_credentials_file, initialise_credentials)
+from proxygen_cli.lib.dot_proxygen import credentials_file
+
+CHOICE_OF_CREDENTIAL_KEYS = click.Choice(Credentials.__fields__.keys())
+
+
+@click.group()
+def credentials():
+    """Get/set credentials."""
+
+
+@credentials.command()
+def list():
+    """
+    List all credentials values.
+    """
+    if not _yaml_credentials_file_source(None):
+        click.echo("Credentials file does not exist. Please run 'proxygen credentials set'")
+        exit()
+
+    creds = get_credentials()
+    output.print_spec(json.loads(creds.json(exclude_none=True)))
+
+
+@credentials.command()
+@click.argument("key", type=CHOICE_OF_CREDENTIAL_KEYS)
+def get(key):
+    """
+    Read a value from your credentials.
+    """
+    if not _yaml_credentials_file_source(None):
+        click.echo("Credentials file does not exist. Please run 'proxygen credentials set'")
+        exit()
+
+    creds = get_credentials()
+    click.echo(getattr(creds, key))
+
+
+@credentials.command()
+@click.argument("custom_pairs", nargs=-1, metavar="KEY VALUE", required=False)
+@click.option("--force", is_flag=True, help="Force re-entry of standard credentials")
+def set(custom_pairs, force):
+    """
+    Write a value to your credentials.
+    """
+    if not _yaml_credentials_file_source(None):
+        create_yaml_credentials_file()
+
+    current_credentials = _yaml_credentials_file_source(None)
+
+    # Check if base credentials are set
+    base_credentials_set = all(
+        current_credentials.get(field) is not None
+        for field in ["client_id", "client_secret", "username", "password"]
+    )
+
+    if not base_credentials_set or force:
+        client_id = click.prompt("Enter client_id")
+        client_secret = click.prompt("Enter client_secret", default="", show_default=False)
+        username = click.prompt("Enter username", default="", show_default=False)
+        password = click.prompt("Enter password", default="", show_default=False)
+
+        current_credentials["client_id"] = client_id
+        current_credentials["client_secret"] = client_secret
+        current_credentials["username"] = username
+        current_credentials["password"] = password
+
+    # Prompt for individual custom key-value pairs
+    for i in range(0, len(custom_pairs), 2):
+        key, value = custom_pairs[i:i + 2]
+        current_credentials[key] = value
+
+    try:
+        new_credentials = json.loads(Credentials(**current_credentials).json(exclude_none=True))
+    except pydantic.ValidationError as e:
+        errors = json.loads(e.json())
+        raise click.BadParameter("\n".join(error["msg"] for error in errors))
+
+    with credentials_file().open("w") as f:
+        yaml.safe_dump(new_credentials, f)
+
+    initialise_credentials()
+
+
+@credentials.command()
+@click.argument("key", type=CHOICE_OF_CREDENTIAL_KEYS)
+def rm(key):
+    """
+    Delete a value from your credentials.
+    """
+    current_credentials = _yaml_credentials_file_source(None)
+    current_credentials.pop(key, None)
+    with credentials_file().open("w") as f:
+        yaml.safe_dump(current_credentials, f)

{proxygen_cli-2.0.15 → 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.15 → 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.15 → proxygen_cli-2.0.17}/proxygen_cli/lib/credentials.py

@@ -3,6 +3,7 @@ import json
 from typing import Optional
 import yaml
 import sys
+import os
 
 import click
 from pydantic import (
@@ -21,6 +22,14 @@ def _yaml_credentials_file_source(_):
         return credentials or {}
 
 
+def create_yaml_credentials_file():
+    file_path = os.path.expanduser("~/.proxygen/credentials.yaml")
+
+    if not os.path.exists(file_path):
+        with open(file_path, 'w'):
+            pass
+
+
 class Credentials(BaseSettings):
     base_url: AnyHttpUrl = (
         "https://identity.prod.api.platform.nhs.uk/realms/api-producers"
@@ -28,9 +37,9 @@ class Credentials(BaseSettings):
     private_key_path: Optional[str] = None
     key_id: Optional[str] = None
     client_id: str
-    client_secret: str = None
-    username: str = None
-    password: str = None
+    client_secret: Optional[str] = None
+    username: Optional[str] = None
+    password: Optional[str] = None
 
     @validator("username", "password", "client_secret", "client_id")
     def validate_humans_users(cls, value, values):
@@ -47,12 +56,12 @@ class Credentials(BaseSettings):
             )
         with private_key_file.open() as f:
             return f.read()
-        
+
     @validator("key_id")
     def validate_kid(cls, kid, values):
         """
-        If authenticating using a machine (with an associated jwks configured in Keycloak) key, then the key id is required 
-        for newer versions of Keycloak.
+        If authenticating using a machine (with an associated jwks configured in Keycloak) key,
+        then the key id is required for newer versions of Keycloak.
         """
         if values.get("private_key_path") and not kid:
             raise ValueError("Private key specified with no associated Key ID (KID)")
@@ -65,7 +74,7 @@ class Credentials(BaseSettings):
         So take string.
         """
         return cls._validate_private_key_path(private_key_path)
-    
+
     @staticmethod
     def _validate_private_key_path(private_key_path):
         """
@@ -104,24 +113,26 @@ class Credentials(BaseSettings):
 
 
 _CREDENTIALS = None
-try:
-    _CREDENTIALS = Credentials()
-except ValidationError as e: # pragma: no cover
-
-    errors = json.loads(e.json())
-    print("*" * 100, file=sys.stderr)
-    print(
-        "Warning: Credentials invalid or not configured. See `proxygen credentials`.",
-        file=sys.stderr,
-    )
-    details = "  " + "\n  ".join(
-        f"{error['loc'][0]}: {error['msg']}" for error in errors
-    )
-    print(details, file=sys.stderr)
-    print("*" * 100, file=sys.stderr)
-    _CREDENTIALS = None
+def initialise_credentials():
+    global _CREDENTIALS
+    try:
+        _CREDENTIALS = Credentials()
+    except ValidationError as e:
+        errors = json.loads(e.json())
+        print("*" * 100, file=sys.stderr)
+        print(
+            "Warning: Credentials invalid or not configured. See `proxygen credentials`.",
+            file=sys.stderr,
+        )
+        details = "  " + "\n  ".join(
+            f"{error['loc'][0]}: {error['msg']}" for error in errors
+        )
+        print(details, file=sys.stderr)
+        print("*" * 100, file=sys.stderr)
+        _CREDENTIALS = None
 
 
 def get_credentials():
+    initialise_credentials()
     global _CREDENTIALS
     return _CREDENTIALS

{proxygen_cli-2.0.15 → proxygen_cli-2.0.17}/proxygen_cli/test/command_credentials_test.py

@@ -1,5 +1,6 @@
 from unittest.mock import patch
 
+import yaml
 import pytest
 from click.testing import CliRunner
 from pydantic.error_wrappers import ValidationError
@@ -72,7 +73,7 @@ def test_private_key_id_missing(patch_config):
     """
     mock_credentials = get_test_credentials()
 
-    with patch_config(credentials=mock_credentials),\
+    with patch_config(credentials=mock_credentials), \
             patch(("proxygen_cli.lib.credentials.Credentials."
                    "_validate_private_key_path")) as mock_creds:
         mock_creds.return_value = True
@@ -107,19 +108,73 @@ def test_set_credential(patch_config, credentials_file):
     assert credentials_file() == expected_credentials
 
 
-def test_set_invalid_setting():
-    runner = CliRunner()
-    result = runner.invoke(cmd_credentials.set, ["invalid", "new-username"])
+def test_update_credentials(patch_config, credentials_file):
+    mock_credentials = get_test_credentials()
+
+    # Convert mock_credentials to a dictionary
+    mock_credentials_dict = yaml.safe_load(mock_credentials)
 
-    assert "'invalid' is not one of 'base_url'" in result.output.strip()
+    # Set an initial value for the username field
+    initial_username = "old-username"
+    mock_credentials_dict["username"] = initial_username
 
+    with patch_config(credentials=mock_credentials):
+        runner = CliRunner()
+        runner.invoke(cmd_credentials.set, ["username", "new-username123"])
 
-def test_set_invalid_private_key_path():
-    runner = CliRunner()
-    result = runner.invoke(
-        cmd_credentials.set, ["private_key_path", "invalid_private_key_path"]
+    expected_credentials = "\n".join(
+        [
+            "base_url: https://mock-keycloak-url.nhs.uk",
+            "client_id: mock-api-client",
+            "client_secret: 1a2f4g5",
+            "password: mock-password",
+            "username: new-username123",  # Updated value
+        ]
+    )
+
+    # Check the file has been written to
+    assert credentials_file() == expected_credentials
+
+
+def test_add_key_id(patch_config, credentials_file):
+    mock_credentials = get_test_credentials()
+
+    with patch_config(credentials=mock_credentials):
+        runner = CliRunner()
+        runner.invoke(cmd_credentials.set, ["key_id", "test_kid"])
+
+    expected_credentials = "\n".join(
+        [
+            "base_url: https://mock-keycloak-url.nhs.uk",
+            "client_id: mock-api-client",
+            "client_secret: 1a2f4g5",
+            "key_id: test_kid",
+            "password: mock-password",
+            "username: mock-user",
+        ]
     )
 
+    # Check the file has been written to
+    assert credentials_file() == expected_credentials
+
+
+def test_set_invalid_setting(patch_config):
+    mock_credentials = get_test_credentials()
+    with patch_config(credentials=mock_credentials):
+        runner = CliRunner()
+        result = runner.invoke(cmd_credentials.set, ["invalid", "new-username"])
+
+    assert "Error: Invalid value: extra fields not permitted" in result.output.strip()
+
+
+def test_set_invalid_private_key_path(patch_config):
+    mock_credentials = get_test_credentials()
+    with patch_config(credentials=mock_credentials):
+        runner = CliRunner()
+        result = runner.invoke(
+            cmd_credentials.set, ["private_key_path", "invalid_private_key_path"]
+        )
+
     assert ".proxygen/invalid_private_key_path does not exist" in result.output.strip()
 
 

{proxygen_cli-2.0.15 → 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.15 → proxygen_cli-2.0.17}/pyproject.toml

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

proxygen_cli-2.0.15/proxygen_cli/cli/command_credentials.py

@@ -1,65 +0,0 @@
-import json
-import pydantic
-import yaml
-import click
-
-from proxygen_cli.lib import output
-from proxygen_cli.lib.credentials import Credentials, get_credentials, _yaml_credentials_file_source
-from proxygen_cli.lib.dot_proxygen import credentials_file
-
-CHOICE_OF_CREDENTIAL_KEYS = click.Choice(Credentials.__fields__.keys())
-
-
-@click.group()
-def credentials():
-    """Get/set credentials."""
-
-
-@credentials.command()
-def list():
-    """
-    List all credentials values.
-    """
-    creds = get_credentials()
-    output.print_spec(json.loads(creds.json(exclude_none=True)))
-
-@credentials.command()
-@click.argument("key", type=CHOICE_OF_CREDENTIAL_KEYS)
-def get(key):
-    """
-    Read a value from your credentials.
-    """
-    creds = get_credentials()
-    click.echo(getattr(creds, key))
-
-
-@credentials.command()
-@click.argument("key", type=CHOICE_OF_CREDENTIAL_KEYS)
-@click.argument("value")
-def set(key, value):
-    """
-    Write a value to your credentials.
-    """
-    current_credentials = _yaml_credentials_file_source(None)
-    current_credentials[key] = value
-    try:
-        new_credentials = json.loads(Credentials(**current_credentials).json(exclude_none=True))
-    except pydantic.ValidationError as e:
-        errors = json.loads(e.json())
-        raise click.BadParameter("\n".join(error["msg"] for error in errors))
-    with credentials_file().open("w") as f:
-        yaml.safe_dump(new_credentials, f)
-
-    
-
-
-@credentials.command()
-@click.argument("key", type=CHOICE_OF_CREDENTIAL_KEYS)
-def rm(key):
-    """
-    Delete a value from your credentials.
-    """
-    current_credentials = _yaml_credentials_file_source(None)
-    current_credentials.pop(key, None)
-    with credentials_file().open("w") as f:
-        yaml.safe_dump(current_credentials, f)