ScriptCollection 3.5.65__py3-none-any.whl → 3.5.67__py3-none-any.whl

ScriptCollection/Executables.py

@@ -553,7 +553,15 @@ def ListFolderContent() -> int:
     # TODO add option to also list transitively list subfolder
     # TODO add option to print only folder
     # TODO add option to print only files
-    return 1
+    parser = argparse.ArgumentParser(description="This function lists folder-content.")
+    parser.add_argument('-p', '--path', required=True)
+    args=parser.parse_args()
+    folder=args.path
+    if not os.path.isabs(folder):
+        folder=GeneralUtilities.resolve_relative_path(folder,os.getcwd())
+    for file in GeneralUtilities.get_direct_files_of_folder(folder):
+        GeneralUtilities.write_message_to_stdout(file)
+    return 0
 
 
 def ForEach() -> int:

ScriptCollection/GeneralUtilities.py

@@ -930,13 +930,14 @@ class GeneralUtilities:
         enabled = True
         while enabled:
             try:
-                action()
-                return
+                result=action()
+                return result
             except Exception:
                 amount_of_fails = amount_of_fails+1
                 GeneralUtilities.assert_condition(not (amount_of_attempts < amount_of_fails))
                 if amount_of_fails == amount_of_attempts:
                     raise
+        return None
 
     @staticmethod
     @check_arguments

ScriptCollection/ScriptCollectionCore.py

@@ -16,6 +16,7 @@ from pathlib import Path
 from subprocess import Popen
 import re
 import shutil
+from typing import IO
 import uuid
 import tempfile
 import io
@@ -31,7 +32,7 @@ from .ProgramRunnerBase import ProgramRunnerBase
 from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 
-version = "3.5.65"
+version = "3.5.67"
 __version__ = version
 
 
@@ -617,6 +618,21 @@ class ScriptCollectionCore:
         for renamed_item, original_name in renamed_items.items():
             os.rename(renamed_item, original_name)
 
+    @GeneralUtilities.check_arguments
+    def list_files(self, path: str) -> list[str]:
+        if self.program_runner.will_be_executed_locally():
+            return GeneralUtilities.get_direct_files_of_folder(path)
+        else:
+            exit_code, stdout, stderr, _ = self.run_program_argsasarray("scfileexists", ["--path", path])
+            if exit_code == 0:
+                result:list[str]=[]
+                for line in stdout.split("\n"):
+                    normalized_line=line.replace("\r","")
+                    result.append(normalized_line)
+                return result
+            else:
+                raise ValueError(f"Fatal error occurrs while checking whether file '{path}' exists. StdErr: '{stderr}'")
+
     @GeneralUtilities.check_arguments
     def is_file(self, path: str) -> bool:
         if self.program_runner.will_be_executed_locally():
@@ -1277,7 +1293,7 @@ class ScriptCollectionCore:
         return popen
 
     @staticmethod
-    def __enqueue_output(file, queue):
+    def __enqueue_output(file:IO, queue:Queue):
         for line in iter(file.readline, ''):
             queue.put(line)
         file.close()
@@ -1432,6 +1448,11 @@ class ScriptCollectionCore:
         except Exception as e:
             raise e
 
+    # Return-values program_runner: Exitcode, StdOut, StdErr, Pid
+    @GeneralUtilities.check_arguments
+    def run_program_with_retry(self, program: str, arguments:  str = "", working_directory: str = None, verbosity: int = 1, 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,amount_of_attempts:int=5) -> tuple[int, str, str, int]:
+        return GeneralUtilities.retry_action(lambda: self.run_program(program, arguments,working_directory,verbosity,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), amount_of_attempts)
+
     # Return-values program_runner: Exitcode, StdOut, StdErr, Pid
     @GeneralUtilities.check_arguments
     def run_program(self, program: str, arguments:  str = "", working_directory: str = None, verbosity: int = 1, 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]:
@@ -1730,7 +1751,7 @@ DNS                 = {domain}
         folder = os.path.dirname(csproj_file)
         csproj_filename = os.path.basename(csproj_file)
         GeneralUtilities.write_message_to_stderr(f"Check for updates in {csproj_filename}")
-        result = self.run_program("dotnet", f"list {csproj_filename} package --outdated", folder)
+        result = self.run_program_with_retry("dotnet", f"list {csproj_filename} package --outdated", folder)
         for line in result[1].replace("\r", "").split("\n"):
             # Relevant output-lines are something like "    > NJsonSchema             10.7.0        10.7.0      10.9.0"
             if ">" in line:

ScriptCollection/TasksForCommonProjectStructure.py

@@ -1015,11 +1015,12 @@ class TasksForCommonProjectStructure:
 
     @GeneralUtilities.check_arguments
     def __standardized_tasks_release_artifact(self, information: CreateReleaseInformationForProjectInCommonProjectFormat) -> None:
+        GeneralUtilities.write_message_to_stdout("Release artifacts...")
         project_version = self.__sc.get_semver_version_from_gitversion(information.repository)
         target_folder_base = os.path.join(information.artifacts_folder, information.projectname, project_version)
         GeneralUtilities.ensure_directory_exists(target_folder_base)
 
-        self.build_codeunits(information.repository, information.verbosity, information.target_environmenttype_for_productive, information.additional_arguments_file, False, information.export_target, [], True)
+        self.build_codeunits(information.repository, information.verbosity, information.target_environmenttype_for_productive, information.additional_arguments_file, False, information.export_target, [], True, "Productive build")
 
         reference_folder = os.path.join(information.reference_repository, "ReferenceContent")
 
@@ -1243,6 +1244,7 @@ class TasksForCommonProjectStructure:
     def merge_to_main_branch(self, repository_folder: str, source_branch: str = "other/next-release", target_branch: str = "main", verbosity: int = 1, additional_arguments_file: str = None, fast_forward_source_branch: bool = False) -> None:
         # This is an automatization for automatic merges. Usual this merge would be done by a pull request in a sourcecode-version-control-platform
         # (like GitHub, GitLab or Azure DevOps)
+        GeneralUtilities.write_message_to_stdout(f"Merge to main-branch...")
         self.__sc.assert_is_git_repository(repository_folder)
         self.assert_no_uncommitted_changes(repository_folder)
 
@@ -1251,7 +1253,7 @@ class TasksForCommonProjectStructure:
             raise ValueError(f"Can not merge because the source-branch and the target-branch are on the same commit (commit-id: {src_branch_commit_id})")
 
         self.__sc.git_checkout(repository_folder, source_branch)
-        self.build_codeunits(repository_folder, verbosity, TasksForCommonProjectStructure.get_qualitycheck_environment_name(), additional_arguments_file, True, None, [], True)
+        self.build_codeunits(repository_folder, verbosity, TasksForCommonProjectStructure.get_qualitycheck_environment_name(), additional_arguments_file, True, None, [], True, "Check if product is buildable")
         self.__sc.git_merge(repository_folder, source_branch, target_branch, False, False, None)
         self.__sc.git_commit(repository_folder, f'Merge branch {source_branch} into {target_branch}', stage_all_changes=True, no_changes_behavior=1)
         self.__sc.git_checkout(repository_folder, target_branch)
@@ -1262,6 +1264,7 @@ class TasksForCommonProjectStructure:
     def merge_to_stable_branch(self, create_release_file: str, createRelease_configuration: CreateReleaseConfiguration):
 
         GeneralUtilities.write_message_to_stdout(f"Create release for project {createRelease_configuration.projectname}.")
+        GeneralUtilities.write_message_to_stdout(f"Merge to stable-branch...")
         self.__sc.assert_is_git_repository(createRelease_configuration.repository_folder)
         folder_of_create_release_file_file = os.path.abspath(os.path.dirname(create_release_file))
 
@@ -1312,7 +1315,7 @@ class TasksForCommonProjectStructure:
         self.__sc.run_program("git", "clean -dfx", information.repository,  verbosity=information.verbosity, throw_exception_if_exitcode_is_not_zero=True)
         project_version = self.__sc.get_semver_version_from_gitversion(information.repository)
 
-        self.build_codeunits(information.repository, information.verbosity, information.target_environmenttype_for_qualitycheck, information.additional_arguments_file, False, information.export_target, [], True)
+        self.build_codeunits(information.repository, information.verbosity, information.target_environmenttype_for_qualitycheck, information.additional_arguments_file, False, information.export_target, [], True, "Productive build")
 
         self.assert_no_uncommitted_changes(information.repository)
 
@@ -2430,7 +2433,7 @@ class TasksForCommonProjectStructure:
         self.__sc.run_program("docker", f"run --volume {repository_folder}:/Workspace/Repository " + f"-e repositoryfolder=/Workspace/Repository -e verbosity={verbosity} -e targetenvironment={target_environmenttype} {image}", repository_folder)
 
     @GeneralUtilities.check_arguments
-    def build_codeunits(self, repository_folder: str, verbosity: int = 1, target_environmenttype: str = "QualityCheck", additional_arguments_file: str = None, is_pre_merge: bool = False, export_target_directory: str = None, commandline_arguments: list[str] = [], do_git_clean_when_no_changes: bool = False) -> None:
+    def build_codeunits(self, repository_folder: str, verbosity: int = 1, target_environmenttype: str = "QualityCheck", additional_arguments_file: str = None, is_pre_merge: bool = False, export_target_directory: str = None, commandline_arguments: list[str] = [], do_git_clean_when_no_changes: bool = False, note: str = None) -> None:
         self.__check_target_environmenttype(target_environmenttype)
         self.__sc.assert_is_git_repository(repository_folder)
         repository_folder = GeneralUtilities.resolve_relative_path_from_current_working_directory(repository_folder)
@@ -2438,10 +2441,13 @@ class TasksForCommonProjectStructure:
         self.build_specific_codeunits(repository_folder, codeunits, verbosity, target_environmenttype, additional_arguments_file, is_pre_merge, export_target_directory, False, commandline_arguments, do_git_clean_when_no_changes)
 
     @GeneralUtilities.check_arguments
-    def build_specific_codeunits(self, repository_folder: str, codeunits: list[str], verbosity: int = 1, target_environmenttype: str = "QualityCheck", additional_arguments_file: str = None, is_pre_merge: bool = False, export_target_directory: str = None, assume_dependent_codeunits_are_already_built: bool = True, commandline_arguments: list[str] = [], do_git_clean_when_no_changes: bool = False) -> None:
+    def build_specific_codeunits(self, repository_folder: str, codeunits: list[str], verbosity: int = 1, target_environmenttype: str = "QualityCheck", additional_arguments_file: str = None, is_pre_merge: bool = False, export_target_directory: str = None, assume_dependent_codeunits_are_already_built: bool = True, commandline_arguments: list[str] = [], do_git_clean_when_no_changes: bool = False, note: str = None) -> None:
+        if verbosity>2:
+            GeneralUtilities.write_message_to_stdout(f"Start building codeunits for repository '{repository_folder}'...")
         self.__sc.assert_is_git_repository(repository_folder)
         self.__check_target_environmenttype(target_environmenttype)
         repository_folder = GeneralUtilities.resolve_relative_path_from_current_working_directory(repository_folder)
+        repository_name = os.path.dirname(repository_folder)
         contains_uncommitted_changes_at_begin = self.__sc.git_repository_has_uncommitted_changes(repository_folder)
         if contains_uncommitted_changes_at_begin:
             if is_pre_merge:
@@ -2470,6 +2476,11 @@ class TasksForCommonProjectStructure:
         project_version = self.get_version_of_project(repository_folder)
 
         now = datetime.now()
+        message = f"Build codeunits in product {repository_name}..."
+        if note is not None:
+            message = f"{message} ({note})"
+        GeneralUtilities.write_message_to_stdout(message)
+
         if not self.__suport_information_exists(repository_folder, project_version):
             support_time = timedelta(days=365*2+30*3+1)  # TODO make this configurable
             until = now + support_time
@@ -2514,6 +2525,11 @@ class TasksForCommonProjectStructure:
                 archive_file = os.path.join(os.getcwd(), f"{filename_without_extension}.zip")
                 shutil.move(archive_file, target_folder)
 
+        message2 = f"Finished build codeunits in product {repository_name}."
+        if note is not None:
+            message2 = f"{message2} ({note})"
+        GeneralUtilities.write_message_to_stdout(message2)
+
     @GeneralUtilities.check_arguments
     def __do_repository_checks(self, repository_folder: str, project_version: str) -> None:
         self.__sc.assert_is_git_repository(repository_folder)
@@ -2869,11 +2885,11 @@ class TasksForCommonProjectStructure:
     @GeneralUtilities.check_arguments
     def generic_update_dependencies(self, repository_folder: str, verbosity: int = 1):
         # Prepare
+        GeneralUtilities.write_message_to_stdout("Update dependencies...")
         self.__sc.assert_is_git_repository(repository_folder)
         codeunits = self.get_codeunits(repository_folder)
-        updated_dependencies = False
         update_dependencies_script_filename = "UpdateDependencies.py"
-        self.build_codeunits(repository_folder, target_environmenttype="QualityCheck", do_git_clean_when_no_changes=True)  # Required because update dependencies is not always possible for not-buildet codeunits (depends on the programming language or package manager)
+        self.build_codeunits(repository_folder, target_environmenttype="QualityCheck", do_git_clean_when_no_changes=True, note="Prepare dependency-update")  # Required because update dependencies is not always possible for not-buildet codeunits (depends on the programming language or package manager)
 
         # update dependencies of resources
         global_scripts_folder = os.path.join(repository_folder, "Other", "Scripts")
@@ -2890,7 +2906,6 @@ class TasksForCommonProjectStructure:
                 GeneralUtilities.ensure_directory_exists(os.path.join(update_dependencies_script_folder, "Resources", "CodeAnalysisResult"))
                 self.__sc.run_program("python", update_dependencies_script_filename, update_dependencies_script_folder, verbosity)
                 if self.__sc.git_repository_has_uncommitted_changes(repository_folder):
-                    updated_dependencies = True
                     version_of_project = self.get_version_of_project(repository_folder)
                     changelog_file = os.path.join(repository_folder, "Other", "Resources", "Changelog", f"v{version_of_project}.md")
                     if not os.path.isfile(changelog_file):
@@ -2903,9 +2918,8 @@ class TasksForCommonProjectStructure:
                         GeneralUtilities.write_message_to_stdout(f"Updated dependencies in codeunit {codeunit}.")
                 else:
                     GeneralUtilities.write_message_to_stdout(f"There are no dependencies to update in codeunit {codeunit}.")
-        if updated_dependencies:
-            self.build_codeunits(repository_folder, target_environmenttype="QualityCheck", do_git_clean_when_no_changes=True)
-            self.__sc.git_commit(repository_folder, "Updated dependencies")
+        self.build_codeunits(repository_folder, target_environmenttype="QualityCheck", do_git_clean_when_no_changes=True, note="Check if product is buildable after dependency-update")
+        self.__sc.git_commit(repository_folder, "Updated dependencies")
 
     class GenericPrepareNewReleaseArguments:
         current_file: str
@@ -2932,8 +2946,8 @@ class TasksForCommonProjectStructure:
         self.__sc.assert_is_git_repository(reference_folder)
         verbosity: int = TasksForCommonProjectStructure.get_verbosity_from_commandline_arguments(generic_prepare_new_release_arguments.commandline_arguments, 1)
 
-        merge_source_branch = "other/next-release"  # TODO make this configurable
-        main_branch = "main"  # TODO make this configurable
+        merge_source_branch = "other/next-release"  # maybe this should be configurable
+        main_branch = "main"  # maybe this should be configurable
 
         # prepare
         self.assert_no_uncommitted_changes(repository_folder)
@@ -2946,6 +2960,7 @@ class TasksForCommonProjectStructure:
             self.generic_update_dependencies(repository_folder)
             self.assert_no_uncommitted_changes(repository_folder)
 
+        GeneralUtilities.write_message_to_stdout(f"Check reference-repository...")
         now = datetime.now()
         for unsupported_version in self.get_unsupported_versions(repository_folder, now):
             reference_folder = f"{reference_folder}/ReferenceContent/v{unsupported_version}"
@@ -2959,6 +2974,8 @@ class TasksForCommonProjectStructure:
         else:
             self.merge_to_main_branch(repository_folder, merge_source_branch, verbosity=verbosity, fast_forward_source_branch=True)
             self.__sc.git_commit(build_repository_folder, "Updated submodule due to merge to main-branch.")
+        GeneralUtilities.write_message_to_stdout(f"Finished prepare release for {generic_prepare_new_release_arguments.product_name}.")
+
 
     class GenericCreateReleaseArguments():
         current_file: str
@@ -3003,6 +3020,7 @@ class TasksForCommonProjectStructure:
 
             # create release
             new_version = self.merge_to_stable_branch(generic_create_release_arguments.current_file, createReleaseConfiguration)
+            GeneralUtilities.write_message_to_stdout(f"Finished create release for {generic_create_release_arguments.product_name}.")
             return True, new_version
 
     class UpdateHTTPDocumentationArguments:

{ScriptCollection-3.5.65.dist-info → ScriptCollection-3.5.67.dist-info}/METADATA

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

{ScriptCollection-3.5.65.dist-info → ScriptCollection-3.5.67.dist-info}/RECORD

@@ -1,16 +1,16 @@
-ScriptCollection/Executables.py,sha256=kON_jatJe84iCJj60uUjA-Aj0ytERRe0FUDWbOWUe6s,28089
-ScriptCollection/GeneralUtilities.py,sha256=Ah-quoBRLNO3iTCfZaAlN0fhOC42b-UEGYRMW_XxgO0,39438
+ScriptCollection/Executables.py,sha256=jGJIVEjRuOEpcC6ZvCny22DgHZPtr4pmKZj6b-Zn-fA,28514
+ScriptCollection/GeneralUtilities.py,sha256=WSBawT958x_0H-hnPg3S3DGzP3KOQTADtZtP145I-M4,39473
 ScriptCollection/ProcessesRunner.py,sha256=3mu4ZxzZleQo0Op6o9EYTCFiJfb6kx5ov2YfZfT89mU,1395
 ScriptCollection/ProgramRunnerBase.py,sha256=2kMIAqdc65UjBAddOZkzy_aFx9h5roZ5a4bQNM6RV6Y,2480
 ScriptCollection/ProgramRunnerEpew.py,sha256=4pjEd0r9Fcz3TTDv0MdTSd5KkigYXcWUVI1X43regfU,6477
 ScriptCollection/ProgramRunnerPopen.py,sha256=BPY7-ZMIlqT7JOKz8qlB5c0laF2Js-ijzqk09GxZC48,3821
 ScriptCollection/RPStream.py,sha256=NRRHL3YSP3D9MuAV2jB_--0KUKCsvJGxeKnxgrRZ9kY,1545
-ScriptCollection/ScriptCollectionCore.py,sha256=NrBHbyNrj604n0TxVMeDiFUjy4lprLU4OUskTJOKgJo,111855
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=xwEhBfIbrRCMxbklBsQnxnuJ07UQgqYy_fjcv-QXJeQ,213628
+ScriptCollection/ScriptCollectionCore.py,sha256=Gjr-4UES3iYDUuYoBTN8XIaLbuzTq4FyMD_6cuOseAY,113595
+ScriptCollection/TasksForCommonProjectStructure.py,sha256=F6e045gUvSxpOcHk61OVnlod_Zn9JSNXrv6I2SzWoVc,214997
 ScriptCollection/UpdateCertificates.py,sha256=Eynbgu7k9jLxApP2D_8Il77B6BFjJap6K7oTeEAZYbk,7790
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ScriptCollection-3.5.65.dist-info/METADATA,sha256=Jqom1sT8VzQZYDWskp7RYVonlTfNhzVcdu3dLahv4Cs,7664
-ScriptCollection-3.5.65.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-ScriptCollection-3.5.65.dist-info/entry_points.txt,sha256=wspYVXWH8kon-wRQTAFEO11JoLJ0fEnOIG7tE7R-xtQ,3502
-ScriptCollection-3.5.65.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-ScriptCollection-3.5.65.dist-info/RECORD,,
+ScriptCollection-3.5.67.dist-info/METADATA,sha256=jSXXQC_Q1zoKYsvPm38722Tok5dvc3a7dtulFS9j9Uk,7664
+ScriptCollection-3.5.67.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+ScriptCollection-3.5.67.dist-info/entry_points.txt,sha256=wspYVXWH8kon-wRQTAFEO11JoLJ0fEnOIG7tE7R-xtQ,3502
+ScriptCollection-3.5.67.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+ScriptCollection-3.5.67.dist-info/RECORD,,