From c1f743ab2e4a7046d5500875a47d1f62c8624603 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Mon, 8 Apr 2024 22:37:50 +0200 Subject: Adding upstream version 5.7.1. Signed-off-by: Daniel Baumann --- tests/config/tapered/doc/index.html | 111 ++++++++++++++++++++++++++++++++++++ 1 file changed, 111 insertions(+) create mode 100644 tests/config/tapered/doc/index.html (limited to 'tests/config/tapered/doc/index.html') diff --git a/tests/config/tapered/doc/index.html b/tests/config/tapered/doc/index.html new file mode 100644 index 0000000..69d6b24 --- /dev/null +++ b/tests/config/tapered/doc/index.html @@ -0,0 +1,111 @@ + + + + + +tapered documentation + + + + +

tapered

+ +

Synopsis

+ +

Very minimal tap testing for Lua. Arguably too minimal.

+ +

Assertions

+ +

The message parameter is always optional. Brief messages help make test output +clearer to readers, but are not needed if the output goes straight to another +program for parsing.

+ +

ok(expression, [message]) Tests whether expression returns a truthy +value.
nok(expression, [message]) Tests whether expression returns a falsy +value.
is(actual, expected, [message]) Tests whether actual is equal to +expected. The test uses == internally.
isnt(actual, expected, [message]) Tests whether actual is not equal to +actual. The test uses ~= internally.
same(actual, expected, [message]) Tests whether actual is a deep copy +of expected. The test uses an __eq metamethod if one is found. Useful +for comparing tables.
like(string, pattern, [message]) Tests whether string matches the given +pattern.
unlike(string, pattern, [message]) Tests whether string does not match +the given pattern.
pass([message]) A test that always passes. Useful as a quasi-skip with a +message.
fail([message]) A test that always fails. Useful as a quasi-TODO with a +message.
boom(function, args, [message]) Calls function with args as +parameters and checks to see if an exception is raised. Passes if an +exception is raised; fails otherwise. (The exception is swallowed.) The +args parameter expects a table. The table can be empty but not nil.

+ + +

Helper method

+ +

A method is available to show how many tests were run. (This output +is required for TAP compliance, which may matter in some cases.)

+ +

done([number]) Call this function (optionally) at the end of your test file. +It will print out a line in the form 1..n where n is the total number +of tests run. This secures TAP compliance when needed. The call to done +is not otherwise required. If you don’t care about TAP compliance, neither does +the library. If you pass the optional parameter to the method, it will check +whether the number of tests you expected matches the number of actual tests. +Thus, if can function like a traditional plan method. However, this method +should always be called last in your tap file, unlike plan methods which +normally start the test file.
+ +
Another reason to use done is if you care about the exit status of the +tests. Many continuous integration tools rely on tests signalling success or +failure via their exit status. After done is called, the script will exit +with a status of 0, indicating success, if all tests passed. If some tests +failed, the script will exit with a status equal to the number of failed +tests, indicating failure. A script will also exit with an error status if +there is a mismatch between the actual number of tests run and the number +passed to done as a parameter.

+ + +

Varia

+ +

The module provides four informational functions that return strings. They +should be self-explanatory.

+ +

version() -- 2.3.0
author() -- Peter Aronoff
url() -- https://github.com/telemachus/tapered.git
license() -- BSD 3-Clause

+ + +

Credits

+ +

For the same method I took ideas and code from Penlight, Underscore, +luassert, and cwtest. I thank all the people who worked on those.

+ +

Indirect inspirations include knock, Test::More, and bats—not so +much for code as for ideas about testing and simplicity.

+ +

Thanks in particular to Pierre Chapuis for help with ideas and +getting continuous integration for tapered.

+ +

An anonymous email showed me that my setup and teardown methods had a logical +flaw. As a result, I’ve removed those methods. I appreciate the report.

+ +

All the mistakes are mine. See version history for release details.

+ +

+ + -- cgit v1.2.3