Hosta

by | Mar 16, 2018 | Hosta

How Can We Help?
You are here:
< Back

Roundup is an open-source issue or bug tracking system featuring a command-line, web and e-mail interface. It is written in Python and designed to be highly customizable[1]. Roundup was designed by Ka-Ping Yee for the Software Carpentry project and is currently being developed under the direction of Richard Jones. It is currently the issue tracker for the Python programming language itself[2].

Features

The standard configuration of Roundup features:

  • a web interface for viewing, editing and searching issues
  • a Mail gateway allowing creation and changing of issues[3]
  • a database abstraction layer, currently supporting (among others) Python's built-in "anydbm" module, PostgreSQL, MySQL and SQLite
  • issue-specific "nosy lists", used for e-mail notifications and conversation (each issue effectively becoming a mini mailing list) [4]
  • an authorization system[5], based on roles (of users), classes and objects
  • an interactive shell for backup and restore tasks and for manipulation of objects

Roundup runs as a daemon process, CGI script[6] or alternatively using mod_python.

Concepts

Roundup is customized by changing the contents of the tracker instance directory:

Database schema

The database schema is defined in a Python file in the tracker instance's root directory; it is re-read whenever the server is started anew. When changes are found (e.g. new attributes), the tables of the underlying RDBS are altered accordingly.

Page templates

Roundup uses the Template Attribute Language (TAL) known from Zope to create HTML or XHTML output. Some templates are used for several classes, e.g. _generic.index.html, which allows (authorized) users to change the objects of all classes which lack an own index template.

When an „issue123“ is requested, this designator is split in the issue class and the id „123“[7]. By default an „item“ template is chosen: First, an issue.item.html template file is looked for; if it can't be found, _generic.item.html is used as a fallback option. If this is missing equally, an error occurs.

Detectors

Many Roundup functions, including some of the standard functionality, are implemented using so-called detectors[8], which are located in the "detectors" sub-directory of the tracker instance. They are Python subroutines which have access to the object to change (if already created) and the requested attribute changes.

Detectors are distinguished between auditors and reactors. Auditors are used primarily for several automatic changes (in the standard configuration, the assignedto user is automagically added to the nosy list of the issue), and to refuse un-allowed changes; reactors are executed thereafter and used e.g. for the e-mail notification feature, sending notification mails to all users interested in a certain issue when a comment is added to it.

Detectors are triggered whenever one of the actions

  • create
  • set (change of attributes)
  • retire
  • restore

is requested. They can be used to create an elaborated custom workflow.

Extensions

The instance subdirectory „extensions“ can hold additional files which are needed for extended functionalities which can't (conveniently) be done with TAL; even totally new actions are possible.

Python modules which are used by both detectors and extensions can be put in the „lib“ subdirectory

See also

References

  1. ^ The primary user interface is the web interface. A so-called classic tracker template is distributed as the standard template and data structure set, but can be used as a starting point for customization
  2. ^ TrackerDocs - PythonInfo Wiki
  3. ^ E-Mail User Interface, Roundup design description
  4. ^ Design of Nosy Lists
  5. ^ access control, Roundup design description
  6. ^ usage via CGI is rare and not recommended, for performance reasons
  7. ^ identifiers and designators, Roundup design description
  8. ^ detector interface, Roundup design description

External links

Categories
Table of Contents