RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 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 "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". 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 "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-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 1893517 - formatting issues when invalid option value provided to sosreport
Summary: formatting issues when invalid option value provided to sosreport
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 8
Classification: Red Hat
Component: sos
Version: 8.4
Hardware: All
OS: Linux
medium
low
Target Milestone: rc
: 8.0
Assignee: Pavel Moravec
QA Contact: Miroslav Hradílek
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-11-01 09:31 UTC by Pavel Moravec
Modified: 2021-11-10 07:39 UTC (History)
6 users (show)

Fixed In Version: sos-4.1-1.el8
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-11-09 19:36:07 UTC
Type: Bug
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github sosreport sos issues 2285 0 None closed better formatting of cmdline option error 2020-12-09 11:59:33 UTC
Red Hat Product Errata RHEA-2021:4388 0 None None None 2021-11-09 19:36:22 UTC

Description Pavel Moravec 2020-11-01 09:31:39 UTC 
Description of problem:
Backport request to RHEL8 of a fix of https://github.com/sosreport/sos/issues/2285. Another particular example:


Version-Release number of selected component (if applicable):
sos-4.0-2


How reproducible:
100%


Steps to Reproduce:
1. sosreport -z aaa
2. sosreport --all-log=on
3. sosreport --blah


Actual results:
1. and 2. fails with badly formatting error:

# sosreport -z aaa
Please note the 'sosreport' command has been deprecated in favor of the new 'sos' command, E.G. 'sos report'.
Redirecting to 'sos report -z aaa'
usage: sos report [options]
sosreport <component> [options]

Available components:
	report, rep                   Collect files and command output in an archive
	clean, cleaner, mask          Obfuscate sensitive networking information in a report
	collect, collector            Collect an sos report from multiple nodes simultaneously report: error: argument -z/--compression-type: invalid choice: 'aaa' (choose from 'auto', 'gzip', 'xz')
#

3. provides well formatted error.



Expected results:
1. and 2. to provide error message formatted like 3.
2. to ideally support --all-log=on, likewise putting the option=value to config file


Additional info:
Comment 1 Pavel Moravec 2021-04-28 19:57:57 UTC 
I can self-verify it works properly:

# rpm -q sos
sos-4.1-1.el8.noarch
#
# sosreport -z aaa
Please note the 'sosreport' command has been deprecated in favor of the new 'sos' command, E.G. 'sos report'.
Redirecting to 'sos report -z aaa'
usage: sos report [options]
sos report: error: argument -z/--compression-type: invalid choice: 'aaa' (choose from 'auto', 'gzip', 'xz')
#
# sosreport --all-log=on
Please note the 'sosreport' command has been deprecated in favor of the new 'sos' command, E.G. 'sos report'.
Redirecting to 'sos report --all-log=on'
usage: sos report [options]
sos report: error: argument --all-logs: ignored explicit argument 'on'
#
# sosreport --blah
Please note the 'sosreport' command has been deprecated in favor of the new 'sos' command, E.G. 'sos report'.
Redirecting to 'sos report --blah'
usage: sosreport <component> [options]

Available components:
	report, rep                   Collect files and command output in an archive
	clean, cleaner, mask          Obfuscate sensitive networking information in a report
	collect, collector            Collect an sos report from multiple nodes simultaneously
sosreport: error: unrecognized arguments: --blah
#
Comment 5 errata-xmlrpc 2021-11-09 19:36:07 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 (sos bug fix and enhancement update), 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/RHEA-2021:4388
Note You need to log in before you can comment on or make changes to this bug.