Merge ~cgrabowski/maas:track_frequency_of_hw_sync_for_specific_machine into maas:master

[Christian Grabowski]

ensure hardware sync values exposed via api

ensure sync values exposed via websocket

add model fields to track sync interval on machine basis

[MAAS Lander (maas-lander)]

UNIT TESTS
-b track_frequency_of_hw_sync_for_specific_machine lp:~cgrabowski/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas/job/branch-tester/12080/console
COMMIT: 96a8dee0db6e7dea739dec939baf0180a7d571ab

review: Needs Fixing

[Alexsander de Souza (alexsander-souza)]

next_sync could have a value before the first time the update runs, so the user can see something right after he deploys the machine

review: Approve

19f51cf... by Christian Grabowski on 2022-03-10

initialize last_sync as time deployment finishes

[MAAS Lander (maas-lander)]

UNIT TESTS
-b track_frequency_of_hw_sync_for_specific_machine lp:~cgrabowski/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas/job/branch-tester/12081/console
COMMIT: 604666498341c0fec27dfcb73fd3fad8ed0189f9

review: Needs Fixing

[MAAS Lander (maas-lander)]

UNIT TESTS
-b track_frequency_of_hw_sync_for_specific_machine lp:~cgrabowski/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas/job/branch-tester/12082/console
COMMIT: 8e061c5c65c5b5d26a23018c2c1b2b9f0f51bafb

review: Needs Fixing

[MAAS Lander (maas-lander)]

UNIT TESTS
-b track_frequency_of_hw_sync_for_specific_machine lp:~cgrabowski/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED
LOG: http://maas-ci.internal:8080/job/maas/job/branch-tester/12083/console
COMMIT: fdd7054bdb77e17febca976115a52bd9f1da2d39

review: Needs Fixing

[MAAS Lander (maas-lander)]

UNIT TESTS
-b track_frequency_of_hw_sync_for_specific_machine lp:~cgrabowski/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 19f51cf3f6a8824925d5e628645d0f509d272be1

review: Approve

diff --git a/src/maasserver/api/machines.py b/src/maasserver/api/machines.py
index 0b23d28..9e51f0b 100644
--- a/src/maasserver/api/machines.py
+++ b/src/maasserver/api/machines.py
@@ -190,6 +190,9 @@ DISPLAYED_MACHINE_FIELDS = (
     ("numanode_set", DISPLAYED_NUMANODE_FIELDS),
     "virtualmachine_id",
     "workload_annotations",
+    "last_sync",
+    "sync_interval",
+    "next_sync",
 )
 
 # Limited set of machine fields exposed on the anonymous API.
diff --git a/src/maasserver/api/tests/test_enlistment.py b/src/maasserver/api/tests/test_enlistment.py
index 44133ad..cc02116 100644
--- a/src/maasserver/api/tests/test_enlistment.py
+++ b/src/maasserver/api/tests/test_enlistment.py
@@ -757,6 +757,9 @@ class SimpleUserLoggedInEnlistmentAPITest(APITestCase.ForUser):
                 "interface_test_status_name",
                 "virtualmachine_id",
                 "workload_annotations",
+                "last_sync",
+                "sync_interval",
+                "next_sync",
             },
             parsed_result.keys(),
         )
@@ -978,6 +981,9 @@ class AdminLoggedInEnlistmentAPITest(APITestCase.ForAdmin):
                 "interface_test_status_name",
                 "virtualmachine_id",
                 "workload_annotations",
+                "last_sync",
+                "sync_interval",
+                "next_sync",
             },
             parsed_result.keys(),
         )
diff --git a/src/maasserver/api/tests/test_machine.py b/src/maasserver/api/tests/test_machine.py
index 863b640..65eaa1d 100644
--- a/src/maasserver/api/tests/test_machine.py
+++ b/src/maasserver/api/tests/test_machine.py
@@ -2,6 +2,7 @@
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 from base64 import b64encode
+from datetime import datetime
 import http.client
 import logging
 from random import choice
@@ -250,6 +251,21 @@ class TestMachineAPI(APITestCase.ForUser):
             parsed_result["boot_interface"]["mac_address"],
         )
 
+    def test_GET_returns_hardware_sync_values(self):
+        machine = factory.make_Node(enable_hw_sync=True)
+        machine.last_sync = datetime.now()
+        machine.save()
+        response = self.client.get(self.get_machine_uri(machine))
+        self.assertEqual(http.client.OK, response.status_code)
+        parsed_result = json_load_bytes(response.content)
+        self.assertEqual(
+            machine.last_sync.isoformat()[:-3], parsed_result["last_sync"]
+        )
+        self.assertEqual(machine.sync_interval, parsed_result["sync_interval"])
+        self.assertEqual(
+            machine.next_sync.isoformat()[:-3], parsed_result["next_sync"]
+        )
+
     def test_GET_refuses_to_access_nonexistent_machine(self):
         # When fetching a Machine, the api returns a 'Not Found' (404) error
         # if no machine is found.
diff --git a/src/maasserver/migrations/maasserver/0267_add_machine_specific_sync_interval_fields.py b/src/maasserver/migrations/maasserver/0267_add_machine_specific_sync_interval_fields.py
new file mode 100644
index 0000000..99d3d99
--- /dev/null
+++ b/src/maasserver/migrations/maasserver/0267_add_machine_specific_sync_interval_fields.py
@@ -0,0 +1,23 @@
+# Generated by Django 2.2.12 on 2022-03-09 03:54
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("maasserver", "0266_nodedevice_unlink_node"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="node",
+            name="last_sync",
+            field=models.DateTimeField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="node",
+            name="sync_interval",
+            field=models.IntegerField(blank=True, null=True),
+        ),
+    ]
diff --git a/src/maasserver/models/node.py b/src/maasserver/models/node.py
index 00bc489..a4761b2 100644
--- a/src/maasserver/models/node.py
+++ b/src/maasserver/models/node.py
@@ -161,6 +161,7 @@ from maasserver.storage_layouts import (
     VMFS6StorageLayout,
     VMFS7StorageLayout,
 )
+from maasserver.utils.converters import parse_systemd_interval
 from maasserver.utils.dns import validate_hostname
 from maasserver.utils.mac import get_vendor_for_mac
 from maasserver.utils.orm import (
@@ -1259,7 +1260,10 @@ class Node(CleanSave, TimestampedModel):
         "NodeConfig", null=True, on_delete=CASCADE, related_name="+"
     )
 
+    # hardware updates
     enable_hw_sync = BooleanField(default=False)
+    sync_interval = IntegerField(blank=True, null=True)
+    last_sync = DateTimeField(blank=True, null=True)
 
     # Note that the ordering of the managers is meaningful.  More precisely,
     # the first manager defined is important: see
@@ -1360,6 +1364,12 @@ class Node(CleanSave, TimestampedModel):
     def is_pod(self):
         return self.get_hosted_pods().exists()
 
+    @property
+    def next_sync(self):
+        if self.last_sync and self.sync_interval:
+            return self.last_sync + timedelta(seconds=self.sync_interval)
+        return None
+
     def is_commissioning(self):
         return self.status not in (NODE_STATUS.DEPLOYED, NODE_STATUS.DEPLOYING)
 
@@ -1741,6 +1751,8 @@ class Node(CleanSave, TimestampedModel):
         from maasserver.models.event import Event
 
         self.status = NODE_STATUS.DEPLOYED
+        if self.enable_hw_sync:
+            self.last_sync = datetime.now()
         self.save()
 
         # Create a status message for DEPLOYED.
@@ -2004,6 +2016,11 @@ class Node(CleanSave, TimestampedModel):
             ):
                 kwargs["update_fields"].append("status_expires")
 
+        if self.enable_hw_sync and self.sync_interval is None:
+            self.sync_interval = parse_systemd_interval(
+                Config.objects.get_config("hardware_sync_interval")
+            )
+
         super().save(*args, **kwargs)
 
         # We let hostname be blank for the initial save, but fix it before the
@@ -3690,6 +3707,8 @@ class Node(CleanSave, TimestampedModel):
         self.install_kvm = False
         self.register_vmhost = False
         self.enable_hw_sync = False
+        self.sync_interval = None
+        self.last_sync = None
         self.save()
 
         # Create a status message for RELEASING.
diff --git a/src/maasserver/models/tests/test_node.py b/src/maasserver/models/tests/test_node.py
index 6bace21..b461bc6 100644
--- a/src/maasserver/models/tests/test_node.py
+++ b/src/maasserver/models/tests/test_node.py
@@ -2892,6 +2892,35 @@ class TestNode(MAASServerTestCase):
             node.release()
         self.assertFalse(node.enable_hw_sync)
 
+    def test_release_sets_sync_interval_to_None(self):
+        node = factory.make_Node(
+            status=NODE_STATUS.ALLOCATED, enable_hw_sync=True
+        )
+        self.patch(node, "_stop")
+        self.patch(node, "_set_status_expires")
+        self.assertEqual(
+            node.sync_interval, timedelta(minutes=15).total_seconds()
+        )
+        with post_commit_hooks:
+            node.release()
+        self.assertIsNone(node.sync_interval)
+
+    def test_sync_interval_is_set_when_enable_hw_sync_is_True(self):
+        node = factory.make_Node(
+            status=NODE_STATUS.ALLOCATED, enable_hw_sync=True
+        )
+        self.assertEqual(
+            node.sync_interval, timedelta(minutes=15).total_seconds()
+        )
+
+    def test_next_sync_returns_time_after_last_sync(self):
+        node = factory.make_Node(
+            status=NODE_STATUS.ALLOCATED, enable_hw_sync=True
+        )
+        node.last_sync = datetime.now()
+        expected_interval = timedelta(minutes=15)
+        self.assertEqual(node.next_sync, node.last_sync + expected_interval)
+
     def test_dynamic_ip_addresses_from_ip_address_table(self):
         node = factory.make_Node()
         interfaces = [
@@ -4867,6 +4896,15 @@ class TestNode(MAASServerTestCase):
         self.assertEqual(NODE_STATUS.DEPLOYED, reload_object(node).status)
         self.assertEqual(event.type.name, EVENT_TYPES.DEPLOYED)
 
+    def test_end_deployment_sets_first_last_sync_value(self):
+        self.disable_node_query()
+        node = factory.make_Node(
+            status=NODE_STATUS.DEPLOYING, enable_hw_sync=True
+        )
+        self.assertIsNone(node.last_sync)
+        node.end_deployment()
+        self.assertIsNotNone(node.last_sync)
+
     def test_start_deployment_changes_state_and_creates_sts_msg(self):
         node = factory.make_Node_with_Interface_on_Subnet(
             status=NODE_STATUS.ALLOCATED
diff --git a/src/maasserver/utils/converters.py b/src/maasserver/utils/converters.py
index 690fb61..9aaa91b 100644
--- a/src/maasserver/utils/converters.py
+++ b/src/maasserver/utils/converters.py
@@ -4,7 +4,9 @@
 """Conversion utilities."""
 
 
+from datetime import timedelta
 import json
+import re
 
 from django.conf import settings
 from lxml import etree
@@ -132,3 +134,17 @@ def json_load_bytes(input: bytes, encoding=None):
             settings.DEFAULT_CHARSET if encoding is None else encoding
         )
     )
+
+
+_duration_re = re.compile(
+    r"((?P<hours>\d+?)(\s?(hour(s?)|hr|h))\s?)?((?P<minutes>\d+?)(\s?(minute(s?)|min|m))\s?)?((?P<seconds>\d+?)(\s?(second(s?)|sec|s))\s?)?"
+)
+
+
+def parse_systemd_interval(interval):
+    duration = _duration_re.match(interval)
+    if not duration:
+        raise ValueError("value is not a valid interval")
+    duration = duration.groupdict()
+    params = {name: int(t) for name, t in duration.items() if t}
+    return timedelta(**params).total_seconds()
diff --git a/src/maasserver/utils/tests/test_converters.py b/src/maasserver/utils/tests/test_converters.py
index 3b24096..960fb57 100644
--- a/src/maasserver/utils/tests/test_converters.py
+++ b/src/maasserver/utils/tests/test_converters.py
@@ -4,11 +4,13 @@
 """Tests for converters utilities."""
 
 
+from datetime import timedelta
 from textwrap import dedent
 
 from maasserver.utils.converters import (
     human_readable_bytes,
     machine_readable_bytes,
+    parse_systemd_interval,
     round_size_to_nearest_block,
     XMLToYAML,
 )
@@ -121,3 +123,42 @@ class TestRoundSizeToNearestBlock(MAASTestCase):
             round_size_to_nearest_block(size, block_size, False),
             "Shouldn't remove a block from the size.",
         )
+
+
+class TestParseSystemdInterval(MAASTestCase):
+    def _assert_parsed(
+        self, interval: str, hours: int = 0, minutes: int = 0, seconds: int = 0
+    ):
+        expected_seconds = timedelta(
+            hours=hours, minutes=minutes, seconds=seconds
+        ).total_seconds()
+        out = parse_systemd_interval(interval)
+        self.assertEqual(expected_seconds, out)
+
+    def test_parses_full_plural_word_durations(self):
+        self._assert_parsed(
+            "2 hours 5 minutes 10 seconds", hours=2, minutes=5, seconds=10
+        )
+
+    def test_parses_full_word_durations(self):
+        self._assert_parsed(
+            "1 hour 1 minute 1 second", hours=1, minutes=1, seconds=1
+        )
+
+    def test_parses_abbreviated_durations(self):
+        self._assert_parsed("1hr 15min 5sec", hours=1, minutes=15, seconds=5)
+
+    def test_parses_initials_durations(self):
+        self._assert_parsed("3h 5m 2s", hours=3, minutes=5, seconds=2)
+
+    def test_parses_single_full_plural_duration(self):
+        self._assert_parsed("5 minutes", minutes=5)
+
+    def test_parses_single_full_duration(self):
+        self._assert_parsed("1 hours", hours=1)
+
+    def test_parses_single_abbreviated_duration(self):
+        self._assert_parsed("5min", minutes=5)
+
+    def test_parses_single_initials_duration(self):
+        self._assert_parsed("15s", seconds=15)
diff --git a/src/maasserver/websockets/handlers/node.py b/src/maasserver/websockets/handlers/node.py
index 8877140..74bae70 100644
--- a/src/maasserver/websockets/handlers/node.py
+++ b/src/maasserver/websockets/handlers/node.py
@@ -304,6 +304,19 @@ class NodeHandler(TimestampedModelHandler):
         else:
             blockdevices = []
 
+        if obj.enable_hw_sync:
+            data.update(
+                {
+                    "last_sync": obj.last_sync,
+                    "sync_interval": obj.sync_interval,
+                    "next_sync": obj.next_sync,
+                }
+            )
+        else:
+            for k in ("last_sync", "sync_interval", "next_sync"):
+                if k in data:
+                    del data[k]
+
         if obj.node_type != NODE_TYPE.DEVICE:
             # These values are not defined on a device.
             data["architecture"] = obj.architecture
diff --git a/src/maasserver/websockets/handlers/tests/test_machine.py b/src/maasserver/websockets/handlers/tests/test_machine.py
index fc3af86..f0a04be 100644
--- a/src/maasserver/websockets/handlers/tests/test_machine.py
+++ b/src/maasserver/websockets/handlers/tests/test_machine.py
@@ -2,6 +2,7 @@
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 
+from datetime import datetime, timedelta
 from functools import partial
 import json
 import logging
@@ -515,6 +516,15 @@ class TestMachineHandler(MAASServerTestCase):
             node_script_results
         )
 
+        if node.enable_hw_sync:
+            data.update(
+                {
+                    "last_sync": node.last_sync,
+                    "sync_interval": node.sync_interval,
+                    "next_sync": node.next_sync,
+                }
+            )
+
         # Clear cache
         handler._script_results = {}
 
@@ -2059,6 +2069,22 @@ class TestMachineHandler(MAASServerTestCase):
         expected = self.dehydrate_node(node, handler)
         self.assertEqual(observed, expected)
 
+    def test_get_hardware_sync_fields(self):
+        user = factory.make_User()
+        handler = MachineHandler(user, {}, None)
+        Config.objects.set_config(name="hardware_sync_interval", value="10m")
+        node = factory.make_Node_with_Interface_on_Subnet(enable_hw_sync=True)
+        node.last_sync = datetime.now()
+        node.save()
+        observed = handler.get({"system_id": node.system_id})
+        self.assertEqual(observed["last_sync"], node.last_sync)
+        self.assertEqual(
+            observed["sync_interval"], timedelta(minutes=10).total_seconds()
+        )
+        self.assertEqual(
+            observed["next_sync"], node.last_sync + timedelta(minutes=10)
+        )
+
     def test_get_driver_for_series(self):
         user = factory.make_User()
         handler = MachineHandler(user, {}, None)