zerobug 0.2.14.16¶
Contents
Overview¶
Zeroincombenze® continuous testing framework for python and bash programs¶
This library can run unit test of target package software. Supported languages are python (through z0testlib.py) and bash (through z0testrc)
zerobug supports test automation, aggregation of tests into collections and independence of the tests from the reporting framework. The zerobug module provides all code that make it easy to support testing both for python programs both for bash scripts. zerobug differs from pytest standard library because show execution test with a message like “n/tot message” where n is current unit test and tot is the total unit test to execute, that is a sort of advancing test progress.
zerobug is built on follow concepts:
- test main - it is a main program to executes all test runners
- test runner - it is a program to executes one or more test suites
- test suite - it is a collection of test cases
- test case -it is a smallest unit test
Quick start¶
Installation¶
Current version via Git¶
cd $HOME
git clone https://github.com/zeroincombenze/tools.git
cd ./tools
./install_tools.sh -p
source /opt/odoo/dev/activate_tools
Usage¶
Test main file (usually is called all_tests) execute the test suite declared in source file. If no test list declared, it searches for test runner files named ‘test_[0-9]*’ executed in sorted order.
Test suite is a collection of test case named ‘test_[0-9]*’ executed in sorted order.
Because zerobug can show total number of unit test to execute, it run tests in 2 passes. In the first pass it counts tests, in second pass executes really it.
- usage: zerobug [-h] [-b] [-C] [-e] [-J] [-k] [-l file] [-N] [-n] [-O] [-q]
- [-r number] [-s number] [-V] [-v] [-x] [-X] [-z number] [-0] [-1] [-3]
Regression test on maintainer-quality-tools
- optional arguments:
-h, --help show this help message and exit -b, --debug trace msgs in zerobug.tracehis -C, --no-coverage run tests without coverage -e, --echo enable echoing even if not interactive tty -J load travisrc -k, --keep keep current logfile -l file, --logname file set logfile name -N, --new create new logfile -n, --dry-run count and display # unit tests -O load odoorc -q, --quiet run tests without output (quiet mode) -r number, --restart number set to counted tests, 1st one next to this -s number, --start number deprecated -V, --version show program’s version number and exit -v, --verbose verbose mode -x, --qsanity like -X but run silently -X, --esanity execute test library sanity check and exit -z number, --end number display total # tests when execute them -0, --no-count no count # unit tests -1, --coverage run tests for coverage (obsolete) -3, --python3 use python3 (w/o switches) do run test and return test result
Code example¶
zerobug makes avaiable following functions to test:
Z0BUG.build_os_tree(ctx, list_of_paths) (python) Z0BUG_build_os_tree list_of_paths (bash) Build a full os tree from supplied list. If python, list of paths is a list of strings. If bash, list is a string of paths separated by spaces. Function reads list of paths and create all directories. If directory is an absolute path, the supplied path is created. If directory is a relative path, the directory is created under tests/res directory.
Warning! To check is made is parent dir does not exit. Please, supply path from parent to children, if you want to build a nested tree.
from zerobug import Z0BUG
class RegressionTest():
def __init__(self, Z0BUG):
self.Z0BUG = Z0BUG
def test_01(self, ctx):
os_tree = ['10.0',
'10.0/addons',
'10.0/odoo',]
root = self.Z0BUG.build_os_tree(ctx, os_tree)
Z0BUG.remove_os_tree(ctx, list_of_paths) (python) Z0BUG_remove_os_tree list_of_paths (bash) Remove a full os tree created by build_os_tree If python, list of paths is a list of strings. If bash, list is a string of paths separated by spaces. Function reads list of paths and remove all directories. If directory is an absolute path, the supplied path is dropped. If directory is a relative path, the directory is dropped from tests/res directory.
Warning! This function remove directory and all sub-directories without any control.
from zerobug import Z0BUG
class RegressionTest():
def __init__(self, Z0BUG):
self.Z0BUG = Z0BUG
def test_01(self, ctx):
os_tree = ['10.0',
'10.0/addons',
'10.0/odoo',]
root = self.Z0BUG.remove_os_tree(ctx, os_tree)
Z0BUG.build_odoo_env(ctx, version) (python) Like build_os_tree but create a specific odoo os tree.
from zerobug import Z0BUG
class RegressionTest():
def __init__(self, Z0BUG):
self.Z0BUG = Z0BUG
def test_01(self, ctx):
root = self.Z0BUG.build_odoo_env(ctx, '10.0')
Z0BUG.git_clone(remote, reponame, branch, odoo_path, force=None) (python) Execute git clone of remote:reponame:branch into local directory odoo_path. In local travis emulation, if repository uses local repository, if exists. Return odoo root directory
from zerobug import Z0BUG
from zerobug import Z0testOdoo
from zerobug import Z0BUG
class RegressionTest():
def __init__(self, Z0BUG):
self.Z0BUG = Z0BUG
def test_01(self, ctx):
remote = 'OCA'
reponame = 'OCB'
branch = '10.0'
odoo_path = '/opt/odoo/10.0'
Z0testOdoo.git_clone(remote, reponame, branch, odoo_path)
Package, test environment and deployment are:
- ./ Package directory
- inside python test program is self.pkg_dir inside bash test script is $RUNDIR
- ./tests Unit test directory
- should contains one of ‘all_tests’ or ‘test_PKGNAME’ inside python test program is self.test_dir inside bash test script is $TESTDIR
- ./tests/z0testlib Python file unit test library from zerobug package
- may be not present if zerobug python package installed
- ./tests/z0testrc Bash file unit test library from zerobug package
- may be not present if zerobug python package installed inside bash test script is $Z0TLIBDIR
- ./tests/z0librc Local bash script library for bash scripts;
- Could be in user root directory or in /etc directory inside bash test script is $Z0LIBDIR
- ./_travis Interface to travis emulator if present (obsolete);
- it used in local host to emulate some travis functions inside bash test script is $TRAVISDIR
Unit test can run in package directory or in ./tests directory of package.
Every test can inquire internal context.
this_fqn parent caller full qualified name (i.e. /opt/odoo/z0bug.pyc) this parent name, w/o extension (i.e. z0bug) ctr test counter [both bash and python tests] dry_run dry-run (do nothing) [opt_dry_run in bash test] “-n” esanity True if required sanity check with echo “-X” max_test # of tests to execute [both bash and python tests] “-z” min_test # of test executed before this one “-r” on_error behavior after error, ‘continue’ or ‘raise’ (default) opt_echo True if echo test result onto std output “-e” opt_new new log file [both bash and python tests] “-N” opt_noctr do not count # tests [both bash and python tests] “-0” opt_verbose show messages during execution “-v” logfn real trace log file name from switch “-l” qsanity True if required sanity check w/o echo “-x” run4cover Run tests for coverage (use coverage run rather python) “-C” python3 Execute test in python3 “-3” run_daemon True if execution w/o tty as stdio run_on_top Top test (not parent) run_tty Opposite of run_daemon tlog default tracelog file name _run_autotest True if running auto-test _parser cmd line parser _opt_obj parser obj, to acquire optional switches WLOGCMD override opt_echo; may be None, ‘echo’, ‘echo-1’, ‘echo-0’ Z0 this library object
Environment read:
DEV_ENVIRONMENT Name of package; if set test is under travis emulator control
- COVERAGE_PROCESS_START
- Name of coverage conf file; if set test is running for coverage
Credits¶
Copyright¶
SHS-AV s.r.l. <https://www.shs-av.com/>
Contributors¶
- Antonio Maria Vigliotti <antoniomaria.vigliotti@gmail.com>
This module is part of tools project.
Last Update / Ultimo aggiornamento: 2020-04-03
