Support binding to IPv6 addresses in TCP sockets

Closes-Bug: 1566036

Change-Id: I0a37b47fba256bc55c8e8e55bafe7e03984dd6cf

designate/tests/test_utils.py

@@ -13,8 +13,10 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
+
 import os
 import tempfile
+import unittest
 
 import testtools
 from jinja2 import Template
@@ -128,3 +130,13 @@ class TestUtils(TestCase):
     def test_get_paging_params_invalid_sort_key(self):
         with testtools.ExpectedException(exceptions.InvalidSortKey):
             utils.get_paging_params({'sort_key': "dsc"}, ['asc', 'desc'])
+
+
+class SocketListenTest(unittest.TestCase):
+
+    def test_listen_tcp(self):
+        # Test listening on TCP on IPv4 and IPv6 addrs
+        # bug 1566036
+        for addr in ('', '0.0.0.0', '127.0.0.1', '::', '::1'):
+            s = utils.bind_tcp(addr, 0, 1)
+            s.close()

designate/utils.py

@@ -28,6 +28,7 @@ from oslo_config import cfg
 from oslo_concurrency import processutils
 from oslo_log import log as logging
 from oslo_utils import timeutils
+from oslo_utils.netutils import is_valid_ipv6
 
 from designate.common import config
 from designate import exceptions
@@ -461,10 +462,23 @@ def get_paging_params(params, sort_keys):
 
 
 def bind_tcp(host, port, tcp_backlog, tcp_keepidle=None):
-    # Bind to the TCP port
+    """Bind to a TCP port and listen.
+    Use reuseaddr, reuseport if available, keepalive if specified
+
+    :param host: IPv4/v6 address or "". "" binds to every IPv4 interface.
+    :type host: str
+    :param port: TCP port
+    :type port: int
+    :param tcp_backlog: TCP listen backlog
+    :type tcp_backlog: int
+    :param tcp_keepidle: TCP keepalive interval
+    :type tcp_keepidle: int
+    :returns: socket
+    """
     LOG.info(_LI('Opening TCP Listening Socket on %(host)s:%(port)d'),
              {'host': host, 'port': port})
-    sock_tcp = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    family = socket.AF_INET6 if is_valid_ipv6(host) else socket.AF_INET
+    sock_tcp = socket.socket(family, socket.SOCK_STREAM)
     sock_tcp.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
     sock_tcp.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
 
@@ -472,7 +486,7 @@ def bind_tcp(host, port, tcp_backlog, tcp_keepidle=None):
     try:
         sock_tcp.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
     except Exception:
-        pass
+        LOG.info(_LI('SO_REUSEPORT not available, ignoring.'))
 
     # This option isn't available in the OS X version of eventlet
     if tcp_keepidle and hasattr(socket, 'TCP_KEEPIDLE'):