Bug 1705097

Summary: An empty report file doesn't show any headers
Product: Red Hat Satellite Reporter: John Mitsch <jomitsch>
Component: ReportingAssignee: Marek Hulan <mhulan>
Status: CLOSED ERRATA QA Contact: Lukáš Hellebrandt <lhellebr>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 6.5.0CC: egolov, inecas, mhulan, mshira, oprazak, wpinheir
Target Milestone: 6.8.0Keywords: EasyFix, Triaged
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: foreman-2.1.0-0 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2020-10-27 12:58:35 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description John Mitsch 2019-05-01 13:22:11 UTC
Description of problem:
When you generate a report template, it doesn't show any CSV headers (name, label, severity, etc...) on the top of the file if no results are found. This is just a blank file and is confusing as it makes one think the file wasn't generated correctly, also it may break automation that users build around this.

We should keep the headers on the file even if its blank

Version-Release number of selected component (if applicable):
6.5.0

How reproducible:
Always

Steps to Reproduce:
1.Navigate to Report Templates
2.Click "Generate" for applicable errata and search with a host that has no errata applicable (name = myhost).
3.view blank report

Actual results:
report is blank

Expected results:
report has headers

Additional info:

Comment 4 Marek Hulan 2019-12-17 10:12:03 UTC
There's the new helper that can be used in reports to define headers in Foreman 1.24. All we need to do is to update all report templates, so it has line like this

<%- report_headers "name", "label", "severity" -%>

That will make sure the report will print headers even if no data was gathered.

Comment 5 Marek Hulan 2020-01-04 19:35:00 UTC
Created redmine issue https://projects.theforeman.org/issues/28637 from this bug

Comment 6 Bryan Kearney 2020-01-04 21:04:45 UTC
Upstream bug assigned to mhulan

Comment 7 Bryan Kearney 2020-01-04 21:04:47 UTC
Upstream bug assigned to mhulan

Comment 8 Bryan Kearney 2020-02-26 13:06:11 UTC
Moving this bug to POST for triage into Satellite 6 since the upstream issue https://projects.theforeman.org/issues/28637 has been resolved.

Comment 9 Lukáš Hellebrandt 2020-06-03 14:27:46 UTC
Verified with Sat 6.8 snap 2.1.

1. Generate "Host - Applicable errata" report without any arguments
2. Generate it with filter for a host without any applicable errata

=> The first one contains correct data, the second one contains an empty dataset with the same headers as the first one.

Note that "Applied errata" template is an old version and this bug has been fixed in new versions of reports, e.g. "Host - Applicable errata". Whether this is correct or not is a different issue.

Comment 12 errata-xmlrpc 2020-10-27 12:58:35 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 (Important: Satellite 6.8 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-2020:4366