Skip to main content

A lightweight unittest extension providing test suites config, concurrent tests, Html/XUnit reports, and data driven utility.

Project description

INTRODUCTION

The features described below come with the latest version 0.2.0. Earlier versions may not have some of the features.

unishark extends unittest (to be more accurate, unittest2) in the following ways:

  • Customizing test suites with dictionary config (or yaml/json like config).
  • Running the tests in parallel.
  • Generating polished test reports in HTML/XUnit formats.
  • Offering data-driven decorator to accelerate tests writing.

You could acquire the first three features for your existent unittests immediately with a single config, without changing any existing code.

The Test Config

Here is an example config in YAML format (you could also write it directly in a dict()):

suites:
  my_suite_name_1:
    package: my.package.name
    max_workers: 6
    groups:
      my_group_1:
        granularity: module
        modules: [test_module1, test_module2]
        except_classes: [test_module2.MyTestClass3]
        except_methods: [test_module1.MyTestClass1.test_1]
      my_group_2:
        granularity: class
        disable: False
        classes: [test_module3.MyTestClass5]
        except_methods: [test_module3.MyTestClass5.test_11]
  my_suite_name_2:
    package: my.package.name
    max_workers: 2
    groups:
      my_group_1:
        granularity: method
        methods: [test_module3.MyTestClass6.test_13, test_module3.MyTestClass7.test_15]

reporters:
  html:
    class: unishark.HtmlReporter
    kwargs:
      dest: logs
      overview_title: 'Example Report'
      overview_description: 'This is an example report'
  xunit:
    class: unishark.XUnitReporter
    kwargs:
      summary_title: 'Example Report'

test:
  suites: [my_suite_name_1, my_suite_name_2]
  max_workers: 2
  reporters: [html, xunit]
  method_prefix: 'test'

It defines two test suites with some of the test cases excluded, and tells unishark to run the defined set of tests with multi-threads (max_workers), then generate both HTML and XUnit (default JUnit) format reports at the end of testing.

To run it, simply add the following code:

import unishark
import yaml

if __name__ == '__main__':
    dict_conf = None
    with open('your_yaml_config_file', 'r') as f:
        dict_conf = yaml.load(f.read())  # use a 3rd party yaml parser, e.g., PyYAML
    program = unishark.DefaultTestProgram(dict_conf)
    unishark.main(program)

A HTML report example can be found Here.

Data Driven

Here are some effects of using @unishark.data_driven.

‘Json’ style data-driven:

@unishark.data_driven(*[{'userid': 1, 'passwd': 'abc'}, {'userid': 2, 'passwd': 'def'}])
def test_data_driven(self, **param):
    print('userid: %d, passwd: %s' % (param['userid'], param['passwd']))

Results:

userid: 1, passwd: abc
userid: 2, passwd: def

‘Args’ style data-driven:

@unishark.data_driven(userid=[1, 2, 3, 4], passwd=['a', 'b', 'c', 'd'])
def test_data_driven(self, **param):
    print('userid: %d, passwd: %s' % (param['userid'], param['passwd']))

Results:

userid: 1, passwd: a
userid: 2, passwd: b
userid: 3, passwd: c
userid: 4, passwd: d

Cross-multiply data-driven:

@unishark.data_driven(left=list(range(10)))
@unishark.data_driven(right=list(range(10)))
def test_data_driven(self, **param):
    l = param['left']
    r = param['right']
    print('%d x %d = %d' % (l, r, l * r))

Results:

0 x 1 = 0
0 x 2 = 0
...
1 x 0 = 0
1 x 1 = 1
1 x 2 = 2
...
...
9 x 8 = 72
9 x 9 = 81

You can get the permutations (with repetition) of the parameters values by doing:

@unishark.data_driven(...)
@unishark.data_driven(...)
@unishark.data_driven(...)
...

For more information please visit the Project_Home and read README.md.

CHANGELOG

0.2.0 (2015-04-04)

  • support running tests in parallel.
  • support configuring test suites, test reporters and concurrent tests in a single dict/yaml config.
  • improve HtmlReporter and XUnitReporter classes to be thread-safe.
  • allow user to generate reports with their own report templates.
  • allow user to filter loaded test cases by setting method name prefix in the test config.
  • bugs fix.
  • improve documentation.

0.1.2 (2015-03-25)

  • hotfix for setup.py (broken auto-downloading dependencies)
  • bugs fix.

0.1.1 (2015-03-24)

  • support loading customized test suites.
  • support a thread-safe string io buffer to buffer logging stream during the test running.
  • support writing logs, exceptions into generated HTML/XUnit reports.
  • offer a data-driven decorator.
  • initial setup (documentation, setup.py, travis CI, coveralls, etc.).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for unishark, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size unishark-0.2.0.tar.gz (17.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page