summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorCody McGinnis <brainwart@gmail.com>2020-08-28 16:21:31 -0400
committerCody McGinnis <brainwart@gmail.com>2020-08-28 16:21:31 -0400
commit205a54baeb75f631795c3de34948e5e9f1af0083 (patch)
treece280744b63d25f042772e7dfc5aaaa74d2a1962 /docs
parent26414a69824a37a65c0fb3a6c423f4cb6c1ef068 (diff)
fix(docs): update the testing docs
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/dev-tests.md21
1 files changed, 9 insertions, 12 deletions
diff --git a/docs/docs/dev-tests.md b/docs/docs/dev-tests.md
index 1709ccd..68d4725 100644
--- a/docs/docs/dev-tests.md
+++ b/docs/docs/dev-tests.md
@@ -1,15 +1,11 @@
-# Basics
-Running tests requires native [posix support](./dev-posix-board). Any folder under `/app/tests`
-containing `native_posix.keymap` will be selected when running `./run-test.sh all`.
-
-`test_case/events.patterns` contains sed patterns that will select the interesting output from the
-application
+---
+id: dev-tests
+title: Tests
+sidebar_label: Tests
+---
-`test_case/keycode_events.snapshot` contains the expected output after applying `events.pattern` to
-the output
-
-`test_case/native_posix.keymap` defines the keys and the mock key presses. Most tests include a
-common keymap for their test set
+Running tests requires [native posix support](./dev-posix-board). Any folder under `/app/tests`
+containing `native_posix.keymap` will be selected when running `./run-test.sh all`.
## Creating a New Test Set
1. Copy the test set that most closely resembles the tests you will be creating.
@@ -20,4 +16,5 @@ common keymap for their test set
- 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. Repeat steps 4 to 6 for every test case \ No newline at end of file
+7. Rename the `test_case` folder to describe the test.
+8. Repeat steps 4 to 7 for every test case \ No newline at end of file