feat: add more type check for the disable_ssl_verificaton parameter with tests

Author: pyrooka

ibm_cloud_sdk_core/authenticators/container_authenticator.py

@@ -56,6 +56,7 @@ class ContainerAuthenticator(IAMRequestBasedAuthenticator):
                 from the endpoint specified by the url.
 
         Raises:
+            TypeError: The `disable_ssl_verification` is not a bool.
             ValueError: Neither of iam_profile_name or iam_profile_idk are set,
             or client_id, and/or client_secret are not valid for IAM token requests.
     """
@@ -72,10 +73,15 @@ def __init__(self,
                  scope: Optional[str] = None,
                  proxies: Optional[Dict[str, str]] = None,
                  headers: Optional[Dict[str, str]] = None) -> None:
+        # Check the type of `disable_ssl_verification`. Must be a bool.
+        if not isinstance(disable_ssl_verification, bool):
+            raise TypeError('disable_ssl_verification must be a bool')
+
         self.token_manager = ContainerTokenManager(
             cr_token_filename=cr_token_filename, iam_profile_name=iam_profile_name, iam_profile_id=iam_profile_id,
             url=url, client_id=client_id, client_secret=client_secret,
             disable_ssl_verification=disable_ssl_verification, scope=scope, proxies=proxies, headers=headers)
+
         self.validate()
 
     def validate(self) -> None:

ibm_cloud_sdk_core/authenticators/cp4d_authenticator.py

@@ -47,6 +47,7 @@ class CloudPakForDataAuthenticator(Authenticator):
         token_manager (CP4DTokenManager): Retrieves and manages CP4D tokens from the endpoint specified by the url.
 
     Raises:
+        TypeError: The `disable_ssl_verification` is not a bool.
         ValueError: The username, password/apikey, and/or url are not valid for CP4D token requests.
     """
     authenticationdict = 'cp4d'
@@ -60,9 +61,14 @@ def __init__(self,
                  disable_ssl_verification: bool = False,
                  headers: Optional[Dict[str, str]] = None,
                  proxies: Optional[Dict[str, str]] = None) -> None:
+        # Check the type of `disable_ssl_verification`. Must be a bool.
+        if not isinstance(disable_ssl_verification, bool):
+            raise TypeError('disable_ssl_verification must be a bool')
+
         self.token_manager = CP4DTokenManager(
             username=username, password=password, apikey=apikey, url=url,
             disable_ssl_verification=disable_ssl_verification, headers=headers, proxies=proxies)
+
         self.validate()
 
     def validate(self) -> None:
@@ -116,6 +122,9 @@ def set_disable_ssl_verification(self, status: bool = False) -> None:
 
         Args:
             status: Set to true in order to disable SSL certificate verification. Defaults to False.
+
+        Raises:
+            TypeError: The `status` is not a bool.
         """
         self.token_manager.set_disable_ssl_verification(status)
 

ibm_cloud_sdk_core/authenticators/iam_authenticator.py

@@ -51,6 +51,7 @@ class IAMAuthenticator(IAMRequestBasedAuthenticator):
         token_manager (IAMTokenManager): Retrieves and manages IAM tokens from the endpoint specified by the url.
 
     Raises:
+        TypeError: The `disable_ssl_verification` is not a bool.
         ValueError: The apikey, client_id, and/or client_secret are not valid for IAM token requests.
     """
     authentication_type = 'iam'
@@ -65,10 +66,15 @@ def __init__(self,
                  headers: Optional[Dict[str, str]] = None,
                  proxies: Optional[Dict[str, str]] = None,
                  scope: Optional[str] = None) -> None:
+        # Check the type of `disable_ssl_verification`. Must be a bool.
+        if not isinstance(disable_ssl_verification, bool):
+            raise TypeError('disable_ssl_verification must be a bool')
+
         self.token_manager = IAMTokenManager(
             apikey, url=url, client_id=client_id, client_secret=client_secret,
             disable_ssl_verification=disable_ssl_verification,
             headers=headers, proxies=proxies, scope=scope)
+
         self.validate()
 
     def validate(self) -> None:

ibm_cloud_sdk_core/authenticators/iam_request_based_authenticator.py

@@ -80,8 +80,11 @@ def set_disable_ssl_verification(self, status: bool = False) -> None:
         """Set the flag that indicates whether verification of the server's SSL certificate should be
         disabled or not. Defaults to False.
 
-        Keyword Arguments:
-            status: Headers to be sent with every IAM token request. Defaults to None.
+        Args:
+            status: Headers to be sent with every IAM token request. Defaults to None
+
+        Raises:
+            TypeError: The `status` is not a bool.
         """
         self.token_manager.set_disable_ssl_verification(status)
 

ibm_cloud_sdk_core/token_managers/token_manager.py

@@ -91,8 +91,14 @@ def set_disable_ssl_verification(self, status: bool = False) -> None:
 
         Args:
             status: the flag to be used for determining status.
+
+        Raises:
+            TypeError: The `status` is not a bool.
         """
-        self.disable_ssl_verification = status
+        if isinstance(status, bool):
+            self.disable_ssl_verification = status
+        else:
+            raise TypeError('status must be a bool')
 
     def paced_request_token(self) -> None:
         """

test/test_container_authenticator.py

@@ -51,6 +51,27 @@ def test_container_authenticator():
     assert authenticator.token_manager.proxies == {'dummy': 'proxies'}
 
 
+def test_disable_ssl_verification():
+    authenticator = ContainerAuthenticator(iam_profile_name='iam-user-123', disable_ssl_verification=True)
+    assert authenticator.token_manager.disable_ssl_verification is True
+
+    authenticator.set_disable_ssl_verification(False)
+    assert authenticator.token_manager.disable_ssl_verification is False
+
+
+def test_invalid_disable_ssl_verification_type():
+    with pytest.raises(TypeError) as err:
+        authenticator = ContainerAuthenticator(iam_profile_name='iam-user-123', disable_ssl_verification='True')
+    assert str(err.value) == 'disable_ssl_verification must be a bool'
+
+    authenticator = ContainerAuthenticator(iam_profile_name='iam-user-123')
+    assert authenticator.token_manager.disable_ssl_verification is False
+
+    with pytest.raises(TypeError) as err:
+        authenticator.set_disable_ssl_verification('True')
+    assert str(err.value) == 'status must be a bool'
+
+
 def test_container_authenticator_with_scope():
     authenticator = ContainerAuthenticator(iam_profile_name='iam-user-123', scope='scope1 scope2')
     assert authenticator is not None

test/test_cp4d_authenticator.py

@@ -38,6 +38,30 @@ def test_cp4d_authenticator():
     assert authenticator.token_manager.proxies == {'dummy': 'proxies'}
 
 
+def test_disable_ssl_verification():
+    authenticator = CloudPakForDataAuthenticator(
+            'my_username', 'my_password', 'http://my_url', disable_ssl_verification=True)
+    assert authenticator.token_manager.disable_ssl_verification is True
+
+    authenticator.set_disable_ssl_verification(False)
+    assert authenticator.token_manager.disable_ssl_verification is False
+
+
+def test_invalid_disable_ssl_verification_type():
+    with pytest.raises(TypeError) as err:
+        authenticator = CloudPakForDataAuthenticator(
+            'my_username', 'my_password', 'http://my_url', disable_ssl_verification='True')
+    assert str(err.value) == 'disable_ssl_verification must be a bool'
+
+    authenticator = CloudPakForDataAuthenticator(
+            'my_username', 'my_password', 'http://my_url')
+    assert authenticator.token_manager.disable_ssl_verification is False
+
+    with pytest.raises(TypeError) as err:
+        authenticator.set_disable_ssl_verification('True')
+    assert str(err.value) == 'status must be a bool'
+
+
 def test_cp4d_authenticator_validate_failed():
     with pytest.raises(ValueError) as err:
         CloudPakForDataAuthenticator('my_username', None, 'my_url')

test/test_iam_authenticator.py

@@ -45,6 +45,27 @@ def test_iam_authenticator():
     assert authenticator.token_manager.disable_ssl_verification
 
 
+def test_disable_ssl_verification():
+    authenticator = IAMAuthenticator(apikey='my_apikey', disable_ssl_verification=True)
+    assert authenticator.token_manager.disable_ssl_verification is True
+
+    authenticator.set_disable_ssl_verification(False)
+    assert authenticator.token_manager.disable_ssl_verification is False
+
+
+def test_invalid_disable_ssl_verification_type():
+    with pytest.raises(TypeError) as err:
+        authenticator = IAMAuthenticator(apikey='my_apikey', disable_ssl_verification='True')
+    assert str(err.value) == 'disable_ssl_verification must be a bool'
+
+    authenticator = IAMAuthenticator(apikey='my_apikey')
+    assert authenticator.token_manager.disable_ssl_verification is False
+
+    with pytest.raises(TypeError) as err:
+        authenticator.set_disable_ssl_verification('True')
+    assert str(err.value) == 'status must be a bool'
+
+
 def test_iam_authenticator_with_scope():
     authenticator = IAMAuthenticator(apikey='my_apikey', scope='scope1 scope2')
     assert authenticator is not None

test/test_token_manager.py

@@ -65,3 +65,20 @@ def test_request_raises_for_non_2xx(request):  # pylint: disable=unused-argument
     mock_token_manager = MockTokenManager(url="https://example.com", disable_ssl_verification=True)
     with pytest.raises(ApiException):
         mock_token_manager.request_token()
+
+
+def test_set_disable_ssl_verification_success():
+    token_manager = MockTokenManager(None)
+    assert token_manager.disable_ssl_verification is False
+
+    token_manager.set_disable_ssl_verification(True)
+    assert token_manager.disable_ssl_verification is True
+
+
+def test_set_disable_ssl_verification_fail():
+    token_manager = MockTokenManager(None)
+
+    with pytest.raises(TypeError) as err:
+        token_manager.set_disable_ssl_verification('True')
+    assert str(err.value) == 'status must be a bool'
+    assert token_manager.disable_ssl_verification is False