DEV-1936 Remove default name from WorkPackageConfig (#22)

Signed-off-by: vince <[email protected]>

Author: vincewhite

changelog.md

@@ -1,14 +1,15 @@
 # EAS Python client
 ## [0.16.0] - UNRELEASED
 ### Breaking Changes
-* None.
+* Updated `WorkPackageConfig` constructor to reorder the parameters and no longer provide a default value for `name`. A `name` must now be provided by the user.
 
 ### New Features
 * Support specifying a `seed` in `ModelConfig` to allow reproducible scenarios
 * Support for using access tokens for authentication that takes advantage of the new EAS personal access token authentication system.
 
 ### Enhancements
 * Update requests restrictions to support all version 2 minor versions.
+* Removed check that prevented passing a `client_secret` for "password" grant_type.
 
 ### Fixes
 * None.

src/zepben/eas/client/eas_client.py

@@ -65,7 +65,7 @@ def __init__(
                           for. (Optional)
         :param username: The username used for account authentication. (Optional)
         :param password: The password used for account authentication. (Optional)
-        :param access_token: The access token used for M2M authentication generate from Evolve App Server or Web Client. (Optional)
+        :param access_token: The access token used for authentication, generated by Evolve App Server. (Optional)
         :param client_secret: The Auth0 client secret used for M2M authentication. (Optional)
         :param token_fetcher: A ZepbenTokenFetcher used to fetch auth tokens for access to the Evolve App Server.
                               (Optional)
@@ -85,7 +85,7 @@ def __init__(
         self._verify_certificate = verify_certificate
         self._ca_filename = ca_filename
         self._access_token = access_token
-        if protocol != "https" and (token_fetcher or client_id or access_token or username or password or client_secret):
+        if protocol != "https" and (token_fetcher or client_id or access_token):
             raise ValueError(
                 "Incompatible arguments passed to connect to secured Evolve App Server. "
                 "Authentication tokens must be sent via https. "
@@ -94,24 +94,17 @@ def __init__(
         if access_token and (client_id or client_secret or username or password or token_fetcher):
             raise ValueError(
                 "Incompatible arguments passed to connect to secured Evolve App Server. "
-                "You cannot provide both an access_token and client_id, client_id + client_secret, username + password, or token_fetcher. "
-                "Please provide either access_token or client_id + client_secret, client_id + username + password, or token_fetcher."
+                "You cannot provide multiple types of authentication. "
+                "When using an access_token, do not provide client_id, client_secret, username, password, or token_fetcher."
             )
 
-        if token_fetcher and (client_id or client_secret or username or password, access_token):
+        if token_fetcher and (client_id or client_secret or username or password or access_token):
             raise ValueError(
                 "Incompatible arguments passed to connect to secured Evolve App Server. "
                 "You cannot provide both a token_fetcher and credentials, "
                 "please provide either client_id, client_id + client_secret, username + password, access_token or token_fetcher."
             )
 
-        if client_secret and (username or password):
-            raise ValueError(
-                "Incompatible arguments passed to connect to secured Evolve App Server. "
-                "You cannot provide both a client_secret and username/password, "
-                "please provide either client_id + client_secret or client_id + username + password."
-            )
-
         if client_id:
             self._token_fetcher = create_token_fetcher(
                 conf_address=f"{self._protocol}://{self._host}:{self._port}/api/config/auth",
@@ -177,9 +170,8 @@ def _get_request_headers(self, content_type: str = "application/json") -> dict:
         headers = {"content-type": content_type}
         if self._access_token:
             headers["authorization"] = f"Bearer {self._access_token}"
-        elif  self._token_fetcher:
+        elif self._token_fetcher:
             headers["authorization"] = self._token_fetcher.fetch_token()
-
         return headers
 
     def run_hosting_capacity_work_package(self, work_package: WorkPackageConfig):

src/zepben/eas/client/work_package.py

@@ -225,6 +225,7 @@ class ResultProcessorConfig:
 @dataclass
 class WorkPackageConfig:
     """ A data class representing the configuration for a hosting capacity work package """
+    name: str
     feeders: List[str]
     years: List[int]
     scenarios: List[str]
@@ -233,7 +234,6 @@ class WorkPackageConfig:
     generator_config: Optional[GeneratorConfig] = None
     executor_config: Optional[object] = None
     result_processor_config: Optional[ResultProcessorConfig] = None
-    name: str = ""
 
 
 @dataclass

test/test_eas_client.py

@@ -4,7 +4,6 @@
 #  License, v. 2.0. If a copy of the MPL was not distributed with this
 #  file, You can obtain one at https://mozilla.org/MPL/2.0/.
 import random
-import re
 import ssl
 import string
 from datetime import datetime
@@ -87,6 +86,20 @@ def test_get_request_headers_adds_access_token_in_auth_header():
     assert headers["authorization"] == f"Bearer {mock_access_token}"
 
 
+@mock.patch("zepben.auth.client.zepben_token_fetcher.ZepbenTokenFetcher.fetch_token", return_value="test_token3")
+def test_get_request_headers_adds_token_from_token_fetcher_in_auth_header(_):
+    eas_client = EasClient(
+        mock_host,
+        mock_port,
+        token_fetcher=ZepbenTokenFetcher(audience="fake", token_endpoint="unused")
+    )
+
+    assert eas_client is not None
+    assert eas_client._token_fetcher is not None
+    headers = eas_client._get_request_headers()
+    assert headers["authorization"] == "test_token3"
+
+
 @mock.patch("zepben.auth.client.zepben_token_fetcher.requests.get", side_effect=lambda *args, **kwargs: MockResponse(
     {"authType": "AUTH0", "audience": mock_audience, "issuer": "test_issuer"}, 200))
 def test_create_eas_client_with_password_success(_):
@@ -162,6 +175,7 @@ def test_run_hosting_capacity_work_package_no_verify_success(httpserver: HTTPSer
     httpserver.expect_oneshot_request("/api/graphql").respond_with_json({"data": {"runWorkPackage": "workPackageId"}})
     res = eas_client.run_hosting_capacity_work_package(
         WorkPackageConfig(
+            "wp_name",
             ["feeder"],
             [1],
             ["scenario"],
@@ -188,6 +202,7 @@ def test_run_hosting_capacity_work_package_invalid_certificate_failure(ca: trust
         with pytest.raises(ssl.SSLError):
             eas_client.run_hosting_capacity_work_package(
                 WorkPackageConfig(
+                    "wp_name",
                     ["feeder"],
                     [1],
                     ["scenario"],
@@ -211,6 +226,7 @@ def test_run_hosting_capacity_work_package_valid_certificate_success(ca: trustme
             {"data": {"runWorkPackage": "workPackageId"}})
         res = eas_client.run_hosting_capacity_work_package(
             WorkPackageConfig(
+                "wp_name",
                 ["feeder"],
                 [1],
                 ["scenario"],
@@ -392,27 +408,27 @@ def test_raises_error_if_token_fetcher_and_creds_configured(httpserver: HTTPServ
         )
 
 
-def test_raises_error_if_secret_and_creds_configured(httpserver: HTTPServer):
-    with pytest.raises(ValueError, match="You cannot provide both a client_secret and username/password"):
-        EasClient(
-            LOCALHOST,
-            httpserver.port,
-            protocol="https",
-            client_id=mock_client_id,
-            client_secret=mock_client_secret,
-            username=mock_username,
-        )
-
-    with pytest.raises(ValueError,
-                       match="You cannot provide both a client_secret and username/password"):
-        EasClient(
-            LOCALHOST,
-            httpserver.port,
-            protocol="https",
-            client_id=mock_client_id,
-            client_secret=mock_client_secret,
-            password=mock_password,
-        )
+@mock.patch("zepben.auth.client.zepben_token_fetcher.requests.get", side_effect=lambda *args, **kwargs: MockResponse(
+    {"authType": "AUTH0", "audience": mock_audience, "issuer": "test_issuer"}, 200))
+def test_allows_secret_and_creds_configured(httpserver: HTTPServer):
+    eas_client = EasClient(
+        mock_host,
+        mock_port,
+        protocol="https",
+        client_id=mock_client_id,
+        client_secret=mock_client_secret,
+        username=mock_username,
+        password=mock_password
+    )
+    assert eas_client is not None
+    assert eas_client._token_fetcher is not None
+    assert eas_client._token_fetcher.token_request_data["grant_type"] == "password"
+    assert eas_client._token_fetcher.token_request_data["client_id"] == mock_client_id
+    assert eas_client._token_fetcher.token_request_data["username"] == mock_username
+    assert eas_client._token_fetcher.token_request_data["password"] == mock_password
+    assert eas_client._token_fetcher.token_request_data["client_secret"] == mock_client_secret
+    assert eas_client._host == mock_host
+    assert eas_client._port == mock_port
 
 
 def test_raises_error_if_access_token_and_creds_configured(httpserver: HTTPServer):
@@ -424,7 +440,8 @@ def test_raises_error_if_access_token_and_creds_configured(httpserver: HTTPServe
             access_token=mock_access_token,
             username=mock_username,
         )
-    assert "You cannot provide both an access_token and client_id, client_id + client_secret, username + password, or token_fetcher." in str(error_message_for_username.value)
+    assert "Incompatible arguments passed to connect to secured Evolve App Server. You cannot provide multiple types of authentication. When using an access_token, do not provide client_id, client_secret, username, password, or token_fetcher." in str(
+        error_message_for_username.value)
 
     with pytest.raises(ValueError) as error_message_for_password:
         EasClient(
@@ -434,7 +451,8 @@ def test_raises_error_if_access_token_and_creds_configured(httpserver: HTTPServe
             access_token=mock_access_token,
             password=mock_password,
         )
-    assert "You cannot provide both an access_token and client_id, client_id + client_secret, username + password, or token_fetcher." in str(error_message_for_password.value)
+    assert "Incompatible arguments passed to connect to secured Evolve App Server. You cannot provide multiple types of authentication. When using an access_token, do not provide client_id, client_secret, username, password, or token_fetcher." in str(
+        error_message_for_password.value)
 
 
 def test_raises_error_if_access_token_and_token_fetcher_configured(httpserver: HTTPServer):
@@ -446,7 +464,8 @@ def test_raises_error_if_access_token_and_token_fetcher_configured(httpserver: H
             access_token=mock_access_token,
             token_fetcher=ZepbenTokenFetcher(audience="test", auth_method="test", token_endpoint="test")
         )
-    assert "You cannot provide both an access_token and client_id, client_id + client_secret, username + password, or token_fetcher." in str(error_message_for_username.value)
+    assert "Incompatible arguments passed to connect to secured Evolve App Server. You cannot provide multiple types of authentication. When using an access_token, do not provide client_id, client_secret, username, password, or token_fetcher." in str(
+        error_message_for_username.value)
 
 
 def test_raises_error_if_access_token_and_client_id_configured(httpserver: HTTPServer):
@@ -458,7 +477,8 @@ def test_raises_error_if_access_token_and_client_id_configured(httpserver: HTTPS
             access_token=mock_access_token,
             client_id=mock_client_id
         )
-    assert "You cannot provide both an access_token and client_id, client_id + client_secret, username + password, or token_fetcher." in str(error_message_for_username.value)
+    assert "Incompatible arguments passed to connect to secured Evolve App Server. You cannot provide multiple types of authentication. When using an access_token, do not provide client_id, client_secret, username, password, or token_fetcher." in str(
+        error_message_for_username.value)
 
 
 def test_raises_error_if_access_token_and_client_secret_configured(httpserver: HTTPServer):
@@ -470,4 +490,5 @@ def test_raises_error_if_access_token_and_client_secret_configured(httpserver: H
             access_token=mock_access_token,
             client_secret=mock_client_secret
         )
-    assert "You cannot provide both an access_token and client_id, client_id + client_secret, username + password, or token_fetcher." in str(error_message_for_username.value)
+    assert "Incompatible arguments passed to connect to secured Evolve App Server. You cannot provide multiple types of authentication. When using an access_token, do not provide client_id, client_secret, username, password, or token_fetcher." in str(
+        error_message_for_username.value)