Merge ~adam-collard/maas:vmcluster-tracked-vms-websocket into maas:master

[Adam Collard]

LP:1949720: Only expose VMs in the VMCluster's project in dehydrate

[Alberto Donato (ack)]

+1!

small nit inline

review: Approve

[MAAS Lander (maas-lander)]

UNIT TESTS
-b vmcluster-tracked-vms-websocket 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/11452/console
COMMIT: c93c0536997573e216a0ca3392fc98ca3efd04df

review: Needs Fixing

[Adam Collard (adam-collard)]

jenkins: !test

[MAAS Lander (maas-lander)]

UNIT TESTS
-b vmcluster-tracked-vms-websocket 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/11453/console
COMMIT: c93c0536997573e216a0ca3392fc98ca3efd04df

review: Needs Fixing

[MAAS Lander (maas-lander)]

UNIT TESTS
-b vmcluster-tracked-vms-websocket 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/11454/console
COMMIT: 158c9f898eea6b22b48743e647350579cf95039c

review: Needs Fixing

[Adam Collard (adam-collard)]

jenkins: !test

[MAAS Lander (maas-lander)]

UNIT TESTS
-b vmcluster-tracked-vms-websocket lp:~adam-collard/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 158c9f898eea6b22b48743e647350579cf95039c

review: Approve

ccce0d6... by Adam Collard on 2021-11-04

Add test for vmcluster vm_count

Pass project through to Pod in factory

[MAAS Lander (maas-lander)]

UNIT TESTS
-b vmcluster-tracked-vms-websocket 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/11457/console
COMMIT: f38a333224e45799316f439145f0ca9250f58d92

review: Needs Fixing

diff --git a/src/maasserver/models/tests/test_vmcluster.py b/src/maasserver/models/tests/test_vmcluster.py
index fa1db30..09fe42f 100644
--- a/src/maasserver/models/tests/test_vmcluster.py
+++ b/src/maasserver/models/tests/test_vmcluster.py
@@ -510,6 +510,19 @@ class TestVMCluster(MAASServerTestCase):
         cluster = VMCluster(name=cluster_name, project=project)
         self.assertEqual(list(cluster.virtual_machines()), [])
 
+    def test_tracked_virtual_machines(self):
+        our_project = factory.make_name("project")
+        other_project = factory.make_name("project")
+        cluster = factory.make_VMCluster(project=our_project, vms=3)
+
+        pod = cluster.hosts().get()
+        # a VM that we're not tracking, since it's in another project
+        untracked_vm = factory.make_VirtualMachine(
+            memory=1024, bmc=pod, project=other_project
+        )
+        self.assertNotIn(untracked_vm, cluster.tracked_virtual_machines())
+        self.assertIn(untracked_vm, cluster.virtual_machines())
+
     def test_update_cluster_certificate_updates_peers_with_same_cert(self):
         cluster = factory.make_VMCluster(pods=3)
         cert = SAMPLE_CERT.certificate_pem()
@@ -589,3 +602,22 @@ class TestVMClusterUpdate(MAASTransactionServerTestCase):
         pod2_pool = yield deferToDatabase(lambda: reload_object(pod2).pool)
         self.assertEqual(pool, pod1_pool)
         self.assertEqual(pool, pod2_pool)
+
+
+class TestVMClusterVMCount(MAASServerTestCase):
+    def test_untracked_vms_counted(self):
+        our_project = factory.make_name("project")
+        other_project = factory.make_name("project")
+
+        cluster = factory.make_VMCluster(project=our_project, vms=3)
+
+        pod = cluster.hosts().get()
+        # a VM that we're not tracking, since it's in another project
+        factory.make_VirtualMachine(
+            memory=1024, bmc=pod.as_bmc(), project=other_project
+        )
+
+        resources = cluster.total_resources()
+        self.assertEqual(3, resources.vm_count.tracked)
+        self.assertEqual(1, resources.vm_count.other)
+        self.assertEqual(4, resources.vm_count.total)
diff --git a/src/maasserver/models/vmcluster.py b/src/maasserver/models/vmcluster.py
index 08f5b08..66bf485 100644
--- a/src/maasserver/models/vmcluster.py
+++ b/src/maasserver/models/vmcluster.py
@@ -194,11 +194,16 @@ class VMCluster(CleanSave, TimestampedModel):
         return cluster_resources
 
     def virtual_machines(self):
+        """All VirtualMachines on this cluster, includes untracked VMs"""
         from maasserver.models.virtualmachine import VirtualMachine
 
         hosts = self.hosts()
         return VirtualMachine.objects.filter(bmc__in=hosts)
 
+    def tracked_virtual_machines(self):
+        """VirtualMachines that are part of this project."""
+        return self.virtual_machines().filter(project=self.project)
+
     def storage_pools(self):
         from maasserver.models.virtualmachine import get_vm_host_storage_pools
 
@@ -349,7 +354,7 @@ class VMClusterVMCount:
 
     @property
     def total(self):
-        return self.tracked - self.other
+        return self.tracked + self.other
 
 
 @dataclass
diff --git a/src/maasserver/testing/factory.py b/src/maasserver/testing/factory.py
index 562d610..6e7ceda 100644
--- a/src/maasserver/testing/factory.py
+++ b/src/maasserver/testing/factory.py
@@ -656,7 +656,7 @@ class Factory(maastesting.factory.Factory):
     def make_BMC(
         self, power_type=None, power_parameters=None, ip_address=None, **kwargs
     ):
-        """Make a :class:`BMC`. """
+        """Make a :class:`BMC`."""
         # If an IP address was specified, we need to present it in the BMC
         # power_parameters, or it will be overwritten.
         if ip_address is not None:
@@ -699,6 +699,7 @@ class Factory(maastesting.factory.Factory):
         parameters=None,
         ip_address=None,
         host=None,
+        project=None,
         cluster=None,
         **kwargs,
     ):
@@ -718,6 +719,8 @@ class Factory(maastesting.factory.Factory):
                 }
             elif pod_type == "lxd":
                 parameters = {"power_address": f"{ip}:8443"}
+        if project:
+            parameters["project"] = project
         pod = Pod(
             power_type=pod_type,
             power_parameters=parameters,
@@ -3014,9 +3017,9 @@ class Factory(maastesting.factory.Factory):
         disk_size=None,
     ):
         if name is None:
-            name = factory.make_name("name")
+            name = self.make_name("name")
         if project is None:
-            project = factory.make_name("project")
+            project = self.make_name("project")
         if zone is None:
             zone = self.make_Zone()
 
@@ -3028,25 +3031,26 @@ class Factory(maastesting.factory.Factory):
         )
 
         for _ in range(0, pods):
-            pod = factory.make_Pod(
+            pod = self.make_Pod(
                 pod_type="lxd",
-                host=None,
                 cores=cores,
                 memory=memory,
                 cluster=cluster,
+                project=project,
             )
-            pool = factory.make_PodStoragePool(pod=pod, storage=storage)
+            pool = self.make_PodStoragePool(pod=pod, storage=storage)
 
             for _ in range(0, vms):
-                node = factory.make_Node(bmc=pod)
-                vm = factory.make_VirtualMachine(
+                node = self.make_Node(bmc=pod)
+                vm = self.make_VirtualMachine(
                     machine=node,
                     memory=vm_memory,
                     pinned_cores=[0, 2],
                     hugepages_backed=False,
                     bmc=pod,
+                    project=project,
                 )
-                factory.make_VirtualMachineDisk(
+                self.make_VirtualMachineDisk(
                     vm=vm, backing_pool=pool, size=disk_size
                 )
 
diff --git a/src/maasserver/websockets/handlers/tests/test_vmcluster.py b/src/maasserver/websockets/handlers/tests/test_vmcluster.py
index 176e015..1b59b43 100644
--- a/src/maasserver/websockets/handlers/tests/test_vmcluster.py
+++ b/src/maasserver/websockets/handlers/tests/test_vmcluster.py
@@ -31,7 +31,9 @@ class TestVMClusterHandler(MAASTransactionServerTestCase):
             ]
             vms = [
                 factory.make_VirtualMachine(
-                    bmc=vmhost.as_bmc(), machine=factory.make_Machine()
+                    bmc=vmhost.as_bmc(),
+                    machine=factory.make_Machine(),
+                    project=cluster.project,
                 )
                 for vmhost in vmhosts
             ]
@@ -62,7 +64,9 @@ class TestVMClusterHandler(MAASTransactionServerTestCase):
                 if with_vms:
                     vms = [
                         factory.make_VirtualMachine(
-                            bmc=vmhost.as_bmc(), machine=factory.make_Machine()
+                            bmc=vmhost.as_bmc(),
+                            machine=factory.make_Machine(),
+                            project=cluster.project,
                         )
                         for vmhost in vmhosts
                     ]
@@ -201,11 +205,13 @@ class TestVMClusterHandler(MAASTransactionServerTestCase):
     def test_full_dehydrate(self):
         cluster = factory.make_VMCluster(pods=3)
         vmhosts = cluster.hosts()
-        _ = [factory.make_PodStoragePool(pod=vmhost) for vmhost in vmhosts]
+        [factory.make_PodStoragePool(pod=vmhost) for vmhost in vmhosts]
 
         vms = [
             factory.make_VirtualMachine(
-                bmc=vmhost.as_bmc(), machine=factory.make_Machine()
+                bmc=vmhost.as_bmc(),
+                machine=factory.make_Machine(),
+                project=cluster.project,
             )
             for vmhost in vmhosts
         ]
@@ -216,6 +222,31 @@ class TestVMClusterHandler(MAASTransactionServerTestCase):
 
         self._assert_dehydrated_cluster_equal(result, cluster, vmhosts, vms)
 
+    def test_full_dehydrate_with_untracked_vms(self):
+        cluster = factory.make_VMCluster()
+        vmhost = cluster.hosts().get()
+        factory.make_PodStoragePool(pod=vmhost)
+
+        tracked_vm = factory.make_VirtualMachine(
+            bmc=vmhost.as_bmc(),
+            machine=factory.make_Machine(),
+            project=cluster.project,
+        )
+        # Untracked VM in a separate project
+        factory.make_VirtualMachine(
+            bmc=vmhost.as_bmc(),
+            machine=None,
+            project=factory.make_name("project"),
+        )
+
+        handler = VMClusterHandler(factory.make_admin(), {}, None)
+
+        result = handler.full_dehydrate(cluster)
+
+        self._assert_dehydrated_cluster_equal(
+            result, cluster, [vmhost], [tracked_vm]
+        )
+
     def test_dehydrate(self):
         cluster = factory.make_VMCluster(pods=0)
         vmhosts = [factory.make_Pod(cluster=cluster) for _ in range(3)]
@@ -223,7 +254,9 @@ class TestVMClusterHandler(MAASTransactionServerTestCase):
 
         vms = [
             factory.make_VirtualMachine(
-                bmc=vmhost.as_bmc(), machine=factory.make_Machine()
+                bmc=vmhost.as_bmc(),
+                machine=factory.make_Machine(),
+                project=cluster.project,
             )
             for vmhost in vmhosts
         ]
diff --git a/src/maasserver/websockets/handlers/vmcluster.py b/src/maasserver/websockets/handlers/vmcluster.py
index 07f20a1..fdeaaa6 100644
--- a/src/maasserver/websockets/handlers/vmcluster.py
+++ b/src/maasserver/websockets/handlers/vmcluster.py
@@ -98,7 +98,10 @@ class VMClusterHandler(TimestampedModelHandler):
 
     def full_dehydrate(self, obj, for_list=False):
         return self.dehydrate(
-            obj, obj.hosts(), obj.total_resources(), obj.virtual_machines()
+            obj,
+            obj.hosts(),
+            obj.total_resources(),
+            obj.tracked_virtual_machines(),
         )
 
     def dehydrate(self, cluster, vmhosts, resources, vms):
@@ -136,7 +139,7 @@ class VMClusterHandler(TimestampedModelHandler):
                     cluster,
                     cluster.hosts(),
                     cluster.total_resources(),
-                    cluster.virtual_machines(),
+                    cluster.tracked_virtual_machines(),
                 )
                 for cluster in objs
             }
@@ -160,7 +163,7 @@ class VMClusterHandler(TimestampedModelHandler):
                         cluster,
                         cluster.hosts(),
                         cluster.total_resources(),
-                        cluster.virtual_machines(),
+                        cluster.tracked_virtual_machines(),
                     )
                     for cluster in phys_cluster
                 ]
@@ -181,7 +184,10 @@ class VMClusterHandler(TimestampedModelHandler):
         @transactional
         def render_object(obj):
             return self.dehydrate(
-                obj, obj.hosts(), obj.total_resources(), obj.virtual_machines()
+                obj,
+                obj.hosts(),
+                obj.total_resources(),
+                obj.tracked_virtual_machines(),
             )
 
         cluster = await deferToDatabase(get_object, params["id"])