chore: Rename identify_required_authn_params to better reflect its updated functionality

Author: anubhav756

packages/toolbox-core/src/toolbox_core/client.py

@@ -18,7 +18,7 @@
 
 from .protocol import ManifestSchema, ToolSchema
 from .tool import ToolboxTool
-from .utils import identify_required_authn_params, resolve_value
+from .utils import identify_auth_requirements, resolve_value
 
 
 class ToolboxClient:
@@ -79,7 +79,7 @@ def __parse_tool(
             else:  # regular parameter
                 params.append(p)
 
-        authn_params, authz_tokens, used_auth_keys = identify_required_authn_params(
+        authn_params, authz_tokens, used_auth_keys = identify_auth_requirements(
             authn_params,
             schema.authRequired,
             auth_token_getters.keys(),

packages/toolbox-core/src/toolbox_core/tool.py

@@ -22,7 +22,7 @@
 from .protocol import ParameterSchema
 from .utils import (
     create_func_docstring,
-    identify_required_authn_params,
+    identify_auth_requirements,
     params_to_pydantic_model,
     resolve_value,
 )
@@ -309,9 +309,9 @@ def add_auth_token_getters(
 
         new_getters = dict(self.__auth_service_token_getters, **auth_token_getters)
 
-        # find the updated required authn params and the auth token getters used
+        # find the updated requirements
         new_req_authn_params, new_req_authz_tokens, used_auth_token_getters = (
-            identify_required_authn_params(
+            identify_auth_requirements(
                 self.__required_authn_params,
                 self.__required_authz_tokens,
                 auth_token_getters.keys(),

packages/toolbox-core/src/toolbox_core/utils.py

@@ -44,7 +44,7 @@ def create_func_docstring(description: str, params: Sequence[ParameterSchema]) -
     return docstring
 
 
-def identify_required_authn_params(
+def identify_auth_requirements(
     req_authn_params: Mapping[str, list[str]],
     req_authz_tokens: Sequence[str],
     auth_service_names: Iterable[str],

packages/toolbox-core/tests/test_utils.py

@@ -23,7 +23,7 @@
 from toolbox_core.protocol import ParameterSchema
 from toolbox_core.utils import (
     create_func_docstring,
-    identify_required_authn_params,
+    identify_auth_requirements,
     params_to_pydantic_model,
     resolve_value,
 )
@@ -82,15 +82,15 @@ def test_create_func_docstring_empty_description():
     assert create_func_docstring(description, params) == expected_docstring
 
 
-def test_identify_required_authn_params_none_required():
+def test_identify_auth_requirements_none_required():
     """Test when no authentication parameters or authorization tokens are required initially."""
     req_authn_params: dict[str, list[str]] = {}
     req_authz_tokens: list[str] = []
     auth_service_names = ["service_a", "service_b"]
     expected_params = {}
     expected_authz: list[str] = []
     expected_used = set()
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == (
@@ -100,7 +100,7 @@ def test_identify_required_authn_params_none_required():
     )
 
 
-def test_identify_required_authn_params_all_covered():
+def test_identify_auth_requirements_all_covered():
     """Test when all required authn parameters are covered, no authz tokens."""
     req_authn_params = {
         "token_a": ["service_a"],
@@ -111,7 +111,7 @@ def test_identify_required_authn_params_all_covered():
     expected_params = {}
     expected_authz: list[str] = []
     expected_used = {"service_a", "service_b"}
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == (
@@ -121,7 +121,7 @@ def test_identify_required_authn_params_all_covered():
     )
 
 
-def test_identify_required_authn_params_some_covered():
+def test_identify_auth_requirements_some_covered():
     """Test when some authn parameters are covered, and some are not, no authz tokens."""
     req_authn_params = {
         "token_a": ["service_a"],
@@ -138,7 +138,7 @@ def test_identify_required_authn_params_some_covered():
     expected_authz: list[str] = []
     expected_used = {"service_a", "service_b"}
 
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == (
@@ -148,7 +148,7 @@ def test_identify_required_authn_params_some_covered():
     )
 
 
-def test_identify_required_authn_params_none_covered():
+def test_identify_auth_requirements_none_covered():
     """Test when none of the required authn parameters are covered, no authz tokens."""
     req_authn_params = {
         "token_d": ["service_d"],
@@ -162,7 +162,7 @@ def test_identify_required_authn_params_none_covered():
     }
     expected_authz: list[str] = []
     expected_used = set()
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == (
@@ -172,7 +172,7 @@ def test_identify_required_authn_params_none_covered():
     )
 
 
-def test_identify_required_authn_params_no_available_services():
+def test_identify_auth_requirements_no_available_services():
     """Test when no authn services are available, no authz tokens."""
     req_authn_params = {
         "token_a": ["service_a"],
@@ -186,7 +186,7 @@ def test_identify_required_authn_params_no_available_services():
     }
     expected_authz: list[str] = []
     expected_used = set()
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == (
@@ -196,7 +196,7 @@ def test_identify_required_authn_params_no_available_services():
     )
 
 
-def test_identify_required_authn_params_empty_services_for_param():
+def test_identify_auth_requirements_empty_services_for_param():
     """Test edge case: authn param requires an empty list of services, no authz tokens."""
     req_authn_params = {
         "token_x": [],
@@ -208,7 +208,7 @@ def test_identify_required_authn_params_empty_services_for_param():
     }
     expected_authz: list[str] = []
     expected_used = set()
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == (
@@ -223,7 +223,7 @@ def test_identify_auth_params_only_authz_empty():
     req_authn_params: dict[str, list[str]] = {}
     req_authz_tokens: list[str] = []
     auth_service_names = ["s1"]
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == ({}, [], set())
@@ -234,7 +234,7 @@ def test_identify_auth_params_authz_all_covered():
     req_authn_params: dict[str, list[str]] = {}
     req_authz_tokens = ["s1", "s2"]
     auth_service_names = ["s1", "s2", "s3"]
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == ({}, [], {"s1", "s2"})
@@ -245,7 +245,7 @@ def test_identify_auth_params_authz_partially_covered_by_available():
     req_authn_params: dict[str, list[str]] = {}
     req_authz_tokens = ["s1", "s2"]
     auth_service_names = ["s1", "s3"]
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == ({}, [], {"s1"})
@@ -256,7 +256,7 @@ def test_identify_auth_params_authz_none_covered():
     req_authn_params: dict[str, list[str]] = {}
     req_authz_tokens = ["s1", "s2"]
     auth_service_names = ["s3", "s4"]
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == ({}, ["s1", "s2"], set())
@@ -267,7 +267,7 @@ def test_identify_auth_params_authz_none_covered_empty_available():
     req_authn_params: dict[str, list[str]] = {}
     req_authz_tokens = ["s1", "s2"]
     auth_service_names: list[str] = []
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == ({}, ["s1", "s2"], set())
@@ -281,7 +281,7 @@ def test_identify_auth_params_authn_covered_authz_uncovered():
     expected_params = {}
     expected_authz: list[str] = ["s_authz_needed1", "s_authz_needed2"]
     expected_used = {"s_authn1"}
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == (expected_params, expected_authz, expected_used)
@@ -296,7 +296,7 @@ def test_identify_auth_params_authn_uncovered_authz_covered():
     expected_authz: list[str] = []
     expected_used = {"s_authz1"}
 
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == (expected_params, expected_authz, expected_used)
@@ -310,7 +310,7 @@ def test_identify_auth_params_authn_and_authz_covered_no_overlap():
     expected_params = {}
     expected_authz: list[str] = []
     expected_used = {"s_authn1", "s_authz1"}
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == (expected_params, expected_authz, expected_used)
@@ -328,7 +328,7 @@ def test_identify_auth_params_authn_and_authz_covered_with_overlap():
     expected_params = {}
     expected_authz: list[str] = []
     expected_used = {"s_common", "s_authz_specific_avail", "s_authn_specific_avail"}
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == (expected_params, expected_authz, expected_used)
@@ -346,7 +346,7 @@ def test_identify_auth_params_authn_and_authz_covered_with_overlap_same_param():
     expected_params = {}
     expected_authz: list[str] = []
     expected_used = {"s_common", "s_authz_specific_avail", "s_authn_specific_avail"}
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == (expected_params, expected_authz, expected_used)
@@ -360,7 +360,7 @@ def test_identify_auth_params_complex_scenario():
     expected_params = {"p2": ["s3"]}
     expected_authz: list[str] = []
     expected_used = {"s1", "s4"}
-    result = identify_required_authn_params(
+    result = identify_auth_requirements(
         req_authn_params, req_authz_tokens, auth_service_names
     )
     assert result == (