3.1. unitth package

3.1.1. Submodules

3.1.2. unitth.__main__ module

class unitth.__main__.App(label=None, **kw)[source]

Bases: cement.core.foundation.App

Command line application

class Meta[source]

Bases: object

base_controller = 'base'[source]
handlers = [<class 'unitth.__main__.BaseController'>][source]
label = 'unitth'[source]
class unitth.__main__.BaseController(*args, **kw)[source]

Bases: cement.ext.ext_argparse.ArgparseController

Base controller for command line application

class Meta[source]

Bases: object

arguments = [(['-v', '--version'], {'action': 'version', 'version': '0.0.14'}), (['xml_report_dir'], {'type': <class 'str'>, 'help': 'Parent directory of XML reports of individual builds to generate a history report of'}), (['--xml-report-filter'], {'type': <class 'str'>, 'default': 'TEST-', 'nargs': '?', 'help': 'Starts-with filter for individual reports with `xml-report-dir` that should be included in the history report. Set `xml-report-filter` to to include all files/subdirectories in the history report.'}), (['--html-report-path'], {'type': <class 'str'>, 'default': '.', 'help': 'Directory of HTML reports of individual builds(relative to XML directories of individual builds)'}), (['--generate-exec-time-graphs'], {'type': <class 'bool'>, 'default': True, 'help': 'Whether execution time graphs shall be generated'}), (['--html-report-dir'], {'type': <class 'str'>, 'default': 'report.th', 'help': 'directory to store generated HTML history report'}), (['--initial_java_heap_size'], {'type': <class 'str'>, 'default': None, 'help': 'Initial Java heap size'}), (['--maximum_java_heap_size'], {'type': <class 'str'>, 'default': None, 'help': 'Maximum Java heap size'})][source]
description = 'Generate HTML unit test history report'[source]
label = 'base'[source]
unitth.__main__.main()[source]

3.1.3. unitth.core module

UnitTH python interface

Author:Jonathan Karr <karr@mssm.edu>
Date:2017-08-04
Copyright:2016, Karr Lab
License:MIT
class unitth.core.UnitTH[source]

Bases: object

UnitTH python interface

static run(xml_report_dir, xml_report_filter='TEST-', html_report_path='.', generate_exec_time_graphs=True, html_report_dir='report.th', initial_java_heap_size=None, maximum_java_heap_size=None)[source]

Use UnitTH to generate a test history report

Parameters:
  • xml_report_dir (str) – Parent directory of XML reports of individual builds to generate a history report of
  • xml_report_filter (str, optional) – Starts-with filter for individual reports with xml_report_dir that should be included in the history report. Set xml_report_filter to ‘’ to include all files/subdirectories in the history report.
  • html_report_path (str, optional) – Directory of HTML reports of individual builds (relative to XML directories of individual builds)
  • generate_exec_time_graphs (bool, optional) – Whether execution time graphs shall be generated
  • html_report_dir (str, optional) – directory to store generated HTML history report
  • initial_java_heap_size (str, optional) – initial Java heap size
  • maximum_java_heap_size (str, optional) – maximum Java heap size

3.1.4. Module contents