zmk_mf68/docs/docs/development/tests.md

---
title: Tests
sidebar_label: Tests
---

- Running tests requires [native posix support](posix-board.md).
- Any folder under `/app/tests` containing `native_posix.keymap` will be selected when running `west test`.
- Run tests from within the `/zmk/app` directory.
- Run a single test with `west test <testname>`, like `west test tests/toggle-layer/normal`.

## Creating a New Test Set

1. Copy the test set that most closely resembles the tests you will be creating.
2. Rename the newly created test set to the behavior you're testing e.g, toggle-layer
3. Modify `behavior_keymap.dtsi` to create a keymap using the behavior and related behaviors
4. Modify `test_case/native_posix.keymap` for a simulated use case
5. Modify `test_case/events.patterns` to collect relevant logs to the test
   - See: [sed manual](https://www.gnu.org/software/sed/manual/sed.html) and
     [tutorial](https://www.digitalocean.com/community/tutorials/the-basics-of-using-the-sed-stream-editor-to-manipulate-text-in-linux)
6. Modify `test_case/keycode_events.snapshot` for to include the expected output
7. Rename the `test_case` folder to describe the test.
8. Repeat steps 4 to 7 for every test case
fix(docs): update the testing docs 2020-08-29 06:21:31 +10:00			`---`
			`title: Tests`
			`sidebar_label: Tests`
			`---`
feat(test): create simple docs for creating tests 2020-08-29 06:21:31 +10:00
feat(behaviors) Required keys for tap-hold behaviors * Add optional `hold-trigger-key-positions` hold-tap configuration * Leverage configuration for decision making around when to trigger hold decision in hold-taps. * Add docs for new configuration. * Tests for the new config/decision logic. 2021-11-02 03:37:20 +11:00			`- Running tests requires [native posix support](posix-board.md).`
			- Any folder under `/app/tests` containing `native_posix.keymap` will be selected when running `west test`.
			- Run tests from within the `/zmk/app` directory.
			- Run a single test with `west test <testname>`, like `west test tests/toggle-layer/normal`.
feat(test): create simple docs for creating tests 2020-08-29 06:21:31 +10:00
			`## Creating a New Test Set`
docs: Format docs with prettier npx prettier --write . 2020-10-26 04:23:51 +11:00
feat(test): create simple docs for creating tests 2020-08-29 06:21:31 +10:00			`1. Copy the test set that most closely resembles the tests you will be creating.`
docs: Format docs with prettier npx prettier --write . 2020-10-26 04:23:51 +11:00			`2. Rename the newly created test set to the behavior you're testing e.g, toggle-layer`
feat(test): create simple docs for creating tests 2020-08-29 06:21:31 +10:00			3. Modify `behavior_keymap.dtsi` to create a keymap using the behavior and related behaviors
			4. Modify `test_case/native_posix.keymap` for a simulated use case
			5. Modify `test_case/events.patterns` to collect relevant logs to the test
docs: Format docs with prettier npx prettier --write . 2020-10-26 04:23:51 +11:00			`- See: [sed manual](https://www.gnu.org/software/sed/manual/sed.html) and`
			`[tutorial](https://www.digitalocean.com/community/tutorials/the-basics-of-using-the-sed-stream-editor-to-manipulate-text-in-linux)`
feat(test): create simple docs for creating tests 2020-08-29 06:21:31 +10:00			6. Modify `test_case/keycode_events.snapshot` for to include the expected output
fix(docs): update the testing docs 2020-08-29 06:21:31 +10:00			7. Rename the `test_case` folder to describe the test.
docs: Format docs with prettier npx prettier --write . 2020-10-26 04:23:51 +11:00			`8. Repeat steps 4 to 7 for every test case`