chore: disable all setter methods in the assume token manager and authenticator

Signed-off-by: Norbert Biczo <[email protected]>

Author: pyrooka

ibm_cloud_sdk_core/authenticators/iam_assume_authenticator.py

@@ -21,7 +21,6 @@
 
 from .authenticator import Authenticator
 from .iam_request_based_authenticator import IAMRequestBasedAuthenticator
-from ..utils import has_bad_first_or_last_char
 
 
 class IAMAssumeAuthenticator(IAMRequestBasedAuthenticator):
@@ -103,10 +102,9 @@ def __init__(
 
         self.validate()
 
-    # Disable a few methods, inherited from the parent class.
+    # Disable all setter methods, inherited from the parent class.
     def __getattribute__(self, name: str) -> Any:
-        disallowed_attrs = ['set_scope', 'set_client_id_and_secret']
-        if name in disallowed_attrs:
+        if name.startswith("set_"):
             raise AttributeError(f"'{self.__class__.__name__}' has no attribute '{name}'")
 
         return super().__getattribute__(name)
@@ -146,34 +144,3 @@ def validate(self) -> None:
         # `iam_account_id` must be specified iff `iam_profile_name` is used.
         if self.token_manager.iam_profile_name and not self.token_manager.iam_account_id:
             raise ValueError('`iam_profile_name` and `iam_account_id` must be provided together, or not at all.')
-
-    def set_disable_ssl_verification(self, status: bool = False) -> None:
-        self.token_manager.iam_delegate.set_disable_ssl_verification(status)
-        return super().set_disable_ssl_verification(status)
-
-    def set_iam_profile_id(self, iam_profile_id: str) -> None:
-        """Set the ID of the IAM profile.
-
-        Args:
-            iam_profile_id (str): the ID of the IAM profile.
-        """
-        self.token_manager.iam_profile_id = iam_profile_id
-
-    def set_iam_profile_crn(self, iam_profile_crn: str) -> None:
-        """Set the CRN of the IAM profile.
-
-        Args:
-            iam_profile_crn (str): the CRN of the IAM profile.
-        """
-        self.token_manager.iam_profile_crn = iam_profile_crn
-
-    def set_iam_profile_name_and_account_id(self, iam_profile_name: str, iam_account_id: str) -> None:
-        """Set both the name of the IAM profile and the IAM account ID that the profile belongs to.
-
-        Args:
-            iam_profile_name (str): name of the IAM profile.
-            iam_account_id (str): ID of the IAM account.
-        """
-        self.token_manager.iam_profile_name = iam_profile_name
-        self.token_manager.iam_account_id = iam_account_id
-        self.validate()

ibm_cloud_sdk_core/token_managers/iam_assume_token_manager.py

@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Dict, Optional
+from typing import Any, Dict, Optional
 
 from ibm_cloud_sdk_core.token_managers.iam_token_manager import IAMTokenManager
 
@@ -112,6 +112,13 @@ def __init__(
         self.request_payload['grant_type'] = 'urn:ibm:params:oauth:grant-type:assume'
         self._set_user_agent(_build_user_agent('iam-assume-authenticator'))
 
+    # Disable all setter methods, inherited from the parent class.
+    def __getattribute__(self, name: str) -> Any:
+        if name.startswith("set_"):
+            raise AttributeError(f"'{self.__class__.__name__}' has no attribute '{name}'")
+
+        return super().__getattribute__(name)
+
     def request_token(self) -> Dict:
         """Retrieves a standard IAM access token by using the IAM token manager
         then obtains another access token for the assumed identity.

test/test_iam_assume_authenticator.py

@@ -30,63 +30,6 @@ def test_iam_assume_authenticator():
     assert authenticator.token_manager.iam_account_id is None
     assert authenticator.token_manager.scope is None
 
-    authenticator.set_iam_profile_id('my-id-123')
-    assert authenticator.token_manager.iam_profile_id == 'my-id-123'
-
-    authenticator.set_iam_profile_crn('crn:iam-profile:456')
-    assert authenticator.token_manager.iam_profile_crn == 'crn:iam-profile:456'
-
-    # We need to unset the other IAM related attributes to avoid validation error.
-    authenticator.set_iam_profile_id(None)
-    authenticator.set_iam_profile_crn(None)
-    authenticator.set_iam_profile_name_and_account_id('my-profile-name', 'my-acc-id')
-    assert authenticator.token_manager.iam_profile_name == 'my-profile-name'
-    assert authenticator.token_manager.iam_account_id == 'my-acc-id'
-
-    with pytest.raises(TypeError) as err:
-        authenticator.set_headers('dummy')
-    assert str(err.value) == 'headers must be a dictionary'
-
-    authenticator.set_headers({'dummy': 'headers'})
-    assert authenticator.token_manager.headers == {'dummy': 'headers'}
-
-    with pytest.raises(TypeError) as err:
-        authenticator.set_proxies('dummy')
-    assert str(err.value) == 'proxies must be a dictionary'
-
-    authenticator.set_proxies({'dummy': 'proxies'})
-    assert authenticator.token_manager.proxies == {'dummy': 'proxies'}
-
-    authenticator.set_disable_ssl_verification(True)
-    assert authenticator.token_manager.disable_ssl_verification
-
-
-def test_disable_ssl_verification():
-    authenticator = IAMAssumeAuthenticator(
-        apikey='my_apikey', iam_profile_id='my-profile-id', disable_ssl_verification=True
-    )
-    assert authenticator.token_manager.disable_ssl_verification is True
-    assert authenticator.token_manager.iam_delegate.disable_ssl_verification is True
-
-    authenticator.set_disable_ssl_verification(False)
-    assert authenticator.token_manager.disable_ssl_verification is False
-    assert authenticator.token_manager.iam_delegate.disable_ssl_verification is False
-
-
-def test_invalid_disable_ssl_verification_type():
-    with pytest.raises(TypeError) as err:
-        authenticator = IAMAssumeAuthenticator(
-            apikey='my_apikey', iam_profile_id='my-profile-id', disable_ssl_verification='True'
-        )
-    assert str(err.value) == 'disable_ssl_verification must be a bool'
-
-    authenticator = IAMAssumeAuthenticator(apikey='my_apikey', iam_profile_id='my-profile-id')
-    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_assume_authenticator_validate_failed():
     with pytest.raises(ValueError) as err:
@@ -217,9 +160,23 @@ def test_multiple_iam_assume_authenticators():
 
 def test_iam_assume_authenticator_unsupported_methods():
     authenticator = IAMAssumeAuthenticator('my_apikey', iam_profile_id='my_profile_id')
+
     with pytest.raises(AttributeError) as err:
         authenticator.set_scope('my_scope')
     assert str(err.value) == "'IAMAssumeAuthenticator' has no attribute 'set_scope'"
+
     with pytest.raises(AttributeError) as err:
         authenticator.set_client_id_and_secret('my_client_id', 'my_client_secret')
     assert str(err.value) == "'IAMAssumeAuthenticator' has no attribute 'set_client_id_and_secret'"
+
+    with pytest.raises(AttributeError) as err:
+        authenticator.set_headers({})
+    assert str(err.value) == "'IAMAssumeAuthenticator' has no attribute 'set_headers'"
+
+    with pytest.raises(AttributeError) as err:
+        authenticator.set_proxies({})
+    assert str(err.value) == "'IAMAssumeAuthenticator' has no attribute 'set_proxies'"
+
+    with pytest.raises(AttributeError) as err:
+        authenticator.set_disable_ssl_verification(True)
+    assert str(err.value) == "'IAMAssumeAuthenticator' has no attribute 'set_disable_ssl_verification'"

test/test_iam_assume_token_manager.py

@@ -21,6 +21,7 @@
 import urllib
 
 import jwt
+import pytest
 import responses
 
 from ibm_cloud_sdk_core import IAMAssumeTokenManager
@@ -213,3 +214,28 @@ def test_correct_properties_used_in_calls():
     # but those were not included in the second, assume type request.
     assert responses.calls[1].request.headers.get('Authorization') is None
     assert 'scope=my_scope' not in responses.calls[1].request.body
+
+
+@responses.activate
+def test_iam_assume_authenticator_unsupported_methods():
+    token_manager = IAMAssumeTokenManager('my_apikey', iam_profile_id='my_profile_id')
+
+    with pytest.raises(AttributeError) as err:
+        token_manager.set_scope('my_scope')
+    assert str(err.value) == "'IAMAssumeTokenManager' has no attribute 'set_scope'"
+
+    with pytest.raises(AttributeError) as err:
+        token_manager.set_client_id_and_secret('my_client_id', 'my_client_secret')
+    assert str(err.value) == "'IAMAssumeTokenManager' has no attribute 'set_client_id_and_secret'"
+
+    with pytest.raises(AttributeError) as err:
+        token_manager.set_headers({})
+    assert str(err.value) == "'IAMAssumeTokenManager' has no attribute 'set_headers'"
+
+    with pytest.raises(AttributeError) as err:
+        token_manager.set_proxies({})
+    assert str(err.value) == "'IAMAssumeTokenManager' has no attribute 'set_proxies'"
+
+    with pytest.raises(AttributeError) as err:
+        token_manager.set_disable_ssl_verification(True)
+    assert str(err.value) == "'IAMAssumeTokenManager' has no attribute 'set_disable_ssl_verification'"