oc-cdtapi 3.28.1__py3-none-any.whl → 3.30.3__py3-none-any.whl

oc_cdtapi/PgQAPI.py

@@ -26,7 +26,7 @@ class PgQAPI (object):
         else:
             logging.debug('No connection provided, creating')
             self.conn = self.pg_connect(url, username, password)
-        self.message_types = ['dlartifacts', 'dlbuild', 'dlcontents', 'dlupload', 'ns']
+        self.message_types = ['dlartifacts', 'dlbuild', 'dlcontents', 'dlupload', 'ns', 'register_file']
 
     def create_queue(self, queue_code, queue_name):
         logging.debug('reached create_queue')
@@ -69,6 +69,21 @@ class PgQAPI (object):
         logging.debug(message)
         return message
 
+    def compose_register_file(self, parms):
+        logging.debug('reached compose_register_file')
+        logging.debug('received parms: [%s]' % parms)
+
+        location = parms.get("location")
+        citype = parms.get("citype")
+        depth = parms.get("depth")
+        if not location or citype is None or depth is None:
+            logging.error('location, citype, and depth must all be specified')
+            return None
+        message = ["register_file", [[*location], citype, depth], {}]
+        logging.debug('composed message')
+        logging.debug(message)
+        return message
+
     def enqueue_message(self, queue_code=None, msg_text=None, priority=50, pg_connection=None):
         logging.debug('reached enqueue_message')
         if pg_connection:

oc_cdtapi/VaultAPI.py

@@ -1,33 +1,32 @@
+import re
 import logging
 import os
+from typing import Any, List, Optional
 
 import hvac
+import requests
 from hvac.exceptions import VaultError
 
+SECRET_PATTERN = re.compile(r"^[A-Z][A-Z0-9_]*__[A-Z][A-Z0-9_]*$")
+
+
 class VaultAPI:
     def __init__(self,
-                 vault_enable=False,
                  vault_url=None,
                  vault_token=None,
                  vault_mount_point=None,
                  verify_ssl=True):
-        self.vault_enable = vault_enable or os.getenv("VAULT_ENABLE")
         self.vault_url = vault_url or os.getenv("VAULT_URL")
         self.vault_token = vault_token or os.getenv("VAULT_TOKEN")
         self.mount_point = vault_mount_point or os.getenv("VAULT_MOUNT_POINT")
-        self.use_staging_secrets = os.getenv("USE_STAGING_ENVIRONMENT", "false").lower() == "true" #Check whether we have env USE_STAGING_ENVIRONMENT true or not
         self.verify_ssl = verify_ssl
         self._client = None
 
         # Create a logger instance for this class
         self.logger = logging.getLogger(__name__)
-        
-    @property
-    def client(self):
-        if not self.vault_enable:
-            self.logger.warning("VAULT_ENABLE environment set to false, skip using vault")
-            return None
 
+    @property
+    def client(self) -> Optional[hvac.Client]:
         if self._client is None:
             if not self.vault_url:
                 self.logger.warning("VAULT_URL environment variable or vault_url parameter is missing, skip using vault")
@@ -41,39 +40,50 @@ class VaultAPI:
                 token=self.vault_token,
                 verify=self.verify_ssl
             )
-
-            if not self._client.is_authenticated():
+            try:
+                is_authenticated = self._client.is_authenticated()
+            except requests.exceptions.ConnectionError as e:
+                self.logger.warning(f"Failed to authenticate with Vault - Vault is unreachable: {e}")
+                self._client = None
+                return None
+            if not is_authenticated:
                 self.logger.warning("Failed to authenticate with Vault - check credentials, skip using vault")
                 return None
-
         return self._client
 
-    def parse_secret_name(self, name):
-        if 'USER' in name:
-            split_name = name.split('_USER')[0]
-            return split_name, 'USER'
+    def _parse_secret_name(self, name: str) -> List[str]:
+        if not SECRET_PATTERN.match(name):
+            raise ValueError("Secret name must match <PATH>__<KEY>")
 
-        if 'PASSWORD' in name:
-            split_name = name.split('_PASSWORD')[0]
-            return split_name, 'PASSWORD'
+        return name.split("__", 1)
 
-        return 'OTHER', name
-
-    def get_secret_from_path(self, name):
+    def get_secret_from_path(self, name: str) -> Optional[Any]:
         client = self.client
         if client is None:
             return None
-
-        secret_path, credentials = self.parse_secret_name(name)
-        if self.use_staging_secrets:
-            secret_path = secret_path + "_TEST"
+        try:
+            secret_path, credentials = self._parse_secret_name(name=name)
+        except ValueError as e:
+            self.logger.warning(f"Failed parsing secret: {e}")
+            return None
 
         try:
             response = client.secrets.kv.read_secret_version(path=secret_path, mount_point=self.mount_point)
-            return response['data']['data'].get(credentials)
+            return response["data"]["data"].get(credentials)
         except VaultError as e:
             self.logger.warning(f"Failed getting data from vault for path {secret_path} and credentials {credentials}: {e}")
             return None
+        except requests.exceptions.ConnectionError as e:
+            self.logger.warning(f"Failed to retrieve secret from Vault - Vault is unreachable: {e}")
+            return None
+
+    def load_secret(self, name: str, default: Optional[Any] = None) -> Optional[Any]:
+        is_test = os.getenv("PYTHON_ENV") == "test"
+        if is_test:
+            name = f"{name}_TEST"
+
+        value = self.get_secret_from_path(name=name)
+        if value is not None:
+            return value
 
-    def load_secret(self, name, default=None):
-        return self.get_secret_from_path(name) or os.getenv(name, default)
+        return os.getenv(name, default=default)

{oc_cdtapi-3.28.1.dist-info → oc_cdtapi-3.30.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oc-cdtapi
-Version: 3.28.1
+Version: 3.30.3
 Summary: Custom Development python API libraries
 License: Apache2.0
 Requires-Python: >=3.6

{oc_cdtapi-3.28.1.dist-info → oc_cdtapi-3.30.3.dist-info}/RECORD

@@ -7,14 +7,14 @@ oc_cdtapi/ForemanAPI.py,sha256=0GsC9s9uGoYgMbsgBW5aDEGoGLGeRPJJSTAWhbelhVY,57135
 oc_cdtapi/JenkinsAPI.py,sha256=lZ8pe3a4eb_6h53JE7QLuzOSlu7Sqatc9PQwWhio9Vg,15748
 oc_cdtapi/NexusAPI.py,sha256=uU12GtHvKlWorFaPAnFcQ5AGEc94MZ5SdmfM2Pw3F7A,26122
 oc_cdtapi/PgAPI.py,sha256=URSz7qu-Ir7AOj0jI3ucTXn2PM-nC96nmPZI746OLjA,14356
-oc_cdtapi/PgQAPI.py,sha256=VwnI6Hm6d0guwuFVrJxr-SvDz0V1NIO6Qh195WgXsEk,8822
+oc_cdtapi/PgQAPI.py,sha256=MJzzm9XGkrMQ8mjoM4WeS1KYAgLeCL73yga8kB-HoUk,9436
 oc_cdtapi/RundeckAPI.py,sha256=O3LmcFaHSz8UqeUyIHTTEMJncDD191Utd-iZaeJay2s,24243
 oc_cdtapi/TestServer.py,sha256=HV97UWg2IK4gOYAp9yaMdwFUWsw9v66MxyZdI3qQctA,2715
-oc_cdtapi/VaultAPI.py,sha256=P-x_PsWe_S0mGUKTCmR1KhUjdfs7GmyaltjGQcnWj_s,2967
+oc_cdtapi/VaultAPI.py,sha256=Vp-tY28rVeVT4zwemH2lKDr7xI0kPXsfzBYFYLveG2o,3380
 oc_cdtapi/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-oc_cdtapi-3.28.1.data/scripts/nexus.py,sha256=4teqZ_KtCSrwHDJVgA7lkreteod4Xt5XJFZNbwb7E6E,6858
-oc_cdtapi-3.28.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-oc_cdtapi-3.28.1.dist-info/METADATA,sha256=0VzwXmwuzjqdH9LNfO08rOSM9yoc5aQn5PkbNPznHK8,504
-oc_cdtapi-3.28.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-oc_cdtapi-3.28.1.dist-info/top_level.txt,sha256=d4-5-D-0CSeSXYuLCP7-nIFCpjkfmJr-Y_muzds8iVU,10
-oc_cdtapi-3.28.1.dist-info/RECORD,,
+oc_cdtapi-3.30.3.data/scripts/nexus.py,sha256=4teqZ_KtCSrwHDJVgA7lkreteod4Xt5XJFZNbwb7E6E,6858
+oc_cdtapi-3.30.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+oc_cdtapi-3.30.3.dist-info/METADATA,sha256=mptP1lE_iMD-16miVFs4RtSvPsClWFdIiOgP07IBlvE,504
+oc_cdtapi-3.30.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+oc_cdtapi-3.30.3.dist-info/top_level.txt,sha256=d4-5-D-0CSeSXYuLCP7-nIFCpjkfmJr-Y_muzds8iVU,10
+oc_cdtapi-3.30.3.dist-info/RECORD,,