ProctorTicket v0.4
Copyright (c) 2008 Zachary Voase <cracka80@gmail.com>
About
ProctorTicket is an application, written in Python, which allows you to read a parseable proctor output log, or run a proctor test, and import all generated errors as Trac tickets. Tickets are the equivalent of issues, tasks or bugs in other software project management systems. ProctorTicket will determine the test class each error belongs to and group them accordingly. In addition, ProctorTicket can tell when a test has already been carried out, and it will not add the issue. If a test has been carried out before but the results vary, then it will automatically update the tickets to reflect this.
ProctorTicket was created as part of the Google Highly Open Participation Contest, and can be found at http://code.google.com/p/proctorticket.
Installation
To install ProctorTicket, ensure that:
- You have the latest versions of both Proctor and Trac installed.
- You have a Trac environment already set up in a directory which you can write to.
- The executable proctorbatch is available on your system path variable.
- The modules trac and proctorlib can both be imported from your Python interpreter.
To install, just type:
sudo python setup.py install
from the directory to which you extracted the tarball or checked out the latest revision from Google Code SVN.
Usage
The command line interface to ProctorTicket, named proctorticket surprisingly enough, was written using optparse, so it has extensive documentation just by typing proctorticket --help at the command line. All of the functions and classes in the Python API have docstrings, so you can explore those from the interpreter or browse the included documentation, which was generated by epydoc.
An example of usage may be the following:
proctorticket --keywords --log-file=example.log --env-path=/usr/share/trac \
--reporter=zvoase --update proctor tracWhat this just did was:
- Specified that there were going to be keywords coming up after all of the options.
- Used the Proctor output log file example.log.
- Used the Trac installation housed at /usr/share/trac.
- Set the reporter of all of the generated issues to 'zvoase'.
- Set the keywords to 'proctor' and 'trac'.
- Told ProctorTicket that, should it find that the same test class has already been carried out, but there are differences, it should update the pre-existing ticket to reflect the changes.
Play around with the --help option and see what else you can find.
