Bug 1325525

Summary: hammer help text shows HTML characters such as "'"
Product: Red Hat Satellite Reporter: Og Maciel <omaciel>
Component: HammerAssignee: Zach Huntington-Meath <zhunting>
Status: CLOSED ERRATA QA Contact: Adam Ruzicka <aruzicka>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 6.2.0CC: aruzicka, bbuckingham, bkearney, jcallaha, rplevka, zhunting
Target Milestone: UnspecifiedKeywords: Triaged
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
URL: http://projects.theforeman.org/issues/14598
Whiteboard:
Fixed In Version: rubygem-hammer_cli-0.5.1.10-1 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-07-27 11:12:14 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 Og Maciel 2016-04-09 14:49:58 UTC
Description of problem:

Several hammer cli commands and subcommands show HTML characters in their help text. For example:

> repository list --help
Usage:
    hammer repository list [OPTIONS]

Options:
 --available-for AVAILABLE_FOR                       interpret specified object to return only Repositories that can be
                                                     associated with specified object.  Only &#39;content_view&#39; is
                                                     supported.

The string 'Only &#39;content_view&#39; is' should be rendered as 'Only "content_view" is'.

At a first glance, it looks like we're converting quote characters into HTML.

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

* Satellite 6.2.0 SNAP 7.1

How reproducible:


Steps to Reproduce:
1. Run the "hammer repository list -h" command (other commands/subcommands will also work)
2.
3.

Actual results:


Expected results:


Additional info:

Comment 3 Roman Plevka 2016-04-09 17:17:01 UTC
I'd propose to merge this and all the following bugs together as they're apparently pointing to the same issue:
https://bugzilla.redhat.com/show_bug.cgi?id=1313531
https://bugzilla.redhat.com/show_bug.cgi?id=1313524

Comment 4 Bryan Kearney 2016-04-12 17:09:30 UTC
*** Bug 1313524 has been marked as a duplicate of this bug. ***

Comment 5 Bryan Kearney 2016-04-12 17:09:36 UTC
*** Bug 1313531 has been marked as a duplicate of this bug. ***

Comment 6 Bryan Kearney 2016-04-12 17:10:29 UTC
please see the dupes per comment 3

Comment 7 Bryan Kearney 2016-04-12 17:10:55 UTC
Created redmine issue http://projects.theforeman.org/issues/14598 from this bug

Comment 8 Bryan Kearney 2016-05-30 14:14:57 UTC
Moving to POST since upstream bug http://projects.theforeman.org/issues/14598 has been closed

Comment 9 Adam Ruzicka 2016-06-02 11:12:16 UTC
VERIFIED.

@Sat6.2.0-Snap14.0
tfm-rubygem-hammer_cli_katello-0.0.22.12-1.el7sat.noarch

# hammer repository list -h
Usage:
    hammer repository list [OPTIONS]

Options:
 --available-for AVAILABLE_FOR                       interpret specified object to return only Repositories that can be
                                                     associated with specified object.  Only 'content_view' is
                                                     supported.
 --by BY                                             Field to sort the results on
 --content-type CONTENT_TYPE                         limit to only repositories of this type
                                                     Possible value(s): 'docker', 'file', 'puppet', 'yum'
 --content-view CONTENT_VIEW_NAME                    Content view name to search by
 --content-view-id CONTENT_VIEW_ID                   content view numeric identifier
 --content-view-version CONTENT_VIEW_VERSION_VERSION Content view version number
 --content-view-version-id CONTENT_VIEW_VERSION_ID   Content view version identifier
 --environment ENVIRONMENT_NAME                      Name to search by
 --environment-id ENVIRONMENT_ID                      
 --erratum-id ERRATUM_ID                             Id of an erratum to find repositories that contain the erratum
 --full-results FULL_RESULTS                         Whether or not to show all results
                                                     One of true/false, yes/no, 1/0.
 --library LIBRARY                                   show repositories in Library and the default content view
                                                     One of true/false, yes/no, 1/0.
 --name NAME                                         name of the repository
 --order ORDER                                       Sort field and order, eg. 'name DESC'
 --organization ORGANIZATION_NAME                    Organization name to search by
 --organization-id ORGANIZATION_ID                   organization ID
 --organization-label ORGANIZATION_LABEL             Organization label to search by
 --page PAGE                                         Page number, starting at 1
 --per-page PER_PAGE                                 Number of results per page to return
 --product PRODUCT_NAME                              Product name to search by
 --product-id PRODUCT_ID                             product numeric identifier
 --rpm-id RPM_ID                                     Id of a package to find repositories that contain the rpm
 --search SEARCH                                     Search string
 -h, --help                                          print help

>> No HTML characters when runnning --help

Comment 10 Bryan Kearney 2016-07-27 11:12:14 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, 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-2016:1501