mawww/kakoune
1
1
Fork 0
mirror of https://github.com/mawww/kakoune.git synced 2024-12-25 12:36:11 +03:00
Code Issues Projects Releases Wiki Activity
149da2064d
kakoune/test
History
Maxime Coste 149da2064d Handle invalid utf8 in command line a bit better 
Reduce the amount of decoding by working directly on
bytes.

Fixes #3388
2020-03-13 08:02:58 +11:00
..
compose Expand env vars as list of strings 2020-03-02 20:53:28 +11:00
display test: Allow expect-style UI tests, testing any var 2019-10-13 14:57:24 -04:00
highlight test: number-lines highlighter now reserves 2 digits by default. 2019-12-17 00:57:28 +11:00
hooks Change remove-hooks to take a regular expression 2018-09-12 21:26:21 +10:00
indent Expand env vars as list of strings 2020-03-02 20:53:28 +11:00
normal Expand env vars as list of strings 2020-03-02 20:53:28 +11:00
regression Handle invalid utf8 in command line a bit better 2020-03-13 08:02:58 +11:00
shell Expand env vars as list of strings 2020-03-02 20:53:28 +11:00
README.asciidoc Include more details in test/README.asciidoc 2019-02-15 11:45:06 -08:00
run Fix test/run ui_out diff display 2019-11-24 18:11:29 +11:00

README.asciidoc

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Regression test
===============

:unified-context-diff: https://en.wikipedia.org/wiki/Diff#Unified_format

Source structure
----------------

----------------------------------------------
.
├── unit
│   └── …
└── compose
    └── …
        ├── [rc]         → configuration
        ├── cmd          → command
        ├── [in]         → start file
        ├── [ui-in]      → start UI state in JSON format
        ├── [out]        → end file
        ├── [ui-out]     → output UI state in JSON format
        ├── [selections] → selection contents
        ├── [state]      → selection states
        └── [error]      → error bypass
----------------------------------------------

Usage
-----

To test, just type +run [test]+ in the +test+ directory.
It will print each passing test.  If a test fails, a {unified-context-diff}[unified context diff]
is printed showing the test’s expected output and the actual output.

Details
-------

+rc+ is optional
and should contain a sequence of commands,
_e.g._, +set-option+, +define-command+, +declare-option+.
+rc+ is sourced and evaluated before the +cmd+ key sequence is executed.

+cmd+ is required
and should contain a key sequence that will edit the input buffer.
+cmd+ is executed after the +rc+ command sequence is sourced.

+in+ is optional
and should contain the initial text loaded into the input buffer
for editing by the +cmd+ key sequence.

+ui-in+ is optional
and should contain the json-rpc commands sent by the UI at startup.

+out+ is optional
and should contain the expected text generated by the +cmd+ key sequence.

+ui-out+ is optional
and should contain the expected UI JSON output.

+selections+ is optional
and should contain the expected value of +$kak_selections+
(_i.e._, content of the selection separated by colons).

+state+ is optional
and should contain the expected value of +$kak_selections_desc+
(_i.e._, range of the selections separated by colons).

If the actual +output+ text, +selections+, +state+, or +ui-out+
does not match the expected content in the corresponding file,
the unit test will fail.

If there is no +output+, +selections+, +state+, or +ui-out+ file,
then the unit test will always succeed.

If there is an +error+ file, which could be empty,
then the unit test will always fail.