Merge pull request #43 from mhchia/fix/ip6zone

Add codec for ip6zone, and tests

Author: mhchia

multiaddr/codecs/utf8.py

@@ -0,0 +1,19 @@
+from __future__ import absolute_import
+
+from . import LENGTH_PREFIXED_VAR_SIZE
+
+
+SIZE = LENGTH_PREFIXED_VAR_SIZE
+IS_PATH = False
+
+
+def to_bytes(proto, string):
+    if len(string) == 0:
+        raise ValueError("{0} value must not be empty".format(proto.name))
+    return string.encode('utf-8')
+
+
+def to_string(proto, buf):
+    if len(buf) == 0:
+        raise ValueError("invalid length (should be > 0)")
+    return buf.decode('utf-8')

multiaddr/protocols.py

@@ -124,7 +124,7 @@ def __repr__(self):
     Protocol(P_UDP, 'udp', 'uint16be'),
     Protocol(P_DCCP, 'dccp', 'uint16be'),
     Protocol(P_IP6, 'ip6', 'ip6'),
-    Protocol(P_IP6ZONE, 'ip6zone', '?'),
+    Protocol(P_IP6ZONE, 'ip6zone', 'utf8'),
     Protocol(P_DNS, 'dns', 'idna'),
     Protocol(P_DNS4, 'dns4', 'idna'),
     Protocol(P_DNS6, 'dns6', 'idna'),

tests/test_multiaddr.py

@@ -29,6 +29,9 @@
      "/ip4/::1",
      "/ip4/fdpsofodsajfdoisa",
      "/ip6",
+     "/ip6zone",
+     "/ip6zone/",
+     "/ip6zone//ip6/fe80::1",
      "/udp",
      "/tcp",
      "/sctp",
@@ -67,6 +70,9 @@ def test_invalid(addr_str):
      "/ip4/0.0.0.0",
      "/ip6/::1",
      "/ip6/2601:9:4f81:9700:803e:ca65:66e8:c21",
+     "/ip6zone/x/ip6/fe80::1",
+     "/ip6zone/x%y/ip6/fe80::1",
+     "/ip6zone/x%y/ip6/::",
      "/onion/timaq4ygg2iegci7:1234",
      "/onion/timaq4ygg2iegci7:80/http",
      "/udp/0",
@@ -330,3 +336,14 @@ def test_decapsulate():
 def test__repr():
     a = Multiaddr("/ip4/127.0.0.1/udp/1234")
     assert(repr(a) == "<Multiaddr %s>" % str(a))
+
+
+def test_zone():
+    ip6_string = "/ip6zone/eth0/ip6/::1"
+    ip6_bytes = b"\x2a\x04eth0\x29\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01"
+
+    maddr_from_str = Multiaddr(ip6_string)
+    assert maddr_from_str.to_bytes() == ip6_bytes
+
+    maddr_from_bytes = Multiaddr(ip6_bytes)
+    assert str(maddr_from_bytes) == ip6_string

tests/test_transforms.py

@@ -20,7 +20,7 @@
 
 # These test values were generated by running them
 # through the go implementation of multiaddr.
-# https://github.com/jbenet/multiaddr
+# https://github.com/multiformats/go-multiaddr
 ADDR_BYTES_MAP_STR_TEST_DATA = [
     (_names_to_protocols['ip4'], b'\x0a\x0b\x0c\x0d', '10.11.12.13'),
     (_names_to_protocols['ip6'],
@@ -148,6 +148,7 @@ def test_bytes_to_string_value_error(protocol_extension, bytes):
     (_names_to_protocols['onion'], 'timaq4ygg2iegci7:0'),
     (_names_to_protocols['onion'], 'timaq4ygg2iegci7:71234'),
     (_names_to_protocols['p2p'], '15230d52ebb89d85b02a284948203a'),
+    (_names_to_protocols['ip6zone'], ""),
 ])
 def test_codec_to_bytes_value_error(proto, address):
     # Codecs themselves may raise any exception type – it will then be converted
@@ -157,7 +158,8 @@ def test_codec_to_bytes_value_error(proto, address):
 
 
 @pytest.mark.parametrize("proto, buf", [
-    (_names_to_protocols['tcp'], b'\xff\xff\xff\xff')
+    (_names_to_protocols['tcp'], b'\xff\xff\xff\xff'),
+    (_names_to_protocols['ip6zone'], b""),
 ])
 def test_codec_to_string_value_error(proto, buf):
     # Codecs themselves may raise any exception type – it will then be converted