From 7e47a3e43692930b07c90b05a777e66333916bf3 Mon Sep 17 00:00:00 2001
From: Dazhao <dzyu@cn.ibm.com>
Date: Wed, 13 Nov 2013 18:24:32 +0800
Subject: [PATCH] Calculate stateless IPv6 address

In order to support stateless IPv6, neutron should calculate IPv6 address base
on IPv6 prefix and MAC address via EUI-64 specification.  This change adds
common library to calculate IPv6 address.

Partially-implements bp ipv6-two-attributes
Co-Authored-By: Xu Han Peng <xuhanp@cn.ibm.com>

Change-Id: I68ccbc42388ec760d6fead242e080822ca753913
---
 neutron/common/ipv6_utils.py    | 39 +++++++++++++++++++++++++
 neutron/tests/unit/test_ipv6.py | 50 +++++++++++++++++++++++++++++++++
 2 files changed, 89 insertions(+)
 create mode 100644 neutron/common/ipv6_utils.py
 create mode 100644 neutron/tests/unit/test_ipv6.py

diff --git a/neutron/common/ipv6_utils.py b/neutron/common/ipv6_utils.py
new file mode 100644
index 00000000000..6e57bfcfe63
--- /dev/null
+++ b/neutron/common/ipv6_utils.py
@@ -0,0 +1,39 @@
+# Copyright 2013 IBM Corp.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+"""
+IPv6-related utilities and helper functions.
+"""
+
+import netaddr
+
+
+def get_ipv6_addr_by_EUI64(prefix, mac):
+    # Check if the prefix is IPv4 address
+    isIPv4 = netaddr.valid_ipv4(prefix)
+    if isIPv4:
+        msg = _("Unable to generate IP address by EUI64 for IPv4 prefix")
+        raise TypeError(msg)
+    try:
+        eui64 = int(netaddr.EUI(mac).eui64())
+        prefix = netaddr.IPNetwork(prefix)
+        return netaddr.IPAddress(prefix.first + eui64 ^ (1 << 57))
+    except netaddr.AddrFormatError:
+        raise TypeError(_('Bad prefix or mac format for generating IPv6 '
+                          'address by EUI-64: %(prefix)s, %(mac)s:')
+                        % {'prefix': prefix, 'mac': mac})
+    except TypeError:
+        raise TypeError(_('Bad prefix type for generate IPv6 address by '
+                          'EUI-64: %s') % prefix)
diff --git a/neutron/tests/unit/test_ipv6.py b/neutron/tests/unit/test_ipv6.py
new file mode 100644
index 00000000000..47bfd2a4b03
--- /dev/null
+++ b/neutron/tests/unit/test_ipv6.py
@@ -0,0 +1,50 @@
+# Copyright 2013 IBM Corp.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+from neutron.common import ipv6_utils
+from neutron.tests import base
+
+
+class IPv6byEUI64TestCase(base.BaseTestCase):
+    """Unit tests for generate IPv6 by EUI-64 operations."""
+
+    def test_generate_IPv6_by_EUI64(self):
+        addr = ipv6_utils.get_ipv6_addr_by_EUI64('2001:db8::',
+                                                 '00:16:3e:33:44:55')
+        self.assertEqual('2001:db8::216:3eff:fe33:4455', addr.format())
+
+    def test_generate_IPv6_with_IPv4_prefix(self):
+        ipv4_prefix = '10.0.8'
+        mac = '00:16:3e:33:44:55'
+        self.assertRaises(TypeError, lambda:
+                          ipv6_utils.get_ipv6_addr_by_EUI64(ipv4_prefix, mac))
+
+    def test_generate_IPv6_with_bad_mac(self):
+        bad_mac = '00:16:3e:33:44:5Z'
+        prefix = '2001:db8::'
+        self.assertRaises(TypeError, lambda:
+                          ipv6_utils.get_ipv6_addr_by_EUI64(prefix, bad_mac))
+
+    def test_generate_IPv6_with_bad_prefix(self):
+        mac = '00:16:3e:33:44:55'
+        bad_prefix = 'bb'
+        self.assertRaises(TypeError, lambda:
+                          ipv6_utils.get_ipv6_addr_by_EUI64(bad_prefix, mac))
+
+    def test_generate_IPv6_with_error_prefix_type(self):
+        mac = '00:16:3e:33:44:55'
+        prefix = 123
+        self.assertRaises(TypeError, lambda:
+                          ipv6_utils.get_ipv6_addr_by_EUI64(prefix, mac))