GNATS Query Plugin

This plugin allows you to directly query the GNATS bug report database. Based on the similar TWiki:Plugins.BugzillaQueryPlugin.

Syntax Rules

• Retrieve the data for a single BR and display using the default FORMAT setting
  • Syntax: %BRQ{"652"}%

    Parameter	Description	Default
    "123"	A valid GNATS bug report number

• Retrieve the data for one or more BRs matching the query expression
  • Syntax: %BRQ{expr="(Number>'650')" format="'| %s | %s |' Number Synopsis"}%

    Parameter	Description	Default
    expr	A valid GNATS query expression. See below
    format	A valid GNATS format. See below

Syntax and variables in 'expr' attribute

Query expressions are used to select specific BRs based on their field contents. The general form is

  fieldname|'value' operator fieldname|'value' [booleanop ...] 

¦ [OR], or & [AND]. 

Query expression examples

• The query expression Category='baz' | Responsible='blee' selects all BRs with a Category field of baz or a Responsible field of blee. The not operator ! may be used to negate a test: ! Category='foo' searches for BRs where the Category is not equal to the regular expression foo.

• Parenthesis may be used to force a particular interpretation of the expression: !(Category='foo' & Submitter-Id='blaz') skips BRs where the Category field is equal to foo and the Submitter-Id field is equal to blaz. Parenthesis may be nested to any arbitrary depth.

• Fieldnames can be specified in several ways. The simplest and most obvious is just a name: Category='foo' checks the value of the Category field for the value foo. A fieldname qualifier may be prepended to the name of the field; a colon is used to separate the qualifier from the name. To refer directly to a builtin field name: builtin:Number='123'. In this case, Number is interpreted as the builtin name of the field to check. (This is useful if the fields have been renamed).

• To scan all fields of a particular type, the fieldtype qualifier may be used: fieldtype:Text='bar' searches all text fields for the regular expression bar. Note that it is not necessary that the right-hand side of the expression be a literal string.

• To query all BRs where the BR has been modified since it was closed, the expression Last-Modified = Closed-Date will work; for each BR, it compares the value of its Last-Modified field against its Closed-Date field, and returns those BRs where the values differ. However, this query will also return all BRs with empty Last-Modified or Closed-Date fields. To further narrow the search: Last-Modified = Closed-Date & Last-Modified = '' & Closed-Date = ''

• In general, comparing fields of two different types (an integer field against a date field, for example) will probably not do what you want.

• Also, a field specifier may be followed by the name of a subfield in braces: State[type] = 'closed' or even builtin:State[type] = 'closed'

Syntax and variables in 'format' attribute

Printing formats for BRs are in one of three forms:

Examples

• %BRQ{"652"}%

• %BRQ{expr="(Number='352')" format="full"}%

• %BRQ{expr="(Number='352')" format="standard"}%

• %BRQ{expr="(Number='350')" format="Description"}%

• %BRQ{expr="(Number='555')" format="summary"}%

• %BRQ{expr="(Number>'650')" format="'| BR#%s | %s |' Number Synopsis"}%

Plugin Settings

• Set URL = http://twiki.org/cgi-bin/view/GNATSQueryPlugin
• Set FORMAT = full
• Set SHORTDESCRIPTION = Display query results from the GNATS bug report database
• Set GNATS_DB_HOST = gnats
• Set GNATS_DB_PORT = 1529
• Set GNATS_DB_NAME = bugs
• Set DEBUG = 0

Plugin Installation Instructions

• Install the GNATS query-pr tool on the TWiki server
• Download the ZIP file from the Plugin web (see below)
• Unzip GNATSQueryPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/GNATSQueryPlugin.txt	Plugin topic
  data/TWiki/GNATSQueryPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/GNATSQueryPlugin.pm	Plugin Perl module

• Edit the GNATSQueryPlugin to your needs changing the path to query-pr

NOTE!

I (RobertInder) got around this by editing GNATSQueryPlugin.pm and replacing line 296...

  $result = `$queryBin -H $dbHost --port $dbPort --database $dbName --expr \'$expr\' --format \'$format\' 2>&1`;

  if ($dbHost eq 'localhost') {
     $result = `$queryBin --database $dbName --expr \'$expr\' --format \'$format\' 2>&1`;
  } else {
     $result = `$queryBin -H $dbHost --port $dbPort --database $dbName --expr \'$expr\' --format \'$format\' 2>&1`;
  }
  return $result;
}

Plugin Info

Plugin Author:	TWiki:Main.NiallMurray
Plugin Version:	16 Nov 2005 (V1.000)
Change History:
16 Nov 2005:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	none
Other Dependencies:	GNATS query-pr tool
Perl Version:	5.005
License:	GPL (GNU General Public License)
Benchmarks:	GoodStyle 99%, FormattedSearch 99%, GNATSQueryPlugin 83%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/GNATSQueryPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/GNATSQueryPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/GNATSQueryPluginAppraisal

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main.NiallMurray - 16 Nov 2005