ScriptCollection 3.5.98__py3-none-any.whl → 3.5.100__py3-none-any.whl

ScriptCollection/GeneralUtilities.py

@@ -952,6 +952,7 @@ class GeneralUtilities:
     @staticmethod
     @check_arguments
     def replace_variable_in_string(input_string: str, variable_name: str, variable_value: str) -> None:
+        GeneralUtilities.assert_condition(not "__" in variable_name, f"'{variable_name}' is an invalid variable name because it contains '__' which is treated as control-sequence.")
         return input_string.replace(f"__[{variable_name}]__", variable_value)
 
     @staticmethod

ScriptCollection/ScriptCollectionCore.py

@@ -33,7 +33,7 @@ from .ProgramRunnerBase import ProgramRunnerBase
 from .ProgramRunnerPopen import ProgramRunnerPopen
 from .ProgramRunnerEpew import ProgramRunnerEpew, CustomEpewArgument
 
-version = "3.5.98"
+version = "3.5.100"
 __version__ = version
 
 

ScriptCollection/TasksForCommonProjectStructure.py

@@ -875,6 +875,10 @@ class TasksForCommonProjectStructure:
         content = re.sub("filename=\"([^\"]+)\"", lambda match: self.__standardized_tasks_run_testcases_for_dotnet_project_helper(source_base_path_in_coverage_file, codeunit_folder, match), content)
         GeneralUtilities.write_text_to_file(target_file, content)
         self.run_testcases_common_post_task(repository_folder, codeunit_name, verbosity, generate_badges, targetenvironmenttype, commandline_arguments)
+        artifacts_folder = os.path.join(repository_folder, codeunit_name, "Other", "Artifacts")
+        for subfolder in GeneralUtilities.get_direct_folders_of_folder(artifacts_folder):
+            if os.path.basename(subfolder).startswith("BuildResultTests_DotNet_"):
+                GeneralUtilities.ensure_directory_does_not_exist(subfolder)
 
     @GeneralUtilities.check_arguments
     def run_testcases_common_post_task(self, repository_folder: str, codeunit_name: str, verbosity: int, generate_badges: bool, targetenvironmenttype: str, commandline_arguments: list[str]) -> None:
@@ -1486,7 +1490,7 @@ class TasksForCommonProjectStructure:
     @GeneralUtilities.check_arguments
     def standardized_tasks_do_common_tasks(self, common_tasks_scripts_file: str, codeunit_version: str, verbosity: int,  targetenvironmenttype: str,  clear_artifacts_folder: bool, additional_arguments_file: str, assume_dependent_codeunits_are_already_built: bool, commandline_arguments: list[str]) -> None:
         additional_arguments_file = self.get_additionalargumentsfile_from_commandline_arguments(commandline_arguments, additional_arguments_file)
-        target_environmenttype = self.get_targetenvironmenttype_from_commandline_arguments(commandline_arguments, targetenvironmenttype)#pylint: disable=unused-variable
+        target_environmenttype = self.get_targetenvironmenttype_from_commandline_arguments(commandline_arguments, targetenvironmenttype)  # pylint: disable=unused-variable
         # assume_dependent_codeunits_are_already_built = self.get_assume_dependent_codeunits_are_already_built_from_commandline_arguments(commandline_arguments, assume_dependent_codeunits_are_already_built)
         if commandline_arguments is None:
             raise ValueError('The "commandline_arguments"-parameter is not defined.')
@@ -2227,7 +2231,7 @@ class TasksForCommonProjectStructure:
             shutil.copytree(artifacts_folder, target_folder)
 
     @GeneralUtilities.check_arguments
-    def add_github_release(self, productname: str, projectversion: str, build_artifacts_folder: str, github_username: str, repository_folder: str, commandline_arguments: list[str]) -> None:
+    def add_github_release(self, productname: str, projectversion: str, build_artifacts_folder: str, github_username: str, repository_folder: str, commandline_arguments: list[str], additional_attached_files: list[str]) -> None:
         self.__sc.assert_is_git_repository(repository_folder)
         GeneralUtilities.write_message_to_stdout(f"Create GitHub-release for {productname}...")
         verbosity = TasksForCommonProjectStructure.get_verbosity_from_commandline_arguments(commandline_arguments, 1)
@@ -2236,6 +2240,9 @@ class TasksForCommonProjectStructure:
         codeunits = self.get_codeunits(repository_folder)
         for codeunit in codeunits:
             artifact_files.append(self.__sc.find_file_by_extension(f"{build_artifacts_folder}\\{productname}\\{projectversion}\\{codeunit}", "Productive.Artifacts.zip"))
+        if additional_attached_files is not None:
+            for additional_attached_file in additional_attached_files:
+                artifact_files.append(additional_attached_file)
         changelog_file = os.path.join(repository_folder, "Other", "Resources", "Changelog", f"v{projectversion}.md")
         self.__sc.run_program_argsasarray("gh", ["release", "create", f"v{projectversion}", "--repo",  github_repo, "--notes-file", changelog_file, "--title", f"Release v{projectversion}"]+artifact_files, verbosity=verbosity)
 
@@ -2517,7 +2524,7 @@ class TasksForCommonProjectStructure:
         project_resources_folder = os.path.join(repository_folder, "Other", "Scripts")
         PrepareBuildCodeunits_script_name = "PrepareBuildCodeunits.py"
         prepare_build_codeunits_scripts = os.path.join(project_resources_folder, PrepareBuildCodeunits_script_name)
-        
+
         if do_git_clean_when_no_changes:
             self.__sc.run_program("git", "clean -dfx", repository_folder)
         if os.path.isfile(prepare_build_codeunits_scripts):
@@ -2742,9 +2749,9 @@ class TasksForCommonProjectStructure:
         self.ensure_file_from_github_assets_is_available_with_retry(target_folder, "CycloneDX", "cyclonedx-cli", "CycloneDXCLI", local_filename, lambda latest_version: filename_on_github)
 
     @GeneralUtilities.check_arguments
-    def ensure_file_from_github_assets_is_available_with_retry(self, target_folder: str, githubuser: str, githubprojectname: str, resource_name: str, local_filename: str, get_filename_on_github,amount_of_attempts:int=5) -> None:
+    def ensure_file_from_github_assets_is_available_with_retry(self, target_folder: str, githubuser: str, githubprojectname: str, resource_name: str, local_filename: str, get_filename_on_github, amount_of_attempts: int = 5) -> None:
         GeneralUtilities.retry_action(lambda: self.ensure_file_from_github_assets_is_available(target_folder, githubuser, githubprojectname, resource_name, local_filename, get_filename_on_github), amount_of_attempts)
- 
+
     @GeneralUtilities.check_arguments
     def ensure_file_from_github_assets_is_available(self, target_folder: str, githubuser: str, githubprojectname: str, resource_name: str, local_filename: str, get_filename_on_github) -> None:
         resource_folder = os.path.join(target_folder, "Other", "Resources", resource_name)
@@ -2871,6 +2878,36 @@ class TasksForCommonProjectStructure:
         control_file_content = self.load_deb_control_file_content(control_file, codeunit_name, self.get_version_of_codeunit_folder(codeunit_folder), installedsize, maintainername, maintaineremail, description)
         self.__sc.create_deb_package(codeunit_name, binary_folder, control_file_content, deb_output_folder, verbosity, 555)
 
+    @GeneralUtilities.check_arguments
+    def create_zip_file_for_artifact(self, codeunit_folder: str, artifact_source_name: str, name_of_new_artifact: str, verbosity: int, cmd_arguments: list[str]) -> None:
+        self.assert_is_codeunit_folder(codeunit_folder)
+        verbosity = self.get_verbosity_from_commandline_arguments(cmd_arguments, verbosity)
+        src_artifact_folder = GeneralUtilities.resolve_relative_path(f"Other/Artifacts/{artifact_source_name}", codeunit_folder)
+        shutil.make_archive(name_of_new_artifact, 'zip', src_artifact_folder)
+        archive_file = os.path.join(os.getcwd(), f"{name_of_new_artifact}.zip")
+        target_folder = GeneralUtilities.resolve_relative_path(f"Other/Artifacts/{name_of_new_artifact}", codeunit_folder)
+        GeneralUtilities.ensure_folder_exists_and_is_empty(target_folder)
+        shutil.move(archive_file, target_folder)
+
+    def generate_winget_zip_manifest(self, codeunit_folder: str, artifact_name_of_zip: str):
+        self.assert_is_codeunit_folder(codeunit_folder)
+        codeunit_version = self.get_version_of_codeunit_folder(codeunit_folder)
+        build_folder = os.path.join(codeunit_folder, "Other", "Build")
+        artifacts_folder = os.path.join(codeunit_folder, "Other", "Artifacts", artifact_name_of_zip)
+        GeneralUtilities.assert_folder_exists(artifacts_folder)
+        artifacts_file = ScriptCollectionCore().find_file_by_extension(artifacts_folder, "zip")
+        winget_template_file = os.path.join(build_folder, "WinGet-Template.yaml")
+        winget_manifest_file = os.path.join(build_folder, "WinGet-Manifest.yaml")
+        GeneralUtilities.assert_file_exists(winget_template_file)
+        GeneralUtilities.ensure_file_exists(winget_manifest_file)
+        manifest_content = GeneralUtilities.read_text_from_file(winget_template_file)
+        manifest_content = GeneralUtilities.replace_variable_in_string(manifest_content, "version", codeunit_version)
+        manifest_content = GeneralUtilities.replace_variable_in_string(manifest_content, "sha256_hashvalue", GeneralUtilities.get_sha256_of_file(artifacts_file))
+        GeneralUtilities.write_text_to_file(winget_manifest_file, manifest_content)
+        target_folder = os.path.join(codeunit_folder, "Other", "Artifacts", "WinGet-Manifest")
+        GeneralUtilities.ensure_folder_exists_and_is_empty(target_folder)
+        shutil.copy(winget_manifest_file, target_folder)
+
     @GeneralUtilities.check_arguments
     def update_year_in_license_file_in_common_scripts_file(self, common_tasks_scripts_file: str) -> None:
         self.update_year_in_license_file(GeneralUtilities.resolve_relative_path("../../..", common_tasks_scripts_file))

{scriptcollection-3.5.98.dist-info → scriptcollection-3.5.100.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ScriptCollection
-Version: 3.5.98
+Version: 3.5.100
 Summary: The ScriptCollection is the place for reusable scripts.
 Home-page: https://github.com/anionDev/ScriptCollection
 Author: Marius Göcke
@@ -23,7 +23,7 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: build>=1.2.2.post1
-Requires-Dist: coverage>=7.6.12
+Requires-Dist: coverage>=7.7.0
 Requires-Dist: cyclonedx-bom>=5.3.0
 Requires-Dist: defusedxml>=0.7.1
 Requires-Dist: keyboard>=0.13.5

{scriptcollection-3.5.98.dist-info → scriptcollection-3.5.100.dist-info}/RECORD

@@ -1,17 +1,17 @@
 ScriptCollection/Executables.py,sha256=HI9Pxs5Z9QxPGyqeJU2lWslEggFyGYANCqYVQZp6eJ0,30490
-ScriptCollection/GeneralUtilities.py,sha256=q0ikIwmhklCFsaaj9YGPGdrNonibuRmWofvbwOtlxdM,42246
+ScriptCollection/GeneralUtilities.py,sha256=unOZbHDqlxwPHXY1epy4gdGYwDbHEETF1XKZYPGX2hw,42429
 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/SCLog.py,sha256=l4aekBiGoNkKGtvO_Er3NY_K7ts4ZWtIGlhq07I-4LY,30
-ScriptCollection/ScriptCollectionCore.py,sha256=BeUb9YO7qeFfkM66-iRFWBh_YV8lYUFY7IHDAxu8G7M,123983
-ScriptCollection/TasksForCommonProjectStructure.py,sha256=FX8Jnuy9V8MHeOUW_Ifbw6b2nQGbV9Xm5YPeDIJyUgU,227251
+ScriptCollection/ScriptCollectionCore.py,sha256=UxY2NmrtgK-GJmuSpANtgUoxjbwVqti1rrR55Rz13DU,123984
+ScriptCollection/TasksForCommonProjectStructure.py,sha256=CkLRb4-ldwVuc6XlORxxyhN3GDR8TZSfe3DUqRl0SKg,230241
 ScriptCollection/UpdateCertificates.py,sha256=Eynbgu7k9jLxApP2D_8Il77B6BFjJap6K7oTeEAZYbk,7790
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scriptcollection-3.5.98.dist-info/METADATA,sha256=NelJnZ3uMi-Y0tuEwmCq0bt0ujwPkJxI3aY6BXTwohw,7664
-scriptcollection-3.5.98.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-scriptcollection-3.5.98.dist-info/entry_points.txt,sha256=fYCGWGNGijBQHhFe6UAO-BEpfEOxLyNJemukt5ElSzs,3644
-scriptcollection-3.5.98.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-scriptcollection-3.5.98.dist-info/RECORD,,
+scriptcollection-3.5.100.dist-info/METADATA,sha256=MxfzekKeh4Ed-NOAXbl1CEEB_nVgb5ibJ_ZwZxvFnlg,7664
+scriptcollection-3.5.100.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
+scriptcollection-3.5.100.dist-info/entry_points.txt,sha256=fYCGWGNGijBQHhFe6UAO-BEpfEOxLyNJemukt5ElSzs,3644
+scriptcollection-3.5.100.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+scriptcollection-3.5.100.dist-info/RECORD,,