Merge ~cgrabowski/maas:add_hardware_sync_systemd_timer into maas:master

[Christian Grabowski]

add systemd configuration for hardware sync

[MAAS Lander (maas-lander)]

UNIT TESTS
-b add_hardware_sync_systemd_timer 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/11796/console
COMMIT: 3f9a48b344b3767f46e5a4b3cc9ff429df705f80

review: Needs Fixing

[MAAS Lander (maas-lander)]

UNIT TESTS
-b add_hardware_sync_systemd_timer 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/11798/console
COMMIT: e815777466ffe91b109727286c609b67e6d2bdd3

review: Needs Fixing

81d409e... by Christian Grabowski on 2022-02-01

add hardware sync interval to settings form

[MAAS Lander (maas-lander)]

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

STATUS: SUCCESS
COMMIT: 81d409ed12d50ed64d9e579dd8354d62bd764f67

review: Approve

f7aa2b0... by Christian Grabowski on 2022-02-02

simplify generate_hardware_sync_systemd_configuration

[MAAS Lander (maas-lander)]

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

STATUS: SUCCESS
COMMIT: f7aa2b0e383ad7cd743a4652fcc37402e8414a05

review: Approve

641ea45... by Christian Grabowski on 2022-02-02

use pkgutil to fetch templates

[MAAS Lander (maas-lander)]

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

STATUS: SUCCESS
COMMIT: 641ea45963dd8b3b6d05434b71c5d25bf3130af5

review: Approve

[Adam Collard (adam-collard)]

nitpik

review: Approve

1091ac1... by Christian Grabowski on 2022-02-03

update doc string

[MAAS Lander (maas-lander)]

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

STATUS: SUCCESS
COMMIT: 1091ac180b95c85665a822947e0ad91cac29ca77

review: Approve

diff --git a/src/maasserver/forms/settings.py b/src/maasserver/forms/settings.py
index df6a13b..0061e09 100644
--- a/src/maasserver/forms/settings.py
+++ b/src/maasserver/forms/settings.py
@@ -1006,6 +1006,18 @@ CONFIG_ITEMS = {
             ),
         },
     },
+    "hardware_sync_interval": {
+        "default": "15m",
+        "form": forms.CharField,
+        "form_kwargs": {
+            "label": "Hardware Sync Interval",
+            "required": False,
+            "help_text": (
+                "The interval to send hardware info to MAAS from"
+                "hardware sync enabled machines, in systemd time span syntax."
+            ),
+        },
+    },
 }
 
 
diff --git a/src/maasserver/models/config.py b/src/maasserver/models/config.py
index b39974c..d87c7b5 100644
--- a/src/maasserver/models/config.py
+++ b/src/maasserver/models/config.py
@@ -134,6 +134,8 @@ def get_default_config():
         "vcenter_username": "",
         "vcenter_password": "",
         "vcenter_datacenter": "",
+        # Hardware Sync options
+        "hardware_sync_interval": "15m",
     }
 
 
diff --git a/src/metadataserver/templates/hardware_sync_service.template b/src/metadataserver/templates/hardware_sync_service.template
new file mode 100644
index 0000000..a649777
--- /dev/null
+++ b/src/metadataserver/templates/hardware_sync_service.template
@@ -0,0 +1,9 @@
+[Unit]
+Description=MAAS Hardware Sync Service
+Documentation=https://maas.io
+Want=network.target
+After=network.target
+
+[Service]
+type=oneshot
+ExecStart=/bin/echo "TODO add hardware sync executable"
diff --git a/src/metadataserver/templates/hardware_sync_timer.template b/src/metadataserver/templates/hardware_sync_timer.template
new file mode 100644
index 0000000..a0c175e
--- /dev/null
+++ b/src/metadataserver/templates/hardware_sync_timer.template
@@ -0,0 +1,11 @@
+[Unit]
+Description=Timer for periodically running MAAS hardware sync
+Documentation=https://maas.io
+Want=network.target
+After=network.target
+
+[Install]
+WantedBy=timers.target
+
+[Timer]
+OnActiveSec={{ hardware_sync_interval }}
diff --git a/src/metadataserver/tests/test_vendor_data.py b/src/metadataserver/tests/test_vendor_data.py
index 1d9f131..0432a9a 100644
--- a/src/metadataserver/tests/test_vendor_data.py
+++ b/src/metadataserver/tests/test_vendor_data.py
@@ -5,6 +5,7 @@ import random
 from textwrap import dedent
 
 from netaddr import IPAddress
+import tempita
 from testtools.matchers import (
     Contains,
     ContainsDict,
@@ -27,14 +28,18 @@ from maasserver.testing.testcase import MAASServerTestCase
 from maastesting.matchers import MockNotCalled
 from metadataserver import vendor_data
 from metadataserver.vendor_data import (
+    _get_metadataserver_template,
     generate_ephemeral_deployment_network_configuration,
     generate_ephemeral_netplan_lock_removal,
+    generate_hardware_sync_systemd_configuration,
     generate_kvm_pod_configuration,
     generate_ntp_configuration,
     generate_rack_controller_configuration,
     generate_snap_configuration,
     generate_system_info,
     get_vendor_data,
+    HARDWARE_SYNC_SERVICE_TEMPLATE,
+    HARDWARE_SYNC_TIMER_TEMPLATE,
 )
 from provisioningserver.drivers.pod.lxd import LXD_MAAS_PROJECT_CONFIG
 
@@ -683,3 +688,50 @@ class TestGenerateVcenterConfiguration(MAASServerTestCase):
             Config.objects.set_config(key, factory.make_name(key))
         config = get_vendor_data(node, None)
         self.assertNotIn("write_files", config)
+
+
+class TestGenerateHardwareSyncSystemdConfiguration(MAASServerTestCase):
+    def _get_timer_template(self):
+        return tempita.Template(
+            _get_metadataserver_template(HARDWARE_SYNC_TIMER_TEMPLATE),
+        )
+
+    def _get_service_template(self):
+        return tempita.Template(
+            _get_metadataserver_template(HARDWARE_SYNC_SERVICE_TEMPLATE),
+        )
+
+    def test_returns_nothing_if_node_enable_hw_sync_is_False(self):
+        node = factory.make_Node(
+            status=NODE_STATUS.DEPLOYING,
+        )
+        config = generate_hardware_sync_systemd_configuration(node)
+        self.assertRaises(StopIteration, next, config)
+
+    def test_returns_timer_and_service_when_node_enable_hw_sync_is_True(self):
+        node = factory.make_Node(
+            status=NODE_STATUS.DEPLOYING,
+            enable_hw_sync=True,
+        )
+        config = generate_hardware_sync_systemd_configuration(node)
+        expected_interval = Config.objects.get_configs(
+            ["hardware_sync_interval"]
+        )
+
+        expected = (
+            "write_files",
+            [
+                {
+                    "content": self._get_timer_template().substitute(
+                        hardware_sync_interval=expected_interval
+                    ),
+                    "path": "/lib/systemd/system/maas_hardware_sync.timer",
+                },
+                {
+                    "content": self._get_service_template().substitute(),
+                    "path": "/lib/systemd/system/maas_hardware_sync.service",
+                },
+            ],
+        )
+
+        self.assertCountEqual(next(config), expected)
diff --git a/src/metadataserver/vendor_data.py b/src/metadataserver/vendor_data.py
index 7e92c68..2826009 100644
--- a/src/metadataserver/vendor_data.py
+++ b/src/metadataserver/vendor_data.py
@@ -8,9 +8,11 @@ from base64 import b64encode
 from crypt import crypt
 from itertools import chain
 from os import urandom
+import pkgutil
 from textwrap import dedent
 
 from netaddr import IPAddress
+import tempita
 import yaml
 
 from maasserver import ntp
@@ -29,6 +31,9 @@ from provisioningserver.utils.text import make_gecos_field
 LXD_CERTIFICATE_METADATA_KEY = "lxd_certificate"
 VIRSH_PASSWORD_METADATA_KEY = "virsh_password"
 
+HARDWARE_SYNC_TIMER_TEMPLATE = "hardware_sync_timer.template"
+HARDWARE_SYNC_SERVICE_TEMPLATE = "hardware_sync_service.template"
+
 
 def get_vendor_data(node, proxy):
     generators = (
@@ -40,6 +45,7 @@ def get_vendor_data(node, proxy):
         generate_ephemeral_netplan_lock_removal(node),
         generate_ephemeral_deployment_network_configuration(node),
         generate_vcenter_configuration(node),
+        generate_hardware_sync_systemd_configuration(node),
     )
     vendor_data = {}
     for key, value in chain(*generators):
@@ -350,6 +356,47 @@ def generate_vcenter_configuration(node):
         ]
 
 
+def _get_metadataserver_template(template_name):
+    """Returns the contents of a given template in metadataserver/vendor_data/templates/"""
+    return pkgutil.get_data(
+        "metadataserver.vendor_data", "templates/" + template_name
+    ).decode("utf-8")
+
+
+def generate_hardware_sync_systemd_configuration(node):
+    """generate systemd unit files for hardware sync"""
+    if not node.enable_hw_sync:
+        return
+
+    hardware_sync_interval = Config.objects.get_configs(
+        ["hardware_sync_interval"]
+    )
+    hardware_sync_timer_tmpl = tempita.Template(
+        _get_metadataserver_template(HARDWARE_SYNC_TIMER_TEMPLATE)
+    )
+    hardware_sync_service_tmpl = tempita.Template(
+        _get_metadataserver_template(HARDWARE_SYNC_SERVICE_TEMPLATE)
+    )
+
+    hardware_sync_timer = hardware_sync_timer_tmpl.substitute(
+        hardware_sync_interval=hardware_sync_interval
+    )
+    hardware_sync_service = (
+        hardware_sync_service_tmpl.substitute()
+    )  # TODO substitute node architecture for executable
+
+    yield "write_files", [
+        {
+            "content": hardware_sync_timer,
+            "path": "/lib/systemd/system/maas_hardware_sync.timer",
+        },
+        {
+            "content": hardware_sync_service,
+            "path": "/lib/systemd/system/maas_hardware_sync.service",
+        },
+    ]
+
+
 def _generate_password():
     """Generate a 32-character password by encoding 24 bytes as base64."""
     return b64encode(urandom(24), altchars=b".!").decode("ascii")