Bug 989495 - Headpin Nighty : User should have ReadMe or Help page description for CLI command that _requires_ --environment option
Summary: Headpin Nighty : User should have ReadMe or Help page description for CLI com...
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Subscription Asset Manager
Classification: Retired
Component: katello
Version: 1.3
Hardware: x86_64
OS: Linux
unspecified
medium
Target Milestone: rc
: 1.3
Assignee: Tom McKay
QA Contact: Tazim Kolhar
URL:
Whiteboard:
Depends On:
Blocks: sam20-tracker
TreeView+ depends on / blocked
 
Reported: 2013-07-29 11:34 UTC by Tazim Kolhar
Modified: 2016-04-26 00:59 UTC (History)
4 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2016-03-11 03:32:11 UTC
Embargoed:

Attachments (Terms of Use)

Description Tazim Kolhar 2013-07-29 11:34:38 UTC 
Description of problem:
User should have ReadMe or Help page description for CLI command that _requires_ --environment option

Version-Release number of selected component (if applicable):
# rpm -qa  | grep katello
katello-certs-tools-1.4.2-1.el6.noarch
katello-glue-candlepin-1.4.2-1.git.987.b81455e.el6.noarch
katello-candlepin-cert-key-pair-1.0-1.noarch
katello-cli-1.4.2-1.git.137.fea0d84.el6.noarch
katello-cli-common-1.4.2-1.git.137.fea0d84.el6.noarch
katello-glue-elasticsearch-1.4.2-1.git.987.b81455e.el6.noarch
katello-headpin-1.4.2-1.git.987.b81455e.el6.noarch
signo-katello-0.0.9-1.el6.noarch
katello-configure-1.4.3-1.git.67.f71e590.el6.noarch
katello-common-1.4.2-1.git.987.b81455e.el6.noarch
katello-headpin-all-1.4.2-1.git.987.b81455e.el6.noarch
katello-selinux-1.4.3-1.git.4.99dc194.el6.noarch
katello-repos-1.4.2-1.el6.noarch


How reproducible:
# yum install -y katello-headpin-all
# katello-configure --deployment=headpin --user-pass=PASSWORD

Steps to Reproduce:
1.# headpin -u admin -p **** activation_key create --help
Usage:  headpin <options> activation_key create <options>

Options:
  -h, --help            show this help message and exit
  --name=NAME           activation key name (required)
  --org=ORG             name of organization e.g.: ACME_Corporation (required)
  --environment=ENVIRONMENT
                        environment name e.g.: production (required)
  --description=DESCRIPTION
                        activation key description
  --limit=USAGE_LIMIT   usage limit (unlimited by default)
  -g                    grep friendly output
  -v                    verbose, more structured output
  -d DELIMITER          column delimiter in grep friendly output, works only
                        with option -g
  --noheading           Suppress any heading output. Useful if grepping the
                        output.


2.# headpin -u admin -p **** activation_key create --name act_key2 --org ACME_Corporation  --environment=Library
Successfully created activation key [ act_key2 ]


3.As you see above cli example, environment name (Library default value)
  something like that should be mentioned.

Actual results:
A proper ReadMe should be provided

Expected results:
No such notes made in the man/help page 

Additional info:
Comment 1 Tazim Kolhar 2013-07-29 12:59:44 UTC 
Hi,

list of cli headpin commands where there is requirement of 
ReadMe page :

# headpin -u admin -p *** activation_key list --help

# headpin -u admin -p *** activation_key update --help

# headpin -u admin -p *** distributor update --help

# headpin -u admin -p *** system update --help

# headpin -u admin -p *** user create --help

Thanks
Note You need to log in before you can comment on or make changes to this bug.