updates api

Author: pcrespov

packages/aws-library/src/aws_library/ec2/_client.py

@@ -30,6 +30,9 @@
 _logger = logging.getLogger(__name__)
 
 
+ALL = None
+
+
 @dataclass()
 class SimcoreEC2API:
     client: EC2Client
@@ -66,20 +69,30 @@ async def ping(self) -> bool:
     @ec2_exception_handler(_logger)
     async def get_ec2_instance_capabilities(
         self,
-        instance_type_names: set[InstanceTypeType],
+        instance_type_names: set[InstanceTypeType] | None = ALL,
     ) -> list[EC2InstanceType]:
         """Returns the ec2 instance types from a list of instance type names (sorted by name)
 
         Arguments:
-            instance_type_names -- the types to filter with. If an empty set, it returns all.
+            instance_type_names -- the types to filter with
 
         Raises:
             Ec2InstanceTypeInvalidError: some invalid types were used as filter
             ClustersKeeperRuntimeError: unexpected error communicating with EC2
 
         """
+        if instance_type_names is None:
+            assert ALL is None  # nosec
+            selected_instance_types = []
+        else:
+            selected_instance_types = list(instance_type_names)
+
+        if len(selected_instance_types) == 0:
+            msg = "`instance_type_names` cannot be an empty set. Set as None if all"
+            raise ValueError(msg)
+
         instance_types = await self.client.describe_instance_types(
-            InstanceTypes=list(instance_type_names)
+            InstanceTypes=selected_instance_types
         )
         list_instances: list[EC2InstanceType] = []
         for instance in instance_types.get("InstanceTypes", []):

packages/aws-library/tests/test_ec2_client.py

@@ -119,15 +119,22 @@ async def test_get_ec2_instance_capabilities(
     assert [_.name for _ in instance_types] == sorted(ec2_allowed_instances)
 
 
-async def test_get_ec2_instance_capabilities_empty_list_returns_all_options(
+async def test_get_ec2_instance_capabilities_returns_all_options(
     simcore_ec2_api: SimcoreEC2API,
 ):
-    instance_types = await simcore_ec2_api.get_ec2_instance_capabilities(set())
+    instance_types = await simcore_ec2_api.get_ec2_instance_capabilities()
     assert instance_types
     # NOTE: this might need adaptation when moto is updated
     assert 700 < len(instance_types) < 828
 
 
+async def test_get_ec2_instance_capabilities_raise_with_empty_set(
+    simcore_ec2_api: SimcoreEC2API,
+):
+    with pytest.raises(ValueError, match="instance_type_names"):
+        await simcore_ec2_api.get_ec2_instance_capabilities(set())
+
+
 async def test_get_ec2_instance_capabilities_with_invalid_type_raises(
     simcore_ec2_api: SimcoreEC2API,
     faker: Faker,