bz_webservice_demo.pl - Show how to talk to Bugzilla via XMLRPC
bz_webservice_demo.pl [options]
bz_webservice_demo.pl --help for detailed help
Print a short help message and exit.
URI to Bugzilla's xmlrpc.cgi script,
along the lines of http://your.bugzilla.installation/path/to/bugzilla/xmlrpc.cgi.
Bugzilla login name. Specify this together with --password in order to log in.
Specify this without a value in order to log out.
Bugzilla password. Specify this together with --login in order to log in.
Gives access to Bugzilla's âBugzilla_rememberâ option.
Specify this option while logging in to do the same thing as ticking the Bugzilla_remember box on Bugilla's log in form.
Don't specify this option to do the same thing as unchecking the box.
See Bugzilla's rememberlogin parameter for details.
Pass a bug ID to have bz_webservice_demo.pl do some bug-related test calls.
Pass a product name to have bz_webservice_demo.pl do some product-related test calls.
Specify a file that contains settings for the creating of a new bug.
Pass a field name to get legal values for this field. It must be either a global select field (such as bug_status, resolution, rep_platform, op_sys, priority, bug_severity) or a custom select field.
Using the XMLRPC::Lite class,
you set up a proxy,
as shown in this script.
Bugzilla's XMLRPC URI ends in xmlrpc.cgi,
so your URI looks along the lines of http://your.bugzilla.installation/path/to/bugzilla/xmlrpc.cgi.
To make sure the Bugzilla you're connecting to supports the methods you wish to call,
you may want to compare the result of Bugzilla.version to the minimum required version your application needs.
To make sure that you understand the dates and times that Bugzilla returns to you,
you may want to call Bugzilla.timezone.
Use a http://login:password@your.bugzilla.installation/path/to/bugzilla/xmlrpc.cgi style URI.
You don't log out if you're using this kind of authentication.
Use the User.login and User.logout calls to log in and out,
as shown in this script.
The Bugzilla_remember parameter is optional.
If omitted,
Bugzilla's defaults apply (as specified by its rememberlogin parameter).
Bugzilla hands back cookies you'll need to pass along during your work calls.
Call Bug.get_bug with the ID of the bug you want to know more of.
The call will return a Bugzilla::Bug object.
Call Product.get_product with the name of the product you want to know more of.
The call will return a Bugzilla::Product object.
Call Bug.create with the settings read from the file indicated on the command line.
The file must contain a valid anonymous hash to use as argument for the call to Bug.create.
The call will return a hash with a bug id for the newly created bug.
Call Bug.legal_values with the name of the field (including custom select fields).
The call will return a reference to an array with the list of legal values for this field.
Make sure that your application either uses the same character set encoding as Bugzilla does, or that it converts correspondingly when using the web service API. By default, Bugzilla uses UTF-8 as its character set encoding.
The create format file is a piece of Perl code, that should look something like this:
{
product => "TestProduct",
component => "TestComponent",
summary => "TestBug - created from bz_webservice_demo.pl",
version => "unspecified",
description => "This is a description of the bug... hohoho",
op_sys => "All",
platform => "All",
priority => "P4",
severity => "normal"
};
There are code comments in bz_webservice_demo.pl which might be of further help to you.