atk-common 3.18.0__py3-none-any.whl → 3.20.0__py3-none-any.whl

atk_common/classes/env_handler.py

@@ -1,13 +1,17 @@
 import os
+from pathlib import Path
 from typing import Optional
 from atk_common.interfaces import IEnvHandler
 from atk_common.interfaces import ILogger
 
-class EnvHandler(IEnvHandler):
-    def __init__(self, logger: Optional[ILogger]): # type: ignore
+class MyEnvHandler(IEnvHandler):
+    def __init__(self, logger: Optional[ILogger]):
         self.logger = logger
 
-    def val_str(self, value):
+    def set_logger(self, logger: ILogger):
+        self.logger = logger
+
+    def val_str(self, value: Optional[object]) -> str:
         if value is None:
             return '<Empty>'
         if isinstance(value, str):
@@ -16,23 +20,57 @@ class EnvHandler(IEnvHandler):
             return value
         return str(value)
 
-    def is_value_null_or_empty(self, value):
-        if isinstance(value, str):
-            return value.strip() == '' or value.lower() == 'null'
-        return False
-
-    def get_env_value(self, key, abort_on_error=True):
+    def is_value_null_or_empty(self, value: Optional[str]) -> bool:
+        if value is None:
+            return True
+        s = value.strip()
+        return s == '' or s.lower() == 'null'
+    
+    def get_env_value(self, key: str) -> Optional[str]:
         val = os.environ.get(key)
+        if val is None:
+            err_msg = f"Environment key '{key}' is missing."
+            if self.logger:
+                self.logger.error(err_msg)
+            raise ValueError(err_msg)
         if self.logger:
             self.logger.info(key + ':' + self.val_str(val))
-        if val is None and abort_on_error:
-            err_msg = f"Environment variable '{key}' is not set."
+        if self.is_value_null_or_empty(val):
+            return None
+        return val
+
+    @staticmethod    
+    def read_secret(path):
+        return Path(path).read_text().rstrip('\n')
+
+    def get_env_value_secret(self, key: str, file_key: str) -> str:
+        val = os.environ.get(key)
+        if val is None:
+            err_msg = f"Environment key '{key}' is missing."
             if self.logger:
                 self.logger.error(err_msg)
             raise ValueError(err_msg)
         if self.is_value_null_or_empty(val):
-            return None
+            secret_path = os.getenv(file_key)
+            if secret_path is None:
+                err_msg = f"Secret file key '{file_key}' is missing."
+                if self.logger:
+                    self.logger.error(err_msg)
+                raise ValueError(err_msg)
+            if self.is_value_null_or_empty(secret_path):
+                err_msg = f"Secret file variable '{file_key}' is not set."
+                if self.logger:
+                    self.logger.error(err_msg)
+                raise ValueError(err_msg)
+            if not Path(secret_path).is_file():
+                err_msg = f"Secret file '{secret_path}' not found."
+                if self.logger:
+                    self.logger.error(err_msg)
+                raise ValueError(err_msg)
+            val = self.read_secret(secret_path)
+            if self.is_value_null_or_empty(val):
+                err_msg = f"Secret from key file '{secret_path}' is empty."
+                if self.logger:
+                    self.logger.error(err_msg)
+                raise ValueError(err_msg)
         return val
-    
-    def set_logger(self, logger: ILogger):
-        self.logger = logger

atk_common/interfaces/env_handler_interface.py

@@ -1,9 +1,8 @@
 # interfaces/env_handler_interface.py
 from typing import Optional, Protocol
-from atk_common.interfaces import ILogger
 
 class IEnvHandler(Protocol):
-    def set_logger(self, logger: ILogger) -> None: ...
+    def set_logger(self, logger) -> None: ...
     def val_str(self, value: Optional[object]) -> str: ...
     def is_value_null_or_empty(self, value: Optional[str]) -> bool: ...
     def get_env_value(self, key: str) -> Optional[str]: ...

atk_common/interfaces/logger_interface.py

@@ -1,6 +1,5 @@
 # interfaces/logger_interface.py
 from typing import Protocol
-
 from atk_common.enums.log_level_enum import LogLevel
 
 class ILogger(Protocol):

{atk_common-3.18.0.dist-info → atk_common-3.20.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: atk_common
-Version: 3.18.0
+Version: 3.20.0
 Summary: ATK common methods
 Home-page: https://github.com/pypa/atk_common
 Author: Roger

{atk_common-3.18.0.dist-info → atk_common-3.20.0.dist-info}/RECORD

@@ -19,7 +19,7 @@ atk_common/response_utils.py,sha256=AxlmwkFoDU5XcFOzBQiuZxAQgswihpKXHSo1T0JJw3Q,
 atk_common/classes/__init__.py,sha256=O_VHYxAilmoz3i9L6jkwS-JZ4UaTezdhFiA5liNl1lY,532
 atk_common/classes/bo_logger.py,sha256=wo1-BNWZjzSnlcM7c0LB7tK__2g3BENXvSvCLEiTOME,2065
 atk_common/classes/docker_handler.py,sha256=VNJecc2ZWcpwNBa61QTGM_kYrsoZTjktMcFRFGF4xI4,3048
-atk_common/classes/env_handler.py,sha256=h3snKwHwDvfc2dt1vgHasqv8n_vnsI9J2MAr-XM5oow,1283
+atk_common/classes/env_handler.py,sha256=_Lv_sBUCwsjxO22oRSC4v2xrbVMv-DMW2Mer4OQKJmk,2877
 atk_common/classes/error_handler.py,sha256=DgRzWx4Yu8PKX1bqj55aWhrkqb92ebDaEwtxgKhTLls,3270
 atk_common/classes/http_response_handler.py,sha256=qgtGyEwUe4lIiayS6syWanr2VE6GaKHddazNL_PxEFM,2327
 atk_common/classes/rabbitmq_consumer.py,sha256=UySYDCMXCapi5XNQnsn7q7sVcVvZKKo73qj6OpEv8Ak,3004
@@ -66,10 +66,10 @@ atk_common/enums/test_image_type_enum.py,sha256=HUjxJorehnzRXMNF2uHk2DrAJ3Y_ajQv
 atk_common/enums/violation_type_enum.py,sha256=01qTHOj-O8bOc-nwIHVnxLosm4cusD_YuqXM3ZsiRRk,86
 atk_common/interfaces/__init__.py,sha256=HynEg28Uy3msO7qd__VxajTasSe9-Evpj9yi3Uw2NTo,508
 atk_common/interfaces/docker_handler_interface.py,sha256=hs71uNcFvSbTqRvcL4XarHx6DONP1J7MrUUz-oO28bM,458
-atk_common/interfaces/env_handler_interface.py,sha256=C6JFqvp-woMKdkR04lICqdFAlORGVdr1TEApQUy33Ak,476
+atk_common/interfaces/env_handler_interface.py,sha256=9pBQMUp5Sq-T3ewHX-BXigWyS3Wt8ZDrcJ-xQmTlRpc,424
 atk_common/interfaces/error_handler_interface.py,sha256=ErhQ69T3fCYUl6sS5GwiMgW-znapmGcmgWLR2QLNu8c,506
 atk_common/interfaces/http_response_handler_interface.py,sha256=Cl_njN_klHz1u06FCJPata1dua1w4Cs-Qt9Rg7uaB1c,169
-atk_common/interfaces/logger_interface.py,sha256=jK1gwkB_XmvqsTENhfOsw2QBplay16yVzc_qDSkgFyk,423
+atk_common/interfaces/logger_interface.py,sha256=H23ZyDgeuHCgURWW8zDe-LYaKge3GT5CfQpfHXS0a4A,421
 atk_common/utils/__init__.py,sha256=hU5xicoI6dXRDz0gQADIDo2YbiL2UptTehVBISReIDo,1857
 atk_common/utils/consumer_retry_handler.py,sha256=aumO5iwVP90UI3aYpMQeQXuDElSZfSmI5wxz6pbNnJY,2811
 atk_common/utils/datetime_utils.py,sha256=h3tv6iPD4peBXLCAcws41nuxIM4KpR1vk71LYXTDHKo,3662
@@ -82,7 +82,7 @@ atk_common/utils/http_utils.py,sha256=eSRuQeDgN0ISQdByZqE6cIGXoorcAXz7PEtVntHUKA
 atk_common/utils/internal_response_utils.py,sha256=2X9eLFEy1pO3Aesj1IRXg2yprwNcBDM5_dXaA5vfmMI,694
 atk_common/utils/mq_utils.py,sha256=DmVcXIZHG45p7cQVvgen6OT8QbW_UifFFJGJBybTkJQ,1835
 atk_common/utils/str_utils.py,sha256=sg3jwTTIfQvgGP-lcY5Xh4PXXhKWse_4HswBQYQKEo4,260
-atk_common-3.18.0.dist-info/licenses/license.txt,sha256=_0O6fWM00-wTurDjnZhUP_N5QiwGhItaQZqHq5eqadA,1063
+atk_common-3.20.0.dist-info/licenses/license.txt,sha256=_0O6fWM00-wTurDjnZhUP_N5QiwGhItaQZqHq5eqadA,1063
 atk_package/__init__.py,sha256=okIFEefQhQrw6DZg6oCEVWsEdkVCk-57VXBW0IUG_wU,834
 atk_package/datetime_utils.py,sha256=qsVF7l90P1-xukG2tV_jLqG9J_Yfl5wTpyfrdPBlyMo,239
 atk_package/env_utils.py,sha256=bXOrxM3fZUslqfmZt75iphbEJHbG4riJa8XOVzPwIII,313
@@ -95,7 +95,7 @@ atk_package/enums/__init__.py,sha256=EtUr_--MQj1Rc_R0sF_ELXIThmhpfmhDWq3YaK9oQMk
 atk_package/enums/command_status_enum.py,sha256=M2Nln27a_DbzI07-gfytWQk2X087JhkU6Fmard5qVHs,127
 atk_package/enums/speed_control_status_enum.py,sha256=qpURh0K1L1tSpbrzVnckoe4hUn1illIkbo7k4mLfzIM,182
 shared_python_atk_enforcement/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atk_common-3.18.0.dist-info/METADATA,sha256=NAgCWU88MgtdNMGjkSMIpNyH99OJ-kTAMCbdbAWfhFk,1761
-atk_common-3.18.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-atk_common-3.18.0.dist-info/top_level.txt,sha256=4CwRjkLnheIdI4jQwc4tK3dbRc58WqUmoqjkdDTWlME,41
-atk_common-3.18.0.dist-info/RECORD,,
+atk_common-3.20.0.dist-info/METADATA,sha256=1-z5T2ctaAYb54SFV5AL8upYfRo7S--P5QdDYDXe5cQ,1761
+atk_common-3.20.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+atk_common-3.20.0.dist-info/top_level.txt,sha256=4CwRjkLnheIdI4jQwc4tK3dbRc58WqUmoqjkdDTWlME,41
+atk_common-3.20.0.dist-info/RECORD,,