From 7c9a06750fb91cf7895ab6833cc5b64ce7120c8b Mon Sep 17 00:00:00 2001 From: Josh Wainwright Date: Thu, 21 Apr 2016 09:11:37 +0100 Subject: Update tests README and add lua tests README files --- lua/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 lua/README.md (limited to 'lua/README.md') diff --git a/lua/README.md b/lua/README.md new file mode 100644 index 0000000..9b19a83 --- /dev/null +++ b/lua/README.md @@ -0,0 +1,21 @@ +Tests for vis specific lua api +------------------------------ + +There are two types of lua tests here: + +1. Tests are formed from a `.in`, `.ref` and `.out` triplet. + The `.in` file is opened by vis, some operatations are performed and + the modified file is written to `.out`. The new `.out` is + compared to `.ref` and the test passes if they are identical. + +2. Tests are formed from a single `.status` file. This file is created by + the lua code in the test. It contains a single line per test case, this + single line should be `true` if the test case passed. The `.status` + file is checked to ensure it contains only `true` lines and if so, the test + passes. + +The shell script `test.sh` looks for a file with extension `.in`, eg `test.in`, +and opens it in vis. The corresponding lua file, `test.lua`, is executed and is +expected to create either a `test.out` or `test.status` file. + +Type `make` to run all tests. -- cgit v1.2.3