Merge ~ltrager/maas:lp1816651 into maas:master

[Lee Trager]

LP: #1816651 - Handle duplicate IP addresses when creating a BMC object.

e172ae2... by Lee Trager on 2019-02-21

Copyright++

[Mike Pontillo (mpontillo)]

Can you see if this slightly simpler change does the trick?

https://paste.ubuntu.com/p/cxqZqmzZHC/

I don't think this change will work as intended, since the BMC IP might be an AUTO IP, not strictly a STICKY. For example, if I deploy a machine and use it for a KVM pod, it might get an AUTO address (or even DHCP), rather than STICKY.

review: Needs Fixing

[MAAS Lander (maas-lander)]

UNIT TESTS
-b lp1816651 lp:~ltrager/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: e172ae26e4215c5ab6ea158069e67f69e2a1d236

review: Approve

951c852... by Lee Trager on 2019-02-21

mpontillo suggestion

326d995... by Lee Trager on 2019-02-22

Use mpontillos patch

[Mike Pontillo (mpontillo)]

Looks good; thanks for the fix!

review: Approve

diff --git a/src/maasserver/models/bmc.py b/src/maasserver/models/bmc.py
index 1e3b865..711e756 100644
--- a/src/maasserver/models/bmc.py
+++ b/src/maasserver/models/bmc.py
@@ -1,4 +1,4 @@
-# Copyright 2015-2018 Canonical Ltd.  This software is licensed under the
+# Copyright 2015-2019 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """BMC objects."""
@@ -337,12 +337,14 @@ class BMC(CleanSave, TimestampedModel):
                     with transaction.atomic():
                         subnet = Subnet.objects.get_best_subnet_for_ip(new_ip)
                         (self.ip_address,
-                         _) = StaticIPAddress.objects.get_or_create(
-                            ip=new_ip,
-                            defaults={
-                                'alloc_type': IPADDRESS_TYPE.STICKY,
-                                'subnet': subnet,
-                            })
+                         _) = StaticIPAddress.objects.exclude(
+                             alloc_type=IPADDRESS_TYPE.DISCOVERED
+                             ).get_or_create(
+                                 ip=new_ip,
+                                 defaults={
+                                     'alloc_type': IPADDRESS_TYPE.STICKY,
+                                     'subnet': subnet,
+                                 })
                 except Exception as error:
                     maaslog.info(
                         "BMC could not save extracted IP "
diff --git a/src/maasserver/models/tests/test_bmc.py b/src/maasserver/models/tests/test_bmc.py
index e806ff0..41ff534 100644
--- a/src/maasserver/models/tests/test_bmc.py
+++ b/src/maasserver/models/tests/test_bmc.py
@@ -1,4 +1,4 @@
-# Copyright 2016-2018 Canonical Ltd.  This software is licensed under the
+# Copyright 2016-2019 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """Test maasserver models."""
@@ -146,6 +146,25 @@ class TestBMC(MAASServerTestCase):
         self.assertNotEqual(machine_ip_addr.id, bmc.ip_address.id)
         return machine, bmc, machine_ip
 
+    def test_make_machine_and_bmc_discovered_ip(self):
+        # Regression test for LP:1816651
+        subnet = factory.make_Subnet()
+        discovered_ip = factory.make_StaticIPAddress(
+            subnet=subnet, alloc_type=IPADDRESS_TYPE.DISCOVERED)
+        sticky_ip = factory.make_StaticIPAddress(
+            ip=discovered_ip.ip, subnet=subnet,
+            alloc_type=IPADDRESS_TYPE.STICKY)
+        bmc = factory.make_BMC(
+            power_type='virsh',
+            power_parameters={
+                'power_address':
+                "protocol://%s:8080/path/to/thing#tag" % (
+                    factory.ip_to_url_format(discovered_ip.ip))})
+        self.assertItemsEqual(
+            [discovered_ip, sticky_ip],
+            StaticIPAddress.objects.filter(ip=discovered_ip.ip))
+        self.assertEqual(sticky_ip, bmc.ip_address)
+
     def test_bmc_save_extracts_ip_address(self):
         subnet = factory.make_Subnet()
         sticky_ip = factory.make_StaticIPAddress(