ScriptCollection 4.0.11__py3-none-any.whl → 4.0.13__py3-none-any.whl

ScriptCollection/TFCPS/TFCPS_CodeUnitSpecific_Base.py

@@ -0,0 +1,417 @@
+import os
+import traceback
+from pathlib import Path
+import shutil
+import re
+import json
+import argparse
+from abc import ABC
+import xmlschema
+from lxml import etree
+from ..GeneralUtilities import GeneralUtilities
+from ..ScriptCollectionCore import ScriptCollectionCore
+from ..SCLog import  LogLevel
+from .TFCPS_Tools_General import TFCPS_Tools_General
+from .TFCPS_Tools_Dependencies import TFCPS_Tools_Dependencies,Dependency
+
+class TFCPS_CodeUnitSpecific_Base(ABC):
+    
+    __current_file:str=None
+    __target_environment_type:str
+    __repository_folder:str=None
+    __codeunit_folder:str=None
+    __current_folder:str=None
+    __verbosity:LogLevel=None
+    __use_cache:bool=None
+    tfcps_Tools_General:TFCPS_Tools_General
+    _protected_sc:ScriptCollectionCore
+    __is_pre_merge:bool=False#TODO must be setable to true
+    __validate_developers_of_repository:bool=True#TODO must be setable to false
+
+    def __init__(self,current_file:str,verbosity:LogLevel,target_envionment_type:str,use_cache:bool):
+        self.__verbosity=verbosity
+        self.__use_cache=use_cache
+        self.__target_environment_type=target_envionment_type
+        self.__current_file = str(Path(current_file).absolute())
+        self.__current_folder = os.path.dirname(self.__current_file)
+        self.__codeunit_folder=self.__search_codeunit_folder()
+        self._protected_sc=ScriptCollectionCore()#TODO set loglevel
+        self.tfcps_Tools_General=TFCPS_Tools_General(self._protected_sc)
+        self.tfcps_Tools_General.assert_is_codeunit_folder(self.__codeunit_folder)
+        self.__repository_folder=GeneralUtilities.resolve_relative_path("..",self.__codeunit_folder)
+        self._protected_sc.assert_is_git_repository(self.__repository_folder)
+
+    def __search_codeunit_folder(self)->str:
+        current_path:str=os.path.dirname(self.__current_file)
+        enabled:bool=True
+        while enabled:
+            try:
+                current_path=GeneralUtilities.resolve_relative_path("..",current_path)
+                foldername=os.path.basename(current_path)
+                codeunit_file:str=os.path.join(current_path,f"{foldername}.codeunit.xml")
+                if os.path.isfile(codeunit_file):
+                    return current_path
+            except:
+                enabled=False
+        raise ValueError(f"Can not find codeunit-folder for folder \"{self.__current_file}\".")
+
+    def update_dependencies_default(self):
+        d:TFCPS_Tools_Dependencies=TFCPS_Tools_Dependencies()
+        dependencies:list[Dependency]=d.get_dependencies()
+        for dependency in dependencies:
+            if dependency.current_version!=dependency.latest_version:
+                pass#TODO update dependency
+        
+    def get_version_of_project(self)->str:
+        return self.tfcps_Tools_General.get_version_of_project(self.get_repository_folder())
+
+    @GeneralUtilities.check_arguments
+    def do_common_tasks_base(self,current_codeunit_version:str):
+
+        repository_folder: str =self.get_repository_folder()
+        self._protected_sc.assert_is_git_repository(repository_folder)
+        codeunit_name: str = self.get_codeunit_name()
+        project_version = self.tfcps_Tools_General.get_version_of_project(repository_folder)
+        if current_codeunit_version is None:
+            current_codeunit_version=project_version
+        codeunit_folder = os.path.join(repository_folder, codeunit_name)
+
+        # check codeunit-conformity
+        # TODO check if foldername=="<codeunitname>[.codeunit.xml]" == <codeunitname> in file
+        supported_codeunitspecificationversion = "2.9.4"  # should always be the latest version of the ProjectTemplates-repository
+        codeunit_file = os.path.join(codeunit_folder, f"{codeunit_name}.codeunit.xml")
+        if not os.path.isfile(codeunit_file):
+            raise ValueError(f'Codeunitfile "{codeunit_file}" does not exist.')
+        # TODO implement usage of self.reference_latest_version_of_xsd_when_generating_xml
+        namespaces = {'cps': 'https://projects.aniondev.de/PublicProjects/Common/ProjectTemplates/-/tree/main/Conventions/RepositoryStructure/CommonProjectStructure',  'xsi': 'http://www.w3.org/2001/XMLSchema-instance'}
+        root: etree._ElementTree = etree.parse(codeunit_file)
+
+        # check codeunit-spcecification-version
+        try:
+            codeunit_file_version = root.xpath('//cps:codeunit/@codeunitspecificationversion', namespaces=namespaces)[0]
+            if codeunit_file_version != supported_codeunitspecificationversion:
+                raise ValueError(f"ScriptCollection only supports processing codeunits with codeunit-specification-version={supported_codeunitspecificationversion}.")
+            schemaLocation = root.xpath('//cps:codeunit/@xsi:schemaLocation', namespaces=namespaces)[0]
+            xmlschema.validate(codeunit_file, schemaLocation)
+            # TODO check if the properties codeunithastestablesourcecode, codeunithasupdatabledependencies, throwexceptionifcodeunitfilecannotbevalidated, developmentState and description exist and the values are valid
+        except Exception as exception:
+            self._protected_sc.log.log_exception(f'Codeunitfile "{codeunit_file}" can not be validated due to the following exception:', exception,traceback,LogLevel.Warning)
+
+        # check codeunit-name
+        codeunit_name_in_codeunit_file = root.xpath('//cps:codeunit/cps:name/text()', namespaces=namespaces)[0]
+        if codeunit_name != codeunit_name_in_codeunit_file:
+            raise ValueError(f"The folder-name ('{codeunit_name}') is not equal to the codeunit-name ('{codeunit_name_in_codeunit_file}').")
+
+        # check owner-name
+        codeunit_ownername_in_codeunit_file = self.tfcps_Tools_General. get_codeunit_owner_name(self.get_codeunit_file())
+        GeneralUtilities.assert_condition(GeneralUtilities.string_has_content(codeunit_ownername_in_codeunit_file), "No valid name for codeunitowner given.")
+
+        # check owner-emailaddress
+        codeunit_owneremailaddress_in_codeunit_file = self.tfcps_Tools_General.get_codeunit_owner_emailaddress(self.get_codeunit_file())
+        GeneralUtilities.assert_condition(GeneralUtilities.string_has_content(codeunit_owneremailaddress_in_codeunit_file), "No valid email-address for codeunitowner given.")
+
+        # check development-state
+        developmentstate = root.xpath('//cps:properties/@developmentstate', namespaces=namespaces)[0]
+        developmentstate_active = "Active development"
+        developmentstate_maintenance = "Maintenance-updates only"
+        developmentstate_inactive = "Inactive"
+        GeneralUtilities.assert_condition(developmentstate in (developmentstate_active, developmentstate_maintenance, developmentstate_inactive), f"Invalid development-state. Must be '{developmentstate_active}' or '{developmentstate_maintenance}' or '{developmentstate_inactive}' but was '{developmentstate}'.")
+
+        # check for mandatory files
+        files = ["Other/Build/Build.py", "Other/QualityCheck/Linting.py", "Other/Reference/GenerateReference.py"]
+        if self.tfcps_Tools_General.codeunit_has_testable_sourcecode(self.get_codeunit_file()):
+            # TODO check if the testsettings-section appears in the codeunit-file
+            files.append("Other/QualityCheck/RunTestcases.py")
+        if self.tfcps_Tools_General.codeunit_has_updatable_dependencies(self.get_codeunit_file()):
+            # TODO check if the updatesettings-section appears in the codeunit-file
+            files.append("Other/UpdateDependencies.py")
+        for file in files:
+            combined_file = os.path.join(codeunit_folder, file)
+            if not os.path.isfile(combined_file):
+                raise ValueError(f'The mandatory file "{file}" does not exist in the codeunit-folder.')
+
+        if os.path.isfile(os.path.join(codeunit_folder, "Other", "requirements.txt")):
+            self.install_requirementstxt_for_codeunit()
+
+        # check developer
+        if self.__validate_developers_of_repository:
+            expected_authors: list[tuple[str, str]] = []
+            expected_authors_in_xml = root.xpath('//cps:codeunit/cps:developerteam/cps:developer', namespaces=namespaces)
+            for expected_author in expected_authors_in_xml:
+                author_name = expected_author.xpath('./cps:developername/text()', namespaces=namespaces)[0]
+                author_emailaddress = expected_author.xpath('./cps:developeremailaddress/text()', namespaces=namespaces)[0]
+                expected_authors.append((author_name, author_emailaddress)) 
+            actual_authors: list[tuple[str, str]] = self.tfcps_Tools_General.get_all_authors_and_committers_of_repository(repository_folder, codeunit_name)
+            # TODO refactor this check to only check commits which are behind this but which are not already on main
+            # TODO verify also if the commit is signed by a valid key of the author
+            for actual_author in actual_authors:
+                if not (actual_author) in expected_authors:
+                    actual_author_formatted = f"{actual_author[0]} <{actual_author[1]}>"
+                    raise ValueError(f'Author/Comitter "{actual_author_formatted}" is not in the codeunit-developer-team. If {actual_author} is a authorized developer for this codeunit you should consider defining this in the codeunit-file or adapting the name using a .mailmap-file (see https://git-scm.com/docs/gitmailmap). The developer-team-check can also be disabled using the property validate_developers_of_repository.')
+
+        dependent_codeunits = self.tfcps_Tools_General.get_dependent_code_units(codeunit_file)
+        for dependent_codeunit in dependent_codeunits:
+            if not self.tfcps_Tools_General.dependent_codeunit_exists(repository_folder, dependent_codeunit):
+                raise ValueError(f"Codeunit {codeunit_name} does have dependent codeunit {dependent_codeunit} which does not exist.")
+
+        # TODO implement cycle-check for dependent codeunits
+
+        artifacts_folder = os.path.join(codeunit_folder, "Other", "Artifacts")
+        GeneralUtilities.ensure_directory_does_not_exist(artifacts_folder)
+
+        # get artifacts from dependent codeunits
+        self.tfcps_Tools_General.copy_artifacts_from_dependent_code_units(repository_folder, codeunit_name)
+
+        # update codeunit-version
+        self.tfcps_Tools_General.write_version_to_codeunit_file(self.get_codeunit_file(), current_codeunit_version)
+ 
+        # set project version
+        package_json_file = os.path.join(repository_folder, "package.json")  # TDOO move this to a general project-specific (and codeunit-independent-script)
+        if os.path.isfile(package_json_file):
+            package_json_data: str = None
+            with open(package_json_file, "r", encoding="utf-8") as f1:
+                package_json_data = json.load(f1)
+                package_json_data["version"] = project_version
+            with open(package_json_file, "w", encoding="utf-8") as f2:
+                json.dump(package_json_data, f2, indent=2)
+            GeneralUtilities.write_text_to_file(package_json_file, GeneralUtilities.read_text_from_file(package_json_file).replace("\r", ""))
+
+        # 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):
+            raise ValueError(f"Hints-file '{hints_file}' does not exist.")
+
+        # Copy license-file
+        self.tfcps_Tools_General.copy_licence_file(self.get_codeunit_folder())
+
+        # Generate diff-report
+        self.tfcps_Tools_General.generate_diff_report(repository_folder, codeunit_name, self.tfcps_Tools_General.get_version_of_codeunit(self.get_codeunit_file()))
+
+        # TODO check for secrets using TruffleHog
+        # TODO run static code analysis tool to search for vulnerabilities
+        
+        d:TFCPS_Tools_Dependencies=TFCPS_Tools_Dependencies()
+        dependencies:list[Dependency]=d.get_dependencies()
+        for dependency in dependencies:
+            #TODO show warning if the latest version of dependency is too old
+            if dependency.current_version!=dependency.latest_version:
+                dependency_is_disabled_for_update=False#TODO read this value from codeunit-file
+                if not dependency_is_disabled_for_update:
+                    self._protected_sc.log.log(f"Dependency \"{dependency.name}\" is used in the outdated version v{dependency.current_version} and can be upudated to v{dependency.latest_version}",LogLevel.Warning)
+
+
+
+
+    @GeneralUtilities.check_arguments
+    def generate_reference_using_docfx(self=None):
+        reference_folder =os.path.join( self.get_codeunit_folder(),"Other","Reference")
+        generated_reference_folder = GeneralUtilities.resolve_relative_path("../Artifacts/Reference", reference_folder)
+        GeneralUtilities.ensure_directory_does_not_exist(generated_reference_folder)
+        GeneralUtilities.ensure_directory_exists(generated_reference_folder)
+        obj_folder = os.path.join(reference_folder, "obj")
+        GeneralUtilities.ensure_folder_exists_and_is_empty(obj_folder)
+        self._protected_sc.run_program("docfx", "-t default,templates/darkfx docfx.json", reference_folder)
+        GeneralUtilities.ensure_directory_does_not_exist(obj_folder)
+
+    @GeneralUtilities.check_arguments
+    def use_cache(self)->bool:
+        return self.__use_cache
+
+    @GeneralUtilities.check_arguments
+    def update_dependencies_base(self):
+        self.update_dependencies_default()
+
+    @GeneralUtilities.check_arguments
+    def get_codeunit_folder(self)->str:
+        return self.__codeunit_folder
+
+    @GeneralUtilities.check_arguments
+    def get_codeunit_name(self)->str:
+        return os.path.basename(self.__codeunit_folder)
+    
+    @GeneralUtilities.check_arguments
+    def get_repository_folder(self)->str:
+        return self.__repository_folder
+    
+    @GeneralUtilities.check_arguments
+    def get_current_folder(self)->str:
+        return self.__current_folder
+    
+    @GeneralUtilities.check_arguments
+    def get_verbosity(self)->LogLevel:
+        return self.__verbosity
+
+    @GeneralUtilities.check_arguments
+    def get_artifacts_folder(self) -> str:
+        return os.path.join(self.get_codeunit_folder(), "Other", "Artifacts")
+
+    @GeneralUtilities.check_arguments
+    def get_codeunit_file(self) -> str:
+        return os.path.join(self.get_codeunit_folder(), f"{self.get_codeunit_name()}.codeunit.xml")
+
+    def get_type_environment_type(self)->str:
+        return self.__target_environment_type
+
+    def get_target_environment_type(self)->str:
+        return self.__target_environment_type
+    
+    @GeneralUtilities.check_arguments
+    def copy_source_files_to_output_directory(self) -> None:
+        self._protected_sc.log.log("Copy sourcecode...")
+        codeunit_folder =self.get_codeunit_folder()
+        result = self._protected_sc.run_program_argsasarray("git", ["ls-tree", "-r", "HEAD", "--name-only"], codeunit_folder)
+        files = [f for f in result[1].split('\n') if len(f) > 0]
+        for file in files:
+            full_source_file = os.path.join(codeunit_folder, file)
+            if os.path.isfile(full_source_file):
+                # Reson of isdir-check:
+                # Prevent trying to copy files which are not exist.
+                # Otherwise exceptions occurr because uncommitted deletions of files will result in an error here.
+                target_file = os.path.join(codeunit_folder, "Other", "Artifacts", "SourceCode", file)
+                target_folder = os.path.dirname(target_file)
+                GeneralUtilities.ensure_directory_exists(target_folder)
+                shutil.copyfile(full_source_file, target_file)
+
+    @GeneralUtilities.check_arguments
+    def run_testcases_common_post_task(self, repository_folder: str, codeunit_name: str, generate_badges: bool, targetenvironmenttype: str) -> None:
+        self._protected_sc.assert_is_git_repository(repository_folder)
+        coverage_file_folder = os.path.join(repository_folder, codeunit_name, "Other/Artifacts/TestCoverage")
+        coveragefiletarget = os.path.join(coverage_file_folder,  "TestCoverage.xml")
+        self.__update_path_of_source_in_testcoverage_file(repository_folder, codeunit_name)
+        self.__standardized_tasks_generate_coverage_report(repository_folder, codeunit_name, generate_badges, targetenvironmenttype)
+        self.__check_testcoverage(coveragefiletarget, repository_folder, codeunit_name)
+        self.__format_xml_file(coveragefiletarget)
+
+    @GeneralUtilities.check_arguments
+    def __format_xml_file(self, xmlfile:str) -> None:
+        GeneralUtilities.write_text_to_file(xmlfile,self.__format_xml_content( GeneralUtilities.read_text_from_file(xmlfile)))
+
+    @GeneralUtilities.check_arguments
+    def __format_xml_content(self, xml:str) -> None:
+        root = etree.fromstring(xml)
+        return etree.tostring(root, pretty_print=True, encoding="unicode")
+
+    @GeneralUtilities.check_arguments
+    def __standardized_tasks_generate_coverage_report(self, repository_folder: str, codeunitname: str, generate_badges: bool, targetenvironmenttype: str, add_testcoverage_history_entry: bool = None) -> None:
+        """This function expects that the file '<repositorybasefolder>/<codeunitname>/Other/Artifacts/TestCoverage/TestCoverage.xml'
+        which contains a test-coverage-report in the cobertura-format exists.
+        This script expectes that the testcoverage-reportfolder is '<repositorybasefolder>/<codeunitname>/Other/Artifacts/TestCoverageReport'.
+        This script expectes that a test-coverage-badges should be added to '<repositorybasefolder>/<codeunitname>/Other/Resources/Badges'."""
+        self._protected_sc.log.log("Generate testcoverage report..")
+        self._protected_sc.assert_is_git_repository(repository_folder)
+        codeunit_version = self.tfcps_Tools_General.get_version_of_codeunit(self.get_codeunit_file()) 
+        verbosity=0#TODO use loglevel-value here
+        if verbosity == 0:
+            verbose_argument_for_reportgenerator = "Off"
+        elif verbosity == 1:
+            verbose_argument_for_reportgenerator = "Error"
+        elif verbosity == 2:
+            verbose_argument_for_reportgenerator = "Info"
+        elif verbosity == 3:
+            verbose_argument_for_reportgenerator = "Verbose"
+        else:
+            raise ValueError(f"Unknown value for verbosity: {GeneralUtilities.str_none_safe(verbosity)}")
+
+        # Generating report
+        GeneralUtilities.ensure_directory_does_not_exist(os.path.join(repository_folder, codeunitname, f"{codeunitname}/Other/Artifacts/TestCoverageReport"))
+        GeneralUtilities.ensure_directory_exists(os.path.join(repository_folder, codeunitname, "Other/Artifacts/TestCoverageReport"))
+
+        if add_testcoverage_history_entry is None:
+            add_testcoverage_history_entry = self.__is_pre_merge
+
+        history_folder = f"{codeunitname}/Other/Resources/TestCoverageHistory"
+        history_folder_full = os.path.join(repository_folder, history_folder)
+        GeneralUtilities.ensure_directory_exists(history_folder_full)
+        history_argument = f" -historydir:{history_folder}"
+        argument = f"-reports:{codeunitname}/Other/Artifacts/TestCoverage/TestCoverage.xml -targetdir:{codeunitname}/Other/Artifacts/TestCoverageReport --verbosity:{verbose_argument_for_reportgenerator}{history_argument} -title:{codeunitname} -tag:v{codeunit_version}"
+        self._protected_sc.run_program("reportgenerator", argument, repository_folder)
+        if not add_testcoverage_history_entry:
+            os.remove(GeneralUtilities.get_direct_files_of_folder(history_folder_full)[-1])
+
+        # Generating badges
+        if generate_badges:
+            testcoverageubfolger = "Other/Resources/TestCoverageBadges"
+            fulltestcoverageubfolger = os.path.join(repository_folder, codeunitname, testcoverageubfolger)
+            GeneralUtilities.ensure_directory_does_not_exist(fulltestcoverageubfolger)
+            GeneralUtilities.ensure_directory_exists(fulltestcoverageubfolger)
+            self._protected_sc.run_program("reportgenerator", f"-reports:Other/Artifacts/TestCoverage/TestCoverage.xml -targetdir:{testcoverageubfolger} -reporttypes:Badges --verbosity:{verbose_argument_for_reportgenerator}", os.path.join(repository_folder, codeunitname))
+
+    @GeneralUtilities.check_arguments
+    def __update_path_of_source_in_testcoverage_file(self, repository_folder: str, codeunitname: str) -> None:
+        self._protected_sc.assert_is_git_repository(repository_folder)
+        self._protected_sc.log.log("Update paths of source files in testcoverage files..")
+        folder = f"{repository_folder}/{codeunitname}/Other/Artifacts/TestCoverage"
+        filename = "TestCoverage.xml"
+        full_file = os.path.join(folder, filename)
+        GeneralUtilities.write_text_to_file(full_file, re.sub("<source>.+<\\/source>", f"<source><!--[repository]/-->./{codeunitname}/</source>", GeneralUtilities.read_text_from_file(full_file)))
+        self.__remove_not_existing_files_from_testcoverage_file(full_file, repository_folder, codeunitname)
+
+    @GeneralUtilities.check_arguments
+    def __remove_not_existing_files_from_testcoverage_file(self, testcoveragefile: str, repository_folder: str, codeunit_name: str) -> None:
+        self._protected_sc.assert_is_git_repository(repository_folder)
+        root: etree._ElementTree = etree.parse(testcoveragefile)
+        codeunit_folder = os.path.join(repository_folder, codeunit_name)
+        xpath = f"//coverage/packages/package[@name='{codeunit_name}']/classes/class"
+        coverage_report_classes = root.xpath(xpath)
+        found_existing_files = False
+        for coverage_report_class in coverage_report_classes:
+            filename = coverage_report_class.attrib['filename']
+            file = os.path.join(codeunit_folder, filename)
+            if os.path.isfile(file):
+                found_existing_files = True
+            else:
+                coverage_report_class.getparent().remove(coverage_report_class)
+        GeneralUtilities.assert_condition(found_existing_files, f"No existing files in testcoderage-report-file \"{testcoveragefile}\".")
+        result = etree.tostring(root).decode("utf-8")
+        GeneralUtilities.write_text_to_file(testcoveragefile, result)
+
+    @GeneralUtilities.check_arguments
+    def __check_testcoverage(self, testcoverage_file_in_cobertura_format: str, repository_folder: str, codeunitname: str) -> None:
+        self._protected_sc.assert_is_git_repository(repository_folder)
+        self._protected_sc.log.log("Check testcoverage..")
+        root: etree._ElementTree = etree.parse(testcoverage_file_in_cobertura_format)
+        if len(root.xpath('//coverage/packages/package')) != 1:
+            raise ValueError(f"'{testcoverage_file_in_cobertura_format}' must contain exactly 1 package.")
+        if root.xpath('//coverage/packages/package[1]/@name')[0] != codeunitname:
+            raise ValueError(f"The package name of the tested package in '{testcoverage_file_in_cobertura_format}' must be '{codeunitname}'.")
+        rates=root.xpath('//coverage/packages/package[1]/@line-rate')
+        coverage_in_percent = round(float(str(rates[0]))*100, 2)
+        technicalminimalrequiredtestcoverageinpercent = 0
+        if not technicalminimalrequiredtestcoverageinpercent < coverage_in_percent:
+            raise ValueError(f"The test-coverage of package '{codeunitname}' must be greater than {technicalminimalrequiredtestcoverageinpercent}%.")
+        minimalrequiredtestcoverageinpercent = self.get_testcoverage_threshold_from_codeunit_file()
+        if (coverage_in_percent < minimalrequiredtestcoverageinpercent):
+            raise ValueError(f"The testcoverage for codeunit {codeunitname} must be {minimalrequiredtestcoverageinpercent}% or more but is {coverage_in_percent}%.")
+
+    @GeneralUtilities.check_arguments
+    def get_testcoverage_threshold_from_codeunit_file(self):
+        root: etree._ElementTree = etree.parse(self.get_codeunit_file())
+        return float(str(root.xpath('//cps:properties/cps:testsettings/@minimalcodecoverageinpercent', namespaces={'cps': 'https://projects.aniondev.de/PublicProjects/Common/ProjectTemplates/-/tree/main/Conventions/RepositoryStructure/CommonProjectStructure'})[0]))
+
+
+    @GeneralUtilities.check_arguments
+    def install_requirementstxt_for_codeunit(self):
+        self._protected_sc.install_requirementstxt_file(self.get_codeunit_folder()+"/Other/requirements.txt")
+
+class TFCPS_CodeUnitSpecific_Base_CLI():
+
+    @staticmethod
+    @GeneralUtilities.check_arguments
+    def get_base_parser()->argparse.ArgumentParser:
+        parser = argparse.ArgumentParser()
+        verbosity_values = ", ".join(f"{lvl.value}={lvl.name}" for lvl in LogLevel)
+        parser.add_argument('-e', '--targetenvironmenttype', required=False, default="QualityCheck")
+        parser.add_argument('-a', '--additionalargumentsfile', required=False, default=None)
+        parser.add_argument('-v', '--verbosity', required=False, default=3, help=f"Sets the loglevel. Possible values: {verbosity_values}")
+        parser.add_argument('-c', '--nocache',  action='store_true', required=False, default=False)
+        return parser

ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnit.py

@@ -0,0 +1,120 @@
+import os
+import re
+from ..GeneralUtilities import GeneralUtilities
+from ..ScriptCollectionCore import ScriptCollectionCore
+from ..SCLog import LogLevel
+from .TFCPS_Tools_General import TFCPS_Tools_General
+
+
+class TFCPS_CodeUnit_BuildCodeUnit:
+
+    codeunit_folder: str
+    repository_folder: str
+    sc: ScriptCollectionCore = ScriptCollectionCore()
+    codeunit_name: str
+    tFCPS_Tools: TFCPS_Tools_General
+    target_environment_type: str
+    additionalargumentsfile: str
+    use_cache: bool
+
+    def __init__(self, codeunit_folder: str, verbosity: LogLevel, target_environment_type: str, additionalargumentsfile: str, use_cache: bool):
+        self.sc = ScriptCollectionCore()
+        self.sc.log.loglevel = verbosity
+        self.tFCPS_Tools = TFCPS_Tools_General(self.sc)
+        self.tFCPS_Tools.assert_is_codeunit_folder(codeunit_folder)
+        self.codeunit_folder = codeunit_folder
+        self.codeunit_name = os.path.basename(self.codeunit_folder)
+        self.target_environment_type = target_environment_type
+        self.additionalargumentsfile = additionalargumentsfile
+        self.use_cache = use_cache
+
+    @GeneralUtilities.check_arguments
+    def build_codeunit(self) -> None:
+        codeunit_file: str = str(os.path.join(self.codeunit_folder, f"{self.codeunit_name}.codeunit.xml"))
+
+        if not self.tFCPS_Tools.codeunit_is_enabled(codeunit_file):
+            self.sc.log.log(f"Codeunit {self.codeunit_name} is disabled.", LogLevel.Warning)
+            return
+
+        self.sc.log.log(f"Build codeunit {self.codeunit_name}...")
+
+        GeneralUtilities.ensure_folder_exists_and_is_empty(self.codeunit_folder+"/Other/Artifacts")
+
+        arguments: str = f"--targetenvironmenttype {self.target_environment_type} --additionalargumentsfile {self.additionalargumentsfile} --verbosity {int(self.sc.log.loglevel)}"
+        if not self.use_cache:
+            arguments = f"{arguments} --nocache"
+
+        self.sc.log.log("Do common tasks...")
+        self.sc.run_program("python", f"CommonTasks.py {arguments}", os.path.join(self.codeunit_folder, "Other"), print_live_output=True)
+        self.verify_artifact_exists(self.codeunit_folder, dict[str, bool]({"Changelog": False, "License": True, "DiffReport": True}))
+
+        self.sc.log.log("Build...")
+        self.sc.run_program("python", f"Build.py {arguments}", os.path.join(self.codeunit_folder, "Other", "Build"), print_live_output=True)
+        artifacts = {"BuildResult_.+": True, "BOM": False, "SourceCode":  self.tFCPS_Tools.codeunit_has_testable_sourcecode(codeunit_file)}
+        self.verify_artifact_exists(self.codeunit_folder, dict[str, bool](artifacts))
+
+        if self.tFCPS_Tools.codeunit_has_testable_sourcecode(codeunit_file):
+            self.sc.log.log("Run testcases...")
+            self.sc.run_program("python", f"RunTestcases.py {arguments}", os.path.join(self.codeunit_folder, "Other", "QualityCheck"), print_live_output=True)
+            self.verify_artifact_exists(self.codeunit_folder, dict[str, bool]({"TestCoverage": True, "TestCoverageReport": False}))
+
+        self.sc.log.log("Check for linting-issues...")
+        linting_result = self.sc.run_program("python", f"Linting.py {arguments}", os.path.join(self.codeunit_folder, "Other", "QualityCheck"), print_live_output=True, throw_exception_if_exitcode_is_not_zero=False)
+        if linting_result[0] != 0:
+            self.sc.log.log("Linting-issues were found.", LogLevel.Warning)
+
+        self.sc.log.log("Generate reference...")
+        self.sc.run_program("python", "GenerateReference.py", os.path.join(self.codeunit_folder, "Other", "Reference"), print_live_output=True)
+        self.verify_artifact_exists(self.codeunit_folder, dict[str, bool]({"Reference": True}))
+
+        if os.path.isfile(os.path.join(self.codeunit_folder, "Other", "OnBuildingFinished.py")):
+            self.sc.log.log('Run "OnBuildingFinished.py"...')
+            self.sc.run_program("python", f"OnBuildingFinished.py {arguments}", os.path.join(self.codeunit_folder, "Other"), print_live_output=True)
+
+        artifacts_folder = os.path.join(self.codeunit_folder, "Other", "Artifacts")
+        artifactsinformation_file = os.path.join(artifacts_folder, f"{self.codeunit_name}.artifactsinformation.xml")
+        codeunit_version = self.tFCPS_Tools.get_version_of_codeunit(codeunit_file)
+        GeneralUtilities.ensure_file_exists(artifactsinformation_file)
+        artifacts_list = []
+        for artifact_folder in GeneralUtilities.get_direct_folders_of_folder(artifacts_folder):
+            artifact_name = os.path.basename(artifact_folder)
+            artifacts_list.append(f"        <cps:artifact>{artifact_name}<cps:artifact>")
+        artifacts = '\n'.join(artifacts_list)
+        moment = GeneralUtilities.datetime_to_string(GeneralUtilities.get_now())
+        # TODO implement usage of reference_latest_version_of_xsd_when_generating_xml
+        GeneralUtilities.write_text_to_file(artifactsinformation_file, f"""<?xml version="1.0" encoding="UTF-8" ?>
+<cps:artifactsinformation xmlns:cps="https://projects.aniondev.de/PublicProjects/Common/ProjectTemplates/-/tree/main/Conventions/RepositoryStructure/CommonProjectStructure" artifactsinformationspecificationversion="1.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://raw.githubusercontent.com/anionDev/ProjectTemplates/main/Templates/Conventions/RepositoryStructure/CommonProjectStructure/artifactsinformation.xsd">
+    <cps:name>{self.codeunit_name}</cps:name>
+    <cps:version>{codeunit_version}</cps:version>
+    <cps:timestamp>{moment}</cps:timestamp>
+    <cps:targetenvironmenttype>{self.target_environment_type}</cps:targetenvironmenttype>
+    <cps:artifacts>
+{artifacts}
+    </cps:artifacts>
+</cps:artifactsinformation>""")
+        # TODO validate artifactsinformation_file against xsd
+        self.sc.log.log(f"Finished building codeunit {self.codeunit_name} without errors.")
+
+    @GeneralUtilities.check_arguments
+    def verify_artifact_exists(self, codeunit_folder: str, artifact_name_regexes: dict[str, bool]) -> None:
+        codeunit_name: str = os.path.basename(codeunit_folder)
+        artifacts_folder = os.path.join(codeunit_folder, "Other/Artifacts")
+        existing_artifacts = [os.path.basename(x) for x in GeneralUtilities.get_direct_folders_of_folder(artifacts_folder)]
+        for artifact_name_regex, required in artifact_name_regexes.items():
+            artifact_exists = False
+            for existing_artifact in existing_artifacts:
+                pattern = re.compile(artifact_name_regex)
+                if pattern.match(existing_artifact):
+                    artifact_exists = True
+            if not artifact_exists:
+                message = f"Codeunit {codeunit_name} does not contain an artifact which matches the name '{artifact_name_regex}'."
+                if required:
+                    raise ValueError(message)
+                else:
+                    self.sc.log.log(message, LogLevel.Warning)
+
+    @GeneralUtilities.check_arguments
+    def update_dependencies(self) -> None:
+        self.sc.log.log("Update dependencies...")
+        self.sc.run_program("python", "UpdateDependencies.py", os.path.join(self.codeunit_folder, "Other"))

ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnits.py

@@ -0,0 +1,80 @@
+import os
+from ..GeneralUtilities import GeneralUtilities
+from ..ScriptCollectionCore import ScriptCollectionCore
+from ..SCLog import  LogLevel
+from .TFCPS_CodeUnit_BuildCodeUnit import TFCPS_CodeUnit_BuildCodeUnit
+from .TFCPS_Tools_General import TFCPS_Tools_General
+
+class TFCPS_CodeUnit_BuildCodeUnits:
+    repository:str=None
+    tFCPS_Other:TFCPS_Tools_General=None 
+    sc:ScriptCollectionCore=None
+    target_environment_type:str=None
+    additionalargumentsfile:str=None
+    __use_cache:bool
+    __is_pre_merge:bool
+
+    def __init__(self,repository:str,loglevel:LogLevel,target_environment_type:str,additionalargumentsfile:str,use_cache:bool,is_pre_merge:bool):
+        self.sc=ScriptCollectionCore()
+        self.sc.log.loglevel=loglevel
+        self.__use_cache=use_cache
+        self.sc.assert_is_git_repository(repository)
+        self.repository=repository
+        self.tFCPS_Other:TFCPS_Tools_General=TFCPS_Tools_General(self.sc)
+        allowed_target_environment_types=["Development","QualityCheck","Productive"]
+        GeneralUtilities.assert_condition(target_environment_type in allowed_target_environment_types,"Unknown target-environment-type. Allowed values are: "+", ".join(allowed_target_environment_types))
+        self.target_environment_type=target_environment_type
+        self.additionalargumentsfile=additionalargumentsfile
+        self.__is_pre_merge=is_pre_merge
+
+    @GeneralUtilities.check_arguments
+    def build_codeunits(self) -> None:
+        self.sc.log.log(GeneralUtilities.get_line())
+        self.sc.log.log(f"Start building codeunits. (Target environment-type: {self.target_environment_type})")
+        changelog_file=os.path.join(self.repository,"Other","Resources","Changelog",f"v{self.tFCPS_Other.get_version_of_project(self.repository)}.md")
+        GeneralUtilities.assert_file_exists(changelog_file,f"Changelogfile \"{changelog_file}\" does not exist. Try to create it for example using \"sccreatechangelogentry -m ...\".") 
+        if  os.path.isfile( os.path.join(self.repository,"Other","Scripts","PrepareBuildCodeunits.py")):
+            arguments:str=f"--targetenvironmenttype {self.target_environment_type} --additionalargumentsfile {self.additionalargumentsfile} --verbosity {int(self.sc.log.loglevel)}"
+            if not self.__use_cache:
+                arguments=f"{arguments} --nocache"
+                if self.sc.git_repository_has_uncommitted_changes(self.repository):
+                    self.sc.log.log("No-cache-option can not be applied because there are uncommited changes in the repository.",LogLevel.Warning)
+                else:
+                    self.sc.run_program("git","clean -dfx",self.repository)
+            self.sc.log.log("Prepare build codeunits...")
+            self.sc.run_program("python", f"PrepareBuildCodeunits.py {arguments}", os.path.join(self.repository,"Other","Scripts"),print_live_output=True)
+        codeunits:list[str]=self.tFCPS_Other.get_codeunits(self.repository)
+        self.sc.log.log("Codeunits will be built in the following order:")
+        for codeunit_name in codeunits:
+            self.sc.log.log("  - "+codeunit_name)
+        for codeunit_name in codeunits:
+            tFCPS_CodeUnit_BuildCodeUnit:TFCPS_CodeUnit_BuildCodeUnit = TFCPS_CodeUnit_BuildCodeUnit(os.path.join(self.repository,codeunit_name),self.sc.log.loglevel,self.target_environment_type,self.additionalargumentsfile,self.use_cache())
+            self.sc.log.log(GeneralUtilities.get_line())
+            tFCPS_CodeUnit_BuildCodeUnit.build_codeunit()
+        self.sc.log.log(GeneralUtilities.get_line())
+        self.sc.log.log("Finished building codeunits.")
+        self.sc.log.log(GeneralUtilities.get_line())
+
+
+    @GeneralUtilities.check_arguments
+    def use_cache(self) -> bool:
+        return self.__use_cache
+
+
+    @GeneralUtilities.check_arguments
+    def is_pre_merge(self) -> bool:
+        return self.__is_pre_merge
+
+    @GeneralUtilities.check_arguments
+    def update_dependencies(self) -> None:
+        self.update_year_in_license_file()
+
+        #TODO update project-wide-dependencies here
+        codeunits:list[str]=self.tFCPS_Other.get_codeunits(self.repository)
+        for codeunit_name in codeunits:
+            tFCPS_CodeUnit_BuildCodeUnit:TFCPS_CodeUnit_BuildCodeUnit = TFCPS_CodeUnit_BuildCodeUnit(os.path.join(self.repository,codeunit_name),self.sc.log.loglevel,self.target_environment_type,self.additionalargumentsfile,self.use_cache())
+            tFCPS_CodeUnit_BuildCodeUnit.update_dependencies() 
+
+    @GeneralUtilities.check_arguments
+    def update_year_in_license_file(self) -> None:
+        self.sc.update_year_in_first_line_of_file(os.path.join(self.repository, "License.txt"))