fbtcmd.pl

Commandline tool to interface with Alcea Fast BugTrack.

This tool uses the Alcea Fast BugTrack SOAP interface to query, create and update issues within the system. It is built on top of Perl, SOAP::Lite, and optionally Text::ASCIITable.

Release notes:

This tool is incomplete and should be considered development quality. Back-up your Fast BugTrack system before using this tool. There is no warranty that this will work.

Syntax:

<options> are:
TBD

Examples:

Update bug 5 updating the status to "Ready For Retest":
fbtcmd.pl update --mId=5 --mStatus="Ready For Retest" --mDescription="Here is a description..."

Create a new bug:
fbtcmd.pl create --mSubject="Problem with code" --mAssignedTo="cjustus" --mDescription="There is a problem with the code at line 123... Please investigate immediately" --mStatus=Open --mProject="Project 1"

Query all bugs assigned to cjustus - retrieving id, subject, and priority:
fbtcmd.pl getList --mAssignedTo=cjustus --mColumn=mId --mColumn=mSubject --mColumn=mPriority

cvsupdate.pl

Commandline tool to tie cvs loginfo with fbtcmd.pl.

This tool is called by cvs, parses messages out of the commit log, and updates Alcea Fast BugTrack. It is dependent on fbtcmd.pl.

Release notes:

This tool is incomplete and should be considered development quality. Back-up your Fast BugTrack system before using this tool. There is no warranty that this will work.

Integrating Alcea Fast BugTrack with CVS and CVSWEB.CGI:

Alcea has created a set of scripts that allows a developer, when checking in changes to CVS, to enter .bug 123, 456, 789. in the cvs commit comments, which will:

• Automatically update the specified bugs, adding links to a cvsweb tool as well as the commit comments to the bug description.
• Re-assigning the bug (and updating the status as well).
• Trigger FBT's notification logic.

These scripts are provided without warranty. They are should be considered development quality (vs. production quality) . They will be changing, and will improve over time. Use at your own risk.

Requirements:

On the CVS server:

• fbtcmd.pl -- a command-line interface to Alcea Fast BugTrack (which in turn requires)
  • Perl
  • SOAP::Lite
• cvsupdate.pl -- a perl program which parses cvs commitinfo data, and calls fbtcmd.pl
• cvsweb.cgi -- if you want to allow links from Fast BugTrack to a web interface of your CVS installation so that you can quickly view differences in what has been commited.

On your Alcea Fast BugTrack server:

• A recent version of Alcea Fast BugTrack (version 4.24 and up)
• Soap Enabled (Admin Menu->SOAP . check enable . for security purposes you might want to put the IP address of your CVS server to prevent soap calls from other machines).

Steps:

1. Ensure that fbtcmd.pl can communicate with Fast BugTrack

   Edit fbtcmd.pl so that SERVICE points to your Fast BugTrack installation. Test by running:

   fbtcmd.pl getId 1

   You should see the details of bug#1 in your system, in xml format.

   Edit cvsupdate.pl so that it points to the full path to fbtcmd.pl . you will likely want to update the SERVICE variable as well to point to your installation of Fast BugTrack.

2. Configure your cvs installation so that it is calling cvsupdate.pl, and that cvsupdate.pl is calling fbtcmd.pl

   Check out your CVSROOT module from CVS. (cvs co CVSROOT)

   Edit the file loginfo, adding the following:
   DEFAULT (id .un; echo %{sVv}; date; cat) | /usr/local/bin/cvsupdate.pl

   (Note you can replace DEFAULT with a specific CVS module name . this might be handy to run this initially on a module for testing purposes)

   Commit this change.

3. Configure Alcea Fast BugTrack to point to your cvsweb location

   In the Fast BugTrack directory . edit the file lang.cfg
   Add the following lines:

   sCVSWEB,http://cvswebserver/cgi-bin/cvsweb.cgi
   sCVSWEBOPT,&f=h

   Where http://cvswebserver/cgi-bin/cvsweb.cgi is the path to your cvsweb.cgi script.

4. End to end test:

   In a module that is covered by your CVSROOT/loginfo update, make a change and commit . In the comments include .bug 1. in the commit comment. Bug 1 should be reassigned to the creator, and links to cvsweb should be included in the update.