diff options
| -rw-r--r-- | tests/README.md | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/tests/README.md b/tests/README.md index c7e1bb93..0c55bdf1 100644 --- a/tests/README.md +++ b/tests/README.md @@ -11,6 +11,7 @@ a test infrastructure on top of the pre-existing nixos-vm-tests. It is further described in the `mkTest` section. ## `mkTest` + A standard application test would look somewhat like this: ```nix @@ -45,15 +46,18 @@ mkTest { ``` ### The test description file + All line starting with `#` or only containing white space are ignored. Additionally, all leading and trailing white space is stripped before evaluating. The general syntax is: + ``` COMMAND ARGS ``` -where `COMMAND` is one of the commands listed in [Commands](#### Commands) + +where `COMMAND` is one of the commands listed in [Commands](#commands) The `ARGS` are the verbatim content from the space after the `COMMAND` to the end of line character. @@ -62,17 +66,22 @@ You can run the description file, similarly as in the tests via the `run_test_de package exported by the flake. #### Commands + ##### `Type` + Send the `ARGS` to the application. This interprets `ARGS` as specified -by the tmux (1) man page on `send-keys`. +by the TMUX (1) man page on `send-keys`. #### `Sleep` + Sleep for `ARGS` seconds. #### `Expect` + Grep the currently visible screen for the regex `ARGS`. This regex must match. + #### `ExpectNot` -Does the same thing as [Expect](##### Expect), but enforces, that the -regex does not match. +Does the same thing as [Expect](#expect), but enforces, that the +regex does not match. |