Added support for changes in Instance and added Maintenance group

Author: ezilber-akamai

linode_api4/groups/__init__.py

@@ -10,6 +10,7 @@
 from .lke import *
 from .lke_tier import *
 from .longview import *
+from .maintenance import *
 from .networking import *
 from .nodebalancer import *
 from .object_storage import *

linode_api4/groups/linode.py

@@ -153,6 +153,7 @@ def instance_create(
                 int,
             ]
         ] = None,
+        maintenance_policy_id: Optional[int] = None,
         **kwargs,
     ):
         """
@@ -296,6 +297,9 @@ def instance_create(
         :type interfaces: list[ConfigInterface] or list[dict[str, Any]]
         :param placement_group: A Placement Group to create this Linode under.
         :type placement_group: Union[InstancePlacementGroupAssignment, PlacementGroup, Dict[str, Any], int]
+        :param maintenance_policy_id: The ID of the maintenance policy to apply during maintenance.
+                                      If not provided, the default policy (migrate) will be applied.
+        :type maintenance_policy_id: int
 
         :returns: A new Instance object, or a tuple containing the new Instance and
                   the generated password.
@@ -327,6 +331,7 @@ def instance_create(
             "firewall_id": firewall,
             "backup_id": backup,
             "stackscript_id": stackscript,
+            "maintenance_policy_id": maintenance_policy_id,
             # Special cases
             "disk_encryption": (
                 str(disk_encryption) if disk_encryption else None

linode_api4/groups/maintenance.py

@@ -0,0 +1,19 @@
+from linode_api4 import MappedObject
+from linode_api4.groups import Group
+
+
+class MaintenanceGroup(Group):
+    def maintenance_policies(self):
+        """
+        Returns a collection of MaintenancePolicy objects representing
+        available maintenance policies that can be applied to Linodes
+
+        API Documentation: TODO
+
+        :returns: A list of Maintenance Policies that can be applied to Linodes
+        :rtype: List of MaintenancePolicy objects as MappedObjects
+        """
+
+        result = self.client.get("/maintenance/policies", model=self)
+
+        return [MappedObject(**r) for r in result]

linode_api4/linode_client.py

@@ -19,6 +19,7 @@
     LinodeGroup,
     LKEGroup,
     LongviewGroup,
+    MaintenanceGroup,
     NetworkingGroup,
     NodeBalancerGroup,
     ObjectStorageGroup,
@@ -149,6 +150,10 @@ def __init__(
         #: more information
         self.account = AccountGroup(self)
 
+        #: Access methods related to Maintenance Policies - see :any:`MaintenanceGroup` for
+        #: more information
+        self.maintenance = MaintenanceGroup(self)
+
         #: Access methods related to networking on your account - see
         #: :any:`NetworkingGroup` for more information
         self.networking = NetworkingGroup(self)

linode_api4/objects/linode.py

@@ -686,6 +686,7 @@ class Instance(Base):
         "disk_encryption": Property(),
         "lke_cluster_id": Property(),
         "capabilities": Property(unordered=True),
+        "maintenance_policy_id": Property(mutable=True),
     }
 
     @property

test/fixtures/linode_instances.json

@@ -48,7 +48,8 @@
         "label": "test",
         "placement_group_type": "anti_affinity:local",
         "placement_group_policy": "strict"
-      }
+      },
+      "maintenance_policy_id" : 1
     },
     {
       "group": "test",
@@ -90,7 +91,8 @@
       "watchdog_enabled": false,
       "disk_encryption": "enabled",
       "lke_cluster_id": 18881,
-      "placement_group": null
+      "placement_group": null,
+      "maintenance_policy_id" : 2
     }
   ]
 }

test/fixtures/maintenance_policies.json

@@ -0,0 +1,18 @@
+[
+  {
+    "id": "1",
+    "name": "Default Migrate",
+    "description": "predefined maintenance policy default for all linodes",
+    "type": "migrate",
+    "notification_period_sec": 3600,
+    "is_default": true
+  },
+  {
+    "id": "2",
+    "name": "Default Power On/Off",
+    "description": "predefined maintenance policy for general use cases",
+    "type": "power on/off",
+    "notification_period_sec": 1800,
+    "is_default": false
+  }
+]

test/unit/groups/linode_test.py

@@ -96,6 +96,20 @@ def test_create_with_placement_group(self):
             m.call_data["placement_group"], {"id": 123, "compliant_only": True}
         )
 
+    def test_create_with_mainteance_policy_id(self):
+        """
+        Tests that you can create a Linode with a maintenance policy
+        """
+
+        with self.mock_post("linode/instances/123") as m:
+            self.client.linode.instance_create(
+                "g6-nanode-1",
+                "eu-west",
+                maintenance_policy_id=1,
+            )
+
+        self.assertEqual(m.call_data["maintenance_policy_id"], 1)
+
 
 class TypeTest(ClientBaseCase):
     def test_get_types(self):

test/unit/linode_client_test.py

@@ -307,6 +307,51 @@ def get_mock(*params, verify=True, **kwargs):
         assert called
 
 
+class MaintenanceGroupTest(ClientBaseCase):
+    """
+    Tests methods of the MaintenanceGroup
+    """
+
+    def test_maintenance(self):
+        """
+        Tests that maintenance can be retrieved
+        """
+        with self.mock_get("/maintenance/policies") as m:
+            result = self.client.maintenance.maintenance_policies()
+
+            self.assertEqual(m.call_url, "/maintenance/policies")
+            self.assertEqual(len(result), 2)
+
+            policy_default_migrate = result[0]
+            policy_default_power_on_off = result[1]
+
+            self.assertEqual(policy_default_migrate.id, "1")
+            self.assertEqual(policy_default_migrate.name, "Default Migrate")
+            self.assertEqual(
+                policy_default_migrate.description,
+                "predefined maintenance policy default for all linodes",
+            )
+            self.assertEqual(policy_default_migrate.type, "migrate")
+            self.assertEqual(
+                policy_default_migrate.notification_period_sec, 3600
+            )
+            self.assertEqual(policy_default_migrate.is_default, True)
+
+            self.assertEqual(policy_default_power_on_off.id, "2")
+            self.assertEqual(
+                policy_default_power_on_off.name, "Default Power On/Off"
+            )
+            self.assertEqual(
+                policy_default_power_on_off.description,
+                "predefined maintenance policy for general use cases",
+            )
+            self.assertEqual(policy_default_power_on_off.type, "power on/off")
+            self.assertEqual(
+                policy_default_power_on_off.notification_period_sec, 1800
+            )
+            self.assertEqual(policy_default_power_on_off.is_default, False)
+
+
 class AccountGroupTest(ClientBaseCase):
     """
     Tests methods of the AccountGroup

test/unit/objects/linode_test.py

@@ -40,6 +40,7 @@ def test_get_linode(self):
             linode.disk_encryption, InstanceDiskEncryptionType.disabled
         )
         self.assertEqual(linode.lke_cluster_id, None)
+        self.assertEqual(linode.maintenance_policy_id, 1)
 
         json = linode._raw_json
         self.assertIsNotNone(json)
@@ -153,6 +154,7 @@ def test_update_linode(self):
 
             linode.label = "NewLinodeLabel"
             linode.group = "new_group"
+            linode.maintenance_policy_id = 2
             linode.save()
 
             self.assertEqual(m.call_url, "/linode/instances/123")
@@ -174,6 +176,7 @@ def test_update_linode(self):
                     "group": "new_group",
                     "tags": ["something"],
                     "watchdog_enabled": True,
+                    "maintenance_policy_id": 2,
                 },
             )