Update test_api_helpers.py for new processor functions

tests/test_api_helpers.py

@@ -7,7 +7,6 @@
 from lib.api import *
 from lib.uinput_stub import UInputStub
 
-from keyszer import input
 from keyszer.config_api import *
 from keyszer.lib import logger
 from keyszer.models.action import Action
@@ -30,6 +29,20 @@
 
 _out = None
 
+
+class Context_with_CapsL_OFF:
+    def __init__(self):
+        self.capslock_on = False
+
+ctx = Context_with_CapsL_OFF()
+
+class Context_with_CapsL_ON:
+    def __init__(self):
+        self.capslock_on = True
+
+ctx_ON = Context_with_CapsL_ON()
+
+
 def setup_function(module):
     global _out
     loop = asyncio.new_event_loop()
@@ -39,88 +52,133 @@ def setup_function(module):
     reset_transform()
     reset_configuration()
 
-
 def test_combo_single_letter():
-    combo = C("A")
-    assert Key.A == combo.key
-    assert [] == combo.modifiers
+    assert_combo = C("A")
+    assert Key.A == assert_combo.key
+    assert [] == assert_combo.modifiers
 
 def test_combo_single_simple_number():
-    combo = C("1")
-    assert Key.KEY_1 == combo.key
-    assert [] == combo.modifiers
+    assert_combo = C("1")
+    assert Key.KEY_1 == assert_combo.key
+    assert [] == assert_combo.modifiers
 
 def test_combo_simple():
-    combo = C("Alt-A")
-    assert Key.A == combo.key
-    assert [Modifier.ALT] == combo.modifiers
+    assert_combo = C("Alt-A")
+    assert Key.A == assert_combo.key
+    assert [Modifier.ALT] == assert_combo.modifiers
 
-def test_type_simple():
-    out = to_US_keystrokes("hello5")
+def test_to_US_keystrokes_simple():
+    out = to_US_keystrokes("hello5")(ctx)
     assert [Key.H, Key.E, Key.L, Key.L, Key.O, Key.KEY_5] == out
 
-def test_type_simple_with_shift():
-    out = to_US_keystrokes("Hello")
+def test_to_US_keystrokes_simple_with_shift():
+    out = to_US_keystrokes("Hello")(ctx)
     assert [C("Shift-H"), Key.E, Key.L, Key.L, Key.O] == out
 
+def test_to_US_keystrokes_simple_with_CapsL_ON():
+    out = to_US_keystrokes("Hello")(ctx_ON)
+    assert [C("h"), C("Shift-e"), C("Shift-l"), C("Shift-l"), C("Shift-o")] == out
+
 # TODO: it wasn't clear what to use here since we support
 # - most all ASCII now so we went with BELL but this may
 # - just be better to remove in the future
-def test_type_unsupported_character():
+def test_to_US_keystrokes_unsupported_character():
     with pytest.raises(CharacterNotSupported) as e:
-        out = to_US_keystrokes("\u0007")
-        assert e.message == "The character \u0007 is not supported by `type` yet"
+        out_fn = to_US_keystrokes("\u0007")
+        out_inner = out_fn(ctx)[0]
+        out = out_inner(ctx)
+        assert e == "The character \u0007 is not supported by `to_US_keystrokes` yet"
 
-def test_type_too_long():
+def test_to_US_keystrokes_too_long():
     with pytest.raises(TypingTooLong) as e:
         out = to_US_keystrokes("lasdjlkad jlkasjd laksjdlkasj dlkasj dlk ajlkd jaldkjal"
             "asdkjhasdkjahkjdhaskjdhakjdhkjadh kajhdkjashdkashdkjajhdajksd")
-        assert e.message == "`type` only supports strings of 100 characters or less"
+        assert e == "`to_US_keystrokes` only supports strings of 100 characters or less"
 
-def test_type_extended_ascii():
-    out = to_US_keystrokes("\u00ff")
-    assert [ C("Shift-Ctrl-U"),
-             Key.F, Key.F,
-             Key.ENTER] == out
+def test_to_US_keystrokes_extended_ascii():
+    out_fn = to_US_keystrokes("\u00ff")
+    out_inner = out_fn(ctx)[0]
+    out = out_inner(ctx)
+    assert [    C("Shift-Ctrl-U"),
+                Key.F, Key.F,
+                Key.ENTER   ] == out
 
 def test_ascii_keys():
-    out = to_US_keystrokes("`-=[]\\;',./")
-    assert [ Key.GRAVE, Key.MINUS, Key.EQUAL, Key.LEFT_BRACE,
-             Key.RIGHT_BRACE, Key.BACKSLASH, Key.SEMICOLON,
-             Key.APOSTROPHE, Key.COMMA, Key.DOT, Key.SLASH
-             ] == out
+    out = to_US_keystrokes("`-=[]\\;',./")(ctx)
+    assert [    Key.GRAVE, Key.MINUS, Key.EQUAL, Key.LEFT_BRACE,
+                Key.RIGHT_BRACE, Key.BACKSLASH, Key.SEMICOLON,
+                Key.APOSTROPHE, Key.COMMA, Key.DOT, Key.SLASH   ] == out
 
 def test_ascii_with_shift_keys():
-    out = to_US_keystrokes('~!@#$%^&*()_+{}|:"<>?')
+    out = to_US_keystrokes('~!@#$%^&*()_+{}|:"<>?')(ctx)
     assert [C("Shift-Grave"),C("Shift-1"),C("Shift-2"),C("Shift-3"),C("Shift-4"),
             C("Shift-5"),C("Shift-6"),C("Shift-7"),C("Shift-8"),C("Shift-9"),
             C("Shift-0"),C("Shift-Minus"),C("Shift-Equal"),C("Shift-Left_Brace"),
             C("Shift-Right_Brace"),C("Shift-Backslash"),C("Shift-Semicolon"),
             C("Shift-Apostrophe"),C("Shift-Comma"),C("Shift-Dot"),C("Shift-Slash")
-             ] == out
-
-def test_type_unicode():
-    out = to_US_keystrokes("🎉")
-    assert [ C("Shift-Ctrl-U"),
-             Key.KEY_1, Key.F, Key.KEY_3, Key.KEY_8, Key.KEY_9,
-             Key.ENTER] == out
-
-    out = to_US_keystrokes("\U0001f389")
-    assert [ C("Shift-Ctrl-U"),
-             Key.KEY_1, Key.F, Key.KEY_3, Key.KEY_8, Key.KEY_9,
-             Key.ENTER] == out
-
-def test_uncode_keystrokes():
-    out = unicode_keystrokes(0x00ff)
-    assert [ C("Shift-Ctrl-U"),
-             Key.F, Key.F,
-             Key.ENTER] == out
-
-    out = unicode_keystrokes(0x10fad)
-    assert [ C("Shift-Ctrl-U"),
-             Key.KEY_1, Key.KEY_0, Key.F, Key.A, Key.D,
-             Key.ENTER] == out
+    ] == out
+
+def test_to_US_keystrokes_unicode():
+
+    # with CapsLock OFF
+
+    out_fn = to_US_keystrokes("🎉")
+    out_inner = out_fn(ctx)[0]
+    out = out_inner(ctx)
+    assert [    C("Shift-Ctrl-U"),
+                Key.KEY_1, Key.F, Key.KEY_3, Key.KEY_8, Key.KEY_9,
+                Key.ENTER   ] == out
+
+    out_fn = to_US_keystrokes("\U0001f389")
+    out_inner = out_fn(ctx)[0]
+    out = out_inner(ctx)
+    assert [    C("Shift-Ctrl-U"),
+                Key.KEY_1, Key.F, Key.KEY_3, Key.KEY_8, Key.KEY_9,
+                Key.ENTER   ] == out
+
+    # with CapsLock ON
+
+    out_fn = to_US_keystrokes("🎉")
+    out_inner = out_fn(ctx_ON)[0]
+    out = out_inner(ctx_ON)
+    assert [    Key.CAPSLOCK, C("Shift-Ctrl-U"),
+                Key.KEY_1, Key.F, Key.KEY_3, Key.KEY_8, Key.KEY_9,
+                Key.ENTER, Key.CAPSLOCK   ] == out
+
+    out_fn = to_US_keystrokes("\U0001f389")
+    out_inner = out_fn(ctx_ON)[0]
+    out = out_inner(ctx_ON)
+    assert [    Key.CAPSLOCK, C("Shift-Ctrl-U"),
+                Key.KEY_1, Key.F, Key.KEY_3, Key.KEY_8, Key.KEY_9,
+                Key.ENTER, Key.CAPSLOCK   ] == out
+
+def test_unicode_keystrokes():
+    ctx_OFF = Context_with_CapsL_OFF()
+
+    # with CapsLock OFF
 
     with pytest.raises(UnicodeNumberToolarge) as e:
-        out = unicode_keystrokes(0x110000)
-        assert e.message == "too large for Unicode keyboard entry."
+        out = unicode_keystrokes(0x110000)(ctx_OFF)
+        assert e == "too large for Unicode keyboard entry."
+
+    out = unicode_keystrokes(0x00ff)(ctx_OFF)
+    assert [    C("Shift-Ctrl-U"),
+                Key.F, Key.F,
+                Key.ENTER   ] == out
+
+    out = unicode_keystrokes(0x10fad)(ctx_OFF)
+    assert [    C("Shift-Ctrl-U"),
+                Key.KEY_1, Key.KEY_0, Key.F, Key.A, Key.D,
+                Key.ENTER   ] == out
+
+    # with CapsLock ON
+
+    out = unicode_keystrokes(0x00ff)(ctx_ON)
+    assert [    Key.CAPSLOCK, C("Shift-Ctrl-U"),
+                Key.F, Key.F,
+                Key.ENTER, Key.CAPSLOCK   ] == out
+
+    out = unicode_keystrokes(0x10fad)(ctx_ON)
+    assert [    Key.CAPSLOCK, C("Shift-Ctrl-U"),
+                Key.KEY_1, Key.KEY_0, Key.F, Key.A, Key.D,
+                Key.ENTER, Key.CAPSLOCK   ] == out