Download

Current version: 0.3.3

NoseXUnit on Sourceforge

Report bugs, request features, browse source...

See

• python-nose
  The nose project.
• coverage
  Code coverage.
• PyLint
  Code checker.
• JUnit XML Schema
  Schema of the JUnit standard output.
• Hudson, Bamboo
  Interesting test reports.

NoseXUnit: JUnit like XML reporting for PyUnit

NoseXUnit provide a convenient way to produce JUnit like XML reports with PyUnit. It also provides code coverage and audit features with beautiful reports generation.

Backgroud

On the one hand, most of complex applications mix different languages and frameworks. On the other hand, test frameworks don't provide standard outputs. This makes difficult to generate an overall report of the tests for your aplication. However, some Java tests frameworks like JUnit with Surefire outputs convenient test report in a simple XML format. This makes further processing simple and convenient for softwares. For example, Hudson and Bamboo creates interesting reports thanks these XML reports.

Our goal is to provide a way to produce test reports in this simple XML format with PyUnit.

Install

NoseXUnit is a plugin for python-nose. Nose is a convenient way to play your PyUnit test.

Install NoseXUnit using setuptools:

easy_install NoseXUnit

NoseXUnit depends on:

• nose,
• pylint, logilab-common and logilab-astng to check the code,
• coverage for code coverage,
• kid and pygments for reports generations.

Install of logilab-common, logilab-astng and pylint doesn't seem to work properly with setuptools. You may have to download them separately and install them with the old fashioned way before installing NoseXUnit.

nosetests --with-nosexunit [options] [(optional) test files or directories]

nosetests --with-nosexunit --source-folder=PATH --enable-audit [options] [(optional) test files or directories]

def foo():
    exec('a=1')
    print a      # pylint: disable-msg=E0602

nosetests --with-nosexunit --source-folder=PATH --enable-cover [options] [(optional) test files or directories]

def foo():
    print "hello"      # pragma: no cover

nosetests [options] --extra-include foo1 --extra-include foo2

NoseXUnit Usage

NoseXUnit launch options can be display by running:

nosetests --help

  --with-nosexunit      Enable plugin NoseXUnit: Output XML report of test
                        status [NOSE_WITH_NOSEXUNIT]
  --core-target=CORE_TARGET
                        Output folder for test reports (default is
                        target/NoseXUnit/core).
  --source-folder=SOURCE
                        Set source folder (optional for core functionality,
                        required for audit and coverage). Add folder in
                        sys.path.
  --search-source       Walk in the source folder to add deeper folders in
                        sys.path if they don't contain __init__.py file. Works
                        only if --source-folder is defined.
  --search-test         Search tests in folders with no __init__.py file
                        (default does nothing).
  --extra-include=EXTRA_INCLUDE
                        Include packages for audit or coverage processing
                        (default: take all packages in --source-folder, except
                        those defined in --extra-exclude).
  --extra-exclude=EXTRA_EXCLUDE
                        Exclude packages for audit or coverage processing
                        (default: ez_setup, setup). Useless if --extra-include
                        defined.
  --extra-test-process  Include packages matching the test pattern in audit or
                        coverage processing (default: no).
  --enable-audit        Use PyLint to audit source code (default: no)
  --audit-target=AUDIT_TARGET
                        Output folder for PyLint reports (default is
                        target/NoseXUnit/audit).
  --audit-output=AUDIT_OUTPUT
                        Output for audit reports: nosexunit, parseable, text,
                        colorized, html, msvs (default: nosexunit).
  --audit-config=AUDIT_CONFIG
                        Configuration file for PyLint (optional).
  --enable-cover        Use coverage to audit source code (default: no)
  --cover-target=COVER_TARGET
                        Output folder for coverage reports (default is
                        target/NoseXUnit/cover).
  --cover-clean         Clean previous coverage results (default: no).
  --cover-collect       Collect other coverage files potentially generated in
                        cover target folder. These extra files should have the
                        following pattern: .coverage.* (default: no).

Bug reports

Please report bugs and make feature requests here.

Changelog

0.3.3

• Degraded mode for multiprocess test runner (--processes option in nose),
• ID 2738914: Catch all sys.exit of PyLint,
• ID 2784278: Allow unicode strings in standard and error outputs,
• ID 2681443: Allow sources to be read only.

0.3.2

• ID 2184206: Include or exclude packages for audit or coverage (options --extra-include and --extra-exclude),
• Consider or not packages matching the test pattern (option --extra-test-process),
• Audit and coverage can be played together (PyLint started in another process).

0.3.1

• Generate a Clover style XML report,
• Generate a Cobertura style XML report,
• Add --cover-collect to collect extra coverage file.

0.3.0c1

• Compatibility with nose 0.10.4,
• PyLint reporting,
• Coverage reporting,
• ID 2078051: Support ContextSuite object with no id attribute in Plugin.startTest,
• Option --xml-report-folder replaced by --core-target,
• Option --recursive replaced by --search-source.

0.2.0c1

• Compatibility with nose 0.10.0a2,
• tb_info and capt removed from XTest (no more available with nose),
• Signature of addSuccess, addFailure and addError modified,
• Entry point modification.

0.2.0a1

• Compatibility with nose 0.10.0a1,
• Create an XML output for each test module.

0.1.0

• First version.