proxygen-cli 2.1.10__tar.gz → 2.1.12__tar.gz

{proxygen_cli-2.1.10 → proxygen_cli-2.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: proxygen-cli
-Version: 2.1.10
+Version: 2.1.12
 Summary: CLI for interacting with NHSD APIM's proxygen service
 Home-page: https://github.com/NHSDigital/proxygen-cli
 Author: Ben Strutt
@@ -38,15 +38,15 @@ After installation, the `proxygen` executable is available. Typing `proxygen` di
 
 ### Credentials
 
-The CLI requires client credentials, which can be obtained from the `platforms-api-producer-support` Slack channel.
+The Proxygen CLI client credentials `client_id`, `client_secret` are setup as part of proxygen CLI package.
 
-All users should also have individual credentials. `proxygen-cli` needs to know about them.
-You can setup the credentials in `proxygen-cli` using:
+All users should have individual credentials. `proxygen-cli` needs to know about them. You can setup your user credentials in proxygen-cli using:
 ```
 proxygen credentials set
 ```
-This command prompts you to enter your `client_id`, `client_secret`, `username`, and `password`. 
-To update credentials in the future, use:
+This command prompts you to enter your `username`, and `password`.
+
+To update any credentials `client_id`/ `client_secret`/ `username`/ `password` in the future, use:
 ```
 proxygen credentials set <KEY> <VALUE>
 ```
@@ -109,4 +109,3 @@ Use the following command to obtain the pytest-nhsd-apim token:
 ```
 $(proxygen pytest_nhsd_apim get_token)
 ```
-

{proxygen_cli-2.1.10 → proxygen_cli-2.1.12}/README.md

@@ -13,15 +13,15 @@ After installation, the `proxygen` executable is available. Typing `proxygen` di
 
 ### Credentials
 
-The CLI requires client credentials, which can be obtained from the `platforms-api-producer-support` Slack channel.
+The Proxygen CLI client credentials `client_id`, `client_secret` are setup as part of proxygen CLI package.
 
-All users should also have individual credentials. `proxygen-cli` needs to know about them.
-You can setup the credentials in `proxygen-cli` using:
+All users should have individual credentials. `proxygen-cli` needs to know about them. You can setup your user credentials in proxygen-cli using:
 ```
 proxygen credentials set
 ```
-This command prompts you to enter your `client_id`, `client_secret`, `username`, and `password`. 
-To update credentials in the future, use:
+This command prompts you to enter your `username`, and `password`.
+
+To update any credentials `client_id`/ `client_secret`/ `username`/ `password` in the future, use:
 ```
 proxygen credentials set <KEY> <VALUE>
 ```
@@ -83,4 +83,4 @@ When testing using the pytest-nhsd-apim python testing package, an apigee manage
 Use the following command to obtain the pytest-nhsd-apim token:
 ```
 $(proxygen pytest_nhsd_apim get_token)
-```
+```

{proxygen_cli-2.1.10 → proxygen_cli-2.1.12}/proxygen_cli/cli/command_credentials.py

@@ -2,6 +2,7 @@ import json
 import click
 import yaml
 import pydantic
+import os
 
 from proxygen_cli.lib import output
 from proxygen_cli.lib.credentials import (
@@ -10,7 +11,6 @@ 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."""
@@ -55,20 +55,16 @@ def set(custom_pairs, force):
 
     current_credentials = _yaml_credentials_file_source(None)
 
-    # Check if base credentials are set
+    # Check if user credentials are set
     base_credentials_set = all(
         current_credentials.get(field) is not None
-        for field in ["client_id", "client_secret", "username", "password"]
+        for field in ["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
 
@@ -98,4 +94,4 @@ def rm(key):
     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)
+        yaml.safe_dump(current_credentials, f)

{proxygen_cli-2.1.10 → proxygen_cli-2.1.12}/proxygen_cli/lib/auth.py

@@ -1,5 +1,4 @@
 """Proxygen test utility functions"""
-import functools
 import hashlib
 import json
 import uuid
@@ -72,9 +71,7 @@ def access_token():
     return token_data["access_token"]
 
 
-def _get_token_data_from_refresh_token(
-        refresh_token: str
-):
+def _get_token_data_from_refresh_token(refresh_token: str):
     CREDENTIALS = get_credentials()
     token_response = requests.post(
         f"{CREDENTIALS.base_url}/protocol/openid-connect/token",
@@ -92,7 +89,7 @@ def _get_token_data_from_refresh_token(
 def _get_token_data_from_user_login():
     session = requests.Session()
     CREDENTIALS = get_credentials()
-    redirect_uri = f"{CREDENTIALS.base_url}/protocol/openid-connect/callback"
+    redirect_uri = f"{CREDENTIALS.base_url}/callback"
     login_page_resp = session.get(
         f"{CREDENTIALS.base_url}/protocol/openid-connect/auth",
         params={
@@ -105,7 +102,9 @@ def _get_token_data_from_user_login():
     )
 
     if login_page_resp.status_code != 200:
-        raise RuntimeError(f"Login page get request status was {login_page_resp.status_code} expected to be 200")
+        raise RuntimeError(
+            f"Login page get request status was {login_page_resp.status_code} expected to be 200"
+        )
 
     login_form = html.fromstring(login_page_resp.content.decode()).get_element_by_id(
         "kc-form-login"
@@ -118,7 +117,11 @@ def _get_token_data_from_user_login():
             "Accept": "application/json",
             "Content-Type": "application/x-www-form-urlencoded",
         },
-        data={"username": CREDENTIALS.username, "password": CREDENTIALS.password, "credentialId": ""},
+        data={
+            "username": CREDENTIALS.username,
+            "password": CREDENTIALS.password,
+            "credentialId": "",
+        },
     )
 
     http_error_msg = "Invalid username or password"
@@ -147,9 +150,6 @@ def _get_token_data_from_user_login():
     return token_response.json()
 
 
-
-
-
 def _get_token_data_from_machine_user():
     CREDENTIALS = get_credentials()
     aud = CREDENTIALS.base_url
@@ -164,10 +164,10 @@ def _get_token_data_from_machine_user():
         "exp": int(time()) + 300,  # 5mins in the future
     }
 
-    additional_jwt_headers = {
-        'kid': CREDENTIALS.key_id
-    }
-    client_assertion = jwt.encode(claims, private_key, algorithm="RS512", headers=additional_jwt_headers)
+    additional_jwt_headers = {"kid": CREDENTIALS.key_id}
+    client_assertion = jwt.encode(
+        claims, private_key, algorithm="RS512", headers=additional_jwt_headers
+    )
     token_response = requests.post(
         token_endpoint,
         data={
@@ -177,5 +177,7 @@ def _get_token_data_from_machine_user():
         },
     )
     if token_response.status_code != 200:
-        raise RuntimeError(f"Token response was {token_response.status_code} expected 200")
-    return token_response.json()
+        raise RuntimeError(
+            f"Token response was {token_response.status_code} expected 200"
+        )
+    return token_response.json()

{proxygen_cli-2.1.10 → proxygen_cli-2.1.12}/proxygen_cli/lib/constants.py

@@ -16,3 +16,6 @@ LITERAL_SECRET_TYPES = Literal[
     "apikey",
     "mtls"
 ]
+
+PROXYGEN_CLIENT_ID = ""
+PROXYGEN_CLIENT_SECRET = ""

{proxygen_cli-2.1.10 → proxygen_cli-2.1.12}/proxygen_cli/lib/credentials.py

@@ -5,7 +5,6 @@ import yaml
 import sys
 import os
 
-import click
 from pydantic import (
     BaseSettings,
     validator,
@@ -14,6 +13,7 @@ from pydantic import (
 )
 
 from . import dot_proxygen
+from . import constants
 
 
 def _yaml_credentials_file_source(_):
@@ -26,7 +26,7 @@ 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'):
+        with open(file_path, "w"):
             pass
 
 
@@ -36,8 +36,8 @@ class Credentials(BaseSettings):
     )
     private_key_path: Optional[str] = None
     key_id: Optional[str] = None
-    client_id: str
-    client_secret: Optional[str] = None
+    client_id: str = constants.PROXYGEN_CLIENT_ID
+    client_secret: Optional[str] = constants.PROXYGEN_CLIENT_SECRET
     username: Optional[str] = None
     password: Optional[str] = None
 
@@ -113,6 +113,8 @@ class Credentials(BaseSettings):
 
 
 _CREDENTIALS = None
+
+
 def initialise_credentials():
     global _CREDENTIALS
     try:

{proxygen_cli-2.1.10 → proxygen_cli-2.1.12}/proxygen_cli/test/command_credentials_test.py

@@ -2,12 +2,14 @@ from unittest.mock import patch
 
 import yaml
 import pytest
+import os
 from click.testing import CliRunner
 from pydantic.error_wrappers import ValidationError
 
 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"]
 
 def get_test_credentials(**kwargs):
     base_credentials = {
@@ -26,6 +28,119 @@ def get_test_credentials(**kwargs):
 
     return "\n".join(text_format_credentials)
 
+#get mock values for credentials.yaml file
+def get_test_proxygen_client_credentials(**kwargs):
+    client_credentials = {
+        "base_url": "https://mock-keycloak-url.nhs.uk",
+        "client_id": CLIENT_ID,
+        "client_secret": CLIENT_SECRET,
+        "password": "mock-password",
+        "username": "mock-user",
+    }
+
+    updated_credentials = client_credentials | kwargs
+
+    text_format_credentials = [
+        f"{key}: {value}" for key, value in updated_credentials.items()
+    ]
+
+    return "\n".join(text_format_credentials)
+
+#set username and password must be successful
+def test_set_proxygen_user_credential(patch_config, credentials_file):
+    mock_credentials = get_test_proxygen_client_credentials()
+
+    with patch_config(credentials=mock_credentials):
+        runner = CliRunner()
+        runner.invoke(cmd_credentials.set, ["username", "new-username"] )
+
+    expected_credentials = "\n".join(
+        [
+            "base_url: https://mock-keycloak-url.nhs.uk",
+            "client_id: "+CLIENT_ID,
+            "client_secret: "+CLIENT_SECRET,
+            "password: mock-password",
+            "username: new-username",
+        ]
+    )
+
+    # Check the file has been written to
+    assert credentials_file() == expected_credentials
+
+
+#overwrite username and password must be successful, with client id and secret values unmodified
+def test_update_proxygen_user_credentials(patch_config, credentials_file):
+    mock_credentials = get_test_proxygen_client_credentials()
+
+    # Convert mock_credentials to a dictionary
+    mock_credentials_dict = yaml.safe_load(mock_credentials)
+
+    # Set an initial value for the username and password field
+    initial_username = "old-username"
+    mock_credentials_dict["username"] = initial_username
+
+    initial_password = "old-password"
+    mock_credentials_dict["password"] = initial_password
+
+    with patch_config(credentials=mock_credentials):
+        runner = CliRunner()
+        runner.invoke(cmd_credentials.set, ["username", "new-username123"])
+        runner.invoke(cmd_credentials.set, ["password", "new-password123"])
+
+    expected_credentials = "\n".join(
+        [
+            "base_url: https://mock-keycloak-url.nhs.uk",
+            "client_id: "+CLIENT_ID,
+            "client_secret: "+CLIENT_SECRET,
+            "password: new-password123",
+            "username: new-username123",
+        ]
+    )
+
+    # Check the file has been written to
+    assert credentials_file() == expected_credentials
+
+#overwrite client id and secret must be successful
+def test_update_proxygen_client_credentials(patch_config, credentials_file):
+    mock_credentials = get_test_proxygen_client_credentials()
+
+    # Convert mock_credentials to a dictionary
+    mock_credentials_dict = yaml.safe_load(mock_credentials)
+    print("HELLO")
+    print(mock_credentials_dict)
+    # Set an initial value for the username and password field
+    initial_clientid = "old-clientid"
+    mock_credentials_dict["username"] = initial_clientid
+
+    initial_clientsecret = "old-clientsecret"
+    mock_credentials_dict["password"] = initial_clientsecret
+
+    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"])
+
+    expected_credentials = "\n".join(
+        [
+            "base_url: https://mock-keycloak-url.nhs.uk",
+            "client_id: new-clientid123",
+            "client_secret: new-clientsecret123",
+            "password: mock-password",
+            "username: mock-user",
+        ]
+    )
+
+    # Check the file has been written to
+    assert credentials_file() == expected_credentials
+
+
+#verify error for missing proxygen username and password
+def test_missing_proxygen_user_credentials(update_config):
+    mock_credentials = get_test_proxygen_client_credentials(username="",password="")
+    update_config(credentials=mock_credentials)
+
+    with pytest.raises(ValidationError):
+        Credentials()
 
 def test_missing_credentials(update_config):
     mock_credentials = get_test_credentials(username="")
@@ -206,4 +321,4 @@ def test_remove_invalid_setting(patch_config):
         runner = CliRunner()
         result = runner.invoke(cmd_credentials.rm, ["invalid"])
 
-        assert "'invalid' is not one of 'base_url'" in result.output.strip()
+        assert "'invalid' is not one of 'base_url'" in result.output.strip()

{proxygen_cli-2.1.10 → proxygen_cli-2.1.12}/pyproject.toml

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