Fix for Bug 220724: Provide standalone bug submission program. Includes

a python script that submits bugs to a specified Bugzilla instance. README, docs and an example bug are included. Work done by Eric Raymond <esr@thyrsus.com> and myself. a=justdave

Fix for Bug 220724: Provide standalone bug submission program. Includes
4d5799ba · kiko%async.com.br · 5a0e0a77 · 4d5799ba · 4d5799ba · 4d5799ba
Commit 4d5799ba authored Oct 31, 2003 by kiko%async.com.br
9 changed files
--- a/contrib/README
+++ b/contrib/README
@@ -5,8 +5,11 @@ be useful to you.

 This directory includes:

+       bug-bugzilla/ --  A standalone bug submission script.
+
   mysqld-watcher.pl --  This script can be installed as a frequent cron 
                         job to clean up stalled/dead queries.
+
         gnats2bz.pl --  A perl script to help import bugs from a GNATS 
                         database into a Bugzilla database.  Contributed by
                         Tom Schutter <tom@platte.com>
@@ -20,6 +23,7 @@ This directory includes:
 
        yp_nomail.sh --  Script you can run via cron that regularly updates
                         the nomail file for terminated employees 
+
 bugzilla_ldapsync.rb --  Script you can run via cron that queries an LDAP
                         server for e-mail addresses to add Bugzilla users
                         for. Will optionally disable Bugzilla users with

--- a/contrib/bug-bugzilla/README
+++ b/contrib/bug-bugzilla/README
+Bug-Bugzilla
+============
+
+Authors: Christian Reis <kiko@async.com.br>
+         Eric Raymond <esr@thyrsus.com>
+
+Bug-Bugzilla is a simple Python program that creates bugs in a Bugzilla
+instance. It takes as input text resembling message headers (RFC-822
+formatted) via standard input, or optionally a number of commandline
+parameters. It communicates using HTTP, which allows it to work over a
+network.
+
+Requirements
+------------
+
+Its only requirement is Python 2.3 or higher; you should have the
+"python" executable in your path.
+
+Usage Notes
+-----------
+
+* Please constrain testing to your own installation of Bugzilla, or use
+* http://landfill.bugzilla.org/ for testing purposes -- opening test
+* bugs on production instances of Bugzilla is definitely not a good idea
+
+Run "bug-bugzilla --help" for a description of the possible options.
+
+An example input file, named bugdata.txt, is provided. You can pipe it
+in as standard input to bug-bugzilla, providing a Bugzilla URI through
+the command-line.
+
+Note that you must create a ~/.netrc entry to authenticate against the
+Bugzilla instance. The entry's machine field is a *quoted* Bugzilla URI,
+the login field is your ID on that host, and the password field is the
+your password password. An example entry follows:
+
+    machine "http://bugzilla.mozilla.org/"
+    login foo@bar.loo
+    password snarf
+
+Documentation
+-------------
+
+Documentation for bug-bugzilla is provided in Docbook format; see
+bug-bugzilla.xml.
+
--- a/contrib/bug-bugzilla/bug-bugzilla
+++ b/contrib/bug-bugzilla/bug-bugzilla
--- a/contrib/bug-bugzilla/bug-bugzilla.xml
+++ b/contrib/bug-bugzilla/bug-bugzilla.xml
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentry PUBLIC 
+   "-//OASIS//DTD DocBook XML V4.1.2//EN"
+   "docbook/docbookx.dtd">
+<refentry id='bug-bugzilla.1'>
+<refmeta>
+<refentrytitle>bug-bugzilla</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo class='date'>Oct 30, 2003</refmiscinfo>
+</refmeta>
+<refnamediv id='name'>
+<refname>bug-bugzilla</refname>
+<refpurpose>post bugs to a Bugzilla instance</refpurpose>
+</refnamediv>
+<refsynopsisdiv id='synopsis'>
+
+<cmdsynopsis>
+  <command>bug-bugzilla</command>
+  <arg choice='opt'>--status <replaceable>bug_status</replaceable></arg>
+  <arg choice='opt'>--url <replaceable>bug_file_loc</replaceable></arg>
+  <arg choice='opt'>--product <replaceable>product</replaceable></arg>
+  <arg choice='opt'>--version <replaceable>version</replaceable></arg>
+  <arg choice='opt'>--component <replaceable>component</replaceable></arg>
+  <arg choice='opt'>--summary <replaceable>short_desc</replaceable></arg>
+  <arg choice='opt'>--hardware <replaceable>rep_platform</replaceable></arg>
+  <arg choice='opt'>--os <replaceable>op_sys</replaceable></arg>
+  <arg choice='opt'>--priority <replaceable>priority</replaceable></arg>
+  <arg choice='opt'>--severity <replaceable>bug_severity</replaceable></arg>
+  <arg choice='opt'>--assigned-to <replaceable>assigned-to</replaceable></arg>
+  <arg choice='opt'>--cc <replaceable>cc</replaceable></arg>
+  <arg choice='opt'>--keywords <replaceable>keywords</replaceable></arg>
+  <arg choice='opt'>--depends-on <replaceable>dependson</replaceable></arg>
+  <arg choice='opt'>--blocked <replaceable>blocked</replaceable></arg>
+  <arg choice='opt'>--description <replaceable>comment</replaceable></arg>
+  <arg choice='opt'>--no-read </arg>
+  <arg choice='plain'><replaceable>bugzilla-url</replaceable></arg>
+</cmdsynopsis>
+
+</refsynopsisdiv>
+
+<refsect1 id='description'><title>DESCRIPTION</title>
+
+<para><application>bug-bugzilla</application> is a command-line tool
+for posting bug reports to any instance of Bugzilla.  It accepts on
+standard input text resembling an RFC-822 message.  The headers of
+that message, and its body, are used to set error-report field values.
+More field values are merged in from command-line options. If required
+fields have not been set, <application>bug-bugzilla</application>
+tries to compute them.  Finally, the resulting error report is
+validated.  If all required fields are present, and there are no
+illegal fields or values, the report is shipped off to the Mozilla
+instance specified by the single positional argument.  Login/password
+credentials are read from the calling user's <filename>~/.netrc</filename> 
+file.</para>
+
+<para>The program accepts the following options to set or override fields:</para>
+<variablelist>
+<varlistentry>
+<term>-b. --bug-status</term>
+<listitem>
+<para>Set the bug_status field, overriding the Status header from
+standard input if present.  (The stock Bugzilla web presentation
+identifies this field as <quote>Status</quote>.)</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-u, --url</term>
+<listitem>
+<para>Set the bug_file_loc field, overriding the URL header from
+standard input if present. (The stock Bugzilla web presentation
+identifies this field as <quote>URL</quote>.)</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-p, --product</term>
+<listitem>
+<para>Set the product field, overriding the Product header from
+standard input if necessary.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-v, --version</term>
+<listitem><para>Set the version field, overriding the Version header
+from standard input if necessary.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-c, --component</term>
+<listitem><para>Set the component field, overriding the Component header
+from standard input if necessary.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-s, --summary</term>
+<listitem><para>Set the short_desc field, overriding the Summary header
+from standard input if necessary. (The stock Bugzilla web presentation
+identifies this field as <quote>Summary</quote>.)</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-H, --hardware</term>
+<listitem><para>Set the rep_platform field, overriding the Hardware header
+from standard input if necessary. (The stock Bugzilla web presentation
+identifies this field as <quote>Hardware</quote>.)</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-o, --os</term>
+<listitem><para>Set the op_sys field, overriding the Operating-System header
+from standard input if necessary. (The stock Bugzilla web presentation
+identifies this field as <quote>OS</quote>.)</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-r, --priority</term>
+<listitem><para>Set the priority field, overriding the Priority header
+from standard input if necessary.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-x, --severity</term>
+<listitem><para>Set the severity field, overriding the Severity header
+from standard input if necessary.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-d, --description</term>
+<listitem><para>Set the comment field, overriding the Description header
+from standard input if necessary. (The stock Bugzilla web presentation
+identifies this field as <quote>Description</quote>.)  If there is a
+message body and no Description field and this option is not
+specified, the message body is used as a description.
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-a, --assigned-to</term>
+<listitem>
+<para>Set the optional assigned_to field, overriding the Assigned-To
+header from standard input if necessary.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-C, --cc</term>
+<listitem>
+<para>Set the optional cc field, overriding the Cc
+header from standard input if necessary.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-k, --keywords</term>
+<listitem>
+<para>Set the optional keywords field, overriding the Keywords
+header from standard input if necessary.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-D, --depends-on</term>
+<listitem>
+<para>Set the optional dependson field, overriding the Depends-On
+header from standard input if necessary.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-B, --assigned-to</term>
+<listitem>
+<para>Set the optional blocked field, overriding the Blocked
+header from standard input if necessary.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-n, --no-stdin</term>
+<listitem><para>Suppress reading fields from standard input.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-h, --help</term>
+<listitem><para>Print usage help and exit.</para></listitem>
+</varlistentry>
+</variablelist>
+
+<para>This program will try to deduce OS and Hardware if those are not
+specified.  If it fails, validation will fail before shipping the
+report.</para>
+
+<para>There is expected to be a single positional argument following
+any options. It should be the URL of the Bugzilla instance to which
+the bug is to be submitted.</para>
+
+</refsect1>
+<refsect1 id='files'><title>FILES</title> 
+<variablelist>
+<varlistentry>
+<term><filename>~/.netrc</filename></term>
+<listitem><para>Must contain an entry in which the machine field is
+the Bugzilla instance URL, the login field is your ID on that host, and the 
+password field is the right password.  The URL in the machine field
+must be enclosed in double quotes.</para></listitem>
+</varlistentry>
+</variablelist>
+
+</refsect1>
+<refsect1 id='author'><title>AUTHORS</title> 
+<para>Christian Reis &lt;kiko@async.com.br&gt;, Eric S. Raymond
+&lt;esr@thyrsus.com&gt;.</para> 
+</refsect1> 
+</refentry>
+
--- a/contrib/bug-bugzilla/bugdata.txt
+++ b/contrib/bug-bugzilla/bugdata.txt
+Product: FoodReplicator
+Component: Salt
+Version: 1.0
+Priority: P2
+Hardware: PC
+OS: Linux
+Severity: critical
+Summary: Impending electron shortage
+
+We need an emergency supply of electrons.
+
--- a/contrib/bugzilla-submit/README
+++ b/contrib/bugzilla-submit/README
+Bug-Bugzilla
+============
+
+Authors: Christian Reis <kiko@async.com.br>
+         Eric Raymond <esr@thyrsus.com>
+
+Bug-Bugzilla is a simple Python program that creates bugs in a Bugzilla
+instance. It takes as input text resembling message headers (RFC-822
+formatted) via standard input, or optionally a number of commandline
+parameters. It communicates using HTTP, which allows it to work over a
+network.
+
+Requirements
+------------
+
+Its only requirement is Python 2.3 or higher; you should have the
+"python" executable in your path.
+
+Usage Notes
+-----------
+
+* Please constrain testing to your own installation of Bugzilla, or use
+* http://landfill.bugzilla.org/ for testing purposes -- opening test
+* bugs on production instances of Bugzilla is definitely not a good idea
+
+Run "bug-bugzilla --help" for a description of the possible options.
+
+An example input file, named bugdata.txt, is provided. You can pipe it
+in as standard input to bug-bugzilla, providing a Bugzilla URI through
+the command-line.
+
+Note that you must create a ~/.netrc entry to authenticate against the
+Bugzilla instance. The entry's machine field is a *quoted* Bugzilla URI,
+the login field is your ID on that host, and the password field is the
+your password password. An example entry follows:
+
+    machine "http://bugzilla.mozilla.org/"
+    login foo@bar.loo
+    password snarf
+
+Documentation
+-------------
+
+Documentation for bug-bugzilla is provided in Docbook format; see
+bug-bugzilla.xml.
+
--- a/contrib/bugzilla-submit/bugdata.txt
+++ b/contrib/bugzilla-submit/bugdata.txt
+Product: FoodReplicator
+Component: Salt
+Version: 1.0
+Priority: P2
+Hardware: PC
+OS: Linux
+Severity: critical
+Summary: Impending electron shortage
+
+We need an emergency supply of electrons.
+
--- a/contrib/bugzilla-submit/bugzilla-submit
+++ b/contrib/bugzilla-submit/bugzilla-submit
--- a/contrib/bugzilla-submit/bugzilla-submit.xml
+++ b/contrib/bugzilla-submit/bugzilla-submit.xml
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentry PUBLIC 
+   "-//OASIS//DTD DocBook XML V4.1.2//EN"
+   "docbook/docbookx.dtd">
+<refentry id='bug-bugzilla.1'>
+<refmeta>
+<refentrytitle>bug-bugzilla</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo class='date'>Oct 30, 2003</refmiscinfo>
+</refmeta>
+<refnamediv id='name'>
+<refname>bug-bugzilla</refname>
+<refpurpose>post bugs to a Bugzilla instance</refpurpose>
+</refnamediv>
+<refsynopsisdiv id='synopsis'>
+
+<cmdsynopsis>
+  <command>bug-bugzilla</command>
+  <arg choice='opt'>--status <replaceable>bug_status</replaceable></arg>
+  <arg choice='opt'>--url <replaceable>bug_file_loc</replaceable></arg>
+  <arg choice='opt'>--product <replaceable>product</replaceable></arg>
+  <arg choice='opt'>--version <replaceable>version</replaceable></arg>
+  <arg choice='opt'>--component <replaceable>component</replaceable></arg>
+  <arg choice='opt'>--summary <replaceable>short_desc</replaceable></arg>
+  <arg choice='opt'>--hardware <replaceable>rep_platform</replaceable></arg>
+  <arg choice='opt'>--os <replaceable>op_sys</replaceable></arg>
+  <arg choice='opt'>--priority <replaceable>priority</replaceable></arg>
+  <arg choice='opt'>--severity <replaceable>bug_severity</replaceable></arg>
+  <arg choice='opt'>--assigned-to <replaceable>assigned-to</replaceable></arg>
+  <arg choice='opt'>--cc <replaceable>cc</replaceable></arg>
+  <arg choice='opt'>--keywords <replaceable>keywords</replaceable></arg>
+  <arg choice='opt'>--depends-on <replaceable>dependson</replaceable></arg>
+  <arg choice='opt'>--blocked <replaceable>blocked</replaceable></arg>
+  <arg choice='opt'>--description <replaceable>comment</replaceable></arg>
+  <arg choice='opt'>--no-read </arg>
+  <arg choice='plain'><replaceable>bugzilla-url</replaceable></arg>
+</cmdsynopsis>
+
+</refsynopsisdiv>
+
+<refsect1 id='description'><title>DESCRIPTION</title>
+
+<para><application>bug-bugzilla</application> is a command-line tool
+for posting bug reports to any instance of Bugzilla.  It accepts on
+standard input text resembling an RFC-822 message.  The headers of
+that message, and its body, are used to set error-report field values.
+More field values are merged in from command-line options. If required
+fields have not been set, <application>bug-bugzilla</application>
+tries to compute them.  Finally, the resulting error report is
+validated.  If all required fields are present, and there are no
+illegal fields or values, the report is shipped off to the Mozilla
+instance specified by the single positional argument.  Login/password
+credentials are read from the calling user's <filename>~/.netrc</filename> 
+file.</para>
+
+<para>The program accepts the following options to set or override fields:</para>
+<variablelist>
+<varlistentry>
+<term>-b. --bug-status</term>
+<listitem>
+<para>Set the bug_status field, overriding the Status header from
+standard input if present.  (The stock Bugzilla web presentation
+identifies this field as <quote>Status</quote>.)</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-u, --url</term>
+<listitem>
+<para>Set the bug_file_loc field, overriding the URL header from
+standard input if present. (The stock Bugzilla web presentation
+identifies this field as <quote>URL</quote>.)</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-p, --product</term>
+<listitem>
+<para>Set the product field, overriding the Product header from
+standard input if necessary.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-v, --version</term>
+<listitem><para>Set the version field, overriding the Version header
+from standard input if necessary.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-c, --component</term>
+<listitem><para>Set the component field, overriding the Component header
+from standard input if necessary.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-s, --summary</term>
+<listitem><para>Set the short_desc field, overriding the Summary header
+from standard input if necessary. (The stock Bugzilla web presentation
+identifies this field as <quote>Summary</quote>.)</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-H, --hardware</term>
+<listitem><para>Set the rep_platform field, overriding the Hardware header
+from standard input if necessary. (The stock Bugzilla web presentation
+identifies this field as <quote>Hardware</quote>.)</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-o, --os</term>
+<listitem><para>Set the op_sys field, overriding the Operating-System header
+from standard input if necessary. (The stock Bugzilla web presentation
+identifies this field as <quote>OS</quote>.)</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-r, --priority</term>
+<listitem><para>Set the priority field, overriding the Priority header
+from standard input if necessary.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-x, --severity</term>
+<listitem><para>Set the severity field, overriding the Severity header
+from standard input if necessary.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-d, --description</term>
+<listitem><para>Set the comment field, overriding the Description header
+from standard input if necessary. (The stock Bugzilla web presentation
+identifies this field as <quote>Description</quote>.)  If there is a
+message body and no Description field and this option is not
+specified, the message body is used as a description.
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-a, --assigned-to</term>
+<listitem>
+<para>Set the optional assigned_to field, overriding the Assigned-To
+header from standard input if necessary.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-C, --cc</term>
+<listitem>
+<para>Set the optional cc field, overriding the Cc
+header from standard input if necessary.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-k, --keywords</term>
+<listitem>
+<para>Set the optional keywords field, overriding the Keywords
+header from standard input if necessary.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-D, --depends-on</term>
+<listitem>
+<para>Set the optional dependson field, overriding the Depends-On
+header from standard input if necessary.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-B, --assigned-to</term>
+<listitem>
+<para>Set the optional blocked field, overriding the Blocked
+header from standard input if necessary.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-n, --no-stdin</term>
+<listitem><para>Suppress reading fields from standard input.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-h, --help</term>
+<listitem><para>Print usage help and exit.</para></listitem>
+</varlistentry>
+</variablelist>
+
+<para>This program will try to deduce OS and Hardware if those are not
+specified.  If it fails, validation will fail before shipping the
+report.</para>
+
+<para>There is expected to be a single positional argument following
+any options. It should be the URL of the Bugzilla instance to which
+the bug is to be submitted.</para>
+
+</refsect1>
+<refsect1 id='files'><title>FILES</title> 
+<variablelist>
+<varlistentry>
+<term><filename>~/.netrc</filename></term>
+<listitem><para>Must contain an entry in which the machine field is
+the Bugzilla instance URL, the login field is your ID on that host, and the 
+password field is the right password.  The URL in the machine field
+must be enclosed in double quotes.</para></listitem>
+</varlistentry>
+</variablelist>
+
+</refsect1>
+<refsect1 id='author'><title>AUTHORS</title> 
+<para>Christian Reis &lt;kiko@async.com.br&gt;, Eric S. Raymond
+&lt;esr@thyrsus.com&gt;.</para> 
+</refsect1> 
+</refentry>
+