Add argument validation to new server_client methods

Author: sam-muncke

src/auth0_server_python/auth_server/server_client.py

@@ -34,6 +34,7 @@
     AccessTokenForConnectionErrorCode,
     ApiError,
     BackchannelLogoutError,
+    InvalidArgumentError,
     MissingRequiredArgumentError,
     MissingTransactionError,
     PollingApiError,
@@ -1497,6 +1498,9 @@ async def list_connected_accounts(
             Auth0Error: If there is an error retrieving the access token.
             MyAccountApiError: If the My Account API returns an error response.
         """
+        if take is not None and (not isinstance(take, int) or take < 1):
+            raise InvalidArgumentError("take", "The 'take' parameter must be a positive integer.")
+        
         access_token = await self.get_access_token(
             audience=self._my_account_client.audience,
             scope="read:me:connected_accounts",
@@ -1521,6 +1525,9 @@ async def delete_connected_account(
             Auth0Error: If there is an error retrieving the access token.
             MyAccountApiError: If the My Account API returns an error response.
         """
+        if not connected_account_id:
+            raise MissingRequiredArgumentError("connected_account_id")
+        
         access_token = await self.get_access_token(
             audience=self._my_account_client.audience,
             scope="delete:me:connected_accounts",
@@ -1550,6 +1557,9 @@ async def list_connected_account_connections(
             Auth0Error: If there is an error retrieving the access token.
             MyAccountApiError: If the My Account API returns an error response.
         """
+        if take is not None and (not isinstance(take, int) or take < 1):
+            raise InvalidArgumentError("take", "The 'take' parameter must be a positive integer.")
+        
         access_token = await self.get_access_token(
             audience=self._my_account_client.audience,
             scope="read:me:connected_accounts",

src/auth0_server_python/error/__init__.py

@@ -101,6 +101,19 @@ def __init__(self, argument: str):
         self.argument = argument
 
 
+class InvalidArgumentError(Auth0Error):
+    """
+    Error raised when a given argument is an invalid value.
+    """
+    code = "invalid_argument"
+
+    def __init__(self, argument: str, message: str):
+        message = message
+        super().__init__(message)
+        self.name = "InvalidArgumentError"
+        self.argument = argument
+
+
 class BackchannelLogoutError(Auth0Error):
     """
     Error raised during backchannel logout processing.

src/auth0_server_python/tests/test_server_client.py

@@ -23,6 +23,7 @@
     AccessTokenForConnectionError,
     ApiError,
     BackchannelLogoutError,
+    InvalidArgumentError,
     MissingRequiredArgumentError,
     MissingTransactionError,
     PollingApiError,
@@ -1937,6 +1938,31 @@ async def test_complete_connect_account_no_transactions(mocker):
     assert "transaction" in str(exc.value)
     mock_my_account_client.complete_connect_account.assert_not_awaited()
 
+@pytest.mark.asyncio
+@pytest.mark.parametrize("take", ["not_an_integer", 21.3, -5, 0])
+async def test_list_connected_accounts__with_invalid_take_param(mocker, take):
+    # Setup
+    client = ServerClient(
+        domain="auth0.local",
+        client_id="<client_id>",
+        client_secret="<client_secret>",
+        secret="some-secret"
+    )
+    mock_my_account_client = AsyncMock(MyAccountClient)
+    mocker.patch.object(client, "_my_account_client", mock_my_account_client)
+
+    # Act
+    with pytest.raises(InvalidArgumentError) as exc:
+        await client.list_connected_accounts(
+            connection="<connection>",
+            from_param="<from_param>",
+            take=take
+        )
+
+    # Assert
+    assert "The 'take' parameter must be a positive integer." in str(exc.value)
+    mock_my_account_client.list_connected_accounts.assert_not_awaited()
+
 @pytest.mark.asyncio
 async def test_list_connected_accounts_gets_access_token_and_calls_my_account(mocker):
     # Setup
@@ -2022,6 +2048,26 @@ async def test_delete_connected_account_gets_access_token_and_calls_my_account(m
         connected_account_id="<id>"
     )
 
+@pytest.mark.asyncio
+async def test_delete_connected_account_with_empty_connected_account_id(mocker):
+    # Setup
+    client = ServerClient(
+        domain="auth0.local",
+        client_id="<client_id>",
+        client_secret="<client_secret>",
+        secret="some-secret"
+    )
+    mock_my_account_client = AsyncMock(MyAccountClient)
+    mocker.patch.object(client, "_my_account_client", mock_my_account_client)
+
+    # Act
+    with pytest.raises(MissingRequiredArgumentError) as exc:
+        await client.delete_connected_account(connected_account_id=None)
+
+    # Assert
+    assert "connected_account_id" in str(exc.value)
+    mock_my_account_client.delete_connected_account.assert_not_awaited()
+
 @pytest.mark.asyncio
 async def test_list_connected_account_connections_gets_access_token_and_calls_my_account(mocker):
     # Setup
@@ -2069,3 +2115,27 @@ async def test_list_connected_account_connections_gets_access_token_and_calls_my
         from_param="<from_param>",
         take=2
     )
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize("take", ["not_an_integer", 21.3, -5, 0])
+async def test_list_connected_account_connections_with_invalid_take_param(mocker, take):
+    # Setup
+    client = ServerClient(
+        domain="auth0.local",
+        client_id="<client_id>",
+        client_secret="<client_secret>",
+        secret="some-secret"
+    )
+    mock_my_account_client = AsyncMock(MyAccountClient)
+    mocker.patch.object(client, "_my_account_client", mock_my_account_client)
+
+    # Act
+    with pytest.raises(InvalidArgumentError) as exc:
+        await client.list_connected_account_connections(
+            from_param="<from_param>",
+            take=take
+        )
+
+    # Assert
+    assert "The 'take' parameter must be a positive integer." in str(exc.value)
+    mock_my_account_client.list_connected_account_connections.assert_not_awaited()