module pycode.utils_tests_private

Short summary

module pyquickhelper.pycode.utils_tests_private

This extension contains various functionalities to help unittesting.

source on GitHub

Functions

function	truncated documentation
clean	Does the cleaning.
default_skip_function	Default skip function for function main_wrapper_tests().
get_estimation_time	Return an estimation of the processing time, it extracts the number in (time=5s) for example.
get_test_file	Returns the list of test files.
import_files	Runs all tests in file list li.
is_valid_error	Checks if the text written on stderr is an error or not, a local server can push logs on this stream, it looks for …
main_run_test	Runs all unit tests, the function looks into the folder _unittest and extract from all files beginning by test_ …

Documentation

This extension contains various functionalities to help unittesting.

source on GitHub

pyquickhelper.pycode.utils_tests_private.clean(folder=None, fLOG=<function noLOG>)

Does the cleaning.

Parameters:

• dir – directory

• fLOG – logging function

source on GitHub

pyquickhelper.pycode.utils_tests_private.default_skip_function(name, code, duration)

Default skip function for function main_wrapper_tests.

Parameters:

• name – name of the test file

• code – code of the test file

• duration – estimated duration of the tests (specified in the file documentation)

Returns:

True if skipped, False otherwise

source on GitHub

pyquickhelper.pycode.utils_tests_private.get_estimation_time(file)

Return an estimation of the processing time, it extracts the number in (time=5s) for example.

Parameters:

file – filename

Returns:

int

source on GitHub

pyquickhelper.pycode.utils_tests_private.get_test_file(filter, folder=None, no_subfolder=False, fLOG=<function noLOG>, root=None)

Returns the list of test files.

Parameters:

• folder – path to look (or paths to look if it is a list)

• filter – only select files matching the pattern (ex: test*)

• no_subfolder – the function investigates the folder folder and does not try any subfolder in {"_nrt", "_unittest", "_unittests"}

• fLOG – logging function

• root – root or folder which contains the project, rules applyong on folder name will not apply on it

Returns:

a list of test files

source on GitHub

pyquickhelper.pycode.utils_tests_private.import_files(li, additional_ut_path=None, fLOG=<function noLOG>)

Runs all tests in file list li.

Parameters:

• li – list of files (python scripts)

• additional_ut_path – additional paths to add when running the unit tests

• fLOG – logging function

Returns:

list of tests [ ( testsuite, file) ]

source on GitHub

pyquickhelper.pycode.utils_tests_private.is_valid_error(error)

Checks if the text written on stderr is an error or not, a local server can push logs on this stream, it looks for keywords such as Exception, Error, TraceBack…

Parameters:

error – text

Returns:

boolean

source on GitHub

pyquickhelper.pycode.utils_tests_private.main_run_test(runner, path_test=None, limit_max=1000000000.0, log=False, skip=-1, skip_list=None, on_stderr=False, processes=False, skip_function=None, additional_ut_path=None, stdout=None, stderr=None, filter_warning=None, fLOG=<function noLOG>)

Runs all unit tests, the function looks into the folder _unittest and extract from all files beginning by test_ all methods starting by test_. Each files should mention an execution time. Tests are sorted by increasing order.

Parameters:

• runner – unittest Runner

• path_test – path to look, if None, looks for defaults path related to this project

• limit_max – avoid running tests longer than limit seconds

• log – if True, enables intermediate files

• skip – if skip != -1, skip the first “skip” test files

• skip_list – skip unit test id in this list (by index, starting by 1)

• skip_function – function(filename,content,duration) –> boolean to skip a unit test

• on_stderr – if True, publish everything on stderr at the end

• processes – to run the unit test in a separate process (with function run_cmd), however, to make that happen, you need to specify exit=False for each test file, see unittest.main

• additional_ut_path – additional paths to add when running the unit tests

• stdout – if not None, use this stream instead of sys.stdout

• stderr – if not None, use this stream instead of sys.stderr

• filter_warning – function which removes some warnings in the final output, if None, the function filters out some recurrent warnings in jupyter (signature: def filter_warning(w: warning) -> bool), default_filter_warning

• fLOG – logging function

Returns:

dictionnary: { "err": err, "tests":list of couple (file, test results) }

source on GitHub