diff options
Diffstat (limited to 'docs/unit_testing.md')
| -rw-r--r-- | docs/unit_testing.md | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/unit_testing.md b/docs/unit_testing.md index 82073a201..a0eef51cb 100644 --- a/docs/unit_testing.md +++ b/docs/unit_testing.md | |||
| @@ -36,12 +36,20 @@ Note how there's several different tests, each mocking out a separate part. Also | |||
| 36 | 36 | ||
| 37 | ## Running the Tests | 37 | ## Running the Tests |
| 38 | 38 | ||
| 39 | To run all the tests in the codebase, type `make test`. You can also run test matching a substring by typing `make test:matchingsubstring` Note that the tests are always compiled with the native compiler of your platform, so they are also run like any other program on your computer. | 39 | To run all the tests in the codebase, type `make test:all`. You can also run test matching a substring by typing `make test:matchingsubstring` Note that the tests are always compiled with the native compiler of your platform, so they are also run like any other program on your computer. |
| 40 | 40 | ||
| 41 | ## Debugging the Tests | 41 | ## Debugging the Tests |
| 42 | 42 | ||
| 43 | If there are problems with the tests, you can find the executable in the `./build/test` folder. You should be able to run those with GDB or a similar debugger. | 43 | If there are problems with the tests, you can find the executable in the `./build/test` folder. You should be able to run those with GDB or a similar debugger. |
| 44 | 44 | ||
| 45 | To forward any [debug messages](unit_testing.md#debug-api) to `stderr`, the tests can run with `DEBUG=1`. For example | ||
| 46 | |||
| 47 | ```console | ||
| 48 | make test:all DEBUG=1 | ||
| 49 | ``` | ||
| 50 | |||
| 51 | Alternatively, add `CONSOLE_ENABLE=yes` to the tests `rules.mk`. | ||
| 52 | |||
| 45 | ## Full Integration Tests | 53 | ## Full Integration Tests |
| 46 | 54 | ||
| 47 | It's not yet possible to do a full integration test, where you would compile the whole firmware and define a keymap that you are going to test. However there are plans for doing that, because writing tests that way would probably be easier, at least for people that are not used to unit testing. | 55 | It's not yet possible to do a full integration test, where you would compile the whole firmware and define a keymap that you are going to test. However there are plans for doing that, because writing tests that way would probably be easier, at least for people that are not used to unit testing. |