ScriptCollection 4.0.51__py3-none-any.whl → 4.0.52__py3-none-any.whl

ScriptCollection/ProgramRunnerSudo.py

@@ -0,0 +1,108 @@
+from subprocess import Popen
+from .GeneralUtilities import GeneralUtilities
+from .ProgramRunnerBase import ProgramRunnerBase
+from .ScriptCollectionCore import ScriptCollectionCore
+
+
+class SudoPopenReader:
+    content: bytes = None
+
+    def __init__(self, content: bytes):
+        self.content = content
+
+    def readable(self) -> bool:
+        return True
+
+    def read(self) -> bytes:
+        return self.content
+
+
+class SudoPopen:
+    returncode: int = None
+    stdout_str: str = None
+    stderr_str: str = None
+    pid: int = None
+    stdout: bytes = None
+    stderr: bytes = None
+
+    def __init__(self, exitcode: int, stdout: str, stderr: str, pid: int):
+        self.returncode: int = exitcode
+        self.stdout_str: str = stdout
+        self.stdout = str.encode(self.stdout_str)
+        self.stderr_str: str = stderr
+        self.stderr = str.encode(self.stderr_str)
+        self.pid = pid
+
+    def communicate(self):
+        return (self.stdout, self.stderr)
+
+    def wait(self):
+        return self.returncode
+
+    def poll(self) -> object:
+        return self.returncode
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        pass
+
+
+class ProgramRunnerSudo(ProgramRunnerBase):
+    __sc: ScriptCollectionCore
+    __password: str
+
+    @GeneralUtilities.check_arguments
+    def __init__(self,user_password:str):
+        GeneralUtilities.assert_condition(GeneralUtilities.current_system_is_linux(), "SudoRunner can only be only executed on Linux.")
+        self.__sc = ScriptCollectionCore()
+        self.__password = user_password
+
+    @GeneralUtilities.check_arguments
+    def will_be_executed_locally(self) -> bool:
+        return True
+
+    @GeneralUtilities.check_arguments
+    def run_program_internal(self, program: str, arguments_as_array: list[str] = [], working_directory: str = None, custom_argument: object = None) -> tuple[int, str, str, int]:
+        argument = program+" " + ' '.join(GeneralUtilities.args_array_surround_with_quotes_if_required(arguments_as_array))
+        argument = f"echo {self.__password} | sudo -k -S {argument}"  # TODO maybe add "exit" somewhere before argument or before sudo to correctly return the exit-code"
+        result = self.__sc.run_program_argsasarray("sh", ["-c", argument], working_directory)
+        return result
+
+    @GeneralUtilities.check_arguments
+    def run_program_argsasarray_async_helper(self, program: str, arguments_as_array: list[str] = [], working_directory: str = None, custom_argument: object = None, interactive: bool = False) -> Popen:
+        if interactive:
+            raise ValueError("Interactive execution is not supported in Sudo-runner")
+        r: tuple[int, str, str, int] = self.run_program_internal(program, arguments_as_array, working_directory, custom_argument)
+        popen: SudoPopen = SudoPopen(r[0], r[1], r[2], r[3])
+        return popen
+
+    # Return-values program_runner: Exitcode, StdOut, StdErr, Pid
+    @GeneralUtilities.check_arguments
+    def wait(self, process: Popen, custom_argument: object) -> tuple[int, str, str, int]:
+        raise ValueError("Wait is not supported in Sudo-runner")
+
+    # Return-values program_runner: Exitcode, StdOut, StdErr, Pid
+    @GeneralUtilities.check_arguments
+    def run_program_argsasarray(self, program: str, arguments_as_array: list[str] = [], working_directory: str = None, custom_argument: object = None, interactive: bool = False) -> tuple[int, str, str, int]:
+        if interactive:
+            raise ValueError("Interactive execution is not supported in Sudo-runner")
+        return self.run_program_internal(program, arguments_as_array, working_directory, custom_argument)
+
+    # Return-values program_runner: Exitcode, StdOut, StdErr, Pid
+    @GeneralUtilities.check_arguments
+    def run_program(self, program: str, arguments:  str = "", working_directory: str = None, custom_argument: object = None, interactive: bool = False) -> tuple[int, str, str, int]:
+        if interactive:
+            raise ValueError("Interactive execution is not supported in Sudo-runner")
+        return self.run_program_internal(program, arguments.split(" "), working_directory, custom_argument)
+
+    # Return-values program_runner: Pid
+    @GeneralUtilities.check_arguments
+    def run_program_argsasarray_async(self, program: str, arguments_as_array: list[str] = [], working_directory: str = None, custom_argument: object = None, interactive: bool = False) -> int:
+        raise ValueError("Async execution is not supported in Sudo-runner")
+
+    # Return-values program_runner: Pid
+    @GeneralUtilities.check_arguments
+    def run_program_async(self, program: str, arguments: str,  working_directory: str, custom_argument: object, interactive: bool = False) -> int:
+        raise ValueError("Async execution is not supported in Sudo-runner")

ScriptCollection/ScriptCollectionCore.py

@@ -34,10 +34,9 @@ from pypdf import PdfReader, PdfWriter
 from .GeneralUtilities import GeneralUtilities
 from .ProgramRunnerBase import ProgramRunnerBase
 from .ProgramRunnerPopen import ProgramRunnerPopen
-from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 from .SCLog import SCLog, LogLevel
 
-version = "4.0.51"
+version = "4.0.52"
 __version__ = version
 
 
@@ -1549,8 +1548,6 @@ class ScriptCollectionCore:
 
     @GeneralUtilities.check_arguments
     def __run_program_argsasarray_async_helper(self, program: str, arguments_as_array: list[str] = [], working_directory: str = None, print_errors_as_information: bool = False, log_file: str = None, timeoutInSeconds: int = 600, addLogOverhead: bool = False, title: str = None, log_namespace: str = "", arguments_for_log:  list[str] = None, custom_argument: object = None, interactive: bool = False) -> Popen:
-        if isinstance(self.program_runner, ProgramRunnerEpew):
-            custom_argument = CustomEpewArgument(print_errors_as_information, log_file, timeoutInSeconds, addLogOverhead, title, log_namespace,self.log.loglevel, arguments_for_log)
         popen: Popen = self.program_runner.run_program_argsasarray_async_helper(program, arguments_as_array, working_directory, custom_argument, interactive)
         return popen
 
@@ -1833,10 +1830,14 @@ class ScriptCollectionCore:
         pid: int
 
     @GeneralUtilities.check_arguments
-    def run_with_epew(self, program: str, argument: str = "", working_directory: str = None, print_errors_as_information: bool = False, log_file: str = None, timeoutInSeconds: int = 600, addLogOverhead: bool = False, title: str = None, log_namespace: str = "", arguments_for_log:  list[str] = None, throw_exception_if_exitcode_is_not_zero: bool = True, custom_argument: object = None, interactive: bool = False,print_live_output:bool=False) -> tuple[int, str, str, int]:
-        sc: ScriptCollectionCore = ScriptCollectionCore()
-        sc.program_runner = ProgramRunnerEpew()
-        return sc.run_program(program, argument, working_directory, print_errors_as_information, log_file, timeoutInSeconds, addLogOverhead, title, log_namespace, arguments_for_log, throw_exception_if_exitcode_is_not_zero, custom_argument, interactive,print_live_output=print_live_output)
+    def run_with_epew(self, program: str, argument: str = "", working_directory: str = None, print_errors_as_information: bool = False, log_file: str = None, timeoutInSeconds: int = 600, addLogOverhead: bool = False, title: str = None, log_namespace: str = "", arguments_for_log:  list[str] = None, throw_exception_if_exitcode_is_not_zero: bool = True, custom_argument: object = None, interactive: bool = False,print_live_output:bool=False,encode_argument_in_base64:bool=False) -> tuple[int, str, str, int]:
+        epew_argument=f"-p {program} -a {argument} -w {working_directory}"
+        if encode_argument_in_base64:
+            base64_bytes = base64.b64encode(argument)
+            base64_string = base64_bytes.decode('utf-8')
+            argument=base64.b64decode(base64_string)
+            epew_argument=epew_argument+" -b"
+        return self.run_program("epew", epew_argument, working_directory, print_errors_as_information, log_file, timeoutInSeconds, addLogOverhead, title, log_namespace, arguments_for_log, throw_exception_if_exitcode_is_not_zero, custom_argument, interactive,print_live_output=print_live_output)
 
 
     # </run programs>

{scriptcollection-4.0.51.dist-info → scriptcollection-4.0.52.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ScriptCollection
-Version: 4.0.51
+Version: 4.0.52
 Summary: The ScriptCollection is the place for reusable scripts.
 Home-page: https://github.com/anionDev/ScriptCollection
 Author: Marius Göcke

{scriptcollection-4.0.51.dist-info → scriptcollection-4.0.52.dist-info}/RECORD

@@ -5,11 +5,11 @@ ScriptCollection/GeneralUtilities.py,sha256=9Xd9aKPj3TkpVtdHXzFMILrRoXAfJCph69XR
 ScriptCollection/ImageUpdater.py,sha256=qTe3yoqzQJY7LZdXBbjbWvrsSQaeHy1VwmOxaRzU2ig,29305
 ScriptCollection/ProcessesRunner.py,sha256=3mu4ZxzZleQo0Op6o9EYTCFiJfb6kx5ov2YfZfT89mU,1395
 ScriptCollection/ProgramRunnerBase.py,sha256=4A2eQgSg_rRgQcgSi-LYtUlM-uSQEpS7qFWn0tWt4uo,2171
-ScriptCollection/ProgramRunnerEpew.py,sha256=TJdDx9zIMSiCaXh8X-ekrMlbXfGtmd0Mmyxj-tV_gHg,7338
 ScriptCollection/ProgramRunnerMock.py,sha256=uTu-aFle1W_oKjeQEmuPsFPQpvo0kRf2FrRjAPIwT5Y,37
 ScriptCollection/ProgramRunnerPopen.py,sha256=BPY7-ZMIlqT7JOKz8qlB5c0laF2Js-ijzqk09GxZC48,3821
+ScriptCollection/ProgramRunnerSudo.py,sha256=_khC3xuTdrPoLluBJZWfldltmmuKltABJPcbjZSFW-4,4835
 ScriptCollection/SCLog.py,sha256=dxGOI4E9lG5v9jk_LajXCkM5nghliCDV8YB8Ihn160s,4541
-ScriptCollection/ScriptCollectionCore.py,sha256=n-QprUwKp_hE2W9jPHzktCEDurVVcvkH4Sz8EIcyV0M,142178
+ScriptCollection/ScriptCollectionCore.py,sha256=2EqLxmuiBYobgKIjQ2yBYZYkHmu1g3QsZykfhvU1SbI,142125
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ScriptCollection/TFCPS/TFCPS_CodeUnitSpecific_Base.py,sha256=H9ampfCfJ4-ohN33VkYWTKwYaTV-y3AelZAiTduwHzw,25442
 ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnit.py,sha256=4rYKgTAga11NiDx8YUqz3K_Q4eX_n3kC6lvNdXEa24s,7389
@@ -35,8 +35,8 @@ ScriptCollection/TFCPS/NodeJS/TFCPS_CodeUnitSpecific_NodeJS.py,sha256=e2bvR_zzAr
 ScriptCollection/TFCPS/NodeJS/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ScriptCollection/TFCPS/Python/TFCPS_CodeUnitSpecific_Python.py,sha256=q7msAxCb5VIZ-xhFg1MfzUvWomQRKYldqmW42KFhyMU,6868
 ScriptCollection/TFCPS/Python/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scriptcollection-4.0.51.dist-info/METADATA,sha256=IAPmwcVuxRDd8BqNGVtKq5bZyU9gwBJzD4N1k6jiby8,7688
-scriptcollection-4.0.51.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-scriptcollection-4.0.51.dist-info/entry_points.txt,sha256=_izhaQEyHiyBIfM2zTYDaJ7qvgsP1WntkVChFnkWymE,4431
-scriptcollection-4.0.51.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-scriptcollection-4.0.51.dist-info/RECORD,,
+scriptcollection-4.0.52.dist-info/METADATA,sha256=5SNVHNlcuIWhu4ufQyC648iLMrNWuaMTHtSE7d6toQM,7688
+scriptcollection-4.0.52.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+scriptcollection-4.0.52.dist-info/entry_points.txt,sha256=_izhaQEyHiyBIfM2zTYDaJ7qvgsP1WntkVChFnkWymE,4431
+scriptcollection-4.0.52.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+scriptcollection-4.0.52.dist-info/RECORD,,

ScriptCollection/ProgramRunnerEpew.py

@@ -1,148 +0,0 @@
-import os
-import base64
-import tempfile
-from subprocess import Popen
-from uuid import uuid4
-
-from .GeneralUtilities import GeneralUtilities
-from .ProgramRunnerBase import ProgramRunnerBase
-from .ProgramRunnerPopen import ProgramRunnerPopen
-from .SCLog import LogLevel
-
-
-class CustomEpewArgument:
-
-    print_errors_as_information: bool
-    log_file: str
-    timeoutInSeconds: int
-    addLogOverhead: bool
-    title: str
-    log_namespace: str
-    verbosity: LogLevel
-    arguments_for_log:  list[str]
-    tempdir = os.path.join(tempfile.gettempdir(), str(uuid4()))
-    stdoutfile = tempdir + ".epew.stdout.txt"
-    stderrfile = tempdir + ".epew.stderr.txt"
-    exitcodefile = tempdir + ".epew.exitcode.txt"
-    pidfile = tempdir + ".epew.pid.txt"
-
-    def __init__(self, print_errors_as_information: bool, log_file: str, timeoutInSeconds: int, addLogOverhead: bool, title: str, log_namespace: str, verbosity: LogLevel,  arguments_for_log:  list[str]):
-        self.print_errors_as_information = print_errors_as_information
-        self.log_file = log_file
-        self.timeoutInSeconds = timeoutInSeconds
-        self.addLogOverhead = addLogOverhead
-        self.title = title
-        self.log_namespace = log_namespace
-        self.verbosity = verbosity
-        self.arguments_for_log = arguments_for_log
-
-
-class ProgramRunnerEpew(ProgramRunnerBase):
-
-    @GeneralUtilities.check_arguments
-    def run_program_argsasarray_async_helper(self, program: str, arguments_as_array: list[str] = [], working_directory: str = None, custom_argument: object = None, interactive: bool = False) -> Popen:
-        if GeneralUtilities.epew_is_available():
-            custom_argument: CustomEpewArgument = custom_argument
-            args = []
-
-            base64argument = base64.b64encode(' '.join(arguments_as_array).encode('utf-8')).decode('utf-8')
-            args.append(f'-p "{program}"')
-            args.append(f'-a {base64argument}')
-            args.append('-b')
-            args.append(f'-w "{working_directory}"')
-            if custom_argument.stdoutfile is not None:
-                args.append(f'-o {custom_argument.stdoutfile}')
-            if custom_argument.stderrfile is not None:
-                args.append(f'-e {custom_argument.stderrfile}')
-            if custom_argument.exitcodefile is not None:
-                args.append(f'-x {custom_argument.exitcodefile}')
-            if custom_argument.pidfile is not None:
-                args.append(f'-r {custom_argument.pidfile}')
-            args.append(f'-d {str(custom_argument.timeoutInSeconds*1000)}')
-            if GeneralUtilities.string_has_content(custom_argument.title):
-                args.append(f'-t "{custom_argument.title}"')
-            if GeneralUtilities.string_has_content(custom_argument.log_namespace):
-                args.append(f'-l "{custom_argument.log_namespace}"')
-            if not GeneralUtilities.string_is_none_or_whitespace(custom_argument.log_file):
-                args.append(f'-f "{custom_argument.log_file}"')
-            if custom_argument.print_errors_as_information:
-                args.append("-i")
-            if custom_argument.addLogOverhead:
-                args.append("-g")
-            args.append("-v "+str(self.__get_microsoft_loglevel()))
-            return ProgramRunnerPopen().run_program_argsasarray_async_helper("epew", args, working_directory, custom_argument, interactive)
-        else:
-            raise ValueError("Epew is not available.")
-
-    def __get_microsoft_loglevel(self):
-        #see https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.loglevel
-        #match self.verbosity:
-        #    case LogLevel.Quiet:
-        #        return 6
-        #    case LogLevel.Error:
-        #        return 4
-        #    case LogLevel.Warning:
-        #        return 3
-        #    case LogLevel.Information:
-        #        return 5
-        #    case LogLevel.Debug:
-        #        return 1
-        #    case LogLevel.Diagnostig:
-        #        return 0
-        #    case _:
-        #        raise ValueError(f"Unhandled log level: {level}")
-        return 2#TODO
-
-    # Return-values program_runner: Exitcode, StdOut, StdErr, Pid
-    @GeneralUtilities.check_arguments
-    def wait(self, process: Popen, custom_argument: object = None) -> tuple[int, str, str, int]:
-        process.wait()
-        custom_argument: CustomEpewArgument = custom_argument
-        stdout = self.__load_text(custom_argument.output_file_for_stdout)
-        stderr = self.__load_text(custom_argument.output_file_for_stderr)
-        exit_code = self.__get_number_from_filecontent(self.__load_text(custom_argument.output_file_for_exit_code))
-        pid = self.__get_number_from_filecontent(self.__load_text(custom_argument.output_file_for_pid))
-        GeneralUtilities.ensure_directory_does_not_exist(custom_argument.tempdir)
-        result = (exit_code, stdout, stderr, pid)
-        return result
-
-    @GeneralUtilities.check_arguments
-    def run_program_argsasarray(self, program: str, arguments_as_array: list[str] = [], working_directory: str = None, custom_argument: object = None, interactive: bool = False) -> tuple[int, str, str, int]:
-        process: Popen = self.run_program_argsasarray_async_helper(program, arguments_as_array, working_directory, custom_argument, interactive)
-        return self.wait(process, custom_argument)
-
-    @GeneralUtilities.check_arguments
-    def run_program(self, program: str, arguments: str = "", working_directory: str = None, custom_argument: object = None, interactive: bool = False) -> tuple[int, str, str, int]:
-        return self.run_program_argsasarray(program, GeneralUtilities.arguments_to_array(arguments), working_directory, custom_argument, interactive)
-
-    @GeneralUtilities.check_arguments
-    def run_program_argsasarray_async(self, program: str, arguments_as_array: list[str] = [], working_directory: str = None, custom_argument: object = None, interactive: bool = False) -> int:
-        return self.run_program_argsasarray_async_helper(program, arguments_as_array, working_directory, custom_argument, interactive).pid
-
-    @GeneralUtilities.check_arguments
-    def run_program_async(self, program: str, arguments: str = "", working_directory: str = None, custom_argument: object = None, interactive: bool = False) -> int:
-        return self.run_program_argsasarray_async(program, GeneralUtilities.arguments_to_array(arguments), working_directory, custom_argument, interactive)
-
-    @GeneralUtilities.check_arguments
-    def __get_number_from_filecontent(self, filecontent: str) -> int:
-        for line in filecontent.splitlines():
-            try:
-                striped_line = GeneralUtilities.strip_new_line_character(line)
-                result = int(striped_line)
-                return result
-            except:
-                pass
-        raise ValueError(f"'{filecontent}' does not containe an int-line")
-
-    @GeneralUtilities.check_arguments
-    def __load_text(self, file: str) -> str:
-        if os.path.isfile(file):
-            content = GeneralUtilities.read_text_from_file(file).replace('\r', '')
-            os.remove(file)
-            return content
-        else:
-            raise ValueError(f"File '{file}' does not exist")
-
-    @GeneralUtilities.check_arguments
-    def will_be_executed_locally(self) -> bool:
-        return True