Merge lp:~hopem/charm-helpers/lp1581598 into lp:charm-helpers

[Edward Hope-Morley]

[lp:~hopem/charm-helpers/lp1581598]

574. By Edward Hope-Morley on 2016-05-16

add more docstring

=== modified file 'charmhelpers/contrib/network/ip.py'
--- charmhelpers/contrib/network/ip.py	2016-03-21 16:33:03 +0000
+++ charmhelpers/contrib/network/ip.py	2016-05-16 10:01:19 +0000
@@ -214,7 +214,16 @@
 
 def get_iface_addr(iface='eth0', inet_type='AF_INET', inc_aliases=False,
                    fatal=True, exc_list=None):
-    """Return the assigned IP address for a given interface, if any."""
+    """Return the assigned IP address for a given interface, if any.
+
+    :param iface: network interface on which address(es) are expected to
+                  be found.
+    :param inet_type: inet address family
+    :param inc_aliases: include alias interfaces in search
+    :param fatal: if True, raise exception if address not found
+    :param exc_list: list of addresses to ignore
+    :return: list of ip addresses
+    """
     # Extract nic if passed /dev/ethX
     if '/' in iface:
         iface = iface.split('/')[-1]
@@ -315,6 +324,14 @@
     We currently only support scope global IPv6 addresses i.e. non-temporary
     addresses. If no global IPv6 address is found, return the first one found
     in the ipv6 address list.
+
+    :param iface: network interface on which ipv6 address(es) are expected to
+                  be found.
+    :param inc_aliases: include alias interfaces in search
+    :param fatal: if True, raise exception if address not found
+    :param exc_list: list of addresses to ignore
+    :param dynamic_only: only recognise dynamic addresses
+    :return: list of ipv6 addresses
     """
     addresses = get_iface_addr(iface=iface, inet_type='AF_INET6',
                                inc_aliases=inc_aliases, fatal=fatal,
@@ -336,7 +353,7 @@
             cmd = ['ip', 'addr', 'show', iface]
             out = subprocess.check_output(cmd).decode('UTF-8')
             if dynamic_only:
-                key = re.compile("inet6 (.+)/[0-9]+ scope global dynamic.*")
+                key = re.compile("inet6 (.+)/[0-9]+ scope global.* dynamic.*")
             else:
                 key = re.compile("inet6 (.+)/[0-9]+ scope global.*")
 

=== modified file 'tests/contrib/network/test_ip.py'
--- tests/contrib/network/test_ip.py	2016-01-27 12:47:55 +0000
+++ tests/contrib/network/test_ip.py	2016-05-16 10:01:19 +0000
@@ -81,6 +81,19 @@
        valid_lft forever preferred_lft forever
 """
 
+IP2_OUTPUT = b"""link/ether fa:16:3e:2a:cc:ce brd ff:ff:ff:ff:ff:ff
+    inet 10.5.16.93/16 brd 10.5.255.255 scope global eth0
+       valid_lft forever preferred_lft forever
+    inet6 2001:db8:1:0:d0cf:528c:23eb:6000/64 scope global
+       valid_lft forever preferred_lft forever
+    inet6 2001:db8:1:0:2918:3444:852:5b8a/64 scope global temporary dynamic
+       valid_lft 86400sec preferred_lft 14400sec
+    inet6 2001:db8:1:0:f816:3eff:fe2a:ccce/64 scope global mngtmpaddr dynamic
+       valid_lft 86400sec preferred_lft 14400sec
+    inet6 fe80::f816:3eff:fe2a:ccce/64 scope link
+       valid_lft forever preferred_lft forever
+"""
+
 IP_OUTPUT_NO_VALID = b"""link/ether fa:16:3e:2a:cc:ce brd ff:ff:ff:ff:ff:ff
     inet 10.5.16.93/16 brd 10.5.255.255 scope global eth0
        valid_lft forever preferred_lft forever
@@ -508,6 +521,22 @@
                                             'fe80::f816:3eff:fe2a:ccce%eth0']
         self.assertEqual([scope_global_dyn_addr], net_ip.get_ipv6_addr())
 
+    @patch('charmhelpers.contrib.network.ip.get_iface_from_addr')
+    @patch('charmhelpers.contrib.network.ip.subprocess.check_output')
+    @patch('charmhelpers.contrib.network.ip.get_iface_addr')
+    def test_get_ipv6_global_dynamic_address_ip2(self, mock_get_iface_addr,
+                                                 mock_check_out,
+                                                 mock_get_iface_from_addr):
+        mock_get_iface_from_addr.return_value = 'eth0'
+        mock_check_out.return_value = IP2_OUTPUT
+        scope_global_addr = '2001:db8:1:0:d0cf:528c:23eb:6000'
+        scope_global_dyn_addr = '2001:db8:1:0:f816:3eff:fe2a:ccce'
+        mock_get_iface_addr.return_value = [scope_global_addr,
+                                            scope_global_dyn_addr,
+                                            '2001:db8:1:0:2918:3444:852:5b8a',
+                                            'fe80::f816:3eff:fe2a:ccce%eth0']
+        self.assertEqual([scope_global_dyn_addr], net_ip.get_ipv6_addr())
+
     @patch('charmhelpers.contrib.network.ip.subprocess.check_output')
     @patch('charmhelpers.contrib.network.ip.get_iface_addr')
     def test_get_ipv6_global_dynamic_address_invalid_address(self,