fix!: support GovCloud regions in commercial region list

Since region support requests can now update gov regions
with the API, this change allows gov regions to be
included in the `region` field.

Instead of removing the entire validator, gov regions are
excluded from the invalid region list, allowing users
to add them to listings.

BREAKING-CHANGE: 'all' option in `commercial_regions` field
is removed to require users to specify each region explicitly.

Author: JessicaJang

awsmp/models.py

@@ -221,14 +221,13 @@ class Region(BaseModel):
     @field_validator("commercial_regions")
     def commercial_region_validator(cls, value):
         client = boto3.client("ec2")
-        available_regions = [region["RegionName"] for region in client.describe_regions()["Regions"]]
-        if value[0] == "all":
-            return available_regions
-        else:
-            invalid_regions = set(value) - set(available_regions)
-            if invalid_regions:
-                raise ValueError(f"{invalid_regions} are not valid for commercial regions")
-            return value
+        gov_regions = ["us-gov-east-1", "us-gov-west-1"]
+        available_regions = [region["RegionName"] for region in client.describe_regions()["Regions"]] + gov_regions
+
+        invalid_regions = set(value) - set(available_regions)
+        if invalid_regions:
+            raise ValueError(f"{invalid_regions} are not valid for commercial regions")
+        return value
 
     def future_region_supported(self) -> List[str]:
         return ["All" if self.future_region_support else "None"]

tests/test_driver.py

@@ -1133,7 +1133,7 @@ def test_ami_product_update_region_invalid_values(mock_boto3, mock_get_client, i
     "valid_region_configs",
     [
         ({"future_region_support": True}),
-        ({"commercial_regions": ["all"]}),
+        ({"commercial_regions": ["eu-north-1"]}),
     ],
 )
 @patch("awsmp._driver.get_client")
@@ -1159,6 +1159,39 @@ def test_ami_product_update_region_valid_values(mock_boto3, mock_get_client, val
     ] == {"FutureRegionSupport": {"SupportedRegions": ["All"]}}
 
 
+@patch("awsmp._driver.get_client")
+@patch("awsmp._driver.changesets.models.boto3")
+def test_ami_product_update_region_valid_values_with_gov_regions(mock_boto3, mock_get_client):
+    mock_region_config = {
+        "commercial_regions": ["us-east-1", "us-gov-east-1"],
+        "future_region_support": True,
+    }
+    mock_boto3.client.return_value.describe_regions.return_value = {
+        "Regions": [{"Endpoint": "ec2.us-east-1.amazonaws.com", "RegionName": "us-east-1", "OptInStatus": "opted-in"}]
+    }
+    ap = _driver.AmiProduct(product_id="testing")
+    ap.update_regions(mock_region_config)
+
+    assert mock_get_client.return_value.start_change_set.call_args_list[0].kwargs["ChangeSet"][0][
+        "DetailsDocument"
+    ] == {"Regions": ["us-east-1", "us-gov-east-1"]}
+
+
+@patch("awsmp._driver.get_client")
+@patch("awsmp._driver.changesets.models.boto3")
+def test_ami_product_update_region_invalid_values_with_gov_regions(mock_boto3, mock_get_client):
+    mock_region_config = {
+        "commercial_regions": ["us-east-1", "us-gov-west-2"],
+        "future_region_support": True,
+    }
+    mock_boto3.client.return_value.describe_regions.return_value = {
+        "Regions": [{"Endpoint": "ec2.us-east-1.amazonaws.com", "RegionName": "us-east-1", "OptInStatus": "opted-in"}]
+    }
+
+    with pytest.raises(ValidationError):
+        _driver.AmiProduct(product_id="testing").update_regions(mock_region_config)
+
+
 @pytest.mark.parametrize(
     "invalid_version_configs",
     [

tests/test_models.py

@@ -77,6 +77,18 @@ def test_region_availability_future_region_supported(self, mock_boto3):
         region = models.Region(commercial_regions=["us-east-1", "us-east-2"], future_region_support=False)
         assert region.future_region_supported() == ["None"]
 
+    def test_region_availability_regions(self, mock_boto3):
+        region = models.Region(commercial_regions=["us-east-1", "us-east-2"], future_region_support=True)
+        assert region.commercial_regions == ["us-east-1", "us-east-2"]
+
+    def test_region_availability_gov_regions(self, mock_boto3):
+        region = models.Region(commercial_regions=["us-east-1", "us-gov-east-1"], future_region_support=True)
+        assert region.commercial_regions == ["us-east-1", "us-gov-east-1"]
+
+    def test_region_availability_only_gov_regions(self, mock_boto3):
+        region = models.Region(commercial_regions=["us-gov-west-1", "us-gov-east-1"], future_region_support=True)
+        assert region.commercial_regions == ["us-gov-west-1", "us-gov-east-1"]
+
 
 class TestAmiVersion:
     def _get_version_details(self):