V2 list region by version #593

src/cloudimagedirectory/transform/transform.py

@@ -564,3 +564,51 @@
                     connection.DataEntry(f"v2/os/{os}/provider/{provider}/version/list", version_map[provider])
                 )
         return results
+
+
+class TransformerV2ListRegionByVersion(Transformer):
+    """Generate a list for all available regions for one version."""
+
+    @no_type_check
+    def run(self, data: type[Transformer]) -> list:  # noqa: C901
+        # NOTE: check that its the v2 data entries.
+        entries = [x for x in data if x.is_API("v2")]
+
+        results = []
+        regions = {}
+
+        for e in entries:
+            entry = copy.deepcopy(e)
+            filename = entry.filename.split("/")
+            os = filename[2]
+            provider = filename[4]
+            version = filename[6]
+            region = filename[8]
+
+            if os not in regions:
+                regions[os] = {provider: {}}
+
+            if provider not in regions[os]:
+                regions[os][provider] = {version: {}}
+
+            if version not in regions[os][provider]:
+                regions[os][provider][version] = {region: 1}
+                continue
+
+            if region not in regions[os][provider][version]:
+                regions[os][provider][version][region] = 1
+                continue
+
+            # NOTE: Counter of how many images are available in this explicit version.
+            regions[os][provider][version][region] += 1
+
+        for os, region_map in regions.items():
+            for provider, version_map in region_map.items():
+                for version in version_map:
+                    # NOTE: Add /list suffix to prevent collision with "region" folder.
+                    results.append(
+                        connection.DataEntry(
+                            f"v2/os/{os}/provider/{provider}/version/{version}/region/list", version_map[version]
+                        )
+                    )
+        return results

src/cloudimagedirectory/transformer.py

@@ -100,6 +100,7 @@ def run(origin_path: str, destination_path: str, arg_files: str, filter_until: s
             transform.TransformerV2ListOS,
             transform.TransformerV2ListProviderByOS,
             transform.TransformerV2ListVersionByProvider,
+            transform.TransformerV2ListRegionByVersion,
         ],
     )
     print("run pipeline v2")

tests/transformer/test_list_region.py

@@ -0,0 +1,86 @@
+"""Test for the list region endpoint."""
+import filecmp
+import os
+
+from cloudimagedirectory import transformer
+
+
+def test_V2ListRegion(runner, tmp_path):
+    """Run transformer end to end and generate a list with all available
+    regions for the specific version."""
+    result = runner.invoke(
+        transformer.run,
+        [
+            "-f",
+            "tests/transformer/testdata/input/raw/google/all.json,tests/transformer/testdata/input/raw/aws/af-south-1.json,tests/transformer/testdata/input/raw/azure/eastus.json",
+            "-op=.",
+            f"-dp={tmp_path}",
+            "--filter.until=none",
+        ],
+    )
+
+    assert result.exit_code == 0, f"expected no error, but got code {result.exit_code} and output:\n{result.output}"
+
+    # Get current directory
+    pwd = os.getcwd()
+
+    # Check image data by comparing the expected file and the output file byte by byte.
+    assert filecmp.cmp(
+        f"{pwd}/tests/transformer/testdata/expected/v2/os/rhel/provider/google/version/7/region/list",
+        f"{tmp_path}/v2/os/rhel/provider/google/version/7/region/list",
+    )
+
+
+def test_transformerV2ListVersion(tmpdir):
+    """Test list version run method."""
+    temporary_directory = tmpdir.mkdir("test")
+    connection = transformer.connection.ConnectionFS(temporary_directory, [])
+    runner = transformer.transform.TransformerV2ListRegionByVersion(connection)
+    chunk_size = 2
+    runner.chunk_size = chunk_size
+    data = [
+        transformer.connection.DataEntry(
+            "v2/os/rhel/provider/google/version/9/region/global/image/9054fbe0b622c638224d50d20824d2ff6782e308",
+            {
+                "date": "2023-03-06T12:57:17.827-08:00",
+                "name": "test2",
+                "arch": "ARM64",
+                "region": "global",
+            },
+        ),
+        transformer.connection.DataEntry(
+            "v2/os/rhel/provider/google/version/8/region/global/image/dba7673010f19a94af4345453005933fd511bea9",
+            {
+                "date": "2019-01-01",
+                "name": "test1",
+                "arch": "arch1",
+                "region": "global",
+            },
+        ),
+        transformer.connection.DataEntry(
+            "v2/os/rhel/provider/aws/version/8/region/ap-south-2/image/9054fbe0b622c638224d50d20824d2ff6782e308",
+            {
+                "date": "2020-01-01",
+                "name": "test2",
+                "arch": "arch2",
+                "region": "ap-south-2",
+            },
+        ),
+        transformer.connection.DataEntry(
+            "v2/os/unkown/provider/aws/version/7/region/some-region-1/image/9054fbe0b622c638224d50d20824d2ff6782e308",
+            {
+                "date": "2020-01-01",
+                "name": "test2",
+                "arch": "arch2",
+                "region": "region-1",
+            },
+        ),
+    ]
+    results = runner.run(data)
+    expected = transformer.connection.DataEntry(
+        "v2/os/rhel/provider/google/version/9/region/list",
+        {"global": 1},
+    )
+
+    assert expected.filename == results[0].filename
+    assert expected.content == results[0].content

tests/transformer/testdata/expected/v2/os/rhel/provider/google/version/7/region/list

@@ -0,0 +1 @@
+{"global": 1}