PG affinity_type, is_strict -> placement_group_type, placement_group_policy (#437)

Author: lgarber-akamai

linode_api4/groups/placement.py

@@ -2,7 +2,11 @@
 
 from linode_api4.errors import UnexpectedResponseError
 from linode_api4.groups import Group
-from linode_api4.objects.placement import PlacementGroup
+from linode_api4.objects.placement import (
+    PlacementGroup,
+    PlacementGroupPolicy,
+    PlacementGroupType,
+)
 from linode_api4.objects.region import Region
 
 
@@ -31,8 +35,8 @@ def group_create(
         self,
         label: str,
         region: Union[Region, str],
-        affinity_type: str,
-        is_strict: bool = False,
+        placement_group_type: PlacementGroupType,
+        placement_group_policy: PlacementGroupPolicy,
         **kwargs,
     ) -> PlacementGroup:
         """
@@ -44,19 +48,19 @@ def group_create(
         :type label: str
         :param region: The region where the placement group will be created. Can be either a Region object or a string representing the region ID.
         :type region: Union[Region, str]
-        :param affinity_type: The affinity type of the placement group.
-        :type affinity_type: PlacementGroupAffinityType
-        :param is_strict: Whether the placement group is strict (defaults to False).
-        :type is_strict: bool
+        :param placement_group_type: The type of the placement group.
+        :type placement_group_type: PlacementGroupType
+        :param placement_group_policy: The policy for assignments to this placement group.
+        :type placement_group_policy: PlacementGroupPolicy
 
         :returns: The new Placement Group.
         :rtype: PlacementGroup
         """
         params = {
             "label": label,
             "region": region.id if isinstance(region, Region) else region,
-            "affinity_type": affinity_type,
-            "is_strict": is_strict,
+            "placement_group_type": placement_group_type,
+            "placement_group_policy": placement_group_policy,
         }
 
         params.update(kwargs)

linode_api4/objects/placement.py

@@ -7,15 +7,23 @@
 from linode_api4.objects.serializable import JSONObject, StrEnum
 
 
-class PlacementGroupAffinityType(StrEnum):
+class PlacementGroupType(StrEnum):
     """
-    An enum class that represents the available affinity policies for Linodes
-    in a Placement Group.
+    An enum class that represents the available types of a Placement Group.
     """
 
     anti_affinity_local = "anti_affinity:local"
 
 
+class PlacementGroupPolicy(StrEnum):
+    """
+    An enum class that represents the policy for Linode assignments to a Placement Group.
+    """
+
+    strict = "strict"
+    flexible = "flexible"
+
+
 @dataclass
 class PlacementGroupMember(JSONObject):
     """
@@ -42,9 +50,9 @@ class PlacementGroup(Base):
         "id": Property(identifier=True),
         "label": Property(mutable=True),
         "region": Property(slug_relationship=Region),
-        "affinity_type": Property(),
+        "placement_group_type": Property(),
+        "placement_group_policy": Property(),
         "is_compliant": Property(),
-        "is_strict": Property(),
         "members": Property(json_object=PlacementGroupMember),
     }
 

test/fixtures/linode_instances.json

@@ -44,8 +44,8 @@
       "placement_group": {
         "id": 123,
         "label": "test",
-        "affinity_type": "anti_affinity:local",
-        "is_strict": true
+        "placement_group_type": "anti_affinity:local",
+        "placement_group_policy": "strict"
       }
     },
     {

test/fixtures/placement_groups.json

@@ -4,8 +4,8 @@
       "id": 123,
       "label": "test",
       "region": "eu-west",
-      "affinity_type": "anti_affinity:local",
-      "is_strict": true,
+      "placement_group_type": "anti_affinity:local",
+      "placement_group_policy": "strict",
       "is_compliant": true,
       "members": [
         {

test/fixtures/placement_groups_123.json

@@ -2,8 +2,8 @@
   "id": 123,
   "label": "test",
   "region": "eu-west",
-  "affinity_type": "anti_affinity:local",
-  "is_strict": true,
+  "placement_group_type": "anti_affinity:local",
+  "placement_group_policy": "strict",
   "is_compliant": true,
   "members": [
     {

test/integration/conftest.py

@@ -8,7 +8,7 @@
 import requests
 from requests.exceptions import ConnectionError, RequestException
 
-from linode_api4 import ApiError, PlacementGroupAffinityType
+from linode_api4 import ApiError, PlacementGroupPolicy, PlacementGroupType
 from linode_api4.linode_client import LinodeClient
 from linode_api4.objects import Region
 
@@ -465,7 +465,8 @@ def create_placement_group(test_linode_client):
     pg = client.placement.group_create(
         "pythonsdk-" + timestamp,
         get_region(test_linode_client, {"Placement Group"}),
-        PlacementGroupAffinityType.anti_affinity_local,
+        PlacementGroupType.anti_affinity_local,
+        PlacementGroupPolicy.flexible,
     )
     yield pg
 

test/unit/objects/linode_test.py

@@ -486,7 +486,7 @@ def test_get_placement_group(self):
 
         assert pg.id == 123
         assert pg.label == "test"
-        assert pg.affinity_type == "anti_affinity:local"
+        assert pg.placement_group_type == "anti_affinity:local"
 
         # Invalidate the instance and try again
         # This makes sure the implicit refresh/cache logic works
@@ -497,7 +497,7 @@ def test_get_placement_group(self):
 
         assert pg.id == 123
         assert pg.label == "test"
-        assert pg.affinity_type == "anti_affinity:local"
+        assert pg.placement_group_type == "anti_affinity:local"
 
     def test_create_with_placement_group(self):
         """

test/unit/objects/placement_test.py

@@ -1,9 +1,10 @@
 from test.unit.base import ClientBaseCase
 
+from linode_api4 import PlacementGroupPolicy
 from linode_api4.objects import (
     PlacementGroup,
-    PlacementGroupAffinityType,
     PlacementGroupMember,
+    PlacementGroupType,
 )
 
 
@@ -42,8 +43,8 @@ def test_create_pg(self):
             pg = self.client.placement.group_create(
                 "test",
                 "eu-west",
-                PlacementGroupAffinityType.anti_affinity_local,
-                is_strict=True,
+                PlacementGroupType.anti_affinity_local,
+                PlacementGroupPolicy.strict,
             )
 
             assert m.call_url == "/placement/groups"
@@ -53,10 +54,10 @@ def test_create_pg(self):
                 {
                     "label": "test",
                     "region": "eu-west",
-                    "affinity_type": str(
-                        PlacementGroupAffinityType.anti_affinity_local
+                    "placement_group_type": str(
+                        PlacementGroupType.anti_affinity_local
                     ),
-                    "is_strict": True,
+                    "placement_group_policy": PlacementGroupPolicy.strict,
                 },
             )
 
@@ -109,8 +110,8 @@ def validate_pg_123(self, pg: PlacementGroup):
         assert pg.id == 123
         assert pg.label == "test"
         assert pg.region.id == "eu-west"
-        assert pg.affinity_type == "anti_affinity:local"
-        assert pg.is_strict
+        assert pg.placement_group_type == "anti_affinity:local"
+        assert pg.placement_group_policy == "strict"
         assert pg.is_compliant
         assert pg.members[0] == PlacementGroupMember(
             linode_id=123, is_compliant=True