awspub 0.0.1__py3-none-any.whl

awspub/tests/fixtures/config1.yaml

@@ -0,0 +1,118 @@
+awspub:
+  s3:
+    bucket_name: "bucket1"
+
+  source:
+    # config1.vmdk generated with
+    # dd if=/dev/zero of=config1.raw bs=1K count=1
+    # qemu-img convert -f raw -O vmdk -o subformat=streamOptimized config1.raw config1.vmdk
+    path: "config1.vmdk"
+    architecture: "x86_64"
+
+  images:
+    "test-image-1":
+      description: |
+        A test image
+      boot_mode: "uefi"
+      regions:
+        - region1
+        - region2
+      temporary: true
+      groups:
+        - group1
+        - group2
+    "test-image-2":
+      description: |
+        A test image with a separate snapshot
+      boot_mode: "uefi"
+      separate_snapshot: true
+      groups:
+        - group1
+    "test-image-3":
+      description: |
+        A test image with a separate snapshot and a billing code
+      boot_mode: "uefi"
+      separate_snapshot: true
+      billing_products:
+        - billingcode
+    "test-image-4":
+      description: |
+        A test image without a separate snapshot but a billing product
+      boot_mode: "uefi-preferred"
+      billing_products:
+        - billingcode
+    "test-image-5":
+      description: |
+        A test image without a separate snapshot but multiple billing products
+      boot_mode: "uefi-preferred"
+      billing_products:
+        - billingcode1
+        - billingcode2
+    "test-image-6":
+      description: |
+        A test image without a separate snapshot but multiple billing products
+      boot_mode: "uefi-preferred"
+      regions:
+        - "eu-central-1"
+      public: true
+      tags:
+        key1: value1
+    "test-image-7":
+      description: |
+        A test image without a separate snapshot but multiple billing products
+      boot_mode: "uefi-preferred"
+      regions:
+        - "eu-central-1"
+      public: true
+      temporary: true
+      tags:
+        key2: name
+        name: "not-foobar"
+    "test-image-8":
+      description: |
+        A test image without a separate snapshot but multiple billing products
+      boot_mode: "uefi-preferred"
+      regions:
+        - "eu-central-1"
+        - "us-east-1"
+      public: true
+      tags:
+        key1: value1
+      marketplace:
+        entity_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+        access_role_arn: "arn:aws:iam::xxxxxxxxxxxx:role/AWSMarketplaceAccess"
+        version_title: "1.0.0"
+        release_notes: "N/A"
+        user_name: "ubuntu"
+        scanning_port: 22
+        os_name: "UBUNTU"
+        os_version: "22.04"
+        usage_instructions: |
+          You can use me
+        recommended_instance_type: "m5.large"
+        security_groups:
+          -
+            from_port: 22
+            ip_protocol: "tcp"
+            ip_ranges:
+              - "0.0.0.0/0"
+            to_port: 22
+      ssm_parameter:
+        -
+          name: /test/image
+        -
+          name: /test/another-image
+    "test-image-9":
+      boot_mode: "uefi"
+      description: |
+        A test image without a separate snapshot but multiple billing products
+      regions:
+        - "eu-central-1"
+        - "us-east-1"
+      ssm_parameter:
+        -
+          name: /awspub-test/param2
+          allow_overwrite: true
+
+  tags:
+    name: "foobar"

awspub/tests/fixtures/config2-mapping.yaml

@@ -0,0 +1,2 @@
+key1: "value1"
+key2: "value$2"

awspub/tests/fixtures/config2.yaml

@@ -0,0 +1,48 @@
+awspub:
+  s3:
+    bucket_name: "bucket1"
+
+  source:
+    # config1.vmdk generated with
+    # dd if=/dev/zero of=config1.raw bs=1K count=1
+    # qemu-img convert -f raw -O vmdk -o subformat=streamOptimized config1.raw config1.vmdk
+    path: "config1.vmdk"
+    architecture: "x86_64"
+
+  images:
+    "test-image-$key1":
+      description: |
+        A test image
+      boot_mode: "uefi"
+      regions:
+        - region1
+        - region2
+      temporary: true
+    "test-image-$key2":
+      description: |
+        A test image with a separate snapshot
+      boot_mode: "uefi"
+      separate_snapshot: true
+    "test-image-3":
+      description: |
+        A test image with a separate snapshot and a billing code
+      boot_mode: "uefi"
+      separate_snapshot: true
+      billing_products:
+        - billingcode
+    "test-image-4":
+      description: |
+        A test image without a separate snapshot but a billing product
+      boot_mode: "uefi-preferred"
+      billing_products:
+        - billingcode
+    "test-image-5":
+      description: |
+        A test image without a separate snapshot but multiple billing products
+      boot_mode: "uefi-preferred"
+      billing_products:
+        - billingcode1
+        - billingcode2
+
+  tags:
+    name: "foobar"

awspub/tests/fixtures/config3-duplicate-keys.yaml

@@ -0,0 +1,18 @@
+awspub:
+  s3:
+    bucket_name: "bucket1"
+
+  source:
+    path: "config1.vmdk"
+    architecture: "x86_64"
+
+  images:
+    "test-image-1":
+      description: |
+        A test image
+      boot_mode: "uefi"
+    # second image with the same key
+    "test-image-1":
+      description: |
+        A test image
+      boot_mode: "uefi"

awspub/tests/test_api.py

@@ -0,0 +1,86 @@
+import pathlib
+
+import pytest
+
+from awspub import api, context, image
+
+curdir = pathlib.Path(__file__).parent.resolve()
+
+
+@pytest.mark.parametrize(
+    "group,expected_image_names",
+    [
+        # without any group, all images should be processed
+        (
+            None,
+            [
+                "test-image-1",
+                "test-image-2",
+                "test-image-3",
+                "test-image-4",
+                "test-image-5",
+                "test-image-6",
+                "test-image-7",
+                "test-image-8",
+                "test-image-9",
+            ],
+        ),
+        # with a group that no image as, no image should be processed
+        (
+            "group-not-used",
+            [],
+        ),
+        # with a group that an image has
+        (
+            "group2",
+            ["test-image-1"],
+        ),
+        # with a group that multiple images have
+        (
+            "group1",
+            ["test-image-1", "test-image-2"],
+        ),
+    ],
+)
+def test_api__images_filtered(group, expected_image_names):
+    """
+    Test the _images_filtered() function
+    """
+    ctx = context.Context(curdir / "fixtures/config1.yaml", None)
+
+    image_names = [i[0] for i in api._images_filtered(ctx, group)]
+    assert image_names == expected_image_names
+
+
+@pytest.mark.parametrize(
+    "group,expected",
+    [
+        # without any group, all images should be processed
+        (
+            None,
+            (
+                {"test-image-1": {"eu-central-1": "ami-123", "eu-central-2": "ami-456"}},
+                {
+                    "group1": {"test-image-1": {"eu-central-1": "ami-123", "eu-central-2": "ami-456"}},
+                    "group2": {"test-image-1": {"eu-central-1": "ami-123", "eu-central-2": "ami-456"}},
+                },
+            ),
+        ),
+        # with a group that no image as, image should be there but nothing in the group
+        ("group-not-used", ({"test-image-1": {"eu-central-1": "ami-123", "eu-central-2": "ami-456"}}, {})),
+    ],
+)
+def test_api__images_grouped(group, expected):
+    """
+    Test the _images_grouped() function
+    """
+    ctx = context.Context(curdir / "fixtures/config1.yaml", None)
+    images = [
+        (
+            "test-image-1",
+            image.Image(ctx, "test-image-1"),
+            {"eu-central-1": image._ImageInfo("ami-123", None), "eu-central-2": image._ImageInfo("ami-456", None)},
+        )
+    ]
+    grouped = api._images_grouped(images, group)
+    assert grouped == expected

awspub/tests/test_context.py

@@ -0,0 +1,88 @@
+import glob
+import os
+import pathlib
+
+import pytest
+from pydantic import ValidationError
+from ruamel.yaml.constructor import DuplicateKeyError
+
+from awspub import context
+
+curdir = pathlib.Path(__file__).parent.resolve()
+
+
+def test_context_create():
+    """
+    Create a Context object from a given configuration
+    """
+    ctx = context.Context(curdir / "fixtures/config1.yaml", None)
+    assert ctx.conf["source"]["path"] == curdir / "fixtures/config1.vmdk"
+    assert ctx.source_sha256 == "6252475408b9f9ee64452b611d706a078831a99b123db69d144d878a0488a0a8"
+    assert ctx.conf["source"]["architecture"] == "x86_64"
+    assert ctx.conf["s3"]["bucket_name"] == "bucket1"
+
+
+def test_context_create_minimal():
+    """
+    Create a Context object from a given minimal configuration
+    """
+    ctx = context.Context(curdir / "fixtures/config-minimal.yaml", None)
+    assert ctx.conf["source"]["path"] == curdir / "fixtures/config1.vmdk"
+    assert ctx.source_sha256 == "6252475408b9f9ee64452b611d706a078831a99b123db69d144d878a0488a0a8"
+    assert ctx.conf["source"]["architecture"] == "x86_64"
+    assert ctx.conf["s3"]["bucket_name"] == "bucket1"
+
+
+def test_context_create_with_mapping():
+    """
+    Create a Context object from a given configuration
+    """
+    ctx = context.Context(curdir / "fixtures/config2.yaml", curdir / "fixtures/config2-mapping.yaml")
+    assert ctx.conf["source"]["path"] == curdir / "fixtures/config1.vmdk"
+    assert ctx.source_sha256 == "6252475408b9f9ee64452b611d706a078831a99b123db69d144d878a0488a0a8"
+    assert ctx.conf["images"].get("test-image-value1")
+    assert ctx.conf["images"].get("test-image-value$2")
+
+
+def test_context_with_docs_config_samples():
+    """
+    Create a Context object with the sample config files used for documentation
+    """
+    config_samples_dir = curdir.parents[1] / "docs" / "config-samples"
+    for f in glob.glob(f"{config_samples_dir}/*.yaml"):
+        mapping_file = f + ".mapping"
+        if os.path.exists(mapping_file):
+            mapping = mapping_file
+        else:
+            mapping = None
+        context.Context(os.path.join(config_samples_dir, f), mapping)
+
+
+def test_context_with_duplicate_image_name():
+    """
+    Create a context with a configuration file that contains a duplicate image name key
+    """
+    with pytest.raises(DuplicateKeyError):
+        context.Context(curdir / "fixtures/config3-duplicate-keys.yaml", None)
+
+
+@pytest.mark.parametrize(
+    "config_file",
+    ["fixtures/config-minimal.yaml", "fixtures/config-valid-nonawspub.yaml"],
+)
+def test_valid_configuration(config_file):
+    """
+    Test with a valid configuration file (no extra fields)
+    """
+    ctx = context.Context(curdir / config_file, None)
+    assert ctx.conf is not None
+    assert ctx.conf["s3"]["bucket_name"] == "bucket1"
+    assert ctx.conf["source"]["architecture"] == "x86_64"
+
+
+def test_invalid_configuration_extra_field():
+    """
+    Test with an invalid configuration file that includes an extra field
+    """
+    with pytest.raises(ValidationError):
+        context.Context(curdir / "fixtures/config-invalid-s3-extra.yaml", None)