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

[Raphaël Badin]

Add utility to parse nmap output.

This is the first branch in a series of branches aimed at adding a fully-automated, non-interactive testing mode where all the BMC details (MAC address, username and password) are given on the command line and then used to power up the node instead of asking the user to do that manually.

This branch adds a simple utility: a parser for the output of nmap. We will use nmap to scan the network and find the IP address of the BMC given its MAC address.

[Graham Binns (gmb)]

review: Approve

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

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

Merge trunk.

[Julian Edwards (julian-edwards)]

You need to rethink this, please don't use NMAP. It is largely disallowed on many networks.

There is a utility for working out IPs from MACs, it's called "arp". Better still perhaps use ipmiping.

review: Disapprove

=== modified file 'maastest/tests/test_utils.py'
--- maastest/tests/test_utils.py	2013-11-20 11:48:59 +0000
+++ maastest/tests/test_utils.py	2013-11-21 14:36:23 +0000
@@ -15,6 +15,7 @@
 import os.path
 import platform
 from subprocess import PIPE
+from textwrap import dedent
 import time
 
 import distro_info
@@ -244,3 +245,58 @@
             self.assertEqual(supported, utils.get_supported_series())
         else:
             self.assertEqual(supported, utils.get_supported_series())
+
+
+class TestExtractMAPIPMapping(testtools.TestCase):
+
+    def test_extract_mac_ip_mapping_parses_output(self):
+        NMAP_XML_OUTPUT = dedent("""
+            <nmaprun scanner="nmap" args="nmap -sP -oX - 192.168.2.0/24">
+              <host>
+                <address addr="192.168.2.2" addrtype="ipv4"/>
+                <address addr="00:9C:02:A2:82:74" addrtype="mac"/>
+              </host>
+              <host>
+                <address addr="192.168.2.4" addrtype="ipv4"/>
+                <address addr="00:9C:02:A0:4D:0A" addrtype="mac"/>
+              </host>
+            </nmaprun>
+        """)
+        expected_result = {
+            '00:9C:02:A2:82:74': '192.168.2.2',
+            '00:9C:02:A0:4D:0A': '192.168.2.4',
+        }
+        self.assertEqual(
+            expected_result, utils.extract_mac_ip_mapping(NMAP_XML_OUTPUT))
+
+    def test_extract_mac_ip_mapping_returns_uppercase_mac(self):
+        NMAP_XML_OUTPUT = dedent("""
+            <nmaprun scanner="nmap" args="nmap -sP -oX - 192.168.2.0/24">
+              <host>
+                <address addr="192.168.2.2" addrtype="ipv4"/>
+                <address addr="AA:bb:cc:dd:ee:FF" addrtype="mac"/>
+              </host>
+            </nmaprun>
+        """)
+        expected_result = {'AA:BB:CC:DD:EE:FF': '192.168.2.2'}
+        self.assertEqual(
+            expected_result, utils.extract_mac_ip_mapping(NMAP_XML_OUTPUT))
+
+    def test_extract_mac_ip_mapping_with_empty_doc(self):
+        self.assertEqual(
+            {}, utils.extract_mac_ip_mapping('<nmaprun></nmaprun>'))
+
+    def test_extract_mac_ip_mapping_with_missing_info(self):
+        # If either the IP address of the MAC address is missing in a host
+        # definition, the host entry is not considered.
+        NMAP_XML_OUTPUT = dedent("""
+            <nmaprun scanner="nmap" args="nmap -sP -oX - 192.168.2.0/24">
+              <host>
+                <address addr="192.168.2.2" addrtype="ipv4"/>
+              </host>
+              <host>
+                <address addr="00:9C:02:A0:4D:0A" addrtype="mac"/>
+              </host>
+            </nmaprun>
+        """)
+        self.assertEqual({}, utils.extract_mac_ip_mapping(NMAP_XML_OUTPUT))

=== modified file 'maastest/utils.py'
--- maastest/utils.py	2013-11-20 11:50:18 +0000
+++ maastest/utils.py	2013-11-21 14:36:23 +0000
@@ -33,6 +33,7 @@
     )
 
 import distro_info
+from lxml import etree
 from testtools.content import Content
 from testtools.content_type import ContentType
 
@@ -64,7 +65,6 @@
     api_root = '/api/1.0/'
     return api_root + path
 
-
 BINARY = ContentType("application", "octet-stream")
 
 
@@ -137,3 +137,25 @@
     cut_off_index = (
         supported.index('precise') if 'precise' in supported else 0)
     return supported[cut_off_index:]
+
+
+def extract_mac_ip_mapping(nmap_xml_scan):
+    """Extract the IP->MAC address mapping from the result of a nmap scan.
+
+    The returned mapping uses uppercase MAC addresses.
+
+    :param nmap_xml_scan: The XML result of scanning a network using nmap.
+        Scanning a network using nmap is typically done by running:
+        `nmap -sP <network_definition> -oX -`.
+    :type nmap_xml_scan: string
+    """
+    parser = etree.XMLParser(remove_blank_text=True)
+    xml_doc = etree.fromstring(nmap_xml_scan, parser)
+    hosts = xml_doc.xpath("/nmaprun/host")
+    mapping = {}
+    for host in hosts:
+        ips = host.xpath("address[@addrtype='ipv4']/@addr")
+        macs = host.xpath("address[@addrtype='mac']/@addr")
+        if len(ips) == 1 and len(macs) == 1:
+            mapping[macs[0].upper()] = ips[0]
+    return mapping