Red Hat Satellite engineering is moving the tracking of its product development work on Satellite to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "Satellite project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs will be migrated starting at the end of May. If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "Satellite project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/SAT-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 1906164 - [RFE] Provide erratum.synopsis option to Applicable errata Reporting template
Summary: [RFE] Provide erratum.synopsis option to Applicable errata Reporting template
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Reporting
Version: 6.8.0
Hardware: x86_64
OS: Linux
unspecified
high
Target Milestone: 6.9.0
Assignee: Marek Hulan
QA Contact: Lukáš Hellebrandt
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-12-09 19:42 UTC by Steffen Froemer
Modified: 2024-03-25 17:29 UTC (History)
5 users (show)

Fixed In Version: tfm-rubygem-katello-3.18.1.1-1
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
: 1933162 (view as bug list)
Environment:
Last Closed: 2021-04-21 13:24:23 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Foreman Issue Tracker 31530 0 Normal Closed Provide erratum.synopsis option to Applicable errata Reporting template 2021-02-17 02:46:56 UTC
Red Hat Product Errata RHSA-2021:1313 0 None None None 2021-04-21 13:24:45 UTC

Description Steffen Froemer 2020-12-09 19:42:03 UTC
1. Proposed title of this feature request
[RFE] Provide erratum.synopsis option to Applicable errata Reporting template


3. What is the nature and description of the request?
To know what kind of errata the specific errata is type of, it's expected to have synopsis reflected as well. 


4. Why does the customer need this? (List the business requirements here)
Customers process with additional tools and CMDB does require the synopsis content. This feature was available in satellite-5 and is a requirement to satellite-6 as full sat-5 replacement

5. How would the customer like to achieve this? (List the functional requirements here)
The reporting engine should provide an option for Katello::Erratum like
  - erratum.synopsis


6. For each functional requirement listed, specify how Red Hat and the customer can test to confirm the requirement is successfully implemented.
Proposal template

<%- report_headers 'Host', 'Erratum', 'Patch Synopsis' -%>
<%- load_hosts(search: input('Hosts filter'), includes: [:operatingsystem, :applicable_errata, :lifecycle_environment]).each_record do |host| -%>
<%-   host_applicable_errata_filtered(host, input('Errata filter')).each do |erratum| -%>
<%-     report_row(
          'Host': host.name,
          'Erratum': erratum.errata_id,
          'Patch Synopsis': erratum.synopsis,
        ) -%>
<%-   end -%>
<%- end -%>

Expected result (for example erratum https://access.redhat.com/errata/RHSA-2020:4060)

Host,Erratum,Patch Synopsis
host.example.com,RHSA-2020:4060,Important: kernel security, bug fix, and enhancement update



7. Is there already an existing RFE upstream or in Red Hat Bugzilla?
no


8. Does the customer have any specific timeline dependencies and which release would they like to target (i.e. RHEL5, RHEL6)?
asap


9. Is the sales team involved in this request and do they have any additional input?
no


10. List any affected packages or components.
Satellite report engine


11. Would the customer be able to assist in testing this functionality if implemented?
yes, workarounds or pre-releases are welcome

Comment 2 Marek Hulan 2020-12-18 09:38:43 UTC
Hello,

I think it would be better to keep the report up to the user, it seems they are interested in host, erratum and synopsis, while our existing applicable report includes many more columns. However we should definitely add erratum title and summary to enabled methods once can use in the report. The report in the comment would then work, just the synopsis will be called title (like in the API)

Would that work? I'm opening the patch with this right now. This would be easy to backport.

Comment 3 Marek Hulan 2020-12-18 09:39:35 UTC
Created redmine issue https://projects.theforeman.org/issues/31530 from this bug

Comment 5 Bryan Kearney 2020-12-18 10:36:30 UTC
Upstream bug assigned to mhulan

Comment 6 Bryan Kearney 2020-12-18 10:36:32 UTC
Upstream bug assigned to mhulan

Comment 7 Steffen Froemer 2020-12-18 11:09:22 UTC
Marek yes. There is no requirement in changing the default report. Having the options available for custom reports is totally enough.

Comment 8 Bryan Kearney 2021-01-05 16:24:46 UTC
Moving this bug to POST for triage into Satellite since the upstream issue https://projects.theforeman.org/issues/31530 has been resolved.

Comment 14 Lukáš Hellebrandt 2021-02-11 13:49:07 UTC
Verified with Sat 6.9.0 snap 12.

It's now possible to use `erratum.title` in the report template, which contains synopsis of the erratum, e.g. "Important: freetype security update". Example based on Applicable Errata report template:

```
<%#
name: Host - Applicable Errata
snippet: false
template_inputs:
- name: Hosts filter
  required: false
  input_type: user
  description: Limit the report only on hosts found by this search query. Keep empty
    for report on all available hosts.
  advanced: false
  value_type: search
  resource_type: Host
- name: Errata filter
  required: false
  input_type: user
  description: Limit the report only on errata found by this search query. Keep empty
    for report on all available errata.
  advanced: false
model: ReportTemplate
require:
- plugin: katello
 version: 3.16.0
-%>
<%- report_headers 'Host', 'Operating System', 'Environment', 'Erratum', 'Type', 'Published', 'Applicable since', 'Severity', 'Packages', 'CVEs', 'Reboot suggested' -%>
<%- load_hosts(search: input('Hosts filter'), preload: [:operatingsystem, :lifecycle_environment]).each_record do |host| -%>
<%-   host_applicable_errata_filtered(host, input('Errata filter')).each do |erratum| -%>
<%-     report_row(
          'Host': host.name,
          'Operating System': host.operatingsystem,
          'Environment': host.lifecycle_environment,
          'Erratum': erratum.errata_id,
          'Type': erratum.errata_type,
          'Published': erratum.issued,
          'Applicable since': erratum.created_at,
          'Severity': erratum.severity,
          'Packages': erratum.package_names,
          'CVEs': erratum.cves.map { |c| c.cve_id },
          'Reboot suggested': erratum.reboot_suggested,
          'Synopsis': erratum.title
        ) -%>
<%-   end -%>
<%- end -%>
<%= report_render -%>

```

Comment 17 errata-xmlrpc 2021-04-21 13:24:23 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Moderate: Satellite 6.9 Release), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2021:1313


Note You need to log in before you can comment on or make changes to this bug.