ScriptCollection 4.2.0__py3-none-any.whl → 4.2.2__py3-none-any.whl

ScriptCollection/CertificateUpdater.py

@@ -102,7 +102,7 @@ class CertificateUpdater:
                 else:
                     GeneralUtilities.write_message_to_stdout(f"Create certificate for domain {domain}")
                 dockerargument = f"run --name {certbot_container_name} --volume {self.__letsencrypt_folder}:/etc/letsencrypt"
-                dockerargument = dockerargument + f" --volume {self.__log_folder}:/var/log/letsencrypt -p 80:80 "+self.__sc.get_image_with_registry_for_docker_image("certbot","latest")
+                dockerargument = dockerargument + f" --volume {self.__log_folder}:/var/log/letsencrypt -p 80:80 "+self.__sc.get_image_with_registry_for_docker_image("certbot","latest","docker.io/certbot/certbot")
                 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)

ScriptCollection/ScriptCollectionCore.py

@@ -35,7 +35,7 @@ from .ProgramRunnerBase import ProgramRunnerBase
 from .ProgramRunnerPopen import ProgramRunnerPopen
 from .SCLog import SCLog, LogLevel
 
-version = "4.2.0"
+version = "4.2.2"
 __version__ = version
 
 
@@ -86,7 +86,33 @@ class ScriptCollectionCore:
         self.run_program("docker",f"push {target_address}")
 
     @GeneralUtilities.check_arguments
-    def get_image_with_registry_for_docker_image(self,image:str,tag:str)->str:
+    def registry_contains_image(self,registry_url:str,image:str,registry_username:str,registry_password:str)->bool:
+        catalog_url = f"{registry_url}/v2/_catalog"
+        response = requests.get(catalog_url, auth=(registry_username, registry_password),timeout=20)
+        response.raise_for_status() # check if statuscode = 200
+        data = response.json()
+        # expected: {"repositories": ["nginx", "myapp"]}
+        images = data.get("repositories", [])
+        result=image in images
+        return result
+
+    @GeneralUtilities.check_arguments
+    def registry_contains_image_with_tag(self,registry_url:str,image:str,tag:str,registry_username:str,registry_password:str)->bool:
+        if not self.registry_contains_image(registry_url,image,registry_username,registry_password):
+            return False
+        tags_url = f"{registry_url}/v2/{image}/tags/list"
+        response = requests.get(tags_url, auth=(registry_username, registry_password),timeout=20)
+        response.raise_for_status() # check if statuscode = 200
+        data=response.json()
+        # expected: {"name":"myapp","tags":["1.2.22","1.2.21","1.2.20"]}
+        tags = data.get("tags", [])
+        result=tag in tags 
+        return result
+
+    default_fallback_docker_registry:str="docker.io/library"
+
+    @GeneralUtilities.check_arguments
+    def get_image_with_registry_for_docker_image(self,image:str,tag:str,fallback_registry:str)->str:
         tag_with_colon:str=None
         if tag is None:
             tag_with_colon=""
@@ -96,21 +122,26 @@ class ScriptCollectionCore:
         docker_image_cache_definition_file=self.__get_docker_image_cache_definition_file()
         for line in [f.split(";")[0] for f in GeneralUtilities.read_nonempty_lines_from_file(docker_image_cache_definition_file)[1:]]:
             if line.endswith("/"+image):
-                result= line+tag_with_colon
+                result = line+tag_with_colon
                 #TODO check if docker image is available and if not show warning
                 return result
-        default_registry:str="docker.io/library"
-        result= default_registry+"/"+image
-        self.log.log(f"For image \"{image}\" no cache-registry is defined, so default-registry \"{default_registry}\" will be used instead, which can lead to problems due docker-hub to rate-limits.",LogLevel.Warning)
-        return result+tag_with_colon
-    
+        if fallback_registry is None:
+            raise ValueError(f"For image \"{image}\" no cache-registry and no default-registry is defined.",LogLevel.Warning)
+        else:
+            return f"{fallback_registry}/{image}{tag_with_colon}"
+        
     @GeneralUtilities.check_arguments
-    def get_docker_build_args_for_base_images(self,dockerfile:str)->list[str]:
+    def get_docker_build_args_for_base_images(self,dockerfile:str,fallback_registries:dict[str,str])->list[str]:
         result=[]
         GeneralUtilities.assert_file_exists(dockerfile)
+        if fallback_registries is None:
+            fallback_registries={}
         required_images=[line.split("_")[1] for line in GeneralUtilities.read_nonempty_lines_from_file(dockerfile) if line.startswith("ARG image_")]
         for required_image in required_images:
-            image_with_registry=self.get_image_with_registry_for_docker_image(required_image,None)
+            fallback_registry:str=None
+            if required_image in fallback_registries:
+                fallback_registry=fallback_registries[required_image]
+            image_with_registry=self.get_image_with_registry_for_docker_image(required_image,None,fallback_registry)
             result=result+["--build-arg",f"image_{required_image}={image_with_registry}"]
         return result
 

ScriptCollection/TFCPS/Docker/TFCPS_CodeUnitSpecific_Docker.py

@@ -13,7 +13,7 @@ class TFCPS_CodeUnitSpecific_Docker_Functions(TFCPS_CodeUnitSpecific_Base):
         super().__init__(current_file, verbosity,targetenvironmenttype,use_cache,is_pre_merge)
 
     @GeneralUtilities.check_arguments
-    def build(self,custom_arguments:dict[str,str]) -> None:
+    def build(self,custom_arguments:dict[str,str],fallback_registries:dict[str,str]) -> None:
 
         codeunitname: str =self.get_codeunit_name()
         codeunit_folder =self.get_codeunit_folder() 
@@ -22,7 +22,7 @@ class TFCPS_CodeUnitSpecific_Docker_Functions(TFCPS_CodeUnitSpecific_Base):
         codeunitversion = self.tfcps_Tools_General.get_version_of_codeunit(codeunit_file)
         args = ["image", "build", "--pull", "--force-rm", "--progress=plain", "--build-arg", f"TargetEnvironmentType={self.get_target_environment_type()}", "--build-arg", f"CodeUnitName={codeunitname}", "--build-arg", f"CodeUnitVersion={codeunitversion}", "--build-arg", f"CodeUnitOwnerName={self.tfcps_Tools_General.get_codeunit_owner_name(self.get_codeunit_file())}", "--build-arg", f"CodeUnitOwnerEMailAddress={self.tfcps_Tools_General.get_codeunit_owner_emailaddress(self.get_codeunit_file())}"]
         docker_file=os.path.join(self.get_codeunit_folder(),codeunitname,"Dockerfile")
-        args=args+self._protected_sc.get_docker_build_args_for_base_images(docker_file)
+        args=args+self._protected_sc.get_docker_build_args_for_base_images(docker_file,fallback_registries)
         if custom_arguments is None:
             custom_arguments=dict[str,str]()
         for custom_argument_key, custom_argument_value in custom_arguments.items():
@@ -52,7 +52,7 @@ class TFCPS_CodeUnitSpecific_Docker_Functions(TFCPS_CodeUnitSpecific_Base):
         sbom_folder = os.path.join(artifacts_folder, "BOM")
         codeunitversion = self.tfcps_Tools_General.get_version_of_codeunit(self.get_codeunit_file())
         GeneralUtilities.ensure_directory_exists(sbom_folder)
-        self._protected_sc.run_program_argsasarray("docker", ["run","--rm","-v","/var/run/docker.sock:/var/run/docker.sock","-v","./BOM:/BOM",self._protected_sc.get_image_with_registry_for_docker_image("syft","image"),f"{codeunitname_lower}:{codeunitversion}","-o",f"cyclonedx-xml=/BOM/{codeunitname}.{codeunitversion}.sbom.xml"], artifacts_folder, print_errors_as_information=True)
+        self._protected_sc.run_program_argsasarray("docker", ["run","--rm","-v","/var/run/docker.sock:/var/run/docker.sock","-v","./BOM:/BOM",self._protected_sc.get_image_with_registry_for_docker_image("syft","image","docker.io/anchore/syft"),f"{codeunitname_lower}:{codeunitversion}","-o",f"cyclonedx-xml=/BOM/{codeunitname}.{codeunitversion}.sbom.xml"], artifacts_folder, print_errors_as_information=True)
         self._protected_sc.format_xml_file(sbom_folder+f"/{codeunitname}.{codeunitversion}.sbom.xml")
  
     @GeneralUtilities.check_arguments

{scriptcollection-4.2.0.dist-info → scriptcollection-4.2.2.dist-info}/METADATA

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

{scriptcollection-4.2.0.dist-info → scriptcollection-4.2.2.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ScriptCollection/AnionBuildPlatform.py,sha256=mohXQ0nQrKoiSggCKPtP591TFkzQ56hxJQTJtORn9KE,10756
-ScriptCollection/CertificateUpdater.py,sha256=E2PvU_0jfAvOTfdiI32mhF34GDjXKA3kiW9HzdIIdz4,9248
+ScriptCollection/CertificateUpdater.py,sha256=HGTpQT-MuBw_KW7aHSCOXn0x_9bRIhk6YJq60dGIQPE,9276
 ScriptCollection/Executables.py,sha256=jK7rj06OHE8l4aZPU1I1SF5HNrX2PUTRh3SON3sFx2k,43167
 ScriptCollection/GeneralUtilities.py,sha256=w6T4l91-nZwyKrOHfZm4NP1OP1N021bFPr2RFoloC8E,53709
 ScriptCollection/ImageUpdater.py,sha256=0KPybKb_9IALhSTNflST-mewQVZ4kvXzNtfcN0-Ut8k,29215
@@ -9,7 +9,7 @@ ScriptCollection/ProgramRunnerMock.py,sha256=uTu-aFle1W_oKjeQEmuPsFPQpvo0kRf2FrR
 ScriptCollection/ProgramRunnerPopen.py,sha256=BPY7-ZMIlqT7JOKz8qlB5c0laF2Js-ijzqk09GxZC48,3821
 ScriptCollection/ProgramRunnerSudo.py,sha256=_khC3xuTdrPoLluBJZWfldltmmuKltABJPcbjZSFW-4,4835
 ScriptCollection/SCLog.py,sha256=8TRy1LeYMsPOIuWUcnUNNbO5pd-cNBS-3cn-kdzP8FU,4768
-ScriptCollection/ScriptCollectionCore.py,sha256=qtG9F3KwObB-elw85lwbcg_ZHyH3RKwrDem8KV9jQIA,152892
+ScriptCollection/ScriptCollectionCore.py,sha256=h5_HW27_9b3xAq1F0jByePR0e0XU78iABOQOIrnVNrk,154465
 ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ScriptCollection/TFCPS/TFCPS_CodeUnitSpecific_Base.py,sha256=WRFdmkPrzAO9P7ue-5BH1DZfqmGN9yyb2AouFuv2MiI,27712
 ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnit.py,sha256=vnNrwvNePvW2dQhnSusBjgvOssI3a1P3g94bNxNIr3o,8069
@@ -21,7 +21,7 @@ ScriptCollection/TFCPS/TFCPS_MergeToStable.py,sha256=-7ZtiLAUp0vdgnVHhcjX_WQSVR1
 ScriptCollection/TFCPS/TFCPS_PreBuildCodeunitsScript.py,sha256=f0Uq1cA_4LvmL72cal0crrbKF6PcxL13D9wBKuQ1YBw,2328
 ScriptCollection/TFCPS/TFCPS_Tools_General.py,sha256=yFWbW51Pt-oEpBlO9Fg8BvSM3bhUmtk__BllgtX6aqI,87785
 ScriptCollection/TFCPS/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ScriptCollection/TFCPS/Docker/TFCPS_CodeUnitSpecific_Docker.py,sha256=kDCgxQgs_TUTvxjGMsKoi_53KCVIn5C3Ia1iLzgw1A8,10299
+ScriptCollection/TFCPS/Docker/TFCPS_CodeUnitSpecific_Docker.py,sha256=ol_Ocfj-jl34wSxHeCIFlG8vSdSYRg9PUnJhDeNdq_I,10378
 ScriptCollection/TFCPS/Docker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ScriptCollection/TFCPS/DotNet/CertificateGeneratorInformationBase.py,sha256=bT6Gd5pQpZCw4OQz6HWkPCSn5z__eUUEisABLDSxd0o,200
 ScriptCollection/TFCPS/DotNet/CertificateGeneratorInformationGenerate.py,sha256=QyjOfMY22JWCvKjMelHiDWbJiWqotOfebpJpgDUaoO4,237
@@ -36,8 +36,8 @@ ScriptCollection/TFCPS/NodeJS/TFCPS_CodeUnitSpecific_NodeJS.py,sha256=aXC_f39edp
 ScriptCollection/TFCPS/NodeJS/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ScriptCollection/TFCPS/Python/TFCPS_CodeUnitSpecific_Python.py,sha256=nLw_eSUd_56jjgfcAvtUyzecSZ14mYmNJl0iu-1YNVk,13496
 ScriptCollection/TFCPS/Python/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scriptcollection-4.2.0.dist-info/METADATA,sha256=vzb2Rt3ykSFEDW0_oE1VMAuijVp13yumtdhUCSV7rec,7689
-scriptcollection-4.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-scriptcollection-4.2.0.dist-info/entry_points.txt,sha256=6Az2eMD7luwGPSdoIhJ1y6ZtgxsfezgJCsFhOnyhnwM,4627
-scriptcollection-4.2.0.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
-scriptcollection-4.2.0.dist-info/RECORD,,
+scriptcollection-4.2.2.dist-info/METADATA,sha256=XmT3BgR6Y2pDcng5_anKCpMEAVO-wvjRFtc4uaDgnaE,7689
+scriptcollection-4.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+scriptcollection-4.2.2.dist-info/entry_points.txt,sha256=6Az2eMD7luwGPSdoIhJ1y6ZtgxsfezgJCsFhOnyhnwM,4627
+scriptcollection-4.2.2.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
+scriptcollection-4.2.2.dist-info/RECORD,,