feat: initial unit tests for dispatch module

Signed-off-by: Christopher Arndt <chris@chrisarndt.de>

Author: SpotlightKid

run_tests.sh

@@ -3,3 +3,4 @@
 export MICROPYPATH="$(pwd):${MICROPYPATH:-.frozen:$HOME/.micropython/lib:/usr/lib/micropython}"
 micropython tests/test_client.py "$@" && \
 micropython tests/test_server.py "$@"
+micropython tests/test_dispatch.py "$@"

tests/test_dispatch.py

@@ -0,0 +1,53 @@
+"""Unit tests for the uosc.dispatch module."""
+
+import unittest
+
+from uosc.dispatch import get_global_root, OSCAddressContainer, OSCMethod, TYPETAGS_ANY
+
+
+class TestCreateMessage(unittest.TestCase):
+    def setUp(self):
+        def _dummy(*args, **kw):
+            pass
+
+        self.root = root = get_global_root()
+        root.register_method(_dummy, "/ops/math/add", "ii")
+        root.register_method(_dummy, "/ops/math/sum", TYPETAGS_ANY)
+        root.register_method(_dummy, "/ops/string/add", "ii")
+        root.register_method(_dummy, "/ops/array/add", "ii")
+        root.register_method(_dummy, "/ops/math/sub", "ii")
+
+    def tearDown(self):
+        self.root.clear()
+
+    def test_get_global_root(self):
+        root = get_global_root()
+        self.assertTrue(root is self.root)
+
+    def test_osc_address_space(self):
+        self.assertTrue(isinstance(self.root, OSCAddressContainer))
+        self.assertEqual(self.root.name, "/")
+
+    def test_match_address(self):
+        results = self.root.match("/ops/math/add")
+        self.assertTrue(isinstance(results, list))
+        self.assertEqual(len(results), 1)
+        self.assertTrue(isinstance(results[0], OSCMethod))
+        self.assertEqual(results[0].name, "/ops/math/add")
+        self.assertTrue(callable(results[0]))
+
+    def test_match_address_with_typetags(self):
+        results = self.root.match("/ops/math/add", "ii")
+        self.assertTrue(isinstance(results, list))
+        self.assertEqual(len(results), 1)
+        self.assertTrue(isinstance(results[0], OSCMethod))
+        self.assertEqual(results[0].name, "/ops/math/add")
+        self.assertTrue(callable(results[0]))
+        self.assertEqual(results[0].typetags, "ii")
+        results = self.root.match("/ops/math/add", "f")
+        self.assertTrue(isinstance(results, list))
+        self.assertEqual(len(results), 0)
+
+
+if __name__ == '__main__':
+    unittest.main()

uosc/dispatch.py

@@ -5,9 +5,9 @@
 * OSC Address Spaces and OSC Addresses
 * OSC Message Dispatching and Pattern Matching
 
-See the ``_demo()`` function below for a usage example.
+See the unit tests in ``tests/ttest_dispatch.py`` for API usage examples.
 
-**Note:** Path-traversing wildcards (``//``) as specified by the OSC 1.1
+**Note:** Path-traversing wildcards (``//``) as envisioned by the OSC 1.1
 "specification" paper are **not** supported.
 
 """
@@ -46,6 +46,11 @@ def expand_curly_braces(s, offset=0):
 
 
 class OSCAddressContainer(dict):
+    """
+    Branch node in the OSC Address Space tree containing OSC Methods or
+    sub-branches.
+
+    """
     def __init__(self, name, parent=None):
         super().__init__()
         self.name = name
@@ -139,6 +144,13 @@ def _check_branch(node, ptn, nodetype, brace_expansion=True):
 
 
 class OSCMethod:
+    """
+    A leaf node in the OSC Address Space tree wrapping the callable for an OSC
+    Method.
+
+    """
+    __slots__ = ("name", "callable_", "typetags", "parent")
+
     def __init__(self, name, callable_, typetags=TYPETAGS_ANY, parent=None):
         self.name = name
         self.callable_ = callable_
@@ -155,28 +167,25 @@ def __repr__(self):
 _root = None
 
 
-def get_default_root():
-    global _root
-    if _root is None:
-        _root = OSCAddressContainer("/")
-    return _root
+def get_global_root():
+    """Return global OSC Address Space root OSCAdressContainer node instance.
 
+    The root node is created on demand, when this function is first called and
+    the tree will initially be unpopulated, i.e. have no branches or leaves.
 
-def _demo():
-    def fn(*args):
-        pass
+    The global root node, as the name says, is a module global, so changes to
+    the tree it is the root of, will be visible via all references to it
+    retrieved via this function in the same program.
 
-    import sys
+    To create a non-global OSC Adress Space tree, just create a new
+    ``OSCAddressContainer`` instance like so:
 
-    root = get_default_root()
-    root.register_method(fn, "/ops/math/add", "ii")
-    root.register_method(fn, "/ops/math/sum", TYPETAGS_ANY)
-    root.register_method(fn, "/ops/string/add", "ii")
-    root.register_method(fn, "/ops/array/add", "ii")
-    root.register_method(fn, "/ops/math/sub", "ii")
+        myroot = OSCAddressContainer(name="/")
 
-    print(root.match(*sys.argv[1:]))
+    """
+    global _root
 
+    if _root is None:
+        _root = OSCAddressContainer("/")
 
-if __name__ == "__main__":
-    _demo()
+    return _root