subunitdetails 0.0.1

SubUnit is a streaming protocol for test results. The protocol is a binary encoding that is easily generated and parsed. By design all the components of the protocol conceptually fit into the xUnit TestCase -> TestResult interaction.

Details may be attached from a TestCase, using the testtools library (extension to Python’s standard unittest lib). They will end up as attachments to the TestResult. Using subunit, the detail attachments may be of any format and mime-type, and can be parsed and retrieved.

Given a binary subunit stream stored as a file, the subunitdetails script will extract test detail attachments and save them individually to the filesystem.

• Invoke the subunitdetails script, with a subunit file name as an argument:

  $ subunitdetails <subunit_file>

subunit-details uses standard python packaging via setuptools.

There are a few options to choose from for installing:

• install from PyPI, system-wide:

  $ sudo pip install subunit-details

• install from PyPI, using a virtualenv:

  $ virtualenv -p python3 .env
  $ source .env/bin/activate
  $ pip install subunit-details

• clone the dev repository and install, system-wide:

  $ git clone https://github.com/cgoldberg/subunit-details.git
  $ cd subunit-details
  $ sudo python3 setup install

• clone the dev repository and install, using a virtualenv:

  $ git clone https://github.com/cgoldberg/subunit-details.git
  $ cd subunit-details
  $ virtualenv -p python3 .env
  $ source .env/bin/activate
  $ python3 setup install