Version: 2.1.2
A testing library for Lua scripts.
For a usage example, please see the test script for utf8Tools.
Creates a new Tester instance.
local test = errTest.new([name], [verbosity])
-
name: (string) An optional test name. -
verbosity: (number) The test's output verbosity level when printing to the terminal.
Returns: The Tester object.
Notes:
- Here is a chart of the verbosity levels. Each level includes the output of the lower levels:
| Level | Description |
|---|---|
| 0 | No output |
| 1 | Start, end labels; final results |
| 2 | Job names, warnings |
| 3 | Job task labels |
| 4 | Job and assertion output |
Registers a function (which is to be tested) with a human-readable name, or removes the function from the Tester's registry.
Tester:registerFunction([label], func)
-
[label]: (string) The name to assign the function, ornilto remove the function from the registry. -
func: (function) The function to register or remove.
Registers a job function (which will conduct tests) with an optional human-readable name.
Tester:registerJob([desc], func)
-
[desc](string) Optional description to print when running the job. -
func(function) The job function.
Notes:
- Running a specific job function more than once in a test is treated as an error.
Runs the Tester. Each job is executed in the order of registration, and is considered to have passed if it returns without raising a Lua error.
Tester:runJobs()
The following methods are intended to be called within job functions.
Wrapper for Lua's print() that only prints if an appropriate verbosity level is set.
Tester:print(level, ...)
-
level: The verbosity level of this message. If the Tester's verbosity is lower, the message is not printed. -
...: Arguments forprint().
Wrapper for Lua's io.write() that only prints if an appropriate verbosity level is set.
Tester:write(level, str)
-
level: The verbosity level of this message. If the Tester's verbosity is lower, the message is not printed. -
str: The string forio.write().
Increments the Tester's warning counter, and prints a message to the terminal if the Tester's verbosity level is 2 or greater.
Tester:warn(str)
str: The string to conditionally print.
Prints a line feed (newline) if the verbosity level matches. Works in tandem with Tester:print(), Tester:write() or Tester:warn() to prevent more than two line feeds from being printed at a time.
For this to work correctly, you must not emit trailing \ns at the end of any console output.
Tester:lf(level)
level: The verbosity level of the line feed to print. If the Tester's verbosity is lower, the line feed is not printed.
Runs a function, expecting it to return without raising a Lua error. If an error is raised, then the job fails.
local a,b,c,d,e,f = Tester:expectLuaReturn([desc], func, ...)
-
[desc]: (string) Optional string description for the job. -
func: (function) The function to test. -
...: varargs list to be passed tofunc.
Returns: The first six return values of func.
Runs a function, expecting it to raise a Lua error. If the function returns, then the job fails.
Tester:expectLuaError([desc], func, ...)
-
[desc]: (string) Optional string description for the job. -
func: (function) The function to test. -
...: varargs list to be passed tofunc.
Notes:
- Care should be taken with functions that modify global state before error paths are hit, and also functions which do not clean up their allocations or other state when raising a Lua error.
The tester instance includes the following assertion methods:
| Method | Pass Condition |
|---|---|
| Tester:isEqual(a, b) | a == b |
| Tester:isNotEqual(a, b) | a ~= b |
| Tester:isBoolTrue(a) | a == true |
| Tester:isBoolFalse(a) | a == false |
| Tester:isEvalTrue(a) | a ~= false and a ~= nil |
| Tester:isEvalFalse(a) | a == false or a == nil |
| Tester:isNil(a) | a == nil |
| Tester:isNotNil(a) | a ~= nil |
| Tester:isNan(a) | a ~= a |
| Tester:isNotNan(a) | a == a |
| Tester:isType(val, expected) | type(val) in expected |
| Tester:isNotType(val, expected) | type(val) not in expected |
For the last two, expected is a string with Lua type tags that are separated by non-alphanumeric characters. For example, to assert that a value is a string or a boolean, you could call Tester:isType(val, "string, boolean").
Copyright (c) 2022 - 2024 RBTS
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.