proxygen-cli 3.0.1__tar.gz → 4.0.0__tar.gz

{proxygen_cli-3.0.1 → proxygen_cli-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proxygen-cli
-Version: 3.0.1
+Version: 4.0.0
 Summary: CLI for interacting with NHSD APIM's proxygen service
 Author: Ben Strutt
 Author-email: ben.strutt1@nhs.net
@@ -16,7 +16,7 @@ Requires-Dist: pydantic (>=1.9.1,<2.0.0)
 Requires-Dist: pyjwt (>=2.9.0,<3.0.0)
 Requires-Dist: pyyaml (>=6.0.3,<7.0.0)
 Requires-Dist: requests (>=2.32.3,<3.0.0)
-Requires-Dist: tabulate (>=0.9.0,<0.10.0)
+Requires-Dist: tabulate (>=0.9,<0.11)
 Requires-Dist: yaspin (>=3.2.0,<4.0.0)
 Project-URL: Repository, https://github.com/NHSDigital/proxygen-cli
 Description-Content-Type: text/markdown

{proxygen_cli-3.0.1 → proxygen_cli-4.0.0}/proxygen_cli/cli/command_credentials.py

@@ -42,11 +42,11 @@ def get(key):
     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):
+@click.option("--env", type=click.Choice(["prod", "ptl"], case_sensitive=False), default="prod", help="Environment to use for authentication")
+def set(custom_pairs, force, env):
     """
     Write a value to your credentials.
     """
@@ -55,16 +55,22 @@ def set(custom_pairs, force):
 
     current_credentials = _yaml_credentials_file_source(None)
 
-    # Check if user credentials are set
-    base_credentials_set = all(
-        current_credentials.get(field) is not None
-        for field in ["username", "password"]
-    )
+    KEYCLOAK_URLS = {
+        "prod": "https://identity.prod.api.platform.nhs.uk/realms/api-producers",
+        "ptl":  "https://identity.ptl.api.platform.nhs.uk/realms/api-producers",
+    }
+
+    current_credentials["base_url"] = KEYCLOAK_URLS[env.lower()]
 
-    if not base_credentials_set or force:
+    context = click.get_current_context()
+    if ("private_key_path" not in context.params["custom_pairs"]):
+        client_id = click.prompt("Enter client ID", default="", show_default=False)
+        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
 

{proxygen_cli-3.0.1 → proxygen_cli-4.0.0}/proxygen_cli/cli/command_settings.py

@@ -19,7 +19,6 @@ def settings():
     """
 
 
-
 def _get_setting(key):
     return getattr(SETTINGS, key)
 
@@ -31,6 +30,7 @@ def list():
     """
     output.print_spec(json.loads(SETTINGS.json(exclude_none=True)))
 
+
 @settings.command()
 @click.argument("key", type=CHOICE_OF_SETTINGS_KEYS)
 def get(key):
@@ -43,14 +43,23 @@ def get(key):
 @settings.command()
 @click.argument("key", type=CHOICE_OF_SETTINGS_KEYS)
 @click.argument("value")
-def set(key, value):
+@click.option("--env", type=click.Choice(["prod", "ptl"], case_sensitive=False), default="prod", help="Environment to use for authentication")
+def set(key, value, env):
     """
     Write a value to your settings.
     """
     _get_setting(key)
 
     current_settings = _yaml_settings_file_source(None)
+
+    PROXYGEN_URLS = {
+        "prod": "https://proxygen.prod.api.platform.nhs.uk",
+        "ptl":  "https://proxygen.ptl.api.platform.nhs.uk",
+    }
+
+    current_settings["endpoint_url"] = PROXYGEN_URLS[env.lower()]
     current_settings[key] = value
+
     try:
         new_settings = json.loads(Settings(**current_settings).json(exclude_none=True))
     except pydantic.ValidationError as e:
@@ -71,4 +80,4 @@ def rm(key):
     current_settings = _yaml_settings_file_source(None)
     current_settings.pop(key, None)
     with settings_file().open("w") as f:
-        yaml.safe_dump(current_settings, f)
+        yaml.safe_dump(current_settings, f)

{proxygen_cli-3.0.1 → proxygen_cli-4.0.0}/proxygen_cli/lib/constants.py

@@ -16,6 +16,3 @@ LITERAL_SECRET_TYPES = Literal[
     "apikey",
     "mtls"
 ]
-
-PROXYGEN_CLIENT_ID = "proxygen-cli-user-client"
-PROXYGEN_CLIENT_SECRET = "CDuV9K39GxFS37tzdopKitIMv8AZaIAj"

{proxygen_cli-3.0.1 → proxygen_cli-4.0.0}/proxygen_cli/lib/credentials.py

@@ -31,13 +31,11 @@ def create_yaml_credentials_file():
 
 
 class Credentials(BaseSettings):
-    base_url: AnyHttpUrl = (
-        "https://identity.prod.api.platform.nhs.uk/realms/api-producers"
-    )
+    base_url: AnyHttpUrl
     private_key_path: Optional[str] = None
     key_id: Optional[str] = None
-    client_id: str = constants.PROXYGEN_CLIENT_ID
-    client_secret: Optional[str] = constants.PROXYGEN_CLIENT_SECRET
+    client_id: Optional[str] = None
+    client_secret: Optional[str] = None
     username: Optional[str] = None
     password: Optional[str] = None
 
@@ -137,4 +135,4 @@ def initialise_credentials():
 def get_credentials():
     initialise_credentials()
     global _CREDENTIALS
-    return _CREDENTIALS
+    return _CREDENTIALS

{proxygen_cli-3.0.1 → proxygen_cli-4.0.0}/proxygen_cli/lib/settings.py

@@ -1,4 +1,4 @@
-from typing import Literal
+from typing import Literal, Optional
 from pydantic import BaseSettings, AnyUrl
 
 import yaml
@@ -13,7 +13,7 @@ def _yaml_settings_file_source(_):
 
 
 class Settings(BaseSettings):
-    endpoint_url: AnyUrl = "https://proxygen.prod.api.platform.nhs.uk"
+    endpoint_url: Optional[AnyUrl] = None
     spec_output_format: Literal["json", "yaml"] = "yaml"
     api: str = None
 

{proxygen_cli-3.0.1 → proxygen_cli-4.0.0}/proxygen_cli/test/command_credentials_test.py

@@ -10,10 +10,13 @@ import proxygen_cli.cli.command_credentials as cmd_credentials
 from proxygen_cli.lib.credentials import Credentials
 CLIENT_ID = os.environ["PROXYGEN_CLIENT_ID"]
 CLIENT_SECRET = os.environ["PROXYGEN_CLIENT_SECRET"]
+KEYCLOAK_URL = "https://identity.prod.api.platform.nhs.uk/realms/api-producers"
+MOCK_KEYCLOAK_URL = "https://mock-keycloak-url.nhs.uk"
+BASE_URL_LABEL = "base_url: "
 
 def get_test_credentials(**kwargs):
     base_credentials = {
-        "base_url": "https://mock-keycloak-url.nhs.uk",
+        "base_url": MOCK_KEYCLOAK_URL,
         "client_id": "mock-api-client",
         "client_secret": "1a2f4g5",
         "password": "mock-password",
@@ -31,7 +34,7 @@ def get_test_credentials(**kwargs):
 #get mock values for credentials.yaml file
 def get_test_proxygen_client_credentials(**kwargs):
     client_credentials = {
-        "base_url": "https://mock-keycloak-url.nhs.uk",
+        "base_url": MOCK_KEYCLOAK_URL,
         "client_id": CLIENT_ID,
         "client_secret": CLIENT_SECRET,
         "password": "mock-password",
@@ -52,11 +55,12 @@ def test_set_proxygen_user_credential(patch_config, credentials_file):
 
     with patch_config(credentials=mock_credentials):
         runner = CliRunner()
-        runner.invoke(cmd_credentials.set, ["username", "new-username"] )
+        input_data = "\n".join([CLIENT_ID, CLIENT_SECRET, "new-username", "mock-password"])
+        runner.invoke(cmd_credentials.set,[],input=input_data,)
 
     expected_credentials = "\n".join(
         [
-            "base_url: https://mock-keycloak-url.nhs.uk",
+            BASE_URL_LABEL + KEYCLOAK_URL,
             "client_id: "+CLIENT_ID,
             "client_secret: "+CLIENT_SECRET,
             "password: mock-password",
@@ -84,12 +88,12 @@ def test_update_proxygen_user_credentials(patch_config, credentials_file):
 
     with patch_config(credentials=mock_credentials):
         runner = CliRunner()
-        runner.invoke(cmd_credentials.set, ["username", "new-username123"])
-        runner.invoke(cmd_credentials.set, ["password", "new-password123"])
+        input_data = "\n".join([CLIENT_ID, CLIENT_SECRET, "new-username123", "new-password123"])
+        runner.invoke(cmd_credentials.set,[],input=input_data,)
 
     expected_credentials = "\n".join(
         [
-            "base_url: https://mock-keycloak-url.nhs.uk",
+            BASE_URL_LABEL + KEYCLOAK_URL,
             "client_id: "+CLIENT_ID,
             "client_secret: "+CLIENT_SECRET,
             "password: new-password123",
@@ -117,16 +121,16 @@ def test_update_proxygen_client_credentials(patch_config, credentials_file):
 
     with patch_config(credentials=mock_credentials):
         runner = CliRunner()
-        runner.invoke(cmd_credentials.set, ["client_id", "new-clientid123"])
-        runner.invoke(cmd_credentials.set, ["client_secret", "new-clientsecret123"])
+        input_data = "\n".join(["new-clientid123", "new-clientsecret123", "new-user", "new-password"])
+        runner.invoke(cmd_credentials.set,[],input=input_data,)
 
     expected_credentials = "\n".join(
         [
-            "base_url: https://mock-keycloak-url.nhs.uk",
+            BASE_URL_LABEL + KEYCLOAK_URL,
             "client_id: new-clientid123",
             "client_secret: new-clientsecret123",
-            "password: mock-password",
-            "username: mock-user",
+            "password: new-password",
+            "username: new-user",
         ]
     )
 
@@ -207,13 +211,14 @@ def test_set_credential(patch_config, credentials_file):
 
     with patch_config(credentials=mock_credentials):
         runner = CliRunner()
-        runner.invoke(cmd_credentials.set, ["username", "new-username"])
+        input_data = "\n".join(["mock-api-client", "mock-api-clientsecret", "new-username", "mock-password"])
+        runner.invoke(cmd_credentials.set,[],input=input_data,)
 
     expected_credentials = "\n".join(
         [
-            "base_url: https://mock-keycloak-url.nhs.uk",
+            BASE_URL_LABEL + KEYCLOAK_URL,
             "client_id: mock-api-client",
-            "client_secret: 1a2f4g5",
+            "client_secret: mock-api-clientsecret",
             "password: mock-password",
             "username: new-username",
         ]
@@ -235,13 +240,14 @@ def test_update_credentials(patch_config, credentials_file):
 
     with patch_config(credentials=mock_credentials):
         runner = CliRunner()
-        runner.invoke(cmd_credentials.set, ["username", "new-username123"])
+        input_data = "\n".join(["mock-api-client", "mock-api-clientsecret", "new-username123", "mock-password"])
+        runner.invoke(cmd_credentials.set,[],input=input_data,)
 
     expected_credentials = "\n".join(
         [
-            "base_url: https://mock-keycloak-url.nhs.uk",
+            BASE_URL_LABEL + KEYCLOAK_URL,
             "client_id: mock-api-client",
-            "client_secret: 1a2f4g5",
+            "client_secret: mock-api-clientsecret",
             "password: mock-password",
             "username: new-username123",  # Updated value
         ]
@@ -260,10 +266,9 @@ def test_add_key_id(patch_config, credentials_file):
 
     expected_credentials = "\n".join(
         [
-            "base_url: https://mock-keycloak-url.nhs.uk",
+            BASE_URL_LABEL + MOCK_KEYCLOAK_URL,
             "client_id: mock-api-client",
             "client_secret: 1a2f4g5",
-            "key_id: test_kid",
             "password: mock-password",
             "username: mock-user",
         ]
@@ -279,7 +284,7 @@ def test_set_invalid_setting(patch_config):
         runner = CliRunner()
         result = runner.invoke(cmd_credentials.set, ["invalid", "new-username"])
 
-    assert "Error: Invalid value: extra fields not permitted" in result.output.strip()
+    assert "Enter client ID:Aborted!" in result.output.strip()
 
 
 def test_set_invalid_private_key_path(patch_config):
@@ -302,7 +307,7 @@ def test_remove_setting(patch_config, credentials_file):
 
     expected_credentials = "\n".join(
         [
-            "base_url: https://mock-keycloak-url.nhs.uk",
+            BASE_URL_LABEL + MOCK_KEYCLOAK_URL,
             "client_id: mock-api-client",
             "client_secret: 1a2f4g5",
             "password: mock-password",

{proxygen_cli-3.0.1 → proxygen_cli-4.0.0}/proxygen_cli/test/command_settings_test.py

@@ -73,7 +73,7 @@ def test_set_setting(patch_config, settings_file):
     expected_settings = "\n".join(
         [
             "api: new_api_name",
-            "endpoint_url: https://mock-proxygen.nhs.uk",
+            "endpoint_url: https://proxygen.prod.api.platform.nhs.uk",
             "spec_output_format: json",
         ]
     )

{proxygen_cli-3.0.1 → proxygen_cli-4.0.0}/proxygen_cli/test/validate_cli_version_test.py

@@ -13,7 +13,7 @@ def test_validate_cli_version_success(patch_request):
 
 
 def test_validate_cli_version_failure(patch_request):
-    required_version = "4.0.0"
+    required_version = "5.0.0"
 
     mocked_response = {"proxygen_cli": {"min_version": required_version}}
     with patch_request(200, mocked_response), pytest.raises(RuntimeError) as e:

{proxygen_cli-3.0.1 → proxygen_cli-4.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "proxygen-cli"
-version = "3.0.1"
+version = "4.0.0"
 description = "CLI for interacting with NHSD APIM's proxygen service"
 authors = ["Ben Strutt <ben.strutt1@nhs.net>"]
 readme = "README.md"
@@ -20,7 +20,7 @@ lxml = "^6.0.1"
 cryptography = ">= 44.0.1, < 47.0.0" # Not directly imported, but needed by pyjwt for the RS512 algorithm
 pyyaml = "^6.0.3"
 yaspin = "^3.2.0"
-tabulate = "^0.9.0"
+tabulate = ">=0.9,<0.11"
 packaging = "^24.2"
 
 [tool.poetry.group.dev.dependencies]