User Guide
User Guide¶
Bugzilla¶
In order to leverage bzaf, a user must have
credentials (username+password or API key) to a bugzilla instance.
Every bugzilla is unique and may contain various different attributes, the user must be familiar with the bugzilla.
All communication with bugzilla is done through python-bugzilla.
CLI¶
After following the Installation Guide,
bzaf binary will be present.
Arguments¶
–job_env¶
Note
Will migrate to more generic behaviour in the future
Required: True
Description: Set job_env to expect from spec
Example:
bzaf --job_env all
–interactive-login¶
Required: True, mutually exclusive with --access-api-key
Description: Will prompt the user to enter credentials to authenticate with bugzilla instance, will not prompt the user to enter credentials if they’re cached
Example:
bzaf --interactive-login
–access-api-key¶
Required: True, mutually exclusive with --interactive-login
Description: Authenticate with bugzilla instance using an API key (bugzilla 5+)
Example:
bzaf --access-api-key QRaG8wgBkSGRBJfx5MKNvKMoVpxao2MUxI68MqLo
–bugzilla¶
Required: True
Mutually exclusive: False
Description: URL of bugzilla instance to authenticate with
Example:
bzaf --bugzilla http://localhost
–bug-id¶
Required: True, mutually exclusive with --bz-query
Description: Bugzilla bug ID# to query, multiple arguments can be provided
Example:
bzaf --bug-id 1 --bug-id 2
–bz-query¶
Required: True, mutually exclusive with --bug-id
Description: Bugzilla saved/advanced search query to use to query bugs
Example:
bzaf --bugzilla-query \
$URL/buglist.cgi?bug_status=__open__&list_id=2&order=Importance&query_format=specific
–current-status¶
Required: True
Description: Set state of the bug required to be considered as potential bug to be verified
Example:
bzaf --current-status OPEN
–verified-status¶
Required: True
Description: Set state of bug if it were successfully verified
Example:
bzaf --verified-status VERIFIED
–verified-resolution¶
Required: True
Description: Set resolution of bug if it were successfully verified (not required by all states)
Example:
bzaf --verified-resolution FIXED
–private-comments-only¶
Required: False
Description: Set to look for bzaf spec only in private comments
Example:
bzaf --private-comments-only