Merge lp:~rvb/maas-test/bmc-params-3 into lp:maas-test

[Raphaël Badin]

Add get_ip_from_network_scan utility.

This new utility is used to find the BMC's IP address. Yes, I reckon it's a bit cavalier to install 'nmap' every time the method is called but: a) once the package is installed, this really takes a second to return b) this method really should be used once (if that assumption becomes false, we might want to revisit this code).

[Graham Binns (gmb)]

[0]
22 + self.install_packages(['nmap'])

I can't actually think of any reason not to do this when setting up the machine... although it's probably much of a muchness as long as this is only called once.

review: Approve

[lp:~rvb/maas-test/bmc-params-3]

50. By Raphaël Badin on 2013-11-21

Install nmap when setting up the VM.

[Raphaël Badin (rvb)]

> [0]
> 22 + self.install_packages(['nmap'])
>
> I can't actually think of any reason not to do this when setting up the
> machine... although it's probably much of a muchness as long as this is only
> called once.

All right, I've fixed that… I might have been lazy :).
Thanks for the reviews!

[lp:~rvb/maas-test/bmc-params-3]

51. By Raphaël Badin on 2013-11-21

Merge trunk, fix conflicts.

[Julian Edwards (julian-edwards)]

Again, nmap is verboten.

review: Disapprove

=== modified file 'maastest/kvmfixture.py'
--- maastest/kvmfixture.py	2013-11-21 14:40:18 +0000
+++ maastest/kvmfixture.py	2013-11-21 14:40:19 +0000
@@ -27,6 +27,7 @@
 from lxml import etree
 from maastest.utils import (
     binary_content,
+    extract_mac_ip_mapping,
     retries,
     run_command,
     )
@@ -133,6 +134,7 @@
             self.wait_for_cloudinit()
             self.configure_network()
             self.configure_ppa()
+            self.install_base_packages()
         except:
             self.destroy()
             raise
@@ -310,6 +312,11 @@
         self.run_command(
             APT_GET_INSTALL + list(packages), check_call=True)
 
+    def install_base_packages(self):
+        """Install the packages needed for this instance to work."""
+        # Instal nmap so that 'get_ip_from_network_scan' can work.
+        self.install_packages(['nmap'])
+
     def run_command(self, args, input=None, check_call=False):
         """Run the given command in the VM."""
         args = self._make_ssh_command(args)
@@ -325,6 +332,21 @@
         self.addDetail(cmd_prefix + ' stderr', binary_content(stderr))
         return retcode, stdout, stderr
 
+    def get_ip_from_network_scan(self, mac_address):
+        """Return the IP address associated with a MAC address.
+
+        The IP address is found by scanning the direct network using nmap.
+        """
+        network_repr = "%s" % self.direct_network
+        nmap_scan_cmd = ['sudo', 'nmap', '-sP', network_repr, '-oX', '-']
+        _, output, _ = self.run_command(
+            nmap_scan_cmd, check_call=True)
+        mapping = extract_mac_ip_mapping(output)
+        ip = mapping.get(mac_address.upper())
+        if ip is not None:
+            return ip
+        return None
+
 
 KVM_TEMPLATE = """
   <domain type='kvm'>

=== modified file 'maastest/tests/test_kvmfixture.py'
--- maastest/tests/test_kvmfixture.py	2013-11-21 14:40:18 +0000
+++ maastest/tests/test_kvmfixture.py	2013-11-21 14:40:19 +0000
@@ -139,6 +139,10 @@
         self.patch(kvmfixture.KVMFixture, 'import_image', mock_import_image)
         mock_start = mock.MagicMock()
         self.patch(kvmfixture.KVMFixture, 'start', mock_start)
+        mock_install_base_packages = mock.MagicMock()
+        self.patch(
+            kvmfixture.KVMFixture, 'install_base_packages',
+            mock_install_base_packages)
         mock_configure_network = mock.MagicMock()
         self.patch(
             kvmfixture.KVMFixture, 'configure_network',
@@ -156,12 +160,14 @@
                     mock.call(),
                     mock.call(),
                     mock.call(),
+                    mock.call(),
                 ],
                 [
                     mock_import_image.mock_calls,
                     mock_start.mock_calls,
                     mock_configure_network.mock_calls,
                     mock_configure_ppa.mock_calls,
+                    mock_install_base_packages.mock_calls,
                 ])
 
     def test_setUp_awaits_boot_and_cloudinit_completion(self):
@@ -502,6 +508,19 @@
                 kvmfixture.APT_GET_INSTALL + packages, check_call=True)],
             kvm_run_command.mock_calls)
 
+    def test_install_base_packages(self):
+        self.patch_run_command()
+        fixture = self.make_KVMFixture('series', 'architecture')
+        kvm_run_command = mock.MagicMock(return_value=(0, '', ''))
+        self.patch(kvmfixture.KVMFixture, 'run_command', kvm_run_command)
+
+        fixture.install_base_packages()
+
+        self.assertEqual(
+            [mock.call(
+                kvmfixture.APT_GET_INSTALL + ['nmap'], check_call=True)],
+            kvm_run_command.mock_calls)
+
     def test_run_command_runs_command_remotely(self):
         fake_run_command = self.patch_run_command()
         series = "test-series"
@@ -552,6 +571,41 @@
                 details['cmd #0001 stderr'],
             ))
 
+    def test_get_ip_from_network_scan(self):
+        self.patch_run_command()
+        mac = self.getUniqueString()
+        ip = self.getUniqueString()
+        network_str = '192.168.12.0/24'
+        network = netaddr.IPNetwork(network_str)
+        fixture = self.make_KVMFixture(
+            'series', 'architecture', direct_network=network)
+        mapping = {mac.upper(): ip}
+        extract_mac_ip_mapping_mock = mock.MagicMock(return_value=mapping)
+        xml_output = self.getUniqueString()
+        self.patch(
+            kvmfixture, 'extract_mac_ip_mapping',
+            extract_mac_ip_mapping_mock)
+        kvm_run_command = mock.MagicMock(return_value=(0, xml_output, ''))
+        self.patch(kvmfixture.KVMFixture, 'run_command', kvm_run_command)
+
+        returned_ip = fixture.get_ip_from_network_scan(mac)
+
+        self.assertEqual(
+            (
+                ip,
+                [
+                    mock.call(
+                        ['sudo', 'nmap', '-sP', network_str, '-oX', '-'],
+                        check_call=True)
+                ],
+                [mock.call(xml_output)],
+            ),
+            (
+                returned_ip,
+                kvm_run_command.mock_calls,
+                extract_mac_ip_mapping_mock.mock_calls,
+            ))
+
 
 def xml_normalize(snippet):
     parser = etree.XMLParser(remove_blank_text=True)