test: update e2e test

Author: Theaninova

e2e/__main__.py

@@ -3,7 +3,7 @@
 import urllib.request
 import json
 
-DEFAULT_VERSION = "2.2.0-beta.12+c733b95"
+DEFAULT_VERSION = "2.2.0-beta.19"
 
 builds_dir = os.path.join(os.path.dirname(__file__), "builds")
 

e2e/ccos.py

@@ -63,6 +63,7 @@ class CCOS:
     action_to_id: dict[int, str]
     id_to_action: dict[str, int]
     id_to_keycode: dict[str, int]
+    settings: dict[str, dict[str, dict]]
 
     meta: dict
     actions: dict
@@ -75,6 +76,7 @@ def __init__(self, lib_path: str, data_path: str):
         self.action_to_id = {}
         self.id_to_action = {}
         self.id_to_keycode = {}
+        self.settings = {}
         self.lib = cdll.LoadLibrary(lib_path)
         self.idle = False
 
@@ -121,7 +123,20 @@ def load_factory_defaults(items: dict):
 
         load_factory_defaults(self.meta["factory_defaults"])
 
-        with open(os.path.join(os.path.dirname(lib_path), "actions.json"), "r") as f:
+        with open(
+            os.path.join(os.path.dirname(lib_path), self.meta["settings"]), "r"
+        ) as f:
+            settings = json.load(f)
+            for category in settings:
+                category_name = category["name"]
+                self.settings[category_name] = {}
+                for item in category["items"]:
+                    item_name = item["name"]
+                    self.settings[category_name][item_name] = item
+
+        with open(
+            os.path.join(os.path.dirname(lib_path), self.meta["actions"]), "r"
+        ) as f:
             self.actions = json.load(f)
         for group in self.actions:
             group_actions = group["actions"]

e2e/ccos_wrapper.py

@@ -113,3 +113,15 @@ def verify_layout(self, profile: str, layout: list[list[int]]):
             for key, action in enumerate(row):
                 command = f"VAR B3 {profile}{layer + 1} {key}"
                 self.serial_verify(command, f"{command} {action} 0")
+
+    def set_setting(self, category: str, item: str, value: str | int):
+        setting_info: dict = self.ccos.settings[category][item]
+        value_id: int = (
+            setting_info["enum"].index(value) if isinstance(value, str) else value
+        )
+        assert value_id >= 0, f"Invalid setting value: {value}"
+        command_str = f"VAR B2 0x{setting_info['id']:02X} {value_id}"
+        self.serial_verify(
+            command_str,
+            f"{command_str} 0",
+        )

e2e/runner.py

@@ -1,8 +1,9 @@
 import os
 import json
 import yaml
-from unittest import TestSuite, TestCase, main
+from unittest import TestSuite, TestCase
 import io
+import re
 from xmlrunner import XMLTestRunner
 from xmlrunner.extra.xunit_plugin import transform
 
@@ -37,6 +38,8 @@ def tearDown(self):
         self.wrapper.ccos.unload()
 
     def runTest(self):
+        print(f"{BOLD}Running test: {self.id()}{RESET}")
+
         assert isinstance(self.test_case["test"], list)
         for command in self.test_case["test"]:
             print(f"{BOLD}============={RESET}")
@@ -58,6 +61,13 @@ def runTest(self):
                 for chord in command["verifyChords"]:
                     self.wrapper.check_chord(chord["input"], chord["output"])
                     print(f"{BLUE}...1ms{RESET}")
+            if "settings" in command:
+                for category_name, category in command["settings"].items():
+                    for setting_name, setting_value in category.items():
+                        self.wrapper.set_setting(
+                            category_name, setting_name, setting_value
+                        )
+
             if "remap" in command:
                 print(json.dumps(command))
                 for layer, remaps in command["remap"].items():
@@ -90,15 +100,28 @@ def runTest(self):
             self.wrapper.millis += command["step"]
             self.wrapper.ccos.update(self.wrapper.millis)
             print(f"{BLUE}...{command['step']}ms{RESET}")
-            if "keys" in command:
+            if "keys" in command or "modifiers" in command:
+                modifiers = command.get("modifiers", {})
+                keys = command.get("keys", [])
                 print(
-                    f"{YELLOW}? modifiers=[{', '.join(command.get('modifiers', []))}] keys=[{', '.join(command['keys'])}]{RESET}"
+                    f"{YELLOW}? modifiers=[{', '.join(modifiers.keys())}] keys=[{', '.join(keys)}]{RESET}"
                 )
                 self.assertGreater(len(self.wrapper.reports), 0)
                 report = self.wrapper.reports.pop(0)
-                keys = [self.wrapper.ccos.toKeycode(key) for key in command["keys"]]
+                expected_modifiers = (
+                    (modifiers.get("lctrl", False) << 0)
+                    | (modifiers.get("lshift", False) << 1)
+                    | (modifiers.get("lalt", False) << 2)
+                    | (modifiers.get("lmeta", False) << 3)
+                    | (modifiers.get("rctrl", False) << 4)
+                    | (modifiers.get("rshift", False) << 5)
+                    | (modifiers.get("ralt", False) << 6)
+                    | (modifiers.get("rmeta", False) << 7)
+                )
+                expected_keys = [self.wrapper.ccos.toKeycode(key) for key in keys]
                 report.keys = [key for key in report.keys if key != 0]
-                self.assertEqual(report.keys, keys)
+                self.assertEqual(report.keys, expected_keys)
+                self.assertEqual(report.modifiers, expected_modifiers)
 
             self.assertEqual(
                 0,
@@ -152,23 +175,34 @@ def runTest(self):
         self.wrapper.check_chord_backup([])
 
 
-def collect_tests(build_dir: str) -> TestSuite:
-    tests: list[TestCase] = [FactoryTest(build_dir)]
+def collect_tests(build_dir: str, filter: str | None) -> TestSuite:
+    filter_match = re.compile(filter) if filter is not None else None
+    tests: list[TestCase] = (
+        [FactoryTest(build_dir)]
+        if filter_match is None or filter_match.match("factory")
+        else []
+    )
     for root, _, files in os.walk(tests_dir):
+        dirs = os.path.relpath(root, tests_dir).split(os.sep)
+        if dirs == ["."]:
+            dirs = []
         for file in files:
             if not file.endswith(".yml"):
                 continue
+            test_name = ".".join([*dirs, file.removesuffix(".yml")])
+            if filter_match is not None and not filter_match.match(test_name):
+                continue
             with open(os.path.join(root, file), "r") as f:
-                test = CCOSTest(build_dir, file.removesuffix(".yml"), yaml.safe_load(f))
+                test = CCOSTest(build_dir, test_name, yaml.safe_load(f))
                 tests.append(test)
     return TestSuite(tests)
 
 
-def run_tests(build_dir: str):
+def run_tests(build_dir: str, filter: str | None = None):
     report_file = os.path.join(e2e_dir, "report.xml")
     if os.path.exists(report_file):
         os.remove(report_file)
-    suite = collect_tests(build_dir)
+    suite = collect_tests(build_dir, filter)
     out = io.BytesIO()
     runner = XMLTestRunner(output=out)
     runner.run(suite)

e2e/tests/actions/capitalize.yml

@@ -0,0 +1,36 @@
+test:
+  - clearChords: true
+    addChords:
+      - input: [[c, p]]
+        output: [CAPITALIZE]
+      - input: [[a, b]]
+        output: [a, b, c]
+    idle: true
+
+  - press: [c, p]
+    keys: [c, p]
+  - release: [c, p]
+  - step: 16
+    keys: []
+  - keys: [BKSP]
+  - keys: []
+  - keys: [BKSP]
+  - keys: []
+    idle: true
+
+  - press: [a, b]
+    keys: [a, b]
+  - release: [a, b]
+  - step: 16
+    keys: []
+  - keys: [BKSP]
+  - keys: []
+  - keys: [BKSP]
+  - keys: [a]
+    modifiers:
+      lshift: true
+  - keys: [b]
+  - keys: [c]
+  - keys: [SPACE]
+  - keys: []
+    idle: true

e2e/tests/actions/capitalize_no_space.yml

@@ -0,0 +1,35 @@
+test:
+  - clearChords: true
+    addChords:
+      - input: [[c, p]]
+        output: [CAPITALIZE, KSC_00]
+      - input: [[a, b]]
+        output: [JOIN, a, b, c, KSC_00]
+    idle: true
+
+  - press: [c, p]
+    keys: [c, p]
+  - release: [c, p]
+  - step: 16
+    keys: []
+  - keys: [BKSP]
+  - keys: []
+  - keys: [BKSP]
+  - keys: []
+    idle: true
+
+  - press: [a, b]
+    keys: [a, b]
+  - release: [a, b]
+  - step: 16
+    keys: []
+  - keys: [BKSP]
+  - keys: []
+  - keys: [BKSP]
+  - keys: [a]
+    modifiers:
+      lshift: true
+  - keys: [b]
+  - keys: [c]
+  - keys: []
+    idle: true

e2e/tests/dup.yml e2e/tests/actions/dup/dup.ymle2e/tests/dup.yml renamed to e2e/tests/actions/dup/dup.yml

@@ -1,31 +1,33 @@
 test:
   - remap:
       A1:
-        - [b, DUP]
+        - [d, DUP]
     idle: true
 
   - press: [a]
     keys: [a]
   - release: [a]
   - step: 16
     keys: []
+    idle: true
 
-  - press: [b]
+  - press: [d]
     keys: [a]
-  - release: [b]
+  - release: [d]
   - step: 16
     keys: []
+    idle: true
 
   - press: [c]
     keys: [c]
   - release: [c]
   - step: 16
     keys: []
+    idle: true
 
-  - press: [b]
+  - press: [d]
     keys: [c]
-  - release: [b]
+  - release: [d]
   - step: 16
     keys: []
-
-  - idle: true
+    idle: true

e2e/tests/actions/dup/modifiers.yml

@@ -0,0 +1,24 @@
+test:
+  - remap:
+      A1:
+        - [d, DUP]
+    idle: true
+
+  - press: [a]
+    keys: [a]
+  - release: [a]
+  - step: 16
+    keys: []
+    idle: true
+
+  - press: [LEFT_SHIFT]
+    modifiers:
+      lshift: true
+  - press: [d]
+    keys: [a]
+    modifiers:
+      lshift: true
+  - release: [LEFT_SHIFT, d]
+  - step: 16
+    keys: []
+    idle: true

e2e/tests/actions/dup/release_keys.yml

@@ -0,0 +1,25 @@
+test:
+  - remap:
+      A1:
+        - [d, DUP]
+    idle: true
+
+  - press: [a]
+    keys: [a]
+  - release: [a]
+  - step: 16
+    keys: []
+    idle: true
+
+  - step: 16
+    idle: true
+
+  - press: [a]
+    keys: [a]
+  - press: [d]
+    keys: []
+  - keys: [a]
+  - release: [a, d]
+  - step: 16
+    keys: []
+    idle: true