Login
Back to bricks list
Introduction Version

BaseTestCase

Base class for test, contain method to ease testing and automatically init env and clear it after Extend this class if your tests require database. If you are only using the TaskRunner, you can use BaseTestCaseComplete. This will init the database which is way slower. If you do not need the database, use BaseTestCaseLight

Attributes

init_before_each_test: booljson_ignore_keys: List

Functions

__INIT__

Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

Parameters:
NameTypeDefault valueDescription
methodNamestr runTest
ADDCLEANUP

Add a function, with arguments, to be called when the test is completed. Functions added are called on a LIFO basis and are called after tearDown on test failure or success.

Cleanup items are called even if setUp fails (unlike tearDown).

Parameters:
NameTypeDefault valueDescription
functionAny
ADDTYPEEQUALITYFUNC

Add a type specific assertEqual style function to compare a type.

This method is for use by TestCase subclasses that need to register their own type equality functions to provide nicer error messages.

Args: typeobj: The data type to call this function on when both values are of the same type in assertEqual(). function: The callable taking two arguments and an optional msg= argument that raises self.failureException with a useful error message when the two arguments are not equal.

Parameters:
NameTypeDefault valueDescription
typeobjAny
functionAny
ASSERT_
ASSERTALMOSTEQUAL

Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the difference between the two objects is more than the given delta.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most significant digit).

If the two objects compare equal then they will automatically compare almost equal.

Parameters:
NameTypeDefault valueDescription
firstAny
secondAny
placesAny
msgAny
deltaAny
ASSERTALMOSTEQUALS
ASSERTCOUNTEQUAL

Asserts that two iterables have the same elements, the same number of times, without regard to order.

self.assertEqual(Counter(list(first)),
                 Counter(list(second)))

Example: - [0, 1, 1] and [1, 0, 1] compare equal. - [0, 0, 1] and [0, 1] compare unequal.

Parameters:
NameTypeDefault valueDescription
firstAny
secondAny
msgAny
ASSERTDICTCONTAINSSUBSET

Checks whether dictionary is a superset of subset.

Parameters:
NameTypeDefault valueDescription
subsetAny
dictionaryAny
msgAny
ASSERTDICTEQUAL
Parameters:
NameTypeDefault valueDescription
d1Any
d2Any
msgAny
ASSERTEQUAL

Fail if the two objects are unequal as determined by the '==' operator.

Parameters:
NameTypeDefault valueDescription
firstAny
secondAny
msgAny
ASSERTEQUALS
ASSERTFALSE

Check that the expression is false.

Parameters:
NameTypeDefault valueDescription
exprAny
msgAny
ASSERTGREATER

Just like self.assertTrue(a > b), but with a nicer default message.

Parameters:
NameTypeDefault valueDescription
aAny
bAny
msgAny
ASSERTGREATEREQUAL

Just like self.assertTrue(a >= b), but with a nicer default message.

Parameters:
NameTypeDefault valueDescription
aAny
bAny
msgAny
ASSERTIN

Just like self.assertTrue(a in b), but with a nicer default message.

Parameters:
NameTypeDefault valueDescription
memberAny
containerAny
msgAny
ASSERTIS

Just like self.assertTrue(a is b), but with a nicer default message.

Parameters:
NameTypeDefault valueDescription
expr1Any
expr2Any
msgAny
ASSERTISINSTANCE

Same as self.assertTrue(isinstance(obj, cls)), with a nicer default message.

Parameters:
NameTypeDefault valueDescription
objAny
msgAny
ASSERTISNONE

Same as self.assertTrue(obj is None), with a nicer default message.

Parameters:
NameTypeDefault valueDescription
objAny
msgAny
ASSERTISNOT

Just like self.assertTrue(a is not b), but with a nicer default message.

Parameters:
NameTypeDefault valueDescription
expr1Any
expr2Any
msgAny
ASSERTISNOTNONE

Included for symmetry with assertIsNone.

Parameters:
NameTypeDefault valueDescription
objAny
msgAny
ASSERTLESS

Just like self.assertTrue(a < b), but with a nicer default message.

Parameters:
NameTypeDefault valueDescription
aAny
bAny
msgAny
ASSERTLESSEQUAL

Just like self.assertTrue(a <= b), but with a nicer default message.

Parameters:
NameTypeDefault valueDescription
aAny
bAny
msgAny
ASSERTLISTEQUAL

A list-specific equality assertion.

Args: list1: The first list to compare. list2: The second list to compare. msg: Optional message to use on failure instead of a list of differences.

Parameters:
NameTypeDefault valueDescription
list1Any
list2Any
msgAny
ASSERTLOGS

Fail unless a log message of level level or higher is emitted on logger_name or its children. If omitted, level defaults to INFO and logger defaults to the root logger.

This method must be used as a context manager, and will yield a recording object with two attributes: output and records. At the end of the context manager, the output attribute will be a list of the matching formatted log messages and the records attribute will be a list of the corresponding LogRecord objects.

Example::

with self.assertLogs('foo', level='INFO') as cm:
    logging.getLogger('foo').info('first message')
    logging.getLogger('foo.bar').error('second message')
self.assertEqual(cm.output, ['INFO:foo:first message',
                             'ERROR:foo.bar:second message'])
Parameters:
NameTypeDefault valueDescription
loggerAny
levelAny
ASSERTMULTILINEEQUAL

Assert that two multi-line strings are equal.

Parameters:
NameTypeDefault valueDescription
firstAny
secondAny
msgAny
ASSERTNOLOGS

Fail unless no log messages of level level or higher are emitted on logger_name or its children.

This method must be used as a context manager.

Parameters:
NameTypeDefault valueDescription
loggerAny
levelAny
ASSERTNOTALMOSTEQUAL

Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the difference between the two objects is less than the given delta.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most significant digit).

Objects that are equal automatically fail.

Parameters:
NameTypeDefault valueDescription
firstAny
secondAny
placesAny
msgAny
deltaAny
ASSERTNOTALMOSTEQUALS
ASSERTNOTEQUAL

Fail if the two objects are equal as determined by the '!=' operator.

Parameters:
NameTypeDefault valueDescription
firstAny
secondAny
msgAny
ASSERTNOTEQUALS
ASSERTNOTIN

Just like self.assertTrue(a not in b), but with a nicer default message.

Parameters:
NameTypeDefault valueDescription
memberAny
containerAny
msgAny
ASSERTNOTISINSTANCE

Included for symmetry with assertIsInstance.

Parameters:
NameTypeDefault valueDescription
objAny
msgAny
ASSERTNOTREGEX

Fail the test if the text matches the regular expression.

Parameters:
NameTypeDefault valueDescription
textAny
unexpected_regexAny
msgAny
ASSERTNOTREGEXPMATCHES
ASSERTRAISES

Fail unless an exception of class expected_exception is raised by the callable when invoked with specified positional and keyword arguments. If a different type of exception is raised, it will not be caught, and the test case will be deemed to have suffered an error, exactly as for an unexpected exception.

If called with the callable and arguments omitted, will return a context object used like this::

 with self.assertRaises(SomeException):
     do_something()

An optional keyword argument 'msg' can be provided when assertRaises is used as a context object.

The context manager keeps a reference to the exception as the 'exception' attribute. This allows you to inspect the exception after the assertion::

with self.assertRaises(SomeException) as cm:
    do_something()
the_exception = cm.exception
self.assertEqual(the_exception.error_code, 3)
Parameters:
NameTypeDefault valueDescription
expected_exceptionAny
ASSERTRAISESREGEX

Asserts that the message in a raised exception matches a regex.

Args: expected_exception: Exception class expected to be raised. expected_regex: Regex (re.Pattern object or string) expected to be found in error message. args: Function to be called and extra positional args. kwargs: Extra kwargs. msg: Optional message used in case of failure. Can only be used when assertRaisesRegex is used as a context manager.

Parameters:
NameTypeDefault valueDescription
expected_exceptionAny
expected_regexAny
ASSERTRAISESREGEXP
ASSERTREGEX

Fail the test unless the text matches the regular expression.

Parameters:
NameTypeDefault valueDescription
textAny
expected_regexAny
msgAny
ASSERTREGEXPMATCHES
ASSERTSEQUENCEEQUAL

An equality assertion for ordered sequences (like lists and tuples).

For the purposes of this function, a valid ordered sequence type is one which can be indexed, has a length, and has an equality operator.

Args: seq1: The first sequence to compare. seq2: The second sequence to compare. seq_type: The expected datatype of the sequences, or None if no datatype should be enforced. msg: Optional message to use on failure instead of a list of differences.

Parameters:
NameTypeDefault valueDescription
seq1Any
seq2Any
msgAny
seq_typeAny
ASSERTSETEQUAL

A set-specific equality assertion.

Args: set1: The first set to compare. set2: The second set to compare. msg: Optional message to use on failure instead of a list of differences.

assertSetEqual uses ducktyping to support different types of sets, and is optimized for sets specifically (parameters must support a difference method).

Parameters:
NameTypeDefault valueDescription
set1Any
set2Any
msgAny
ASSERTTRUE

Check that the expression is true.

Parameters:
NameTypeDefault valueDescription
exprAny
msgAny
ASSERTTUPLEEQUAL

A tuple-specific equality assertion.

Args: tuple1: The first tuple to compare. tuple2: The second tuple to compare. msg: Optional message to use on failure instead of a list of differences.

Parameters:
NameTypeDefault valueDescription
tuple1Any
tuple2Any
msgAny
ASSERTWARNS

Fail unless a warning of class warnClass is triggered by the callable when invoked with specified positional and keyword arguments. If a different type of warning is triggered, it will not be handled: depending on the other warning filtering rules in effect, it might be silenced, printed out, or raised as an exception.

If called with the callable and arguments omitted, will return a context object used like this::

 with self.assertWarns(SomeWarning):
     do_something()

An optional keyword argument 'msg' can be provided when assertWarns is used as a context object.

The context manager keeps a reference to the first matching warning as the 'warning' attribute; similarly, the 'filename' and 'lineno' attributes give you information about the line of Python code from which the warning was triggered. This allows you to inspect the warning after the assertion::

with self.assertWarns(SomeWarning) as cm:
    do_something()
the_warning = cm.warning
self.assertEqual(the_warning.some_attribute, 147)
Parameters:
NameTypeDefault valueDescription
expected_warningAny
ASSERTWARNSREGEX

Asserts that the message in a triggered warning matches a regexp. Basic functioning is similar to assertWarns() with the addition that only warnings whose messages also match the regular expression are considered successful matches.

Args: expected_warning: Warning class expected to be triggered. expected_regex: Regex (re.Pattern object or string) expected to be found in error message. args: Function to be called and extra positional args. kwargs: Extra kwargs. msg: Optional message used in case of failure. Can only be used when assertWarnsRegex is used as a context manager.

Parameters:
NameTypeDefault valueDescription
expected_warningAny
expected_regexAny
COUNTTESTCASES
DEBUG

Run the test without collecting errors in a TestResult

DEFAULTTESTRESULT
DOCLEANUPS

Execute all cleanup functions. Normally called for you after tearDown.

FAIL

Fail immediately, with the given message.

Parameters:
NameTypeDefault valueDescription
msgAny
FAILIF
FAILIFALMOSTEQUAL
FAILIFEQUAL
FAILUNLESS
FAILUNLESSALMOSTEQUAL
FAILUNLESSEQUAL
FAILUNLESSRAISES
ID
RUN
Parameters:
NameTypeDefault valueDescription
resultAny
SETUP

Hook method for setting up the test fixture before exercising it.

SHORTDESCRIPTION

Returns a one-line description of the test, or None if no description has been provided.

The default implementation of this method returns the first line of the specified test method's docstring.

SKIPTEST

Skip this test.

Parameters:
NameTypeDefault valueDescription
reasonAny
SUBTEST

Return a context manager that will return the enclosed block of code in a subtest identified by the optional message and keyword parameters. A failure in the subtest marks the test case as failed but resumes execution at the end of the enclosed block, allowing further test code to be executed.

Parameters:
NameTypeDefault valueDescription
msgobject <object object at 0x7ff5f7337220>
paramsAny
TEARDOWN

Hook method for deconstructing the test fixture after testing it.

ADDCLASSCLEANUP - @classmethod

Same as addCleanup, except the cleanup items are called even if setUpClass fails (unlike tearDownClass).

Parameters:
NameTypeDefault valueDescription
functionAny
ASSERT_JSON - @classmethod

Assert a json with possibility to ignore key

Parameters:
NameTypeDefault valueDescription
json_1Union
json_2Union
ignore_keysList
CLEAR_AFTER_TEST - @classmethod
DOCLASSCLEANUPS - @classmethod

Execute all class cleanup functions. Normally called for you after tearDownClass.

INIT_BEFORE_TEST - @classmethod
PRINT - @classmethod

Print test title

Parameters:
NameTypeDefault valueDescription
textstr
SETUPCLASS - @classmethod

Hook method for setting up class fixture before running tests in the class.

TEARDOWNCLASS - @classmethod

Hook method for deconstructing the class fixture after running all tests in the class.