Merge ~adam-collard/maas:machine-list-owner-data into maas:master

[Adam Collard]

Add OwnerData to the machine list websocket handler

Supersedes https://code.launchpad.net/~d0ugal/maas/+git/maas/+merge/395529

c77f87e... by Adam Collard on 2021-01-04

Remove redundant owner_data from fields in machine list test

[Alberto Donato (ack)]

LGTM!

one tiny nit inline

review: Approve

[MAAS Lander (maas-lander)]

UNIT TESTS
-b machine-list-owner-data lp:~adam-collard/maas/+git/maas into -b master lp:~maas-committers/maas

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

review: Needs Fixing

[Adam Collard (adam-collard)]

jenkins: !test

[MAAS Lander (maas-lander)]

UNIT TESTS
-b machine-list-owner-data lp:~adam-collard/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: c77f87e1dc4ca4c39570ae5adde64346a56dbfd0

review: Approve

diff --git a/src/maasserver/websockets/handlers/controller.py b/src/maasserver/websockets/handlers/controller.py
index 965a766..b3881bd 100644
--- a/src/maasserver/websockets/handlers/controller.py
+++ b/src/maasserver/websockets/handlers/controller.py
@@ -32,6 +32,7 @@ class ControllerHandler(MachineHandler):
             .select_related("controllerinfo", "domain", "bmc")
             .prefetch_related("service_set")
             .prefetch_related("tags")
+            .prefetch_related("ownerdata_set")
             .annotate(
                 status_event_type_description=Subquery(
                     Event.objects.filter(
diff --git a/src/maasserver/websockets/handlers/machine.py b/src/maasserver/websockets/handlers/machine.py
index 469e072..0df469f 100644
--- a/src/maasserver/websockets/handlers/machine.py
+++ b/src/maasserver/websockets/handlers/machine.py
@@ -133,6 +133,7 @@ class MachineHandler(NodeHandler):
             .prefetch_related("boot_interface__vlan__fabric")
             .prefetch_related("tags")
             .prefetch_related("pool")
+            .prefetch_related("ownerdata_set")
             .annotate(
                 status_event_type_description=Subquery(
                     Event.objects.filter(
@@ -199,8 +200,8 @@ class MachineHandler(NodeHandler):
             "set_script_result_unsuppressed",
             "get_suppressible_script_results",
             "get_latest_failed_testing_script_results",
-            "get_owner_data",
-            "set_owner_data",
+            "get_workload_annotations",
+            "set_workload_annotations",
         ]
         form = AdminMachineWithMACAddressesForm
         exclude = [
@@ -361,6 +362,8 @@ class MachineHandler(NodeHandler):
             node_script_results
         )
 
+        data["workload_annotations"] = OwnerData.objects.get_owner_data(obj)
+
         if not for_list:
             # Add info specific to a machine.
             data["show_os_info"] = self.dehydrate_show_os_info(obj)
@@ -1121,21 +1124,21 @@ class MachineHandler(NodeHandler):
             raise HandlerPermissionError()
         return node
 
-    def get_owner_data(self, params):
-        """Get the owner data for a machine"""
+    def get_workload_annotations(self, params):
+        """Get the owner data for a machine, known as workload annotations."""
         machine = self._get_node_or_permission_error(
             params, permission=NodePermission.edit
         )
         return OwnerData.objects.get_owner_data(machine)
 
-    def set_owner_data(self, params):
-        """Set the owner data for a machine"""
+    def set_workload_annotations(self, params):
+        """Set the owner data for a machine, known as workload annotations."""
         machine = self._get_node_or_permission_error(
             params, permission=NodePermission.edit
         )
         owner_data = {
             key: None if value == "" else value
-            for key, value in params["owner_data"].items()
+            for key, value in params["workload_annotations"].items()
         }
         OwnerData.objects.set_owner_data(machine, owner_data)
         return OwnerData.objects.get_owner_data(machine)
diff --git a/src/maasserver/websockets/handlers/tests/test_controller.py b/src/maasserver/websockets/handlers/tests/test_controller.py
index 84a157f..873fff1 100644
--- a/src/maasserver/websockets/handlers/tests/test_controller.py
+++ b/src/maasserver/websockets/handlers/tests/test_controller.py
@@ -108,12 +108,12 @@ class TestControllerHandler(MAASServerTestCase):
         # and slowing down the client waiting for the response.
         self.assertEqual(
             queries_one,
-            4,
+            5,
             "Number of queries has changed; make sure this is expected.",
         )
         self.assertEqual(
             queries_total,
-            4,
+            5,
             "Number of queries has changed; make sure this is expected.",
         )
 
diff --git a/src/maasserver/websockets/handlers/tests/test_machine.py b/src/maasserver/websockets/handlers/tests/test_machine.py
index 8f46f16..6ce5614 100644
--- a/src/maasserver/websockets/handlers/tests/test_machine.py
+++ b/src/maasserver/websockets/handlers/tests/test_machine.py
@@ -61,6 +61,7 @@ from maasserver.models.nodeprobeddetails import (
     get_single_probed_details,
     script_output_nsmap,
 )
+from maasserver.models.ownerdata import OwnerData
 from maasserver.models.partition import Partition, PARTITION_ALIGNMENT_SIZE
 import maasserver.node_action as node_action_module
 from maasserver.node_action import compile_node_actions
@@ -125,6 +126,9 @@ wait_for_reactor = wait_for(30)  # 30 seconds.
 
 
 class TestMachineHandler(MAASServerTestCase):
+
+    maxDiff = None
+
     def get_blockdevice_status(self, handler, blockdevice):
         blockdevice_script_results = [
             script_result
@@ -321,6 +325,7 @@ class TestMachineHandler(MAASServerTestCase):
             "zone": handler.dehydrate_zone(node.zone),
             "pool": handler.dehydrate_pool(node.pool),
             "default_user": node.default_user,
+            "workload_annotations": OwnerData.objects.get_owner_data(node),
         }
         if "module" in driver and "comment" in driver:
             data["third_party_driver"] = {
@@ -374,6 +379,7 @@ class TestMachineHandler(MAASServerTestCase):
                 "testing_script_count",
                 "testing_status",
                 "vlan",
+                "workload_annotations",
             ]
             for key in list(data):
                 if key not in allowed_fields:
@@ -577,14 +583,15 @@ class TestMachineHandler(MAASServerTestCase):
         # It is important to keep this number as low as possible. A larger
         # number means regiond has to do more work slowing down its process
         # and slowing down the client waiting for the response.
+        expected_query_count = 24
         self.assertEqual(
             queries_one,
-            23,
+            expected_query_count,
             "Number of queries has changed; make sure this is expected.",
         )
         self.assertEqual(
             queries_total,
-            23,
+            expected_query_count,
             "Number of queries has changed; make sure this is expected.",
         )
 
@@ -629,7 +636,7 @@ class TestMachineHandler(MAASServerTestCase):
         # It is important to keep this number as low as possible. A larger
         # number means regiond has to do more work slowing down its process
         # and slowing down the client waiting for the response.
-        expected_query_count = 23
+        expected_query_count = 24
         self.assertEqual(
             queries_one,
             expected_query_count,
@@ -673,7 +680,7 @@ class TestMachineHandler(MAASServerTestCase):
         # and slowing down the client waiting for the response.
         self.assertEqual(
             queries,
-            51,
+            52,
             "Number of queries has changed; make sure this is expected.",
         )
 
@@ -5274,90 +5281,90 @@ class TestMachineHandlerUpdateFilesystem(MAASServerTestCase):
 
 
 class TestMachineHandlerOwnerData(MAASServerTestCase):
-    """Tests for MachineHandle methods set_owner_data and get_owner_data."""
+    """Tests for MachineHandle methods set_workload_annotations and get_workload_annotations."""
 
-    def test_set_owner_data(self):
+    def test_set_workload_annotations(self):
         user = factory.make_User()
         node = factory.make_Node(owner=user)
         handler = MachineHandler(user, {}, None)
-        owner_data = {"data 1": "value 1"}
+        workload_annotations = {"data 1": "value 1"}
         self.assertEqual(
-            owner_data,
-            handler.set_owner_data(
+            workload_annotations,
+            handler.set_workload_annotations(
                 {
                     "system_id": node.system_id,
-                    "owner_data": owner_data,
+                    "workload_annotations": workload_annotations,
                 }
             ),
         )
 
-    def test_set_owner_data_overwrite(self):
+    def test_set_workload_annotations_overwrite(self):
         user = factory.make_User()
         node = factory.make_Node(owner=user)
         handler = MachineHandler(user, {}, None)
-        owner_data = {"data 1": "value 1"}
+        workload_annotations = {"data 1": "value 1"}
         self.assertEqual(
-            owner_data,
-            handler.set_owner_data(
+            workload_annotations,
+            handler.set_workload_annotations(
                 {
                     "system_id": node.system_id,
-                    "owner_data": owner_data,
+                    "workload_annotations": workload_annotations,
                 }
             ),
         )
-        owner_data = {"data 1": "value 2"}
+        workload_annotations = {"data 1": "value 2"}
         self.assertEqual(
-            owner_data,
-            handler.set_owner_data(
+            workload_annotations,
+            handler.set_workload_annotations(
                 {
                     "system_id": node.system_id,
-                    "owner_data": owner_data,
+                    "workload_annotations": workload_annotations,
                 }
             ),
         )
 
-    def test_set_owner_data_empty(self):
+    def test_set_workload_annotations_empty(self):
         user = factory.make_User()
         node = factory.make_Node(owner=user)
         handler = MachineHandler(user, {}, None)
-        owner_data = {"data 1": "value 1"}
+        workload_annotations = {"data 1": "value 1"}
         self.assertEqual(
-            owner_data,
-            handler.set_owner_data(
+            workload_annotations,
+            handler.set_workload_annotations(
                 {
                     "system_id": node.system_id,
-                    "owner_data": owner_data,
+                    "workload_annotations": workload_annotations,
                 }
             ),
         )
-        owner_data = {"data 1": ""}
+        workload_annotations = {"data 1": ""}
         self.assertEqual(
             {},
-            handler.set_owner_data(
+            handler.set_workload_annotations(
                 {
                     "system_id": node.system_id,
-                    "owner_data": owner_data,
+                    "workload_annotations": workload_annotations,
                 }
             ),
         )
 
-    def test_get_ower_data(self):
+    def test_get_workload_annotations(self):
         user = factory.make_User()
         node = factory.make_Node(owner=user)
         handler = MachineHandler(user, {}, None)
-        owner_data = {"data 1": "value 1"}
+        workload_annotations = {"data 1": "value 1"}
         self.assertEqual(
-            owner_data,
-            handler.set_owner_data(
+            workload_annotations,
+            handler.set_workload_annotations(
                 {
                     "system_id": node.system_id,
-                    "owner_data": owner_data,
+                    "workload_annotations": workload_annotations,
                 }
             ),
         )
         self.assertEqual(
-            owner_data,
-            handler.get_owner_data(
+            workload_annotations,
+            handler.get_workload_annotations(
                 {
                     "system_id": node.system_id,
                 }