https://github.com/cgoldberg/subunitdetails
SubUnit Details Parser - Test Detail attachment extractor
https://github.com/cgoldberg/subunitdetails
Last synced: 8 months ago
JSON representation
SubUnit Details Parser - Test Detail attachment extractor
- Host: GitHub
- URL: https://github.com/cgoldberg/subunitdetails
- Owner: cgoldberg
- Created: 2014-07-02T17:35:51.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-07-03T13:46:14.000Z (over 11 years ago)
- Last Synced: 2024-04-23T22:09:34.355Z (over 1 year ago)
- Language: Python
- Homepage: https://pypi.python.org/pypi/subunitdetails/
- Size: 152 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
===============
subunitdetails
===============
Requires:
- Python 3.x
- python-subunit
- testtools
Author:
- Corey Goldberg, 2014
++++
About subunitdetails:
----------------------
``subunitdetails`` takes a binary encoded ``subunit`` stream, and extracts test details (content object attachments) and saves them to the filesystem.
Using subunitdetails to extract content object attachments:
-----------------------------------------------------------
Invoke the ``subunitdetails`` script, with a ``subunit`` file name as an argument. It will extract the embedded content objects (test details) from the ``subunit`` result, into the current directory::
$ subunitdetails
++++
About SubUnit:
--------------
`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.
About Test Details:
-------------------
`Details `_ are MIME-based `content objects `_ that may be attached to a ``TestCase``. This is done using the `testtools `_ library (extensions to Python's standard ``unittest`` lib). It allows you to attach any information that you could possibly conceive of to a test, and allows ``testtools`` to use or serialize that information.
Using ``subunit``, the encoded stream can be parsed. Test suite results and attached Details (with MIME-types) can then be retrieved.
Installing subunitdetails:
------------------------------
`subunit-details `_ uses standard python packaging via `setuptools `_.
There are a few ways to install ``subunitdetails``.
* Install from `PyPI `_ using `pip `_ (system-wide)::
$ sudo pip install subunitdetails
* Install from `PyPI `_ using `pip `_, into a `virtualenv `_:::
$ virtualenv -p python3 .env
$ source .env/bin/activate
$ pip install subunitdetails
* Clone the dev repository and install, using a virtualenv::
$ git clone https://github.com/cgoldberg/subunitdetails.git
$ cd subunitdetails
$ virtualenv -p python3 .env
$ source .env/bin/activate
$ python3 setup install