REPORTER-BUGZILLA(1)

πŸ“¦
version 2.17.15 Β· 4 versions
, in opensuse-leap 16.0

πŸ’… reporter-bugzilla β€” NAME ✨

okay so bestie, reporter-bugzilla is the little icon that reports a problem to Bugzilla. that's it, that's the vibe. πŸ’– (this whole thing lives in the LIBREPORT MANUAL, iykyk.)


🫢 SYNOPSIS

reporter-bugzilla [-vbf] [-g GROUP]... [-c CONFFILE]... [-F FMTFILE] [-A
FMTFILE2] -d DIR

Or, and hear me out:

reporter-bugzilla [-v] [-c CONFFILE]... [-d DIR] -t[ID] FILE...

Or like this:

reporter-bugzilla [-v] [-c CONFFILE]... [-d DIR] -t[ID] -w

Or finally, the last one:

reporter-bugzilla [-v] [-c CONFFILE]... -h DUPHASH [-p[PRODUCT]]

🌸 DESCRIPTION

so the tool reads the problem directory DIR. then it logs in to Bugzilla and tries to find a bug with the same abrt_hash:HEXSTRING in Whiteboard. lowkey detective energy. πŸ”

if such a bug is not found, then a new bug is created. elements of DIR are stored in the bug as part of the bug description or as attachments, depending on their type and size. slay.

otherwise, if such a bug is found and it is marked as CLOSED DUPLICATE, the tool follows the chain of duplicates until it finds a non-DUPLICATE bug. then it adds a new comment to the found bug. πŸŽ€

the URL to the new or modified bug is printed to stdout and recorded in the reported_to element in DIR.

option -t uploads FILEs to the already created bug on the Bugzilla site. the bug ID is retrieved from the directory specified by -d DIR. if problem data in DIR was never reported to Bugzilla, the upload will fail. 😭 (sorry bestie, that's just how it is.)

option -tID uploads FILEs to the bug with the specified ID on the Bugzilla site. -d DIR is ignored.

option -w adds the bugzilla user to the bug's CC list.

option -r sets the last url from reporter_to element which is prefixed with TRACKER_NAME to the URL field. this option is applied only when a new bug is to be filed. the default value is ABRT Server. πŸ’…

🧚 Configuration file

if you don't specify it, CONFFILE defaults to /etc/libreport/plugins/bugzilla.conf and to the user's local ~/.config/libreport/bugzilla.conf. configuration file lines should have PARAM = VALUE format. the parameters are listed below. the user's local configuration overrides the system wide configuration. πŸ‘‘

  • APIKey β€” API key for authentication to the Bugzilla account.
  • BugzillaURL β€” Bugzilla HTTP(S) address. (default: https://bugzilla.redhat.com)
  • SSLVerify β€” use yes/true/on/1 to verify the server's SSL certificate. (default: yes)
  • Product β€” Product bug field value. useful if you needed a different product than the one specified in /etc/os-release
  • ProductVersion β€” Version bug field value. useful if you needed a different product version than the one specified in /etc/os-release

parameters can be overridden via $Bugzilla_PARAM environment variables. ✨

🌈 Formatting configuration files

lines starting with # are ignored.

lines can be continued on the next line using a trailing backslash.

format:

"%summary
    summary format"

"section
    element1[,element2]..."

the literal text line to be added to the Bugzilla comment. can be empty. (Empty lines are NOT ignored! β€” yes bestie, for real, they are not ignored, do not come for me πŸ’€)

  • Summary format is a line of text, where %element% is replaced by the text element's content, and [[...%element%...]] block is used only if %element% exists. [[...]] blocks can nest. πŸͺ†
  • Sections can be:
    • %summary: bug summary format string.
    • %attach: a list of elements to attach.
    • text, double colon (::) and the list of comma-separated elements.
  • Elements can be:
    • problem directory element names, which get formatted as
<element_name>: <contents>

or

<element_name>:
:<contents>
:<contents>
:<contents>
  • problem directory element names prefixed by %bare_, which is formatted as-is, without <element_name>: and colons
  • %oneline, %multiline, %text wildcards, which select all corresponding elements for output or attachment
  • %binary wildcard, valid only for the %attach section, which instructs to attach binary elements
  • problem directory element names prefixed by -, which excludes the given element from all wildcards

nonexistent elements are silently ignored. πŸ™ˆ if none of the elements exists, the section will not be created.

⭐ Integration with ABRT events

reporter-bugzilla can be used as an ABRT reporter. here's an example fragment for /etc/libreport/report_event.conf:

# Report Python crashes
EVENT=report_Bugzilla analyzer=Python
      reporter-bugzilla -d . -c /etc/libreport/plugins/bugzilla.conf

πŸŽ€ OPTIONS

  • -d DIR β€” path to the problem directory.
  • -c CONFFILE β€” path to the configuration file.
  • -b β€” when creating a bug, attach binary files too. πŸ–‡οΈ
  • -f β€” force reporting even if this problem is already reported.
  • -F CONF_FORMAT_FILE β€” formatting file for the initial comment. Default: /etc/libreport/plugins/bugzilla_format.conf
  • -A CONF_FORMAT_FILE β€” formatting file for duplicates. Default: /etc/libreport/plugins/bugzilla_format.conf
  • -t[ID] β€” upload FILEs to the already created bug on the Bugzilla site.
  • -w β€” add the bugzilla user to the CC list [of the bug with this ID]. applicable only with -t.
  • -h, --duphash DUPHASH β€” search in Bugzilla by abrt's DUPHASH and print BUG_ID. πŸ”Ž
  • -p[PRODUCT], --product[PRODUCT] β€” specify a Bugzilla's product (ignored without -h). Default: "Fedora". if only -p or --product without PRODUCT is presented, either the value from the environment variable Bugzilla_Product in the first place or the REDHAT_BUGZILLA_PRODUCT value from /etc/os-release is used.
  • -g, --group GROUP β€” when creating a new ticket, restrict access to this group only. πŸ”’

πŸ’œ ENVIRONMENT VARIABLES

environment variables take precedence over values provided in the configuration file. periodt.

  • Bugzilla_APIKey β€” API key for authentication to the Bugzilla account.
  • Bugzilla_BugzillaURL β€” Bugzilla HTTP(S) address. (default: https://bugzilla.redhat.com)
  • Bugzilla_SSLVerify β€” use yes/true/on/1 to verify the server's SSL certificate. (default: yes)
  • Bugzilla_Product β€” Product bug field value. useful if you needed a different product than the one specified in /etc/os-release
  • Bugzilla_ProductVersion β€” Version bug field value. useful if you needed a different product version than the one specified in /etc/os-release
  • Bugzilla_PrivateGroups β€” list of Bugzilla group names that will be set to the new bug if Bugzilla_CreatePrivate equals yes
  • Bugzilla_CreatePrivate β€” use yes/no to control whether the new bug should have the groups listed in Bugzilla_PrivateGroups set
  • Bugzilla_DontMatchComponents β€” comma-separated list of package components (e.g. selinux-policy, anaconda) for which reporter-bugzilla should not use Bugzilla component match when searching for duplicate bug reports.
  • http_proxy β€” the proxy server to use for HTTP
  • HTTPS_PROXY β€” the proxy server to use for HTTPS

πŸ¦‹ FILES

  • /usr/share/libreport/conf.d/plugins/bugzilla.conf β€” readonly default configuration files.
  • /etc/libreport/plugins/bugzilla.conf β€” configuration file.
  • ~/.config/libreport/bugzilla.conf β€” user's local configuration file.
  • /etc/libreport/plugins/bugzilla_format.conf β€” configure formatting for reporting.

🌟 SEE ALSO

report_event.conf(5), bugzilla_format.conf(5)


πŸ‘‘ AUTHORS

  • ABRT team

and that's the whole page bestie, no cap. this was LIBREPORT 2.17.15, dated 07/15/2024 β€” go forth and file those bugs πŸ’…πŸ”₯🫢