osbot-utils 1.28.0__tar.gz → 1.30.0__tar.gz

{osbot_utils-1.28.0 → osbot_utils-1.30.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osbot_utils
-Version: 1.28.0
+Version: 1.30.0
 Summary: OWASP Security Bot - Utils
 Home-page: https://github.com/owasp-sbot/OSBot-Utils
 License: MIT
@@ -22,7 +22,7 @@ Description-Content-Type: text/markdown
 
 Powerful Python util methods and classes that simplify common apis and tasks.
 
-![Current Release](https://img.shields.io/badge/release-v1.28.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.30.0-blue)
 [![codecov](https://codecov.io/gh/owasp-sbot/OSBot-Utils/graph/badge.svg?token=GNVW0COX1N)](https://codecov.io/gh/owasp-sbot/OSBot-Utils)
 
 

{osbot_utils-1.28.0 → osbot_utils-1.30.0}/README.md

@@ -2,7 +2,7 @@
 
 Powerful Python util methods and classes that simplify common apis and tasks.
 
-![Current Release](https://img.shields.io/badge/release-v1.28.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.30.0-blue)
 [![codecov](https://codecov.io/gh/owasp-sbot/OSBot-Utils/graph/badge.svg?token=GNVW0COX1N)](https://codecov.io/gh/owasp-sbot/OSBot-Utils)
 
 

osbot_utils-1.30.0/osbot_utils/helpers/Hashicorp_Secrets.py

@@ -0,0 +1,101 @@
+from osbot_utils.utils.Env                  import get_env
+from osbot_utils.base_classes.Type_Safe     import Type_Safe
+from osbot_utils.utils.Lists                import list_index_by
+from osbot_utils.utils.Misc                 import list_set
+
+ENV_VAR__HCP_ACCESS_TOKEN    = 'HCP_ACCESS_TOKEN'
+ENV_VAR__HCP_APP_NAME        = 'HCP_APP_NAME'
+ENV_VAR__HCP_CLIENT_ID       = 'HCP_CLIENT_ID'
+ENV_VAR__HCP_CLIENT_SECRET   = 'HCP_CLIENT_SECRET'
+ENV_VAR__HCP_ORGANIZATION_ID = 'HCP_ORGANIZATION_ID'
+ENV_VAR__HCP_PROJECT_ID      = 'HCP_PROJECT_ID'
+
+class Hashicorp_Secrets(Type_Safe):
+
+    # helper methods
+    def hcp__auth_details(self):
+        client_id     = get_env(ENV_VAR__HCP_CLIENT_ID)
+        client_secret = get_env(ENV_VAR__HCP_CLIENT_SECRET)
+        return client_id, client_secret
+
+    def hcp__access_token(self):                                                                    # todo: refactor to remove dependency on requests package (which is not part of the OSBOt_utils project)
+        import requests
+
+        access_token = get_env(ENV_VAR__HCP_ACCESS_TOKEN)                   # todo: add better way to detect when the access token as expired
+        if not access_token:
+
+            client_id, client_secret = self.hcp__auth_details()
+            token_url               = 'https://auth.idp.hashicorp.com/oauth2/token'
+            payload                 = { 'client_id'     : client_id                     ,
+                                        'client_secret' : client_secret                 ,
+                                        'grant_type'    : 'client_credentials'          ,
+                                        'audience'      : 'https://api.hashicorp.cloud' }
+
+            response = requests.post(token_url, data=payload)                                       # todo: refactor into requests_post method
+            if response.status_code == 200:
+                access_token = response.json().get('access_token')
+        return access_token
+
+    def hcp__enabled(self):
+        if self.hcp__organization_id():
+            if self.hcp__project_id():
+                return True
+        return False
+
+    def hcp__app_name(self):
+        return get_env(ENV_VAR__HCP_APP_NAME)
+
+    def hcp__organization_id(self):
+        return get_env(ENV_VAR__HCP_ORGANIZATION_ID)
+
+    def hcp__project_id(self):
+        return get_env(ENV_VAR__HCP_PROJECT_ID)
+
+    def requests_get(self, path, data_field=None):
+        import requests
+
+        organization_id = self.hcp__organization_id()
+        project_id      = self.hcp__project_id()
+        headers         = {'Authorization': f"Bearer  { self.hcp__access_token()}" }
+        url             = f"https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{organization_id}/projects/{project_id}/{path}"
+        response = requests.get(url, headers=headers)
+        if response.status_code == 200:
+            json_data = response.json()
+            if data_field is None:
+                data_field = path
+            return json_data.get(data_field)
+        return {}
+
+    # API methods
+    def app_secrets(self, app_name=None):
+        if app_name is None:
+            app_name = self.hcp__app_name()
+        path_secrets = f'apps/{app_name}/secrets'
+        app_secrets  = self.requests_get(path_secrets, 'secrets')
+        return app_secrets
+
+    def app_secrets_open(self, app_name=None):
+        if app_name is None:
+            app_name = self.hcp__app_name()
+        path_secrets = f'apps/{app_name}/open'
+        app_secrets  = self.requests_get(path_secrets, 'secrets')
+        return app_secrets
+
+    def app_secrets_names(self, app_name=None):
+        app_secrets = self.app_secrets(app_name)
+        return list_set(list_index_by(app_secrets, 'name'))
+
+    def app_secrets_values(self, app_name=None):
+        secrets_values = {}
+        app_secrets    = self.app_secrets_open(app_name)
+        for app_secret in app_secrets:
+            secret_name                 = app_secret.get('name'       )
+            secret_value                = app_secret.get('version', {}).get('value')
+            secrets_values[secret_name] = secret_value
+        return secrets_values
+
+
+
+    def apps(self):
+        return self.requests_get('apps')
+

{osbot_utils-1.28.0 → osbot_utils-1.30.0}/osbot_utils/helpers/Zip_Bytes.py

@@ -1,16 +1,20 @@
 from osbot_utils.base_classes.Type_Safe import Type_Safe
 from osbot_utils.utils.Dev import pprint
 from osbot_utils.utils.Files import files_list, file_create_from_bytes, temp_file, parent_folder, parent_folder_create
+from osbot_utils.utils.Regex import list__match_regex, list__match_regexes
 from osbot_utils.utils.Zip import zip_bytes_empty, zip_bytes__files, zip_bytes__add_file, zip_bytes__add_files, \
     zip_bytes__replace_files, zip_bytes__replace_file, zip_bytes__file_list, zip_bytes__file, \
-    zip_bytes__add_file__from_disk, zip_bytes__add_files__from_disk, zip_files, zip_file__files
+    zip_bytes__add_file__from_disk, zip_bytes__add_files__from_disk, zip_files, zip_file__files, zip_bytes__remove_files
 
 
 class Zip_Bytes(Type_Safe):
-    zip_bytes : bytes
+    zip_bytes : bytes = None
 
-    def __enter__(self):
+    def __init__(self):
+        super().__init__()
         self.zip_bytes = zip_bytes_empty()
+
+    def __enter__(self):
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
@@ -20,7 +24,9 @@ class Zip_Bytes(Type_Safe):
         self.zip_bytes = zip_bytes__add_file(self.zip_bytes, file_path, file_contents)
         return self
 
-    def add_file__from_disk(self, base_path, file_to_add):
+    def add_file__from_disk(self, file_to_add, base_path=None):
+        if base_path is None:
+            base_path = parent_folder(file_to_add)
         self.zip_bytes = zip_bytes__add_file__from_disk(self.zip_bytes, base_path, file_to_add)
         return self
 
@@ -28,14 +34,22 @@ class Zip_Bytes(Type_Safe):
         self.zip_bytes = zip_bytes__add_files(self.zip_bytes, files_to_add)
         return self
 
-    def add_files__from_disk(self, base_path, files_to_add):
-        self.zip_bytes = zip_bytes__add_files__from_disk(self.zip_bytes, base_path, files_to_add)
+    def add_files__from_disk(self, base_path, files_to_add, path_prefix=None):
+        self.zip_bytes = zip_bytes__add_files__from_disk(self.zip_bytes, base_path, files_to_add, path_prefix=path_prefix)
         return self
 
-    def add_folder__from_disk(self, base_path, folder_to_add, pattern="*"):
-        files_to_add = files_list(folder_to_add, pattern=pattern)
+    def add_folder__from_disk(self, folder_to_add, *patterns):
+        base_path           = folder_to_add
+        all_files_in_folder = files_list(folder_to_add)
+        files_to_add        = list__match_regexes(all_files_in_folder, *patterns)
         return self.add_files__from_disk(base_path, files_to_add)
 
+    def add_folder__from_disk__with_prefix(self, folder_to_add, path_prefix, *patterns):
+        base_path           = folder_to_add
+        all_files_in_folder = files_list(folder_to_add)
+        files_to_add        = list__match_regexes(all_files_in_folder, *patterns)
+        return self.add_files__from_disk(base_path, files_to_add, path_prefix=path_prefix)
+
     def add_from_zip_file(self, path_zip_file):
         files_to_add = zip_file__files(path_zip_file)
         self.add_files(files_to_add)
@@ -47,15 +61,27 @@ class Zip_Bytes(Type_Safe):
     def file(self, file_path):
         return zip_bytes__file(self.zip_bytes, file_path)
 
+    def file_paths(self):
+        return self.files_list()
+
     def files(self):
         return zip_bytes__files(self.zip_bytes)
 
     def files_list(self):
         return zip_bytes__file_list(self.zip_bytes)
 
+    def list(self):
+        return self.files_list()
+
     def print_files_list(self):
         pprint(self.files_list())
         return self
+
+    def remove_files(self, *patterns):
+        files_to_remove = list__match_regexes(self.files_list(), *patterns)
+        self.zip_bytes = zip_bytes__remove_files(self.zip_bytes, files_to_remove)
+        return self
+
     def replace_files(self, files_to_replace):
         self.zip_bytes = zip_bytes__replace_files(self.zip_bytes, files_to_replace)
         return self

{osbot_utils-1.28.0 → osbot_utils-1.30.0}/osbot_utils/helpers/trace/Trace_Call.py

@@ -11,8 +11,8 @@ from osbot_utils.helpers.trace.Trace_Call__View_Model       import Trace_Call__V
 
 
 def trace_calls(title         = None , print_traces = True , show_locals    = False, source_code          = False ,
-                ignore        = None , include      = None , show_path      = False, duration_bigger_than = 0     , trace_depth=0,
-                max_string    = None , show_types   = False, show_duration  = False ,# show_caller    = False     ,         # todo: add back when show_caller is working again
+                ignore        = None , include      = None , show_path      = False, duration_bigger_than = 0     ,
+                trace_depth   = 0    , max_string   = None , show_types     = False, show_duration        = False , # show_caller    = False     ,         # todo: add back when show_caller is working again
                 show_class    = False, contains     = None , show_internals = False, enabled              = True  ,
                 extra_data    = False, show_lines   = False, print_lines    = False, show_types_padding   = None  , duration_padding=None):
     def decorator(func):

{osbot_utils-1.28.0 → osbot_utils-1.30.0}/osbot_utils/testing/Temp_Folder.py

@@ -96,6 +96,13 @@ class Temp_Folder:
         file_path = path_combine(self.full_path, target_file)
         return file_contents(file_path)
 
+    def files_contents(self):
+        result = {}
+        for file_path in self.files():
+            full_path         = path_combine(self.full_path, file_path)
+            result[file_path] = file_contents(full_path)
+        return result
+
     def files(self, show_parent_folder=False, include_folders=False):
         all_files = files_recursive(self.path(), include_folders=include_folders)
         if show_parent_folder:

{osbot_utils-1.28.0 → osbot_utils-1.30.0}/osbot_utils/utils/Env.py

@@ -6,10 +6,10 @@ from osbot_utils.utils.Files    import all_parent_folders, file_exists
 from osbot_utils.utils.Misc     import list_set
 from osbot_utils.utils.Str      import strip_quotes
 
-def env__home_root():
+def env__home_root():                           # todo: this should be refatored to be env__home__is__root
     return os.getenv('HOME') == '/root'
 
-def env__terminal_xterm():
+def env__terminal_xterm():                      # todo: this should be refatored to be env__terminal__is__xterm
     return os.getenv('TERM') == 'xterm'
 
 def env__not_terminal_xterm():

{osbot_utils-1.28.0 → osbot_utils-1.30.0}/osbot_utils/utils/Files.py

@@ -81,7 +81,7 @@ class Files:
         return glob.glob(path_pattern, recursive=recursive)
 
     @staticmethod
-    def files(path, pattern= '*.*', only_files=True):
+    def files(path, pattern= '*', only_files=True):
         result = []
         for file in Path(path).rglob(pattern):
             if only_files and is_not_file(file):

osbot_utils-1.30.0/osbot_utils/utils/Regex.py

@@ -0,0 +1,25 @@
+import re
+
+from osbot_utils.utils.Status import status_error
+
+
+def list__match_regex(target, pattern):
+    return list__match_regexes(target, [pattern])
+
+def list__match_regexes(target, *patterns):
+    if len (patterns) == 0:
+        return target
+    compiled_patterns = []
+    for pattern in patterns:
+        try:
+            compiled_patterns.append(re.compile(pattern))                           # todo: find better way to handle regex errors
+        except Exception as error:
+            return status_error(message='Error compiling pattern: {pattern}', error=error)
+    matched_files = []
+    if target and type(target) is list:
+        for file in target:
+            for compiled_pattern in compiled_patterns:
+                if compiled_pattern.match(file):
+                    matched_files.append(file)
+                    break
+    return matched_files

{osbot_utils-1.28.0 → osbot_utils-1.30.0}/osbot_utils/utils/Zip.py

@@ -52,14 +52,17 @@ def zip_bytes__add_file(zip_bytes, zip_file_path, file_contents):
 def zip_bytes__add_file__from_disk(zip_bytes, base_path, file_to_add):
     return zip_bytes__add_files__from_disk(zip_bytes, base_path, files_to_add=[file_to_add])
 
-def zip_bytes__add_files__from_disk(zip_bytes, base_path, files_to_add, replace_files=True):
+def zip_bytes__add_files__from_disk(zip_bytes, base_path, files_to_add, replace_files=True, path_prefix=None):
     zip_files_to_add = {}
     if base_path[:-1] != '/':
         base_path += "/"
+
     for file_to_add in files_to_add:
         if file_exists(file_to_add):
             file_contents = file_contents_as_bytes(file_to_add)
             zip_file_path = file_to_add.replace(base_path, '')
+            if path_prefix:
+                zip_file_path = path_prefix + zip_file_path
             zip_files_to_add[zip_file_path] = file_contents
 
     if replace_files:

osbot_utils-1.30.0/osbot_utils/version

@@ -0,0 +1 @@
+v1.30.0

{osbot_utils-1.28.0 → osbot_utils-1.30.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name        = "osbot_utils"
-version     = "v1.28.0"
+version     = "v1.30.0"
 description = "OWASP Security Bot - Utils"
 authors     = ["Dinis Cruz <dinis.cruz@owasp.org>"]
 license     = "MIT"

osbot_utils-1.28.0/osbot_utils/version

@@ -1 +0,0 @@
-v1.28.0