e1a925ff83
Replaced the run-test.sh script with a Python script that runs our unit tests through pytest. Tests are now run in parallel to speed up running the entire test suite, and it allows for integration with other tools that support pytest, such as IDEs. Also removed a dependency on remarshal, because it depends on an old version of PyYAML that conflicts with other Python packages in our Docker image. Replaced it with yq.
1.8 KiB
1.8 KiB
| title | sidebar_label |
|---|---|
| Tests | Tests |
- Running tests requires native posix support.
- Any folder under
/app/testscontainingnative_posix_64.keymapwill be selected when runningwest test.
Running Tests
All the following commands assume you have a terminal opened to the zmk/app directory.
First, make sure all Python dependencies are installed:
python3 -m pip install -r scripts/requirements.txt
Tests can then be run from Zephyr's west tool with the test subcommand:
west test
Running it with no arguments will run the entire test suite. You can run a single test case or test set by providing the relative path from zmk/app/tests to the test directory, e.g.
# Run all tests cases in the toggle-layer set
west test toggle-layer
# Run the toggle-layer/normal test case
west test toggle-layer/normal
Any additional arguments are passed through to PyTest.
Creating a New Test Set
- Copy the test set that most closely resembles the tests you will be creating.
- Rename the newly created test set to the behavior you're testing e.g, toggle-layer
- Modify
behavior_keymap.dtsito create a keymap using the behavior and related behaviors - Modify
test_case/native_posix_64.keymapfor a simulated use case - Modify
test_case/events.patternsto collect relevant logs to the test- See: sed manual and tutorial
- Modify
test_case/keycode_events.snapshotfor to include the expected output - Rename the
test_casefolder to describe the test. - Repeat steps 4 to 7 for every test case