Merge lp:~mpontillo/maas/maas-rack--send-beacons into lp:~maas-committers/maas/trunk

[Mike Pontillo]

Add test command for sending out beacons.

[lp:~mpontillo/maas/maas-rack--send-beacons]

6090. By Mike Pontillo on 2017-06-14

Add tests for interface index.

6091. By Mike Pontillo on 2017-06-14

Merge branch: lp:~mpontillo/maas/get-all-interfaces--add-ifindex

[MAAS Lander (maas-lander)]

Transitioned to Git.

lp:maas has now moved from Bzr to Git.
Please propose your branches with Launchpad using Git.

git clone https://git.launchpad.net/maas

Unmerged revisions

6091. By Mike Pontillo on 2017-06-14

Merge branch: lp:~mpontillo/maas/get-all-interfaces--add-ifindex

6090. By Mike Pontillo on 2017-06-14

Add tests for interface index.

6089. By Mike Pontillo on 2017-06-14

Add test command to send beacons out.

=== modified file 'src/provisioningserver/__main__.py'
--- src/provisioningserver/__main__.py	2017-06-08 20:41:27 +0000
+++ src/provisioningserver/__main__.py	2017-06-14 15:45:59 +0000
@@ -16,6 +16,7 @@
 import provisioningserver.utils.dhcp
 import provisioningserver.utils.scan_network
 from provisioningserver.utils.script import MainScript
+import provisioningserver.utils.send_beacons
 
 
 script_commands = {
@@ -27,6 +28,7 @@
     'observe-beacons': provisioningserver.utils.beaconing,
     'observe-mdns': provisioningserver.utils.avahi,
     'observe-dhcp': provisioningserver.utils.dhcp,
+    'send-beacons': provisioningserver.utils.send_beacons,
     'scan-network': provisioningserver.utils.scan_network,
     'register': provisioningserver.register_command,
     'support-dump': provisioningserver.support_dump,
 
=== modified file 'src/provisioningserver/utils/beaconing.py'
--- src/provisioningserver/utils/beaconing.py	2017-06-14 15:45:58 +0000
+++ src/provisioningserver/utils/beaconing.py	2017-06-14 15:45:59 +0000
@@ -53,7 +53,7 @@
 class BEACON_ENCAPSULATION:
     """Enumeration to describe beacon encapsulation types."""
 
-    FERNET_PSK = "fernet_psk"
+    FERNET_PSK = "fernet-psk"
 
 
 BeaconPayload = namedtuple('BeaconPayload', (
@@ -63,7 +63,7 @@
 ))
 
 
-def create_beacon_payload(beacon_type, data=None):
+def create_beacon_payload(beacon_type, data=None) -> BeaconPayload:
     """Creates a beacon payload of the specified type, with the given data.
 
     :param beacon_type: The beacon packet type. Indicates the purpose of the
 
=== modified file 'src/provisioningserver/utils/network.py'
--- src/provisioningserver/utils/network.py	2017-04-26 21:15:06 +0000
+++ src/provisioningserver/utils/network.py	2017-06-14 15:45:59 +0000
@@ -1159,6 +1159,7 @@
         # Create the interface definition will links for both IPv4 and IPv6.
         interface = {
             "type": iface_type,
+            "index": ipaddr['index'],
             "links": [],
             "enabled": True if 'UP' in ipaddr['flags'] else False,
             "parents": parents,
 
=== added file 'src/provisioningserver/utils/send_beacons.py'
--- src/provisioningserver/utils/send_beacons.py	1970-01-01 00:00:00 +0000
+++ src/provisioningserver/utils/send_beacons.py	2017-06-14 15:45:59 +0000
@@ -0,0 +1,123 @@
+# Copyright 2016 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Utilities for scanning attached networks."""
+import struct
+
+
+__all__ = [
+    "add_arguments",
+    "run"
+]
+
+import select
+import socket
+import sys
+from textwrap import dedent
+import time
+
+from provisioningserver.utils.beaconing import (
+    BEACON_PORT,
+    create_beacon_payload,
+    read_beacon_payload,
+)
+from provisioningserver.utils.network import get_all_interfaces_definition
+from pprint import pformat
+
+
+def add_arguments(parser):
+    """Add this command's options to the `ArgumentParser`.
+
+    Specified by the `ActionScript` interface.
+    """
+    parser.description = dedent("""\
+        Send solicitation beacons to a particular address.
+        """)
+    parser.add_argument(
+        '-v', '--verbose', action='store_true', required=False,
+        help='Verbose packet output.')
+    parser.add_argument(
+        '-s', '--source', type=str, required=False,
+        help='Source address to send beacons from.')
+    parser.add_argument(
+        'destination', type=str, nargs='?',
+        help="Destination to send beacon to. If not specified, will use the "
+             "MAAS multicast group (224.0.0.118).")
+
+
+def do_beaconing(args, source_ip, destination_ip, interfaces, stdout):
+    """Interprets the specified `args` and `to_scan` dict to perform the scan.
+
+    Uses the specified `stdout` and `stderr` for output.
+    """
+    clock = time.monotonic()
+    transport = socket.socket(socket.AF_INET6, socket.SOCK_DGRAM)
+    if source_ip is not None:
+        if ':' not in source_ip:
+            source_ip = "::ffff:" + source_ip
+        transport.bind((source_ip, 0))
+    if destination_ip is None:
+        destination_ip = "::ffff:224.0.0.118"
+    elif ':' not in destination_ip:
+        destination_ip = "::ffff:" + destination_ip
+    beacon = create_beacon_payload("solicitation")
+    if "224.0.0.118" in destination_ip:
+        for ifdata in interfaces.values():
+            for link in ifdata["links"]:
+                address = link["address"]
+                # Strip off CIDRs.
+                address = address.split("/")[0]
+                if ':' not in address:
+                    transport.setsockopt(
+                        socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, 1)
+                    transport.setsockopt(
+                        socket.IPPROTO_IP, socket.IP_MULTICAST_IF,
+                        socket.inet_aton(address))
+                    destination_ip = "::ffff:224.0.0.118"
+                    transport.sendto(
+                        beacon.packet_bytes, (destination_ip, BEACON_PORT))
+                else:
+                    # We're sending to an IPv4 multicast address, so we can't
+                    # actually use IPv6 addresses here.
+                    transport.setsockopt(
+                        socket.IPPROTO_IPV6, socket.IPV6_MULTICAST_HOPS, 1)
+                    packed_ifindex = struct.pack('I', ifdata['index'])
+                    transport.setsockopt(
+                        socket.IPPROTO_IPV6, socket.IPV6_MULTICAST_IF,
+                        packed_ifindex)
+                    destination_ip = "ff02::15a"
+                    transport.sendto(
+                        beacon.packet_bytes, (destination_ip, BEACON_PORT))
+    else:
+        transport.sendto(beacon.packet_bytes, (destination_ip, BEACON_PORT))
+    transport.setblocking(0)
+    clock_diff = 0
+    timeout = 5
+    while clock_diff < timeout:
+        ready = select.select([transport], [], [], timeout)
+        if ready[0]:
+            reply, reply_address = transport.recvfrom(16384)
+            if args.verbose:
+                print("%s: %s" % (
+                    pformat(reply), pformat(reply_address)), file=stdout)
+            reply = read_beacon_payload(reply)
+            print("%s" % pformat(reply), file=stdout)
+        clock_diff = time.monotonic() - clock
+
+
+def run(args, stdout=sys.stdout):
+    """Scan local networks for on-link hosts.
+
+    :param args: Parsed output of the arguments added in `add_arguments()`.
+    :param stdout: Standard output stream to write to.
+    :param stderr: Standard error stream to write to.
+    """
+    # Record the current time so we can figure out how long it took us to
+    # do all this scanning.
+    source_ip = args.source
+    destination_ip = args.destination
+    interfaces = get_all_interfaces_definition(annotate_with_monitored=False)
+    if args.verbose:
+        print("%s" % pformat(interfaces), file=stdout)
+    do_beaconing(
+        args, source_ip, destination_ip, interfaces, stdout)
 
=== modified file 'src/provisioningserver/utils/tests/test_network.py'
--- src/provisioningserver/utils/tests/test_network.py	2017-04-26 02:29:43 +0000
+++ src/provisioningserver/utils/tests/test_network.py	2017-06-14 15:45:59 +0000
@@ -5,6 +5,7 @@
 
 __all__ = []
 
+import random
 import socket
 from socket import (
     EAI_BADFLAGS,
@@ -1174,6 +1175,7 @@
                 "flags": ["UP"],
                 "inet": ["127.0.0.1/32"],
                 "inet6": ["::1"],
+                "index": 1,
             },
         }
         self.assertInterfacesResult(ip_addr, {}, {}, MatchesDict({}))
@@ -1185,6 +1187,7 @@
                 "mac": factory.make_mac_address(),
                 "flags": ["UP"],
                 "inet": ["192.168.122.2/24"],
+                "index": 2,
             },
         }
         self.assertInterfacesResult(ip_addr, {}, {}, MatchesDict({}))
@@ -1194,6 +1197,7 @@
             "vnet": {
                 "type": "ipip",
                 "flags": ["UP"],
+                "index": 2,
             },
         }
         self.assertInterfacesResult(ip_addr, {}, {}, MatchesDict({}))
@@ -1202,6 +1206,7 @@
         ip_addr = {
             "eth0": {
                 "type": "ethernet.physical",
+                "index": 2,
                 "mac": factory.make_mac_address(),
                 "flags": ["UP"],
                 "inet": ["192.168.122.2/24"],
@@ -1210,6 +1215,7 @@
         expected_result = MatchesDict({
             "eth0": MatchesDict({
                 "type": Equals("physical"),
+                "index": Equals(ip_addr["eth0"]["index"]),
                 "mac_address": Equals(ip_addr["eth0"]["mac"]),
                 "enabled": Is(True),
                 "parents": Equals([]),
@@ -1226,6 +1232,7 @@
         ip_addr = {
             "eth0": {
                 "type": "ethernet.physical",
+                "index": random.randint(2, 99),
                 "mac": factory.make_mac_address(),
                 "flags": ["UP"],
                 "inet": ["192.168.122.2/24"],
@@ -1239,6 +1246,7 @@
         expected_result = MatchesDict({
             "eth0": MatchesDict({
                 "type": Equals("physical"),
+                "index": Equals(ip_addr["eth0"]["index"]),
                 "mac_address": Equals(ip_addr["eth0"]["mac"]),
                 "enabled": Is(True),
                 "parents": Equals([]),
@@ -1256,6 +1264,7 @@
         ip_addr = {
             "eth0": {
                 "type": "ethernet",
+                "index": random.randint(2, 99),
                 "mac": factory.make_mac_address(),
                 "flags": ["UP"],
                 "inet": ["192.168.122.2/24"],
@@ -1264,6 +1273,7 @@
         expected_result = MatchesDict({
             "eth0": MatchesDict({
                 "type": Equals("physical"),
+                "index": Equals(ip_addr["eth0"]["index"]),
                 "mac_address": Equals(ip_addr["eth0"]["mac"]),
                 "enabled": Is(True),
                 "parents": Equals([]),
@@ -1281,6 +1291,7 @@
         ip_addr = {
             "eth0": {
                 "type": "ethernet.physical",
+                "index": random.randint(2, 99),
                 "mac": factory.make_mac_address(),
                 "flags": ["UP"],
                 "inet": ["192.168.122.2/24", "192.168.122.200/32"],
@@ -1292,6 +1303,7 @@
         expected_result = MatchesDict({
             "eth0": MatchesDict({
                 "type": Equals("physical"),
+                "index": Equals(ip_addr["eth0"]["index"]),
                 "mac_address": Equals(ip_addr["eth0"]["mac"]),
                 "enabled": Is(True),
                 "parents": Equals([]),
@@ -1315,6 +1327,7 @@
         ip_addr = {
             "eth0": {
                 "type": "ethernet.physical",
+                "index": random.randint(2, 99),
                 "mac": factory.make_mac_address(),
                 "flags": ["UP"],
                 "inet": [
@@ -1331,6 +1344,7 @@
         expected_result = MatchesDict({
             "eth0": MatchesDict({
                 "type": Equals("physical"),
+                "index": Equals(ip_addr["eth0"]["index"]),
                 "mac_address": Equals(ip_addr["eth0"]["mac"]),
                 "enabled": Is(True),
                 "parents": Equals([]),
@@ -1365,21 +1379,25 @@
         ip_addr = {
             "eth0": {
                 "type": "ethernet.physical",
+                "index": 2,
                 "mac": factory.make_mac_address(),
                 "flags": [],
             },
             "eth1": {
                 "type": "ethernet.physical",
+                "index": 3,
                 "mac": factory.make_mac_address(),
                 "flags": ["UP"],
             },
             "eth2": {
                 "type": "ethernet.physical",
+                "index": 4,
                 "mac": factory.make_mac_address(),
                 "flags": ["UP"],
             },
             "bond0": {
                 "type": "ethernet.bond",
+                "index": 5,
                 "mac": factory.make_mac_address(),
                 "flags": ["UP"],
                 "bonded_interfaces": ["eth1", "eth2"],
@@ -1388,6 +1406,7 @@
             },
             "bond0.10": {
                 "type": "ethernet.vlan",
+                "index": 6,
                 "flags": ["UP"],
                 "vid": 10,
                 "inet": ["192.168.123.2/24", "192.168.123.3/32"],
@@ -1395,6 +1414,7 @@
             },
             "vlan20": {
                 "type": "ethernet.vlan",
+                "index": 7,
                 "mac": factory.make_mac_address(),
                 "flags": ["UP"],
                 "vid": 20,
@@ -1402,11 +1422,13 @@
             },
             "wlan0": {
                 "type": "ethernet.wireless",
+                "index": 8,
                 "mac": factory.make_mac_address(),
                 "flags": ["UP"],
             },
             "br0": {
                 "type": "ethernet.bridge",
+                "index": 9,
                 "bridged_interfaces": ["eth0"],
                 "mac": factory.make_mac_address(),
                 "flags": ["UP"],
@@ -1424,6 +1446,7 @@
         expected_result = MatchesDict({
             "eth0": MatchesDict({
                 "type": Equals("physical"),
+                "index": Equals(2),
                 "mac_address": Equals(ip_addr["eth0"]["mac"]),
                 "enabled": Is(False),
                 "parents": Equals([]),
@@ -1432,6 +1455,7 @@
             }),
             "eth1": MatchesDict({
                 "type": Equals("physical"),
+                "index": Equals(3),
                 "mac_address": Equals(ip_addr["eth1"]["mac"]),
                 "enabled": Is(True),
                 "parents": Equals([]),
@@ -1440,6 +1464,7 @@
             }),
             "eth2": MatchesDict({
                 "type": Equals("physical"),
+                "index": Equals(4),
                 "mac_address": Equals(ip_addr["eth2"]["mac"]),
                 "enabled": Is(True),
                 "parents": Equals([]),
@@ -1448,6 +1473,7 @@
             }),
             "bond0": MatchesDict({
                 "type": Equals("bond"),
+                "index": Equals(5),
                 "mac_address": Equals(ip_addr["bond0"]["mac"]),
                 "enabled": Is(True),
                 "parents": Equals(["eth1", "eth2"]),
@@ -1471,6 +1497,7 @@
             }),
             "bond0.10": MatchesDict({
                 "type": Equals("vlan"),
+                "index": Equals(6),
                 "enabled": Is(True),
                 "parents": Equals(["bond0"]),
                 "vid": Equals(10),
@@ -1486,24 +1513,27 @@
                 ),
                 "source": Equals("ipaddr"),
             }),
+            "vlan20": MatchesDict({
+                "type": Equals("vlan"),
+                "index": Equals(7),
+                "enabled": Is(True),
+                "parents": Equals(["eth0"]),
+                "links": Equals([]),
+                "source": Equals("ipaddr"),
+                "vid": Equals(20),
+            }),
             "wlan0": MatchesDict({
                 "type": Equals("physical"),
+                "index": Equals(8),
                 "mac_address": Equals(ip_addr["wlan0"]["mac"]),
                 "enabled": Is(True),
                 "parents": Equals([]),
                 "links": Equals([]),
                 "source": Equals("ipaddr"),
             }),
-            "vlan20": MatchesDict({
-                "type": Equals("vlan"),
-                "enabled": Is(True),
-                "parents": Equals(["eth0"]),
-                "links": Equals([]),
-                "source": Equals("ipaddr"),
-                "vid": Equals(20),
-            }),
             "br0": MatchesDict({
                 "type": Equals("bridge"),
+                "index": Equals(9),
                 "mac_address": Equals(ip_addr["br0"]["mac"]),
                 "enabled": Is(True),
                 "parents": Equals(["eth0"]),