Module luatest

after_suite (fn)

Add after suite hook.

Parameters:

• fn: (func)

before_suite (fn)

Add before suite hook.

Parameters:

• fn: (func)

configure ([options={}])

Update default options. See luatest.runner:run for the list of available options.

Parameters:

• options: (tab) list of options to update (default $(def))

Returns:

options after update

params

Create group of tests.

Fields:

• name: (string) (optional)

See also:

• luatest.group

Server

Class to manage tarantool instances.

See also:

• luatest.server

helpers

Helpers.

See also:

• luatest.helpers

EPS

EPS is meant to help with Lua’s floating point math in simple corner cases like almost_equals(1.1-0.1, 1), which may not work as-is (e.g. on numbers with rational binary representation) if the user doesn’t provide some explicit error margin.

The default margin used by almost_equals() in such cases is EPS; and since Lua may be compiled with different numeric precisions (single vs. double), we try to select a useful default for it dynamically. Note: If the initial value is not acceptable, it can be changed by the user to better suit specific needs.

See also: https://en.wikipedia.org/wiki/Machine_epsilon

almost_equals (actual, expected, margin[, message])

Parameters:

• actual: (number)
• expected: (number)
• margin: (number)
• message: (string) (optional)

assert (value[, message[, …]])

Check that value is truthy.

Parameters:

• value:
• message: (string) (optional)
• …: (optional)

Returns:

input values

assert_almost_equals (actual, expected, margin[, message])

Check that two floats are close by margin.

Parameters:

• actual: (number)
• expected: (number)
• margin: (number)
• message: (string) (optional)

assert_covers (actual, expected[, message])

Checks that actual map includes expected one.

Parameters:

• actual: (tab)
• expected: (tab)
• message: (string) (optional)

assert_equals (actual, expected[, message[, deep_analysis]])

Check that two values are equal. Tables are compared by value.

Parameters:

• actual:
• expected:
• message: (string) (optional)
• deep_analysis: (bool) print diff. (optional)

assert_error (fn, …)

Check that calling fn raises an error.

Parameters:

• fn: (func)
• …: arguments for function

assert_error_msg_contains (expected_partial, fn, …)

Parameters:

• expected_partial: (string)
• fn: (func)
• …: arguments for function

assert_error_msg_content_equals (expected, fn, …)

Strips location info from message text.

Parameters:

• expected: (string)
• fn: (func)
• …: arguments for function

assert_error_msg_equals (expected, fn, …)

Checks full error: location and text.

Parameters:

• expected: (string)
• fn: (func)
• …: arguments for function

assert_error_msg_matches (pattern, fn, …)

Parameters:

• pattern: (string)
• fn: (func)
• …: arguments for function

assert_eval_to_false (value[, message])

Alias for assert_not.

Parameters:

• value:
• message: (string) (optional)

assert_eval_to_true (value[, message])

Alias for assert.

Parameters:

• value:
• message: (string) (optional)

assert_ge (left, right[, message])

Check that left is greater than or equal to right.

Parameters:

• left: (number)
• right: (number)
• message: (string) (optional)

assert_gt (left, right[, message])

Check that left is greater than right.

Parameters:

• left: (number)
• right: (number)
• message: (string) (optional)

assert_is (actual, expected[, message])

Check that values are the same.

Parameters:

• actual:
• expected:
• message: (string) (optional)

assert_is_not (actual, expected[, message])

Check that values are not the same.

Parameters:

• actual:
• expected:
• message: (string) (optional)

assert_items_equals (actual, expected[, message])

Checks that two tables contain the same items, irrespective of their keys.

Parameters:

• actual:
• expected:
• message: (string) (optional)

assert_items_include (actual, expected[, message])

Checks that one table includes all items of another, irrespective of their keys.

Parameters:

• actual:
• expected:
• message: (string) (optional)

assert_le (left, right[, message])

Check that left is less than or equal to right.

Parameters:

• left: (number)
• right: (number)
• message: (string) (optional)

assert_lt (left, right[, message])

Check that left is less than right.

Parameters:

• left: (number)
• right: (number)
• message: (string) (optional)

assert_nan (value[, message])

Parameters:

• value:
• message: (string) (optional)

assert_not (value[, message])

Check that value is falsy.

Parameters:

• value:
• message: (string) (optional)

assert_not_almost_equals (actual, expected, margin[, message])

Check that two floats are not close by margin.

Parameters:

• actual: (number)
• expected: (number)
• margin: (number)
• message: (string) (optional)

assert_not_covers (actual, expected[, message])

Checks that map does not contain the other one.

Parameters:

• actual: (tab)
• expected: (tab)
• message: (string) (optional)

assert_not_equals (actual, expected[, message])

Check that two values are not equal. Tables are compared by value.

Parameters:

• actual:
• expected:
• message: (string) (optional)

assert_not_nan (value[, message])

Parameters:

• value:
• message: (string) (optional)

assert_not_str_contains (actual, expected[, is_pattern[, message]])

Case-sensitive strings comparison.

Parameters:

• actual: (string)
• expected: (string)
• is_pattern: (bool) (optional)
• message: (string) (optional)

assert_not_str_icontains (value, expected[, message])

Case-insensitive strings comparison.

Parameters:

• value: (string)
• expected: (string)
• message: (string) (optional)

assert_str_contains (value, expected[, is_pattern[, message]])

Case-sensitive strings comparison.

Parameters:

• value: (string)
• expected: (string)
• is_pattern: (bool) (optional)
• message: (string) (optional)

assert_str_icontains (value, expected[, message])

Case-insensitive strings comparison.

Parameters:

• value: (string)
• expected: (string)
• message: (string) (optional)

assert_str_matches (value, pattern[, start=1[, final=value:len()[, message]]])

Verify a full match for the string.

Parameters:

• value: (string)
• pattern: (string)
• start: (int) (default $(def))
• final: (int) (default $(def))
• message: (string) (optional)

assert_type (value, expected_type[, message[, level]])

Check value’s type.

Parameters:

• value: (string)
• expected_type: (string)
• message: (string) (optional)
• level: (int) (optional)

fail (message)

Stops a test due to a failure.

Parameters:

• message: (string)

fail_if (condition, message)

Stops a test due to a failure if condition is met.

Parameters:

• condition:
• message: (string)

skip (message)

Skip a running test.

Parameters:

• message: (string)

skip_if (condition, message)

Skip a running test if condition is met.

Parameters:

• condition:
• message: (string)

success ()

Stops a test with a success.

success_if (condition)

Stops a test with a success if condition is met.

Parameters:

• condition:

xfail (message)

Mark a test as xfail.

Parameters:

• message: (string)

xfail_if (condition, message)

Mark a test as xfail if condition is met

Parameters:

• condition:
• message: (string)