osbot-utils 1.25.0__tar.gz → 1.27.0__tar.gz

{osbot_utils-1.25.0 → osbot_utils-1.27.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osbot_utils
-Version: 1.25.0
+Version: 1.27.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.25.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.27.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.25.0 → osbot_utils-1.27.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.25.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.27.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.25.0 → osbot_utils-1.27.0}/osbot_utils/helpers/ssh/SSH__Execute.py

@@ -4,6 +4,7 @@ from osbot_utils.decorators.lists.group_by                  import group_by
 from osbot_utils.decorators.lists.index_by                  import index_by
 from osbot_utils.utils.Dev                                  import pprint
 from osbot_utils.utils.Env                                  import get_env
+from osbot_utils.utils.Http import is_port_open
 from osbot_utils.utils.Misc                                 import str_to_int, str_to_bool
 from osbot_utils.utils.Process import start_process, run_process
 from osbot_utils.utils.Status                               import status_error
@@ -140,10 +141,11 @@ class SSH__Execute(Type_Safe):
     def ssh_not__setup_ok(self):
         return self.ssh_setup_ok() is False
 
-    # print helpers
-    # def print_ls(self, path=''):
-    #     pprint(self.ls(path))
-    #     return self
+    def ssh_host_available(self):
+        return is_port_open(self.ssh_host, self.ssh_port)
+
+    def ssh_host_not_available(self):
+        return self.ssh_host_available() is False
 
     def print_status__stderr__stdout(self, result):
         print()

{osbot_utils-1.25.0 → osbot_utils-1.27.0}/osbot_utils/helpers/ssh/TestCase__SSH.py

@@ -21,6 +21,10 @@ class TestCase__SSH(TestCase):
             import pytest                           # we can only import this locally since this dependency doesn't exist in the main osbot_utils codebase
             pytest.skip("SSH host not set")
 
+        with cls.ssh.ssh_execute() as _:
+            if _.ssh_not__setup_ok() or _.ssh_host_not_available():
+                cls.skipTest(cls, 'ssh is not setup or enabled')
+
         cls.cache = SSH__Cache__Requests()
         cls.cache.patch_apply()
 

{osbot_utils-1.25.0 → osbot_utils-1.27.0}/osbot_utils/testing/Temp_Folder.py

@@ -4,7 +4,7 @@ from osbot_utils.utils.Misc import random_string
 
 from osbot_utils.utils.Files import path_combine, temp_folder_current, safe_file_name, folder_exists, folder_create, \
     folder_delete_recursively, files_list, file_create, folder_files, folders_recursive, files_find, files_recursive, \
-    temp_file_in_folder, create_folder, filter_parent_folder
+    temp_file_in_folder, create_folder, filter_parent_folder, file_contents
 from osbot_utils.utils.Zip import zip_folder
 
 
@@ -92,6 +92,10 @@ class Temp_Folder:
     def path(self):
         return self.full_path
 
+    def file_contents(self, target_file):
+        file_path = path_combine(self.full_path, target_file)
+        return file_contents(file_path)
+
     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.25.0 → osbot_utils-1.27.0}/osbot_utils/testing/Temp_Zip.py

@@ -1,5 +1,6 @@
 from osbot_utils.testing.Temp_Folder import Temp_Folder
-from osbot_utils.utils.Files import Files, is_folder, file_exists, file_name
+from osbot_utils.utils.Files import Files, is_folder, file_exists, file_name, file_move_to_folder, file_move, \
+    file_move_to
 from osbot_utils.utils.Zip import zip_folder, zip_file_list
 
 
@@ -42,4 +43,7 @@ class Temp_Zip():
         return self
 
     def zip_file_exists(self):
-        return file_exists(self.zip_file)
+        return file_exists(self.zip_file)
+
+    def move_to(self, target_file):
+        file_move_to(self.zip_file, target_file)

{osbot_utils-1.25.0 → osbot_utils-1.27.0}/osbot_utils/utils/Env.py

@@ -94,6 +94,9 @@ def load_dotenv(dotenv_path=None, override=False):              # todo: add dete
 def not_in_github_action():
     return in_github_action() is False
 
+def set_env(key, value):
+    os.environ[key] = value
+    return value
 
 def unload_dotenv(dotenv_path=None):
     if dotenv_path:                                                 # If a specific dotenv path is provided, unload from it

{osbot_utils-1.25.0 → osbot_utils-1.27.0}/osbot_utils/utils/Files.py

@@ -8,6 +8,8 @@ import shutil
 import tempfile
 from   os.path              import abspath, join
 from pathlib import Path, PosixPath
+from typing import Union
+
 from osbot_utils.utils.Misc import bytes_to_base64, base64_to_bytes, random_string
 
 
@@ -306,13 +308,24 @@ class Files:
         return Files.open(path, mode='rb')
 
     @staticmethod
-    def path_combine(path1, path2):
-        if type(path1) in [str, Path] and type(path2) in [str, Path]:
-            parent_path = str(path1)
-            sub_path    = str(path2)
-            if sub_path.startswith('/'):
-                sub_path = sub_path[1:]
-            return abspath(join(parent_path,sub_path))
+    # def path_combine(path1, path2):
+    #     if type(path1) in [str, Path] and type(path2) in [str, Path]:
+    #         parent_path = str(path1)
+    #         sub_path    = str(path2)
+    #         if sub_path.startswith('/'):
+    #             sub_path = sub_path[1:]
+    #         return abspath(join(parent_path,sub_path))
+
+    def path_combine(path1: Union[str, os.PathLike], path2: Union[str, os.PathLike]) -> str:
+        if path1 is None or path2 is None:
+            raise ValueError("Both paths must be provided")
+
+        parent_path = str(path1)
+        sub_path = str(path2)
+
+        sub_path = sub_path.lstrip('/')     # Remove leading slashes from sub_path
+
+        return abspath(join(parent_path, sub_path))
 
     @staticmethod
     def parent_folder(path, use_full_path=False):
@@ -451,8 +464,8 @@ def all_parent_folders(path=None, include_path=False):
             if path and path not in parent_directories:  # to handle the root path case
                 parent_directories.append(path)
             break
-
     return parent_directories
+
 def file_move(source_file, target_file):
     if file_exists(source_file):
         file_copy(source_file, target_file)
@@ -461,6 +474,14 @@ def file_move(source_file, target_file):
                 return True
     return False
 
+def file_move_to_folder(source_file, target_folder):
+    if file_exists(source_file):
+        if folder_exists(target_folder):
+            target_file = path_combine(target_folder, file_name(source_file))
+            if file_move(source_file, target_file):
+                return target_file
+
+
 def folders_names_in_folder(target):
     folders = folders_in_folder(target)
     return folders_names(folders)
@@ -506,6 +527,7 @@ file_full_path                 = absolute_path
 file_lines                     = Files.lines
 file_lines_gz                  = Files.lines_gz
 file_md5                       = Files.contents_md5
+file_move_to                   = file_move
 file_name                      = Files.file_name
 file_name_without_extension    = Files.file_name_without_extension
 file_not_exists                = Files.not_exists

{osbot_utils-1.25.0 → osbot_utils-1.27.0}/osbot_utils/utils/Zip.py

@@ -136,5 +136,6 @@ def zip_files(base_folder, file_pattern="*.*", target_file=None):
 
 
 # extra function's mappings
-file_unzip  = unzip_file
-folder_zip  = zip_folder
+file_unzip                = unzip_file
+folder_zip                = zip_folder
+zip_bytes_unzip_to_folder = zip_bytes_extract_to_folder

osbot_utils-1.27.0/osbot_utils/version

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

{osbot_utils-1.25.0 → osbot_utils-1.27.0}/pyproject.toml

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

osbot_utils-1.25.0/osbot_utils/version

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