msgpack: support UUID extended type

Tarantool supports UUID type since version 2.4.1 [1]. This patch
introduced the support of Tarantool UUID type in msgpack decoders and
encoders. The Tarantool UUID type is mapped to the native Python
uuid.UUID type.

1. tarantool/tarantool#4268

Closed #202

Author: DifferentialOrange

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 - Decimal type support (#203).
+- UUID type support (#202).
 
 ### Changed
 - Bump msgpack requirement to 1.0.4 (PR #223).

tarantool/msgpack_ext/packer.py

@@ -1,9 +1,17 @@
 from decimal import Decimal
+from uuid import UUID
 from msgpack import ExtType
 
 import tarantool.msgpack_ext.decimal as ext_decimal
+import tarantool.msgpack_ext.uuid as ext_uuid
+
+encoders = [
+    {'type': Decimal, 'ext': ext_decimal},
+    {'type': UUID,    'ext': ext_uuid   },
+]
 
 def default(obj):
-    if isinstance(obj, Decimal):
-        return ExtType(ext_decimal.EXT_ID, ext_decimal.encode(obj))
+    for encoder in encoders:
+        if isinstance(obj, encoder['type']):
+            return ExtType(encoder['ext'].EXT_ID, encoder['ext'].encode(obj))
     raise TypeError("Unknown type: %r" % (obj,))

tarantool/msgpack_ext/unpacker.py

@@ -1,6 +1,12 @@
 import tarantool.msgpack_ext.decimal as ext_decimal
+import tarantool.msgpack_ext.uuid as ext_uuid
+
+decoders = {
+    ext_decimal.EXT_ID: ext_decimal.decode,
+    ext_uuid.EXT_ID   : ext_uuid.decode   ,
+}
 
 def ext_hook(code, data):
-    if code == ext_decimal.EXT_ID:
-        return ext_decimal.decode(data)
+    if code in decoders:
+        return decoders[code](data)
     raise NotImplementedError("Unknown msgpack type: %d" % (code,))

tarantool/msgpack_ext/uuid.py

@@ -0,0 +1,17 @@
+from uuid import UUID
+
+# https://www.tarantool.io/en/doc/latest/dev_guide/internals/msgpack_extensions/#the-uuid-type
+#
+# The UUID MessagePack representation looks like this:
+# +--------+------------+-----------------+
+# | MP_EXT | MP_UUID    | UuidValue       |
+# | = d8   | = 2        | = 16-byte value |
+# +--------+------------+-----------------+
+
+EXT_ID = 2
+
+def encode(obj):
+    return obj.bytes
+
+def decode(data):
+    return UUID(bytes=data)

test/suites/lib/skip.py

@@ -143,3 +143,14 @@ def skip_or_run_decimal_test(func):
 
     return skip_or_run_test_pcall_require(func, 'decimal',
                                       'does not support decimal type')
+
+def skip_or_run_UUID_test(func):
+    """Decorator to skip or run UUID-related tests depending on
+    the tarantool version.
+
+    Tarantool supports UUID type only since 2.4.1 version.
+    See https://github.com/tarantool/tarantool/issues/4268
+    """
+
+    return skip_or_run_test_tarantool(func, '2.4.1',
+                                      'does not support UUID type')

test/suites/test_msgpack_ext.py

@@ -4,6 +4,7 @@
 
 import sys
 import unittest
+import uuid
 import decimal
 import msgpack
 import warnings
@@ -13,7 +14,7 @@
 from tarantool.msgpack_ext.unpacker import ext_hook as unpacker_ext_hook
 
 from .lib.tarantool_server import TarantoolServer
-from .lib.skip import skip_or_run_decimal_test
+from .lib.skip import skip_or_run_decimal_test, skip_or_run_UUID_test
 from tarantool.error import MsgpackError, MsgpackWarning
 
 class TestSuite_MsgpackExt(unittest.TestCase):
@@ -28,6 +29,7 @@ def setUpClass(self):
         self.adm = self.srv.admin
         self.adm(r"""
             _, decimal = pcall(require, 'decimal')
+            _, uuid = pcall(require, 'uuid')
 
             box.schema.space.create('test')
             box.space['test']:create_index('primary', {
@@ -424,6 +426,85 @@ def test_decimal_tarantool_encode_with_precision_loss(self):
 
                 self.assertSequenceEqual(self.con.eval(lua_eval), [True])
 
+
+    UUID_cases = {
+        'uuid_1': {
+            'python': uuid.UUID('ae28d4f6-076c-49dd-8227-7f9fae9592d0'),
+            'msgpack': (b'\xae\x28\xd4\xf6\x07\x6c\x49\xdd\x82\x27\x7f\x9f\xae\x95\x92\xd0'),
+            'tarantool': "uuid.fromstr('ae28d4f6-076c-49dd-8227-7f9fae9592d0')",
+        },
+        'uuid_2': {
+            'python': uuid.UUID('b3121301-9300-4038-a652-ead943fb9c39'),
+            'msgpack': (b'\xb3\x12\x13\x01\x93\x00\x40\x38\xa6\x52\xea\xd9\x43\xfb\x9c\x39'),
+            'tarantool': "uuid.fromstr('b3121301-9300-4038-a652-ead943fb9c39')",
+        },
+        'uuid_3': {
+            'python': uuid.UUID('dfa69f02-92e6-44a5-abb5-84b39292ff93'),
+            'msgpack': (b'\xdf\xa6\x9f\x02\x92\xe6\x44\xa5\xab\xb5\x84\xb3\x92\x92\xff\x93'),
+            'tarantool': "uuid.fromstr('dfa69f02-92e6-44a5-abb5-84b39292ff93')",
+        },
+        'uuid_4': {
+            'python': uuid.UUID('8b69a1ce-094a-4e21-a5dc-4cdae7cd8960'),
+            'msgpack': (b'\x8b\x69\xa1\xce\x09\x4a\x4e\x21\xa5\xdc\x4c\xda\xe7\xcd\x89\x60'),
+            'tarantool': "uuid.fromstr('8b69a1ce-094a-4e21-a5dc-4cdae7cd8960')",
+        },
+        'uuid_5': {
+            'python': uuid.UUID('25932334-1d42-4686-9299-ec1a7165227c'),
+            'msgpack': (b'\x25\x93\x23\x34\x1d\x42\x46\x86\x92\x99\xec\x1a\x71\x65\x22\x7c'),
+            'tarantool': "uuid.fromstr('25932334-1d42-4686-9299-ec1a7165227c')",
+        },
+    }
+
+    def test_UUID_msgpack_decode(self):
+        for name in self.UUID_cases.keys():
+            with self.subTest(msg=name):
+                UUID_case = self.UUID_cases[name]
+
+                self.assertEqual(unpacker_ext_hook(2, UUID_case['msgpack']),
+                                 UUID_case['python'])
+
+    @skip_or_run_UUID_test
+    def test_UUID_tarantool_decode(self):
+        for name in self.UUID_cases.keys():
+            with self.subTest(msg=name):
+                UUID_case = self.UUID_cases[name]
+
+                self.adm(f"box.space['test']:replace{{'{name}', {UUID_case['tarantool']}}}")
+
+                self.assertSequenceEqual(self.con.select('test', name),
+                                         [[name, UUID_case['python']]])
+
+    def test_UUID_msgpack_encode(self):
+        for name in self.UUID_cases.keys():
+            with self.subTest(msg=name):
+                UUID_case = self.UUID_cases[name]
+
+                self.assertEqual(packer_default(UUID_case['python']),
+                                 msgpack.ExtType(code=2, data=UUID_case['msgpack']))
+
+    @skip_or_run_UUID_test
+    def test_UUID_tarantool_encode(self):
+        for name in self.UUID_cases.keys():
+            with self.subTest(msg=name):
+                UUID_case = self.UUID_cases[name]
+
+                self.con.insert('test', [name, UUID_case['python']])
+
+                lua_eval = f"""
+                    local tuple = box.space['test']:get('{name}')
+                    assert(tuple ~= nil)
+
+                    local id = {UUID_case['tarantool']}
+                    if tuple[2] == id then
+                        return true
+                    else
+                        return nil, ('%s is not equal to expected %s'):format(
+                            tostring(tuple[2]), tostring(id))
+                    end
+                """
+
+                self.assertSequenceEqual(self.con.eval(lua_eval), [True])
+
     @classmethod
     def tearDownClass(self):
         self.con.close()