fixed the cyclic import issue

Author: Nirupma-Verma

conjur_api/client.py

@@ -19,8 +19,8 @@
 from conjur_api.models import SslVerificationMode, CreateHostData, CreateTokenData, ListMembersOfData, \
     ListPermittedRolesData, ConjurConnectionInfo, Resource, CredentialsData
 from conjur_api.utils.decorators import allow_sync_invocation
-from conjur_api.wrappers.http_wrapper import set_header_value
-from conjur_api import __version__
+from conjur_api.wrappers.http_wrapper import set_telemetry_header_value
+from importlib.metadata import version, PackageNotFoundError
 
 LOGGING_FORMAT = '%(asctime)s %(levelname)s: %(message)s'
 LOGGING_FORMAT_WARNING = 'WARNING: %(message)s'
@@ -34,30 +34,30 @@ class Client:
 
     This class is used to construct a client for API interaction
     """
-    integration_name = 'SecretsManager Python SDK'
-    integration_version = __version__
+    integration_name = 'SecretsManagerPython SDK'
+    try:
+        integration_version = version("conjur_api")
+    except PackageNotFoundError:
+        integration_version = 'No Version Found'
     integration_type = 'cybr-secretsmanager'
     vendor_name = 'CyberArk'
     vendor_version = None
 
-    def set_source_name_header(self):
+    def set_telemetry_header(self):
         """
         Build http header
         """
-        final_string = ""
-        if Client.integration_name is not None:
-            final_string += "in=" + Client.integration_name
-            if Client.integration_type is not None:
-                final_string += "&it=" + Client.integration_type
-                if Client.integration_version is not None:
-                    final_string += "&iv=" + Client.integration_version
+        final_telemetry_header = ""
 
-        if Client.vendor_name is not None:
-            final_string += "&vn=" + Client.vendor_name
-            if Client.vendor_version is not None:
-                final_string += "&vv=" + Client.vendor_version
+        final_telemetry_header += "in=" + Client.integration_name
+        final_telemetry_header += "&it=" + Client.integration_type
+        final_telemetry_header += "&iv=" + Client.integration_version
 
-        set_header_value(final_string)
+        final_telemetry_header += "&vn=" + Client.vendor_name
+        if Client.vendor_version is not None:
+            final_telemetry_header += "&vv=" + Client.vendor_version
+
+        set_telemetry_header_value(final_telemetry_header)
 
     # The method signature is long but we want to explicitly control
     # what parameters are allowed
@@ -96,28 +96,73 @@ def __init__(
         self.debug = debug
         self._api = self._create_api(http_debug, authn_strategy)
 
-        self.set_source_name_header()
+        self.set_telemetry_header()
         logging.debug("Client initialized")
 
     def set_integration_name( self, value ):
+        """
+        Sets the integration name for the client and updates the telemetry header.
+
+        This function updates the integration name value for the client and triggers an update to the
+            telemetry header to reflect the change.
+
+        Args:
+            value (str): The integration name to be set for the client.
+        """
         Client.integration_name = value
-        self.set_source_name_header()
+        self.set_telemetry_header()
 
     def set_integration_type( self, value ):
+        """
+        Sets the integration type for the client and updates the telemetry header.
+
+        This function updates the integration type value for the client and triggers an update to the
+        telemetry header to reflect the change.
+
+        Args:
+            value (str): The integration type to be set for the client.
+        """
         Client.integration_type = value
-        self.set_source_name_header()
+        self.set_telemetry_header()
 
     def set_integration_version( self, value ):
+        """
+        Sets the integration version for the client and updates the telemetry header.
+
+        This function updates the integration version value for the client and triggers an update to the
+        telemetry header to reflect the change.
+
+        Args:
+            value (str): The integration version to be set for the client.
+        """
         Client.integration_version = value
-        self.set_source_name_header()
+        self.set_telemetry_header()
 
     def set_vendor_name( self, value ):
+        """
+        Sets the vendor name for the client and updates the telemetry header.
+
+        This function updates the vendor name value for the client and triggers an update to the
+        telemetry header to reflect the change.
+
+        Args:
+            value (str): The vendor name to be set for the client.
+        """
         Client.vendor_name = value
-        self.set_source_name_header()
+        self.set_telemetry_header()
 
     def set_vendor_version( self, value ):
+        """
+        Sets the vendor version for the client and updates the telemetry header.
+
+        This function updates the vendor version value for the client and triggers an update to the
+        telemetry header to reflect the change.
+
+        Args:
+            value (str): The vendor version to be set for the client.
+        """
         Client.vendor_version = value
-        self.set_source_name_header()
+        self.set_telemetry_header()
 
     @staticmethod
     def configure_logger(debug: bool):

conjur_api/wrappers/http_wrapper.py

@@ -32,19 +32,19 @@ class Header():
     """
     Set header value
     """
-    final = 'undefined'
+    final_telemetry = 'undefined'
 
-    def set_value( self, value ):
+    def set_telemetry_value( self, value ):
         """
         Set header value
         """
-        self.final = value
+        self.final_telemetry = value
 
-    def get_value( self ):
+    def get_telemetry_value( self ):
         """
         Get header value
         """
-        return self.final
+        return self.final_telemetry
 
 globalheader = Header()
 CONJUR_HEADER_NAME = "x-cybr-telemetry"
@@ -61,12 +61,16 @@ class HttpVerb(Enum):
     PATCH = 5
     HEAD = 6
 
-def set_header_value(value:str):  # pragma: no cover
+def set_telemetry_header_value(value:str):  # pragma: no cover
     """
-    Set header value
+    Set telemetry header value by encoding the provided string in base64 URL-safe format.
+
+    This function encodes the provided string `value` using URL-safe base64 encoding. The padding characters
+    (`=`) are removed from the encoded string before being set in the global header through the
+    `set_telemetry_value` method.
     """
     encoded = base64.urlsafe_b64encode(value.encode()).rstrip(b'=').decode()
-    globalheader.set_value( encoded )
+    globalheader.set_telemetry_value( encoded )
 
 # pylint: disable=too-many-locals,consider-using-f-string,too-many-arguments
 async def invoke_endpoint(http_verb: HttpVerb,
@@ -97,7 +101,7 @@ async def invoke_endpoint(http_verb: HttpVerb,
     if headers is None:
         headers = {}
 
-    headers[ CONJUR_HEADER_NAME ] = globalheader.get_value()
+    headers[ CONJUR_HEADER_NAME ] = globalheader.get_telemetry_value()
 
     urllib3.disable_warnings()
     orig_params = params or {}

tests/authentication_strategy/test_unit_authn_authentication_provider.py

@@ -26,4 +26,4 @@ async def test_missing_username(self):
 
         self.assertRegex(context.exception.message, "Missing parameters")
 
-    # TODO: Mock a conjur authn server and test that it is called with the correct parameters
+    # TODO: Mock a conjur authn server and test that it is called with the correct parameters