ScriptCollection 4.2.51__py3-none-any.whl → 4.2.53__py3-none-any.whl

ScriptCollection/CertificateUpdater.py

@@ -21,8 +21,9 @@ class CertificateUpdater:
     __log_folder: str = None
     __sc: ScriptCollectionCore = None
     __arguments: ScriptCollectionCore = None
+    __certbot_image_address_with_tag:str=None
 
-    def __init__(self, domains: list[str], email: str, current_file: str, arguments: list[str]):
+    def __init__(self, domains: list[str], email: str, current_file: str, arguments: list[str],certbot_image_address_with_tag:str=None):
         self.__sc = ScriptCollectionCore()
         self.maximal_age_of_certificates_in_days = 15
         self.__domains = domains
@@ -36,6 +37,9 @@ class CertificateUpdater:
         self.__letsencrypt_live_folder = os.path.join(self.__letsencrypt_folder, "live")
         self.__letsencrypt_archive_folder = os.path.join(self.__letsencrypt_folder, "archive")
         self.__log_folder = GeneralUtilities.resolve_relative_path("Logs/Overhead", self.__repository_folder)
+        if certbot_image_address_with_tag is None:
+            certbot_image_address_with_tag="docker.io/certbot/certbot:latest"
+        self.__certbot_image_address_with_tag=certbot_image_address_with_tag
 
     @GeneralUtilities.check_arguments
     def __get_latest_index_by_domain(self, domain: str) -> int:
@@ -102,7 +106,7 @@ class CertificateUpdater:
                 else:
                     GeneralUtilities.write_message_to_stdout(f"Create certificate for domain {domain}")
                 dockerargument = f"run --rm --name {certbot_container_name} --volume {self.__letsencrypt_folder}:/etc/letsencrypt"
-                dockerargument = dockerargument + f" --volume {self.__log_folder}:/var/log/letsencrypt -p 80:80 "+"docker.io/certbot/certbot"#TODO make this replaceable
+                dockerargument = dockerargument + f" --volume {self.__log_folder}:/var/log/letsencrypt -p 80:80 "+self.__certbot_image_address_with_tag
                 certbotargument = f"--standalone --email {self.__email} --agree-tos --force-renewal --rsa-key-size 4096 --non-interactive --no-eff-email --domain {domain}"
                 if (certificate_for_domain_already_exists):
                     self.__sc.run_program("docker", f"{dockerargument} certonly --no-random-sleep-on-renew {certbotargument}", self.__current_folder)
@@ -113,13 +117,6 @@ class CertificateUpdater:
             except Exception as exception:
                 error_occurred = True
                 GeneralUtilities.write_exception_to_stderr_with_traceback(exception, traceback, "Error while updating certificate")
-            finally:
-                enabled=False#disabled because docker run has now the --rm argument
-                if enabled:
-                    try:
-                        self.__sc.run_program("docker", f"container rm {certbot_container_name}", self.__current_folder, throw_exception_if_exitcode_is_not_zero=True)
-                    except Exception as exception:
-                        GeneralUtilities.write_exception_to_stderr_with_traceback(exception, traceback, "Error while removing container")
         self.__sc.git_commit(self.__repository_folder, "Executed certificate-update-process")
         GeneralUtilities.write_message_to_stdout("Finished certificate-update-process")
         if error_occurred:

ScriptCollection/Executables.py

@@ -8,7 +8,6 @@ import keyboard
 from .ScriptCollectionCore import ScriptCollectionCore
 from .GeneralUtilities import GeneralUtilities
 from .SCLog import LogLevel, SCLog
-from .ImageUpdater import ImageUpdater, VersionEcholon
 from .TFCPS.TFCPS_CodeUnit_BuildCodeUnits import TFCPS_CodeUnit_BuildCodeUnits
 from .TFCPS.TFCPS_Tools_General import TFCPS_Tools_General
 
@@ -282,7 +281,7 @@ def BuildCodeUnitsC() -> int:
     parser.add_argument('--ispremerge', required=False, default=False, action='store_true')
     parser.add_argument('--image', required=False, default="scbuilder:latest")
     args = parser.parse_args()
-    GeneralUtilities.reconfigure_standrd_input_and_outputs()
+    GeneralUtilities.reconfigure_standard_input_and_outputs()
     repo:str=GeneralUtilities.resolve_relative_path(args.repositoryfolder,os.getcwd())
     verbosity=LogLevel(int(args.verbosity))
     t:TFCPS_CodeUnit_BuildCodeUnits=TFCPS_CodeUnit_BuildCodeUnits(repo,verbosity,args.targetenvironment,args.additionalargumentsfile,not args.nocache,args.ispremerge) 
@@ -704,66 +703,52 @@ def ConvertGitRepositoryToBareRepository() -> int:
 def OCRAnalysisOfFolder() -> int:
     parser = argparse.ArgumentParser()
     parser.add_argument('-s', '--serviceaddress', required=False, default=None)
-    parser.add_argument('-e', '--extensions', required=False, default=None)
-    parser.add_argument('-l', '--languages', required=False, default="en")
+    parser.add_argument('-e', '--extensions', required=False, default="pdf,docx,jpg,png,xlsx")
+    parser.add_argument('-l', '--languages', required=False, default="eng")
     parser.add_argument('-f', '--folder', required=False, default=None)
+    parser.add_argument('-d', '--datafolder', required=False, default=None)
     args = parser.parse_args()
     sc = ScriptCollectionCore()
     if args.folder is None:
         args.folder = os.getcwd()
-    extensions_value: str = None
-    if args.extensions is not None:
-        if "," in args.extensions:
-            extensions_value = args.extensions.split(",")
-        else:
-            extensions_value = [args.extensions]
-    sc.ocr_analysis_of_folder(args.folder, args.serviceaddress, extensions_value, args.languages)
+    languages=args.languages.split(",")
+    extensions=args.extensions.split(",")
+    sc.ocr_analysis_of_folder(args.folder, args.serviceaddress, extensions, languages,args.datafolder,args.folder,[])
     return 0
 
 
 def OCRAnalysisOfFile() -> int:
     parser = argparse.ArgumentParser()
     parser.add_argument('-s', '--serviceaddress', required=False, default=None)
-    parser.add_argument('-l', '--languages', required=False, default="en")
+    parser.add_argument('-l', '--languages', required=False, default="eng")
     parser.add_argument('-f', '--file', required=True)
+    parser.add_argument('-d', '--datafolder', required=False, default=None)
     args = parser.parse_args()
     sc = ScriptCollectionCore()
-    sc.ocr_analysis_of_file(args.file, args.serviceaddress, args.languages)
+    languages=args.languages.split(",")
+    sc.ocr_analysis_of_file(args.file, args.serviceaddress, languages,args.datafolder,".")
     return 0
 
 
 def OCRAnalysisOfRepository() -> int:
     parser = argparse.ArgumentParser()
     parser.add_argument('-s', '--serviceaddress', required=False, default=None)
-    parser.add_argument('-e', '--extensions', required=False, default=None)
-    parser.add_argument('-l', '--languages', required=False, default="en")
+    parser.add_argument('-e', '--extensions', required=False, default="pdf,docx,jpg,png,xlsx")
+    parser.add_argument('-l', '--languages', required=False, default="eng")
     parser.add_argument('-f', '--folder', required=False, default=None)
+    parser.add_argument('-d', '--datafolder', required=False, default=None)
     args = parser.parse_args()
     sc = ScriptCollectionCore()
     if args.folder is None:
         args.folder = os.getcwd()
-    extensions_value: str = None
-    if args.extensions is not None:
-        if "," in args.extensions:
-            extensions_value = args.extensions.split(",")
-        else:
-            extensions_value = [args.extensions]
-    sc.ocr_analysis_of_repository(args.folder, args.serviceaddress, extensions_value, args.languages)
+    languages=args.languages.split(",")
+    extensions=args.extensions.split(",")
+    sc.ocr_analysis_of_repository(args.folder, args.serviceaddress, extensions, languages,args.datafolder)
     return 0
 
 
 def UpdateImagesInDockerComposeFile() -> int:
-    iu: ImageUpdater = ImageUpdater()
-    parser = argparse.ArgumentParser()
-    parser.add_argument('-f', '--file', required=False, default=None)
-    parser.add_argument('-v', '--versionecholon', required=False, default=VersionEcholon.LatestVersion.name, dest="Possible values are: " + ", ".join([e.name for e in VersionEcholon]))
-    parser.add_argument("-s", "--servicename", required=True, default=None)
-    parser.add_argument("-u", "--updatertype", required=True, default=None)
-    args = parser.parse_args()
-    if args.file is None:
-        args.file = os.path.join(os.getcwd(), "docker-compose.yml")
-    versionecholonTyped = VersionEcholon[args.versionecholon]
-    iu.update_services_in_docker_compose_file(args.file, [args.servicename], versionecholonTyped, args.updatertype)
+    #TODO use OCIImageUpdater
     return 0
 
 
@@ -910,9 +895,22 @@ def AddImageToCustomRegistry()->int:
     parser.add_argument('-p', '--password', required=False,default=None)
     verbosity_values = ", ".join(f"{lvl.value}={lvl.name}" for lvl in LogLevel)
     parser.add_argument('-v', '--verbosity', required=False, default=3, help=f"Sets the loglevel. Possible values: {verbosity_values}")
+    parser.add_argument('-r', '--removeimagelocally', action='store_true', default=False)
     args = parser.parse_args()
     sc:ScriptCollectionCore=ScriptCollectionCore()
     verbosity=int(args.verbosity)
     sc.log.loglevel=LogLevel(verbosity)
-    sc.add_image_to_custom_docker_image_registry(args.remotehub,args.imagenameonremotehub,args.ownregistryaddress,args.imagenameonownregistry,args.tag,args.username,args.password)
+    sc.add_image_to_custom_docker_image_registry(args.remotehub,args.imagenameonremotehub,args.ownregistryaddress,args.imagenameonownregistry,args.tag,args.username,args.password,args.removeimagelocally)
     return 0
+
+def SyncXlfFiles()->int:
+    parser = argparse.ArgumentParser(description="This function syncs the content of xlf-files in a folder. This is useful to keep the content of xlf-files in sync which are used for translations in software projects.")
+    parser.add_argument('-p', '--prefix',  required=True, help="File prefix. Example: 'message' when the files are named 'message.xlf', 'message.fr.xlf', etc.")
+    parser.add_argument('-l', '--languages',  required=True, help="Comma-separated list of languages. Example: 'en,fr,de'")
+    parser.add_argument('-f', '--folder',  required=False)
+    args = parser.parse_args()
+    sc:ScriptCollectionCore=ScriptCollectionCore()
+    languages=str(args.languages).split(",")
+    folder=GeneralUtilities.resolve_relative_path(args.folder, os.getcwd())
+    sc.sync_xlf2_files(args.prefix, languages, folder)
+    return 0

ScriptCollection/GeneralUtilities.py

@@ -235,8 +235,8 @@ class GeneralUtilities:
     @staticmethod
     @check_arguments
     def is_ignored_by_glob_pattern(source_directory:str,path:str, ignored_glob_patterms: list[str]) -> bool:
-        source_directory=source_directory.replace("\\","/")
-        path=path.replace("\\","/")
+        source_directory=GeneralUtilities.normalize_path(source_directory)
+        path=GeneralUtilities.normalize_path(path)
         GeneralUtilities.assert_condition(path.startswith(source_directory), f"Path '{path}' is not located in source directory '{source_directory}'.")
         if ignored_glob_patterms is None:
             return False
@@ -380,7 +380,7 @@ class GeneralUtilities:
 
     @staticmethod
     @check_arguments
-    def reconfigure_standrd_input_and_outputs():
+    def reconfigure_standard_input_and_outputs():
         sys.stdin.reconfigure(encoding='utf-8')
         sys.stderr.reconfigure(encoding='utf-8')
         sys.stdout.reconfigure(encoding='utf-8')
@@ -542,7 +542,7 @@ class GeneralUtilities:
     @staticmethod
     @check_arguments
     def file_ends_with_newline(file: str) -> bool:
-        file=GeneralUtilities.normaliza_path(file)
+        file=GeneralUtilities.normalize_path(file)
         with open(file, "rb") as file_object:
             return GeneralUtilities.ends_with_newline_character(file_object.read())
 
@@ -575,13 +575,13 @@ class GeneralUtilities:
     @staticmethod
     @check_arguments
     def append_line_to_file(file: str, line: str, encoding: str = "utf-8") -> None:
-        file=GeneralUtilities.normaliza_path(file)
+        file=GeneralUtilities.normalize_path(file)
         GeneralUtilities.append_lines_to_file(file, [line], encoding)
 
     @staticmethod
     @check_arguments
     def append_lines_to_file(file: str, lines: list[str], encoding: str = "utf-8") -> None:
-        file=GeneralUtilities.normaliza_path(file)
+        file=GeneralUtilities.normalize_path(file)
         if len(lines) == 0:
             return
         is_first_line = True
@@ -604,7 +604,7 @@ class GeneralUtilities:
     @staticmethod
     @check_arguments
     def append_to_file(file: str, content: str, encoding: str = "utf-8") -> None:
-        file=GeneralUtilities.normaliza_path(file)
+        file=GeneralUtilities.normalize_path(file)
         GeneralUtilities.assert_condition(not "\n" in content, "Appending multiple lines is not allowed. Use append_lines_to_file instead.")
         with open(file, "a", encoding=encoding) as fileObject:
             fileObject.write(content)
@@ -612,14 +612,14 @@ class GeneralUtilities:
     @staticmethod
     @check_arguments
     def ensure_directory_exists(path: str) -> None:
-        path=GeneralUtilities.normaliza_path(path)
+        path=GeneralUtilities.normalize_path(path)
         if not os.path.isdir(path):
             os.makedirs(path)
 
     @staticmethod
     @check_arguments
     def ensure_file_exists(path: str) -> None:
-        path=GeneralUtilities.normaliza_path(path)
+        path=GeneralUtilities.normalize_path(path)
         if (not os.path.isfile(path)):
             with open(path, "a+", encoding="utf-8"):
                 pass
@@ -786,7 +786,7 @@ class GeneralUtilities:
     @staticmethod
     @check_arguments
     def read_binary_from_file(file: str) -> bytes:
-        file=GeneralUtilities.normaliza_path(file)
+        file=GeneralUtilities.normalize_path(file)
         with open(file, "rb") as file_object:
             return file_object.read()
 
@@ -1281,7 +1281,7 @@ class GeneralUtilities:
 
     @staticmethod
     @check_arguments
-    def normaliza_path(path)->str:
+    def normalize_path(path)->str:
         path=str(path)
         if GeneralUtilities.current_system_is_windows():
             path=path.replace("/","\\")

ScriptCollection/OCIImages/AbstractImageHandler.py

@@ -10,7 +10,7 @@ class AbstractImageHandler(ABC):
     
     def _protected_get_credentials_for_registry(self,registry_address:str,username_str:str)->tuple[str,str]:
         """return (username, password) for basic auth.
-        Data will be taken from "~/.scriptcollection/GlobalCache/RegistryCredentials.csv" if available.
+        Data will be taken from "~/.ScriptCollection/GlobalCache/RegistryCredentials.csv" if available.
         If no credentials are available then None will be returned for the missing values."""
         raise NotImplementedError()
     

ScriptCollection/OCIImages/OCIImageManager.py

@@ -2,7 +2,7 @@ import os
 from packaging.version import Version
 from ..GeneralUtilities import GeneralUtilities
 from ..ScriptCollectionCore import ScriptCollectionCore
-from ..ImageUpdater import VersionEcholon
+from ..GeneralUtilities import VersionEcholon
 from .AbstractImageHandler import AbstractImageHandler
 from .ConcreteImageHandlers.ImageHandlerDebianSlim import ImageHandlerDebianSlim
 
@@ -52,30 +52,21 @@ class OCIImageManager:
             result.append(line[0])
         return result
 
-    def custom_registry_is_defined(self,image_name:str)->str: 
+    def custom_registry_is_defined(self,image_name:str)->bool:
         global_docker_image_registries_file=self.get_global_docker_image_registries_file()
         for line in  GeneralUtilities.read_nonempty_lines_from_file(global_docker_image_registries_file)[1:]:
             splitted_line=line.split(";")
             if image_name==splitted_line[0]:
-                GeneralUtilities.assert_condition( GeneralUtilities.string_has_content(splitted_line[1]),f"No registry defined for image {image_name}.")
+                GeneralUtilities.assert_condition(GeneralUtilities.string_has_content(splitted_line[1]),f"No registry defined for image {image_name}.")
                 return True
         return False
 
-    def get_default_tag(self,repository:str,image_name:str,strict_mode:bool)->str:
-        """this functions returns a string like "17.7" or "latest"."""
-        if self.custom_registry_is_defined(image_name):
-            repository_image_definition_file=self.get_repository_image_definition_file(repository)
-            for line in [f.split(";") for f in GeneralUtilities.read_nonempty_lines_from_file(repository_image_definition_file)[1:]]:
-                if image_name==line[0]:
-                    GeneralUtilities.assert_condition( GeneralUtilities.string_has_content(line[2]),f"No default-tag defined for image {image_name}.")
-                    return line[2]
-        else:
-            if strict_mode:
-                raise ValueError(f"No default-tag is defined for image \"{image_name}\".")
-            else:
-                return "latest"
-
-        raise ValueError(f"No registry defined for image \"{image_name}\".")
+    def get_tag_for_image(self,repository:str,image_name:str,strict_mode:bool)->str:
+        repository_image_definition_file=self.get_repository_image_definition_file(repository)
+        for line in [f.split(";") for f in GeneralUtilities.read_nonempty_lines_from_file(repository_image_definition_file)[1:]]:
+            if image_name==line[0]:
+                return line[2]
+        raise ValueError(f"No tag defined for image \"{image_name}\".")
 
     def get_registry_address_for_image(self,repository:str,image_name:str)->str:
         """if image_name==Debian this function returns something like "myregistry.example.com/debian", always without tag."""
@@ -91,11 +82,10 @@ class OCIImageManager:
             for line in [f.split(";") for f in GeneralUtilities.read_nonempty_lines_from_file(repository_image_definition_file)[1:]]:
                 if image_name==line[0]:
                     return line[1]
-
         raise ValueError(f"No registry defined for image \"{image_name}\".")
 
     def get_registry_address_for_image_with_default_tag(self,repository:str,image_name:str,strict_mode:bool=True)->str:
-        return f"{self.get_registry_address_for_image(repository,image_name)}:{self.get_default_tag(repository,image_name,strict_mode)}"
+        return f"{self.get_registry_address_for_image(repository,image_name)}:{self.get_tag_for_image(repository,image_name,strict_mode)}"
 
     def update_default_tag_for_image(self,repository:str,image_name:str,echolon:VersionEcholon,search_in_custom_registry_only_if_available:bool)->None:
         pass#TODO update in ImageDefinition.csv using get_available_versions_of_image_which_are_newer
@@ -116,4 +106,4 @@ class OCIImageManager:
         """registry_address must have one of theese formats: "myregistry.example.com/debian" or "docker.io/debian" or "docker.io/myuser/debian".
         returns something like "13.3-slim".
         If there are multiple tags available for a certain version then the image-handler decides which one will be returned."""
-        return self.get_image_handler(image_name).version_to_tag(image_name,registry_address,version)# 
+        return self.get_image_handler(image_name).version_to_tag(image_name,registry_address,version)