Bug 1734766

Summary: Unnecessary options present in subcommands of "foreman-maintain packages" command.
Product: Red Hat Satellite Reporter: Jameer Pathan <jpathan>
Component: Satellite MaintainAssignee: Anurag Patel <apatel>
Status: CLOSED ERRATA QA Contact: Gaurav Talreja <gtalreja>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 6.6.0CC: ahumbe, apatel, aupadhye, gtalreja, inecas, kgaikwad, mbacovsk, mvanderw, osousa
Target Milestone: 6.10.0Keywords: Triaged, UserExperience
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: rubygem-foreman_maintain-0.8.3 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2021-11-16 13:48:05 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 Jameer Pathan 2019-07-31 11:40:58 UTC
Description of problem:
Unnecessary options present in subcommands of "foreman-maintain packages" command.
Version-Release number of selected component (if applicable):
- Satellite 6.6.0 snap 13
- rubygem-foreman_maintain-0.4.5-1.el7sat.noarch

How reproducible:
always

Steps to Reproduce:
1. Run "foreman-maintain packages lock --help"
2. Run "foreman-maintain packages unlock --help"
3. Run "foreman-maintain packages is-locked --help"
4. Run "foreman-maintain packages status --help"

Actual results:

[root@hpe-dl380egen8-01 ~]# foreman-maintain packages lock --help
Usage:
    foreman-maintain packages lock [OPTIONS]

Options:
    -y, --assumeyes               Automatically answer yes for all questions
    -w, --whitelist whitelist     Comma-separated list of labels of steps to be skipped
    -f, --force                   Force steps that would be skipped as they were already run
    -h, --help                    print help
[root@hpe-dl380egen8-01 ~]# foreman-maintain packages unlock --help
Usage:
    foreman-maintain packages unlock [OPTIONS]

Options:
    -y, --assumeyes               Automatically answer yes for all questions
    -w, --whitelist whitelist     Comma-separated list of labels of steps to be skipped
    -f, --force                   Force steps that would be skipped as they were already run
    -h, --help                    print help
[root@hpe-dl380egen8-01 ~]# foreman-maintain packages is-locked --help
Usage:
    foreman-maintain packages is-locked [OPTIONS]

Options:
    -y, --assumeyes               Automatically answer yes for all questions
    -w, --whitelist whitelist     Comma-separated list of labels of steps to be skipped
    -f, --force                   Force steps that would be skipped as they were already run
    -h, --help                    print help
[root@hpe-dl380egen8-01 ~]# foreman-maintain packages status --help
Usage:
    foreman-maintain packages status [OPTIONS]

Options:
    -y, --assumeyes               Automatically answer yes for all questions
    -w, --whitelist whitelist     Comma-separated list of labels of steps to be skipped
    -f, --force                   Force steps that would be skipped as they were already run
    -h, --help                    print help

Expected results:

[root@hpe-dl380egen8-01 ~]# foreman-maintain packages lock --help
Usage:
    foreman-maintain packages lock [OPTIONS]

Options:
    -y, --assumeyes               Automatically answer yes for all questions
    -h, --help                    print help
[root@hpe-dl380egen8-01 ~]# foreman-maintain packages unlock --help
Usage:
    foreman-maintain packages unlock [OPTIONS]

Options:
    -y, --assumeyes               Automatically answer yes for all questions
    -h, --help                    print help
[root@hpe-dl380egen8-01 ~]# foreman-maintain packages is-locked --help
Usage:
    foreman-maintain packages is-locked [OPTIONS]

Options:
    -y, --assumeyes               Automatically answer yes for all questions
    -h, --help                    print help
[root@hpe-dl380egen8-01 ~]# foreman-maintain packages status --help
Usage:
    foreman-maintain packages status [OPTIONS]

Options:
    -y, --assumeyes               Automatically answer yes for all questions
    -h, --help                    print help

Additional info:
- [RFE] Implement a yum version lock type of protections against upgrades https://bugzilla.redhat.com/show_bug.cgi?id=1512600
- --force and --whitelist options seems unnecessary here.

Comment 3 Suraj Patil 2020-06-10 11:43:18 UTC
Created redmine issue https://projects.theforeman.org/issues/30094 from this bug

Comment 4 Bryan Kearney 2021-06-30 12:03:25 UTC
Moving this bug to POST for triage into Satellite since the upstream issue https://projects.theforeman.org/issues/30094 has been resolved.

Comment 5 Gaurav Talreja 2021-07-19 11:48:14 UTC
Verified.

Tested on Satellite 6.10.0 Snap 9.0
Version: rubygem-foreman_maintain-0.8.6-1.el7sat.noarch

Steps:
# foreman-maintain packages lock --help
Usage:
    foreman-maintain packages lock [OPTIONS]

Options:
    -y, --assumeyes               Automatically answer yes for all questions
    -h, --help                    print help

# foreman-maintain packages unlock --help
Usage:
    foreman-maintain packages unlock [OPTIONS]

Options:
    -y, --assumeyes               Automatically answer yes for all questions
    -h, --help                    print help
# foreman-maintain packages is-locked --help
Usage:
    foreman-maintain packages is-locked [OPTIONS]

Options:
    -h, --help                    print help

# foreman-maintain packages status --help
Usage:
    foreman-maintain packages status [OPTIONS]

Options:
    -y, --assumeyes               Automatically answer yes for all questions
    -h, --help                    print help

Observation:
Unnecessary options like whitelist/force aren't part of --help of subcommands of `foreman-maintain packages`

Comment 8 errata-xmlrpc 2021-11-16 13:48:05 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 (Satellite 6.10 Satellite Maintenance 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/RHBA-2021:4697