awspub 0.0.3__py3-none-any.whl → 0.0.5__py3-none-any.whl

awspub/configmodels.py

@@ -101,7 +101,9 @@ class ConfigImageModel(BaseModel):
 
     description: Optional[str] = Field(description="Optional image description", default=None)
     regions: Optional[List[str]] = Field(
-        description="Optional list of regions for this image. If not given, all available regions will be used",
+        description="Optional list of regions for this image. If not given, all available regions will"
+        "be used from the currently used partition. If a region doesn't exist in the currently used partition,"
+        " it will be ignored.",
         default=None,
     )
     separate_snapshot: bool = Field(description="Use a separate snapshot for this image?", default=False)

awspub/image.py

@@ -54,6 +54,7 @@ class Image:
         self._ctx: Context = context
         self._image_name: str = image_name
         self._image_regions: List[str] = []
+        self._image_regions_cached: bool = False
 
         if self._image_name not in self._ctx.conf["images"].keys():
             raise ValueError(f"image '{self._image_name}' not found in context configuration")
@@ -119,15 +120,28 @@ class Image:
     def image_regions(self) -> List[str]:
         """
         Get the image regions. Either configured in the image configuration
-        or all available regions
+        or all available regions.
+        If a region is listed that is not available in the currently used partition,
+        that region will be ignored (eg. having us-east-1 configured but running in the aws-cn
+        partition doesn't include us-east-1 here).
         """
-        if not self._image_regions:
+        if not self._image_regions_cached:
+            # get all available regions
+            ec2client: EC2Client = boto3.client("ec2", region_name=self._s3.bucket_region)
+            resp = ec2client.describe_regions()
+            image_regions_all = [r["RegionName"] for r in resp["Regions"]]
+
             if self.conf["regions"]:
-                self._image_regions = self.conf["regions"]
+                # filter out regions that are not available in the current partition
+                image_regions_configured_set = set(self.conf["regions"])
+                image_regions_all_set = set(image_regions_all)
+                self._image_regions = list(image_regions_configured_set.intersection(image_regions_all_set))
+                diff = image_regions_configured_set.difference(image_regions_all_set)
+                if diff:
+                    logger.warning(f"configured regions {diff} not available in the current partition. Ignoring those.")
             else:
-                ec2client: EC2Client = boto3.client("ec2", region_name=self._s3.bucket_region)
-                resp = ec2client.describe_regions()
-                self._image_regions = [r["RegionName"] for r in resp["Regions"]]
+                self._image_regions = image_regions_all
+            self._image_regions_cached = True
         return self._image_regions
 
     @property
@@ -493,6 +507,10 @@ class Image:
         else:
             logger.info(f"image {self.image_name} not marked as public. do not publish")
 
+        # handle SSM parameter store
+        if self.conf["ssm_parameter"]:
+            self._put_ssm_parameters()
+
         # handle marketplace publication
         if self.conf["marketplace"]:
             # the "marketplace" configuration is only valid in the "aws" partition
@@ -515,10 +533,6 @@ class Image:
                     f"currently using partition {partition}. Ignoring marketplace config."
                 )
 
-        # handle SSM parameter store
-        if self.conf["ssm_parameter"]:
-            self._put_ssm_parameters()
-
     def _verify(self, region: str) -> List[ImageVerificationErrors]:
         """
         Verify (but don't modify or create anything) the image in a single region

awspub/tests/test_image.py

@@ -40,27 +40,34 @@ def test_snapshot_names(imagename, snapshotname):
 
 
 @pytest.mark.parametrize(
-    "imagename,regions",
+    "imagename,regions_in_partition,regions_expected",
     [
         # test-image-1 has 2 regions defined
-        ("test-image-1", ["region1", "region2"]),
+        ("test-image-1", ["region1", "region2"], ["region1", "region2"]),
+        # test-image-1 has 2 regions defined and there are more regions in the partition
+        ("test-image-1", ["region1", "region2", "region3"], ["region1", "region2"]),
+        ("test-image-1", ["region1", "region2"], ["region1", "region2"]),
         # test-image-2 has no regions defined, so whatever the ec2 client returns should be valid
-        ("test-image-2", ["all-region-1", "all-region-2"]),
+        ("test-image-2", ["all-region-1", "all-region-2"], ["all-region-1", "all-region-2"]),
+        # test-image-1 has 2 regions defined, but those regions are not in the partition
+        ("test-image-1", ["region3", "region4"], []),
+        # test-image-1 has 2 regions defined, but those regions are not partially in the partition
+        ("test-image-1", ["region2", "region4"], ["region2"]),
+        # test-image-2 has no regions defined and the ec2 client doesn't return any regions
+        ("test-image-2", [], []),
     ],
 )
 @patch("awspub.s3.S3.bucket_region", return_value="region1")
-def test_image_regions(s3_region_mock, imagename, regions):
+def test_image_regions(s3_region_mock, imagename, regions_in_partition, regions_expected):
     """
     Test the regions for a given image
     """
     with patch("boto3.client") as bclient_mock:
         instance = bclient_mock.return_value
-        instance.describe_regions.return_value = {
-            "Regions": [{"RegionName": "all-region-1"}, {"RegionName": "all-region-2"}]
-        }
+        instance.describe_regions.return_value = {"Regions": [{"RegionName": r} for r in regions_in_partition]}
         ctx = context.Context(curdir / "fixtures/config1.yaml", None)
         img = image.Image(ctx, imagename)
-        assert img.image_regions == regions
+        assert sorted(img.image_regions) == sorted(regions_expected)
 
 
 @pytest.mark.parametrize(
@@ -77,6 +84,8 @@ def test_image_cleanup(imagename, cleanup):
     with patch("boto3.client") as bclient_mock:
         instance = bclient_mock.return_value
         instance.describe_images.return_value = {"Images": [{"Name": imagename, "Public": False, "ImageId": "ami-123"}]}
+        instance.describe_regions.return_value = {"Regions": [{"RegionName": "region1"}, {"RegionName": "region2"}]}
+        instance.list_buckets.return_value = {"Buckets": [{"Name": "bucket1"}]}
         ctx = context.Context(curdir / "fixtures/config1.yaml", None)
         img = image.Image(ctx, imagename)
         img.cleanup()
@@ -154,6 +163,10 @@ def test_image_publish(
             ]
         }
         instance.get_parameters.return_value = {"Parameters": []}
+        instance.describe_regions.return_value = {
+            "Regions": [{"RegionName": "eu-central-1"}, {"RegionName": "us-east-1"}]
+        }
+        instance.list_buckets.return_value = {"Buckets": [{"Name": "bucket1"}]}
         ctx = context.Context(curdir / "fixtures/config1.yaml", None)
         img = image.Image(ctx, imagename)
         img.publish()
@@ -299,6 +312,10 @@ def test_image_list(available_images, expected):
     with patch("boto3.client") as bclient_mock:
         instance = bclient_mock.return_value
         instance.describe_images.return_value = {"Images": available_images}
+        instance.describe_regions.return_value = {
+            "Regions": [{"RegionName": "eu-central-1"}, {"RegionName": "us-east-1"}]
+        }
+        instance.list_buckets.return_value = {"Buckets": [{"Name": "bucket1"}]}
         ctx = context.Context(curdir / "fixtures/config1.yaml", None)
         img = image.Image(ctx, "test-image-6")
         assert img.list() == expected
@@ -330,6 +347,10 @@ def test_image_create_existing(s3_bucket_mock):
                 }
             ]
         }
+        instance.describe_regions.return_value = {
+            "Regions": [{"RegionName": "eu-central-1"}, {"RegionName": "us-east-1"}]
+        }
+        instance.list_buckets.return_value = {"Buckets": [{"Name": "bucket1"}]}
         ctx = context.Context(curdir / "fixtures/config1.yaml", None)
         img = image.Image(ctx, "test-image-6")
         assert img.create() == {"eu-central-1": image._ImageInfo(image_id="ami-123", snapshot_id="snap-123")}
@@ -375,6 +396,10 @@ def test_image__put_ssm_parameters(
         instance = bclient_mock.return_value
         instance.describe_images.return_value = {"Images": describe_images}
         instance.get_parameters.return_value = {"Parameters": get_parameters}
+        instance.describe_regions.return_value = {
+            "Regions": [{"RegionName": "eu-central-1"}, {"RegionName": "us-east-1"}]
+        }
+        instance.list_buckets.return_value = {"Buckets": [{"Name": "bucket1"}]}
         ctx = context.Context(curdir / "fixtures/config1.yaml", None)
         img = image.Image(ctx, imagename)
         img._put_ssm_parameters()

{awspub-0.0.3.dist-info → awspub-0.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: awspub
-Version: 0.0.3
+Version: 0.0.5
 Summary: Publish images to AWS EC2
 Home-page: https://github.com/canonical/awspub
 License: GPL-3.0-or-later

{awspub-0.0.3.dist-info → awspub-0.0.5.dist-info}/RECORD

@@ -1,10 +1,10 @@
 awspub/__init__.py,sha256=7hgLrq6k53yaJrjFe7X5Cm45z3SIc1Vxocb5k3G8xPc,124
 awspub/api.py,sha256=d1gx9LdqdYXRLf8yZ_spIz_93WhB2GNnCG_x3ABrMkI,6497
 awspub/cli/__init__.py,sha256=-zCBEbnt5zbvSZ8PxQALpPAy0CiQUf-qZnikJ7U4Sf0,5621
-awspub/configmodels.py,sha256=8JV_fh9VTCSTRcwoqdxXoNFUurn5Q1iTfp-r3u-OLUQ,6869
+awspub/configmodels.py,sha256=ZHk9sfe3yAg8kBK6FV7Y0rmke9YKlY4t_D-Q4k3XRMM,7004
 awspub/context.py,sha256=LDkp9Sz5AqRxQq70ICgFIJn5g2qrc5qiVawTyS_rXZE,4064
 awspub/exceptions.py,sha256=SbGf9XyiGlj6estlraAwWAKLtuEfzwEuAbHXYiCiJD0,447
-awspub/image.py,sha256=zVmf_g3JU1CJ2kQCLtRxFumxxmt2vyKDn_NYwINt8B0,25763
+awspub/image.py,sha256=YOa4zV9EHGDnYng06gnQNx4TR5haVTGDUNzp09JbcO8,26683
 awspub/image_marketplace.py,sha256=oiD7yNU5quG5CQG9Ql5Ut9hLWA1yewg6qVwTbyadGwc,5314
 awspub/s3.py,sha256=vnel5UtASHK_mkGuZDnA1IydWCLD_TCZ_WyWwAds9F8,11271
 awspub/snapshot.py,sha256=V5e_07SnmCwEPjRmwZh43spWparhH8X4ugG16uQfGuo,10040
@@ -20,12 +20,12 @@ awspub/tests/fixtures/config3-duplicate-keys.yaml,sha256=Cn0tTQawpEFocDNpWxDz165
 awspub/tests/test_api.py,sha256=7MKm2aCtcvHJ0x_o2qinljfL9xFBWnasUnVpBxB37w8,2504
 awspub/tests/test_cli.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 awspub/tests/test_context.py,sha256=wMXQqj4vi2U3q5w1xPV-stB3mp3K6puUyXhsShJG4wA,3115
-awspub/tests/test_image.py,sha256=4z7UmcUhFBXCFX-iGz4FbHp7mgm_JNTTJsHSONMbwi0,16400
+awspub/tests/test_image.py,sha256=uFY_kfV-ZioqqP2vBTgT3fGy-So50iJc__2ewbt_6t8,18287
 awspub/tests/test_image_marketplace.py,sha256=JP7PrFjix1AyQg7eEaQ-wCROVoIOb873koseniOqGQQ,1456
 awspub/tests/test_s3.py,sha256=UJL8CQDEvhA42MwPGeSvSbQFj8h86c1LrLFDvcMcRws,2857
 awspub/tests/test_snapshot.py,sha256=8KPTqGVyzrpivWuq3HE7ZhgtLllcr3rA_3hZcxu2xjg,4123
-awspub-0.0.3.dist-info/LICENSE,sha256=9GbrzFQ3rWjVKj-IZnX1kGDsIGIdjc25KGRmAp03Jn0,35150
-awspub-0.0.3.dist-info/METADATA,sha256=801RoUx_vjXBbn_MRvZV7HJ8POqBOiJKaFMY4hgdG9s,1773
-awspub-0.0.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-awspub-0.0.3.dist-info/entry_points.txt,sha256=hrQzy9P5yO58nj6W0UDPdQPUTqEkQLpMvuyDDRu7LRQ,42
-awspub-0.0.3.dist-info/RECORD,,
+awspub-0.0.5.dist-info/LICENSE,sha256=9GbrzFQ3rWjVKj-IZnX1kGDsIGIdjc25KGRmAp03Jn0,35150
+awspub-0.0.5.dist-info/METADATA,sha256=Z8H6_DNIlhHGDQjUBCM9SFd4SZNNQrn0ALooc94SjcE,1773
+awspub-0.0.5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+awspub-0.0.5.dist-info/entry_points.txt,sha256=hrQzy9P5yO58nj6W0UDPdQPUTqEkQLpMvuyDDRu7LRQ,42
+awspub-0.0.5.dist-info/RECORD,,