Bug 1893517

Summary:	formatting issues when invalid option value provided to sosreport
Product:	Red Hat Enterprise Linux 8	Reporter:	Pavel Moravec <pmoravec>
Component:	sos	Assignee:	Pavel Moravec <pmoravec>
Status:	CLOSED ERRATA	QA Contact:	Miroslav Hradílek <mhradile>
Severity:	low	Docs Contact:
Priority:	medium
Version:	8.4	CC:	agk, bmr, mhradile, plambri, sbradley, theute
Target Milestone:	rc	Keywords:	Triaged
Target Release:	8.0
Hardware:	All
OS:	Linux
Whiteboard:
Fixed In Version:	sos-4.1-1.el8	Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2021-11-09 19:36:07 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:

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