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

ScriptCollection/ScriptCollectionCore.py

@@ -37,7 +37,7 @@ from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 from .SCLog import SCLog, LogLevel
 
-version = "4.0.49"
+version = "4.0.51"
 __version__ = version
 
 
@@ -1833,10 +1833,10 @@ 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) -> tuple[int, str, str, int]:
+    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)
+        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)
 
 
     # </run programs>

ScriptCollection/TFCPS/NodeJS/TFCPS_CodeUnitSpecific_NodeJS.py

@@ -14,13 +14,13 @@ class TFCPS_CodeUnitSpecific_NodeJS_Functions(TFCPS_CodeUnitSpecific_Base):
 
     @GeneralUtilities.check_arguments
     def build(self) -> None:
-        self._protected_sc.run_with_epew("npm", "run build", self.get_codeunit_folder())
+        self._protected_sc.run_with_epew("npm", "run build", self.get_codeunit_folder(),print_live_output=self._protected_sc.log.loglevel==LogLevel.Diagnostic)
         self.standardized_tasks_build_bom_for_node_project()
         self.copy_source_files_to_output_directory()
 
     @GeneralUtilities.check_arguments
     def linting(self) -> None:
-        self._protected_sc.run_with_epew("npm", "run lint", self.get_codeunit_folder())
+        self._protected_sc.run_with_epew("npm", "run lint", self.get_codeunit_folder(),print_live_output=self._protected_sc.log.loglevel==LogLevel.Diagnostic)
 
     @GeneralUtilities.check_arguments
     def do_common_tasks(self,current_codeunit_version:str)-> None:
@@ -50,7 +50,7 @@ class TFCPS_CodeUnitSpecific_NodeJS_Functions(TFCPS_CodeUnitSpecific_Base):
         repository_folder = os.path.dirname(codeunit_folder)
 
         # run testcases
-        self._protected_sc.run_with_epew("npm", f"run test-{self.get_target_environment_type()}", self.get_codeunit_folder())
+        self._protected_sc.run_with_epew("npm", f"run test-{self.get_target_environment_type()}", self.get_codeunit_folder(),print_live_output=self._protected_sc.log.loglevel==LogLevel.Diagnostic)
 
         # rename file
         coverage_folder = os.path.join(codeunit_folder, "Other", "Artifacts", "TestCoverage")
@@ -107,9 +107,9 @@ class TFCPS_CodeUnitSpecific_NodeJS_Functions(TFCPS_CodeUnitSpecific_Base):
 
 
     @GeneralUtilities.check_arguments 
-    def standardized_tasks_build_bom_for_node_project(self) -> None:        
+    def standardized_tasks_build_bom_for_node_project(self) -> None:
         relative_path_to_bom_file = f"Other/Artifacts/BOM/{os.path.basename(self.get_codeunit_folder())}.{self.tfcps_Tools_General.get_version_of_codeunit(self.get_codeunit_file())}.sbom.xml"
-        self._protected_sc.run_with_epew("cyclonedx-npm", f"--output-format xml --output-file {relative_path_to_bom_file}", self.get_codeunit_folder())
+        self._protected_sc.run_with_epew("cyclonedx-npm", f"--output-format xml --output-file {relative_path_to_bom_file}", self.get_codeunit_folder(),print_live_output=self._protected_sc.log.loglevel==LogLevel.Diagnostic)
         self._protected_sc.format_xml_file(self.get_codeunit_folder()+"/"+relative_path_to_bom_file)
 
 class TFCPS_CodeUnitSpecific_NodeJS_CLI:

ScriptCollection/TFCPS/TFCPS_CodeUnitSpecific_Base.py

@@ -180,13 +180,6 @@ class TFCPS_CodeUnitSpecific_Base(ABC):
         # set default constants
         self.tfcps_Tools_General.set_default_constants(os.path.join(codeunit_folder))
 
-        # Copy changelog-file
-        changelog_folder = os.path.join(repository_folder, "Other", "Resources", "Changelog")
-        changelog_file = os.path.join(changelog_folder, f"v{project_version}.md")
-        target_folder = os.path.join(codeunit_folder, "Other", "Artifacts", "Changelog")
-        GeneralUtilities.ensure_directory_exists(target_folder)
-        shutil.copy(changelog_file, target_folder)
-
         # Hints-file
         hints_file = os.path.join(codeunit_folder, "Other", "Reference", "ReferenceContent", "Hints.md")
         if not os.path.isfile(hints_file):

ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnits.py

@@ -86,14 +86,14 @@ class TFCPS_CodeUnit_BuildCodeUnits:
             tFCPS_CodeUnit_BuildCodeUnit.build_codeunit()
 
         #TODO run static code analysis tool to search for vulnerabilities
-        self.__search_for_secrets()
+        #TODO self.__search_for_secrets()
         self.__save_lines_of_code(self.repository,self.tFCPS_Other.get_version_of_project(self.repository))
 
         self.sc.log.log(GeneralUtilities.get_line())
         self.sc.log.log("Finished building codeunits.")
         self.sc.log.log(GeneralUtilities.get_line())
 
-    def __search_for_secrets(self):
+    def __search_for_secrets(self):#pylint:disable=unused-private-member
         exe_paths=self.tFCPS_Other.ensure_trufflehog_is_available()
         exe_path:str=None
         if GeneralUtilities.current_system_is_windows():

ScriptCollection/TFCPS/TFCPS_Tools_General.py

@@ -1211,3 +1211,55 @@ class TFCPS_Tools_General:
         GeneralUtilities.ensure_directory_does_not_exist(trg_folder)
         GeneralUtilities.ensure_directory_exists(trg_folder)
         GeneralUtilities.copy_content_of_folder(src_folder, trg_folder)
+        
+    @GeneralUtilities.check_arguments
+    def start_dockerfile_example(self, current_file: str,remove_old_container: bool, remove_volumes_folder: bool, env_file: str) -> None:
+        folder = os.path.dirname(current_file)
+        example_name = os.path.basename(folder)
+        oci_image_artifacts_folder = GeneralUtilities.resolve_relative_path("../../../../Artifacts/BuildResult_OCIImage", folder)
+        image_filename = os.path.basename(self.__sc.find_file_by_extension(oci_image_artifacts_folder, "tar"))
+        codeunit_name = os.path.basename(GeneralUtilities.resolve_relative_path("../../../../..", folder))
+        if remove_old_container:
+            docker_compose_file = f"{folder}/docker-compose.yml"
+            container_names = []
+            lines = GeneralUtilities.read_lines_from_file(docker_compose_file)
+            for line in lines:
+                if match := re.search("container_name:\\s*'?([^']+)'?", line):
+                    container_names.append(match.group(1))
+            self.__sc.log.log(f"Ensure container of {docker_compose_file} do not exist...")
+            for container_name in container_names:
+                self.__sc.log.log(f"Ensure container {container_name} does not exist...")
+                self.__sc.run_program("docker", f"container rm -f {container_name}", oci_image_artifacts_folder, throw_exception_if_exitcode_is_not_zero=False)
+        if remove_volumes_folder:
+            volumes_folder = os.path.join(folder, "Volumes")
+            self.__sc.log.log(f"Ensure volumes-folder '{volumes_folder}' does not exist...")
+            GeneralUtilities.ensure_directory_does_not_exist(volumes_folder)
+            GeneralUtilities.ensure_directory_exists(volumes_folder)
+        self.__sc.log.log("Load docker-image...")
+        self.__sc.run_program("docker", f"load -i {image_filename}", oci_image_artifacts_folder)
+        docker_project_name = f"{codeunit_name}_{example_name}".lower()
+        self.__sc.log.log("Start docker-container...")
+        argument = f"compose --project-name {docker_project_name}"
+        if env_file is not None:
+            argument = f"{argument} --env-file {env_file}"
+        argument = f"{argument} up --detach"
+        self.__sc.run_program("docker", argument, folder)
+
+    @GeneralUtilities.check_arguments
+    def ensure_env_file_is_generated(self, current_file: str, env_file_name: str, env_values: dict[str, str]):
+        folder = os.path.dirname(current_file)
+        env_file = os.path.join(folder, env_file_name)
+        if not os.path.isfile(env_file):
+            lines = []
+            for key, value in env_values.items():
+                lines.append(f"{key}={value}")
+            GeneralUtilities.write_lines_to_file(env_file, lines)
+
+    @GeneralUtilities.check_arguments
+    def stop_dockerfile_example(self, current_file: str, remove_old_container: bool, remove_volumes_folder: bool) -> None:
+        folder = os.path.dirname(current_file)
+        example_name = os.path.basename(folder)
+        codeunit_name = os.path.basename(GeneralUtilities.resolve_relative_path("../../../../..", folder))
+        docker_project_name = f"{codeunit_name}_{example_name}".lower()
+        self.__sc.log.log("Stop docker-container...")
+        self.__sc.run_program("docker", f"compose --project-name {docker_project_name} down", folder)

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

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

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

@@ -9,18 +9,18 @@ ScriptCollection/ProgramRunnerEpew.py,sha256=TJdDx9zIMSiCaXh8X-ekrMlbXfGtmd0Mmyx
 ScriptCollection/ProgramRunnerMock.py,sha256=uTu-aFle1W_oKjeQEmuPsFPQpvo0kRf2FrRjAPIwT5Y,37
 ScriptCollection/ProgramRunnerPopen.py,sha256=BPY7-ZMIlqT7JOKz8qlB5c0laF2Js-ijzqk09GxZC48,3821
 ScriptCollection/SCLog.py,sha256=dxGOI4E9lG5v9jk_LajXCkM5nghliCDV8YB8Ihn160s,4541
-ScriptCollection/ScriptCollectionCore.py,sha256=myrHEN83GP6Is8_b-TN0tQfOXYKLkv7DNfEEfvA5ET0,142113
+ScriptCollection/ScriptCollectionCore.py,sha256=n-QprUwKp_hE2W9jPHzktCEDurVVcvkH4Sz8EIcyV0M,142178
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ScriptCollection/TFCPS/TFCPS_CodeUnitSpecific_Base.py,sha256=2Ng-GyKWQ6FfTUmogd7g-xF6_XeTMxvkeJddagxFR5o,25853
+ScriptCollection/TFCPS/TFCPS_CodeUnitSpecific_Base.py,sha256=H9ampfCfJ4-ohN33VkYWTKwYaTV-y3AelZAiTduwHzw,25442
 ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnit.py,sha256=4rYKgTAga11NiDx8YUqz3K_Q4eX_n3kC6lvNdXEa24s,7389
-ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnits.py,sha256=EH5yV33emYfbYqdikrPgW9UdF7UYV6rpBS1JGHNxA6M,7483
+ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnits.py,sha256=f9oGnopuzn3iDHC1AksU7Qr60LbDe0eLjYeXGiDPhAk,7526
 ScriptCollection/TFCPS/TFCPS_CreateRelease.py,sha256=bcJlfI062Eoq7MOIhun-_iNG7SdO1ZIuC_cylaoLI1s,6332
 ScriptCollection/TFCPS/TFCPS_Generic.py,sha256=O-0guM_LJCcZmPZJhMgTvXD2RXUJEBWWv6Bt6hDFhvM,1943
 ScriptCollection/TFCPS/TFCPS_MergeToMain.py,sha256=41g219jaBRZ2VQCrWM4-Trvervrt8b5oATPwIIGNpag,7244
 ScriptCollection/TFCPS/TFCPS_MergeToStable.py,sha256=ifB1K6A903vvfH0LvtiFbZgYSgR94thfEI-jjf40LpU,21653
 ScriptCollection/TFCPS/TFCPS_PreBuildCodeunitsScript.py,sha256=CxdwUklhZVuJGp0vcokoH_KMXFzmlUlZwj77xFYijho,2242
 ScriptCollection/TFCPS/TFCPS_Tools_Dependencies.py,sha256=o7HI3ki3WWqlAiUsrh3Lky_w6UhYh9hdjYPGOhubQGA,414
-ScriptCollection/TFCPS/TFCPS_Tools_General.py,sha256=R4LxdLLl1lVEr2aWsxi92FylpiS6CZKMPChi0Ty2XH4,76571
+ScriptCollection/TFCPS/TFCPS_Tools_General.py,sha256=nIOEeZ3UWzzD5S7RkMnJedDV8oHlPMaCc_2qPH1YxBY,79912
 ScriptCollection/TFCPS/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ScriptCollection/TFCPS/Docker/TFCPS_CodeUnitSpecific_Docker.py,sha256=ylPvcdiN7RuqXpM-3uNqs40v1kyhaC0guV4JA2pIt_M,5234
 ScriptCollection/TFCPS/Docker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -31,12 +31,12 @@ ScriptCollection/TFCPS/DotNet/TFCPS_CodeUnitSpecific_DotNet.py,sha256=ufeWuqtNOP
 ScriptCollection/TFCPS/DotNet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ScriptCollection/TFCPS/Flutter/TFCPS_CodeUnitSpecific_Flutter.py,sha256=TIR95f6TVOnW25ieX9q4RUi1FogbYEfrlZOcZ1aE014,6969
 ScriptCollection/TFCPS/Flutter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ScriptCollection/TFCPS/NodeJS/TFCPS_CodeUnitSpecific_NodeJS.py,sha256=dnuDlQXThFmhe6EbUAWmGhx7AAYGL0lVUqsrhOgtmC8,6255
+ScriptCollection/TFCPS/NodeJS/TFCPS_CodeUnitSpecific_NodeJS.py,sha256=e2bvR_zzArIJcjDLixMOI7ItUQTNuK1zPb4v4sknihg,6531
 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.49.dist-info/METADATA,sha256=hOgBoSuHOVM_45XUcdWZTIBpgqym-h8eiOjVkoSwp2U,7688
-scriptcollection-4.0.49.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-scriptcollection-4.0.49.dist-info/entry_points.txt,sha256=_izhaQEyHiyBIfM2zTYDaJ7qvgsP1WntkVChFnkWymE,4431
-scriptcollection-4.0.49.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-scriptcollection-4.0.49.dist-info/RECORD,,
+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,,