Skip to content

Request Tracker plugin for Errbot. Given a ticket ID, get RT ticket metadata

License

Notifications You must be signed in to change notification settings

alimac/err-request-tracker

Repository files navigation

Build Status Coverage Status

Request Tracker plugin for Errbot

Request Tracker is a plugin for Errbot a Python-based chat bot. The plugin allows you to query tickets in RT: Request Tracker, an issue tracking system.

Requirements

This plugin uses python-rt - the Python interface to Request Tracker API.

sudo pip install rt

Installation

In a private chat with your bot:

!repos install https://github.com/alimac/err-request-tracker.git

Configuration

err-request-tracker requires four variables to be configured:

  • REST_URL - the URL to be used to make REST calls to the RT API (example: http://localhost/REST/1.0)
  • DISPLAY_URL - the URL to view a ticket (example: https://localhost/Ticket/Display.html?id=)
  • USER - username used to log in
  • PASSWORD - password user to log in
  • MINIMUM_TICKET_ID - optional minimum ticket value for ticket searches (helps to avoid triggering the bot on every numerical value posted in chat)

An example configuration might look like:

!plugin config RT
{ "REST_URL" : "http://rt.example.com/REST/1.0",
  "USER" : "err",
  "PASSWORD" : "foo",
  "DISPLAY_URL" : "https://rt.example.com/Ticket/Display.html?id=",
  "MINIMUM_TICKET_ID" : 100000 }

Usage

Enter a ticket number or full URL in the chat:

1173397
is anyone working on 1173397?
https://rt.example.com/Ticket/Display.html?id=1173397

Bot will reply with the ticket subject, URL, queue and requestor(s):

Website is down! (https://rt.example.com/Ticket/Display.html?id=1173397) in
General from customer@example.com

For backends that support HTML display, the reply might look like:

Website is down! in General from customer@example.com

Updates

To update the plugin, tell your bot in private chat:

!repos update err-request-tracker

Development

The test suite for this plugin makes use of environment variables to set the URLs and RT credentials:

  • RT_REST_URL
  • RT_DISPLAY_URL
  • RT_USER
  • RT_PASSWORD

These environmental variables correspond to the plugin configuration variables (by setting environment variables, you can provide credentials to a continuous integration service like Travis or Circle.

Acknowledgements

Easter Eggs hosts a demo instance of RT which I used in developing tests for this plugin.

About

Request Tracker plugin for Errbot. Given a ticket ID, get RT ticket metadata

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages