Merge ~bjornt/maas:hints-in-commissioning-output into maas:master

[Björn Tillenius]

Send the beaconing hints in the commissioning data.

I forgot to include them when I initially added the information that the
networks interfaces monitoring service collects to the commissioning output.

As before, don't pay too much attention on the key names. The will most likely
change soon, as I make use of the data, and remove what's not needed.

[MAAS Lander (maas-lander)]

UNIT TESTS
-b hints-in-commissioning-output lp:~bjornt/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: ef4f1af34a6f1ad3b19d71f2663b9615e7f97788

review: Approve

[Alberto Donato (ack)]

+1

review: Approve

[MAAS Lander (maas-lander)]

LANDING
-b hints-in-commissioning-output lp:~bjornt/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED BUILD
LOG: http://maas-ci.internal:8080/job/maas/job/branch-tester/9474/consoleText

[MAAS Lander (maas-lander)]

LANDING
-b hints-in-commissioning-output lp:~bjornt/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: FAILED BUILD
LOG: http://maas-ci.internal:8080/job/maas/job/branch-tester/9478/consoleText

diff --git a/src/provisioningserver/utils/services.py b/src/provisioningserver/utils/services.py
index 2e00b66..8bcd452 100644
--- a/src/provisioningserver/utils/services.py
+++ b/src/provisioningserver/utils/services.py
@@ -1149,7 +1149,11 @@ class NetworksMonitoringService(MultiService, metaclass=ABCMeta):
                 hints = self.beaconing_protocol.getJSONTopologyHints()
             maas_url, system_id, credentials = yield self.getRefreshDetails()
             yield self._run_refresh(
-                maas_url, system_id, credentials, interfaces
+                maas_url,
+                system_id,
+                credentials,
+                interfaces,
+                hints,
             )
             yield maybeDeferred(self.recordInterfaces, interfaces, hints)
             # Note: _interfacesRecorded() will reconfigure discovery after
@@ -1169,7 +1173,9 @@ class NetworksMonitoringService(MultiService, metaclass=ABCMeta):
             yield maybeDeferred(self._configureNetworkDiscovery, interfaces)
 
     @inlineCallbacks
-    def _run_refresh(self, maas_url, system_id, credentials, interfaces):
+    def _run_refresh(
+        self, maas_url, system_id, credentials, interfaces, hints
+    ):
         yield deferToThread(
             refresh,
             system_id,
@@ -1178,17 +1184,26 @@ class NetworksMonitoringService(MultiService, metaclass=ABCMeta):
             credentials["token_secret"],
             maas_url,
             post_process_hook=functools.partial(
-                self._annotate_commissioning, interfaces
+                self._annotate_commissioning, interfaces, hints
             ),
         )
 
     def _annotate_commissioning(
-        self, interfaces, script_name, combined_path, stdout_path, stderr_path
+        self,
+        interfaces,
+        hints,
+        script_name,
+        combined_path,
+        stdout_path,
+        stderr_path,
     ):
         if script_name != LXD_OUTPUT_NAME:
             return
         lxd_data = json.loads(Path(stdout_path).read_bytes())
-        lxd_data["network-hints"] = interfaces
+        lxd_data["network-extra"] = {
+            "interfaces": interfaces,
+            "hints": hints,
+        }
         Path(stdout_path).write_text(json.dumps(lxd_data))
 
     def _getInterfacesForBeaconing(self, interfaces: dict):
diff --git a/src/provisioningserver/utils/tests/test_services.py b/src/provisioningserver/utils/tests/test_services.py
index d794605..b0c1ad8 100644
--- a/src/provisioningserver/utils/tests/test_services.py
+++ b/src/provisioningserver/utils/tests/test_services.py
@@ -318,7 +318,49 @@ class TestNetworksMonitoringService(MAASTestCase):
         yield service.stopService()
 
     @inlineCallbacks
-    def test_runs_refresh_and_annotates_commissioning(self):
+    def test_runs_refresh_and_annotates_commissioning_with_hints(self):
+        # Don't actually wait for beaconing to complete.
+        self.patch(services, "pause")
+        service = self.makeService(enable_beaconing=True)
+        service.maas_url = "http://my.example.com/MAAS"
+        service.system_id = "my-system"
+        service.credentials = {
+            "consumer_key": "my-consumer",
+            "token_key": "my-key",
+            "token_secret": "my-secret",
+        }
+        self.fake_refresher.credentials.update(service.credentials)
+        base_lxd_data = {factory.make_string(): factory.make_string()}
+        base_lxd_output = json.dumps(base_lxd_data)
+        self.fake_refresher.stdout_content[
+            LXD_OUTPUT_NAME
+        ] = base_lxd_output.encode("utf-8")
+        network_extra = {
+            "interfaces": {"my-interface": "foo"},
+            "hints": {"my-hint": "foo"},
+        }
+        self.all_interfaces_mock.return_value = network_extra["interfaces"]
+        beaconing_mock = self.patch(services.BeaconingSocketProtocol)
+        beaconing_mock.return_value.getJSONTopologyHints.return_value = (
+            network_extra["hints"]
+        )
+
+        yield service.startService()
+        yield self.update_interfaces_deferred
+        yield service.stopService()
+
+        metadata_url = service.maas_url + "/metadata/2012-03-01/"
+        script_runs = self.fake_refresher.script_runs[metadata_url]
+        self.assertEqual("finished", script_runs[LXD_OUTPUT_NAME].status)
+        commissioning_data = json.loads(
+            script_runs[LXD_OUTPUT_NAME].out.decode("utf-8")
+        )
+        expected_commisioning_data = base_lxd_data.copy()
+        expected_commisioning_data.update({"network-extra": network_extra})
+        self.assertEqual(expected_commisioning_data, commissioning_data)
+
+    @inlineCallbacks
+    def test_runs_refresh_and_annotates_commissioning_without_hints(self):
         service = self.makeService()
         service.maas_url = "http://my.example.com/MAAS"
         service.system_id = "my-system"
@@ -333,8 +375,11 @@ class TestNetworksMonitoringService(MAASTestCase):
         self.fake_refresher.stdout_content[
             LXD_OUTPUT_NAME
         ] = base_lxd_output.encode("utf-8")
-        interfaces_hints = {"my-interface": "foo"}
-        self.all_interfaces_mock.return_value = interfaces_hints
+        network_extra = {
+            "interfaces": {"my-interface": "foo"},
+            "hints": None,
+        }
+        self.all_interfaces_mock.return_value = network_extra["interfaces"]
 
         yield service.startService()
         yield self.update_interfaces_deferred
@@ -347,7 +392,7 @@ class TestNetworksMonitoringService(MAASTestCase):
             script_runs[LXD_OUTPUT_NAME].out.decode("utf-8")
         )
         expected_commisioning_data = base_lxd_data.copy()
-        expected_commisioning_data.update({"network-hints": interfaces_hints})
+        expected_commisioning_data.update({"network-extra": network_extra})
         self.assertEqual(expected_commisioning_data, commissioning_data)
 
     @inlineCallbacks