Changes in / [d85a75d:b088380] in trunk

Location:

src/allmydata

Files:

• test/test_iputil.py (modified) (2 diffs)
• util/iputil.py (modified) (8 diffs)

src/allmydata/test/test_iputil.py

@@ -1 +1 @@
 
-import re
+import re, errno, subprocess, os
+
 from twisted.trial import unittest
+
 from allmydata.util import iputil
 import allmydata.test.common_util as testutil
 
+
+class Namespace:
+    pass
+
 DOTTED_QUAD_RE=re.compile("^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$")
+
+MOCK_IPADDR_OUTPUT = """\
+1: lo: <LOOPBACK,UP,LOWER_UP> mtu 16436 qdisc noqueue state UNKNOWN \n\
+    link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
+    inet 127.0.0.1/8 scope host lo
+    inet6 ::1/128 scope host \n\
+       valid_lft forever preferred_lft forever
+2: eth1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP qlen 1000
+    link/ether d4:3d:7e:01:b4:3e brd ff:ff:ff:ff:ff:ff
+    inet 192.168.0.6/24 brd 192.168.0.255 scope global eth1
+    inet6 fe80::d63d:7eff:fe01:b43e/64 scope link \n\
+       valid_lft forever preferred_lft forever
+3: wlan0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq state UP qlen 1000
+    link/ether 90:f6:52:27:15:0a brd ff:ff:ff:ff:ff:ff
+    inet 192.168.0.2/24 brd 192.168.0.255 scope global wlan0
+    inet6 fe80::92f6:52ff:fe27:150a/64 scope link \n\
+       valid_lft forever preferred_lft forever
+"""
+
+MOCK_IFCONFIG_OUTPUT = """\
+eth1      Link encap:Ethernet  HWaddr d4:3d:7e:01:b4:3e  \n\
+          inet addr:192.168.0.6  Bcast:192.168.0.255  Mask:255.255.255.0
+          inet6 addr: fe80::d63d:7eff:fe01:b43e/64 Scope:Link
+          UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
+          RX packets:154242234 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:155461891 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:1000 \n\
+          RX bytes:84367213640 (78.5 GiB)  TX bytes:73401695329 (68.3 GiB)
+          Interrupt:20 Memory:f4f00000-f4f20000 \n\
+
+lo        Link encap:Local Loopback  \n\
+          inet addr:127.0.0.1  Mask:255.0.0.0
+          inet6 addr: ::1/128 Scope:Host
+          UP LOOPBACK RUNNING  MTU:16436  Metric:1
+          RX packets:27449267 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:27449267 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0 \n\
+          RX bytes:192643017823 (179.4 GiB)  TX bytes:192643017823 (179.4 GiB)
+
+wlan0     Link encap:Ethernet  HWaddr 90:f6:52:27:15:0a  \n\
+          inet addr:192.168.0.2  Bcast:192.168.0.255  Mask:255.255.255.0
+          inet6 addr: fe80::92f6:52ff:fe27:150a/64 Scope:Link
+          UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
+          RX packets:12352750 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:4501451 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:1000 \n\
+          RX bytes:3916475942 (3.6 GiB)  TX bytes:458353654 (437.1 MiB)
+"""
+
+# This is actually from a VirtualBox VM running XP.
+MOCK_ROUTE_OUTPUT = """\
+===========================================================================
+Interface List
+0x1 ........................... MS TCP Loopback interface
+0x2 ...08 00 27 c3 80 ad ...... AMD PCNET Family PCI Ethernet Adapter - Packet Scheduler Miniport
+===========================================================================
+===========================================================================
+Active Routes:
+Network Destination        Netmask          Gateway       Interface  Metric
+          0.0.0.0          0.0.0.0         10.0.2.2       10.0.2.15       20
+         10.0.2.0    255.255.255.0        10.0.2.15       10.0.2.15       20
+        10.0.2.15  255.255.255.255        127.0.0.1       127.0.0.1       20
+   10.255.255.255  255.255.255.255        10.0.2.15       10.0.2.15       20
+        127.0.0.0        255.0.0.0        127.0.0.1       127.0.0.1       1
+        224.0.0.0        240.0.0.0        10.0.2.15       10.0.2.15       20
+  255.255.255.255  255.255.255.255        10.0.2.15       10.0.2.15       1
+Default Gateway:          10.0.2.2
+===========================================================================
+Persistent Routes:
+  None
+"""
+
+UNIX_TEST_ADDRESSES = set(["127.0.0.1", "192.168.0.6", "192.168.0.2", "192.168.0.10"])
+WINDOWS_TEST_ADDRESSES = set(["127.0.0.1", "10.0.2.15", "192.168.0.10"])
+CYGWIN_TEST_ADDRESSES = set(["127.0.0.1", "192.168.0.10"])
+
+
+class FakeProcess:
+    def __init__(self, output, err):
+        self.output = output
+        self.err = err
+    def communicate(self):
+        return (self.output, self.err)
+
 
 class ListAddresses(testutil.SignalMixin, unittest.TestCase):
@@ -15 +105 @@
         d = iputil.get_local_addresses_async()
         def _check(addresses):
-            self.failUnless(len(addresses) >= 1) # always have localhost
-            self.failUnless("127.0.0.1" in addresses, addresses)
-            self.failIf("0.0.0.0" in addresses, addresses)
+            self.failUnlessIn("127.0.0.1", addresses)
+            self.failIfIn("0.0.0.0", addresses)
         d.addCallbacks(_check)
         return d
     # David A.'s OpenSolaris box timed out on this test one time when it was at 2s.
     test_list_async.timeout=4
+
+    def _test_list_async_mock(self, command, output, expected):
+        ns = Namespace()
+        ns.first = True
+
+        def call_Popen(args, bufsize=0, executable=None, stdin=None, stdout=None, stderr=None,
+                       preexec_fn=None, close_fds=False, shell=False, cwd=None, env=None,
+                       universal_newlines=False, startupinfo=None, creationflags=0):
+            if ns.first:
+                ns.first = False
+                e = OSError("EINTR")
+                e.errno = errno.EINTR
+                raise e
+            elif os.path.basename(args[0]) == command:
+                return FakeProcess(output, "")
+            else:
+                e = OSError("[Errno 2] No such file or directory")
+                e.errno = errno.ENOENT
+                raise e
+        self.patch(subprocess, 'Popen', call_Popen)
+
+        def call_get_local_ip_for(target):
+            if target in ("localhost", "127.0.0.1"):
+                return "127.0.0.1"
+            else:
+                return "192.168.0.10"
+        self.patch(iputil, 'get_local_ip_for', call_get_local_ip_for)
+
+        def call_which(name):
+            return [name]
+        self.patch(iputil, 'which', call_which)
+
+        d = iputil.get_local_addresses_async()
+        def _check(addresses):
+            self.failUnlessEquals(set(addresses), set(expected))
+        d.addCallbacks(_check)
+        return d
+
+    def test_list_async_mock_ip_addr(self):
+        self.patch(iputil, 'platform', "linux2")
+        return self._test_list_async_mock("ip", MOCK_IPADDR_OUTPUT, UNIX_TEST_ADDRESSES)
+
+    def test_list_async_mock_ifconfig(self):
+        self.patch(iputil, 'platform', "linux2")
+        return self._test_list_async_mock("ifconfig", MOCK_IFCONFIG_OUTPUT, UNIX_TEST_ADDRESSES)
+
+    def test_list_async_mock_route(self):
+        self.patch(iputil, 'platform', "win32")
+        return self._test_list_async_mock("route.exe", MOCK_ROUTE_OUTPUT, WINDOWS_TEST_ADDRESSES)
+
+    def test_list_async_mock_cygwin(self):
+        self.patch(iputil, 'platform', "cygwin")
+        return self._test_list_async_mock(None, None, CYGWIN_TEST_ADDRESSES)

src/allmydata/util/iputil.py

@@ -1 +1 @@
 # from the Python Standard Library
-import os, re, socket, sys, subprocess
+import os, re, socket, subprocess, errno
+
+from sys import platform
 
 # from Twisted
@@ -82 +84 @@
     addresses = []
     local_ip = get_local_ip_for(target)
-    if local_ip:
+    if local_ip is not None:
         addresses.append(local_ip)
 
-    if sys.platform == "cygwin":
-        d = _cygwin_hack_find_addresses(target)
+    if platform == "cygwin":
+        d = _cygwin_hack_find_addresses()
     else:
         d = _find_addresses_via_config()
@@ -132 +134 @@
         # no route to that host
         localip = None
-    port.stopListening() # note, this returns a Deferred
+    d = port.stopListening()
+    d.addErrback(log.err)
     return localip
 
-# k: result of sys.platform, v: which kind of IP configuration reader we use
-_platform_map = {
-    "linux-i386": "linux", # redhat
-    "linux-ppc": "linux",  # redhat
-    "linux2": "linux",     # debian
-    "linux3": "linux",     # debian
-    "win32": "win32",
-    "irix6-n32": "irix",
-    "irix6-n64": "irix",
-    "irix6": "irix",
-    "openbsd2": "bsd",
-    "openbsd3": "bsd",
-    "openbsd4": "bsd",
-    "openbsd5": "bsd",
-    "darwin": "bsd",       # Mac OS X
-    "freebsd4": "bsd",
-    "freebsd5": "bsd",
-    "freebsd6": "bsd",
-    "freebsd7": "bsd",
-    "freebsd8": "bsd",
-    "freebsd9": "bsd",
-    "netbsd1": "bsd",
-    "netbsd2": "bsd",
-    "netbsd3": "bsd",
-    "netbsd4": "bsd",
-    "netbsd5": "bsd",
-    "netbsd6": "bsd",
-    "sunos5": "sunos",
-    "cygwin": "cygwin",
-    }
-
-class UnsupportedPlatformError(Exception):
-    pass
 
 # Wow, I'm really amazed at home much mileage we've gotten out of calling
@@ -173 +143 @@
 # versions so far.  Still, the real system calls would much be preferred...
 # ... thus wrote Greg Smith in time immemorial...
-_win32_path = 'route.exe'
-_win32_args = ('print',)
-_win32_re = re.compile('^\s*\d+\.\d+\.\d+\.\d+\s.+\s(?P<address>\d+\.\d+\.\d+\.\d+)\s+(?P<metric>\d+)\s*$', flags=re.M|re.I|re.S)
-
-# These work in Redhat 6.x and Debian 2.2 potato
-_linux_path = '/sbin/ifconfig'
-_linux_re = re.compile('^\s*inet [a-zA-Z]*:?(?P<address>\d+\.\d+\.\d+\.\d+)\s.+$', flags=re.M|re.I|re.S)
-
-# NetBSD 1.4 (submitted by Rhialto), Darwin, Mac OS X
-_netbsd_path = '/sbin/ifconfig'
-_netbsd_args = ('-a',)
-_netbsd_re = re.compile('^\s+inet [a-zA-Z]*:?(?P<address>\d+\.\d+\.\d+\.\d+)\s.+$', flags=re.M|re.I|re.S)
-
-# Irix 6.5
-_irix_path = '/usr/etc/ifconfig'
-
-# Solaris 2.x
-_sunos_path = '/usr/sbin/ifconfig'
-
-
-# k: platform string as provided in the value of _platform_map
-# v: tuple of (path_to_tool, args, regex,)
-_tool_map = {
-    "linux": (_linux_path, (), _linux_re,),
-    "win32": (_win32_path, _win32_args, _win32_re,),
-    "cygwin": (_win32_path, _win32_args, _win32_re,),
-    "bsd": (_netbsd_path, _netbsd_args, _netbsd_re,),
-    "irix": (_irix_path, _netbsd_args, _netbsd_re,),
-    "sunos": (_sunos_path, _netbsd_args, _netbsd_re,),
-    }
+_win32_re = re.compile(r'^\s*\d+\.\d+\.\d+\.\d+\s.+\s(?P<address>\d+\.\d+\.\d+\.\d+)\s+(?P<metric>\d+)\s*$', flags=re.M|re.I|re.S)
+_win32_commands = (('route.exe', ('print',), _win32_re),)
+
+# These work in most Unices.
+_addr_re = re.compile(r'^\s*inet [a-zA-Z]*:?(?P<address>\d+\.\d+\.\d+\.\d+)[\s/].+$', flags=re.M|re.I|re.S)
+_unix_commands = (('/bin/ip', ('addr',), _addr_re),
+                  ('/sbin/ifconfig', ('-a',), _addr_re),
+                  ('/usr/sbin/ifconfig', ('-a',), _addr_re),
+                  ('/usr/etc/ifconfig', ('-a',), _addr_re),
+                  ('ifconfig', ('-a',), _addr_re),
+                  ('/sbin/ifconfig', (), _addr_re),
+                 )
+
 
 def _find_addresses_via_config():
@@ -208 +161 @@
 
 def _synchronously_find_addresses_via_config():
-    # originally by Greg Smith, hacked by Zooko to conform to Brian's API
-
-    platform = _platform_map.get(sys.platform)
-    if not platform:
-        raise UnsupportedPlatformError(sys.platform)
-
-    (pathtotool, args, regex,) = _tool_map[platform]
-
-    # If pathtotool is a fully qualified path then we just try that.
-    # If it is merely an executable name then we use Twisted's
-    # "which()" utility and try each executable in turn until one
-    # gives us something that resembles a dotted-quad IPv4 address.
-
-    if os.path.isabs(pathtotool):
-        return _query(pathtotool, args, regex)
+    # originally by Greg Smith, hacked by Zooko and then Daira
+
+    # We don't reach here for cygwin.
+    if platform == 'win32':
+        commands = _win32_commands
     else:
-        exes_to_try = which(pathtotool)
+        commands = _unix_commands
+
+    for (pathtotool, args, regex) in commands:
+        # If pathtotool is a fully qualified path then we just try that.
+        # If it is merely an executable name then we use Twisted's
+        # "which()" utility and try each executable in turn until one
+        # gives us something that resembles a dotted-quad IPv4 address.
+
+        if os.path.isabs(pathtotool):
+            exes_to_try = [pathtotool]
+        else:
+            exes_to_try = which(pathtotool)
+
         for exe in exes_to_try:
             try:
@@ -232 +187 @@
             if addresses:
                 return addresses
-        return []
+
+    return []
 
 def _query(path, args, regex):
     env = {'LANG': 'en_US.UTF-8'}
-    p = subprocess.Popen([path] + list(args), stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env)
-    (output, err) = p.communicate()
+    TRIES = 5
+    for trial in xrange(TRIES):
+        try:
+            p = subprocess.Popen([path] + list(args), stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env)
+            (output, err) = p.communicate()
+            break
+        except OSError, e:
+            if e.errno == errno.EINTR and trial < TRIES-1:
+                continue
+            raise
 
     addresses = []
@@ -244 +208 @@
         m = regex.match(outline)
         if m:
-            addr = m.groupdict()['address']
+            addr = m.group('address')
             if addr not in addresses:
                 addresses.append(addr)
@@ -250 +214 @@
     return addresses
 
-def _cygwin_hack_find_addresses(target):
+def _cygwin_hack_find_addresses():
     addresses = []
-    for h in [target, "localhost", "127.0.0.1",]:
-        try:
-            addr = get_local_ip_for(h)
-            if addr not in addresses:
-                addresses.append(addr)
-        except socket.gaierror:
-            pass
+    for h in ["localhost", "127.0.0.1",]:
+        addr = get_local_ip_for(h)
+        if addr is not None and addr not in addresses:
+            addresses.append(addr)
 
     return defer.succeed(addresses)