Bug 1545861 - miqldap_to_sssd help message is incorrect
Summary: miqldap_to_sssd help message is incorrect
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat CloudForms Management Engine
Classification: Red Hat
Component: Appliance
Version: 5.9.0
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: GA
: 5.10.0
Assignee: Joe Vlcek
QA Contact: Mike Shriver
URL:
Whiteboard: auth:miqldap:externalauth
Depends On:
Blocks: 1552791
TreeView+ depends on / blocked
 
Reported: 2018-02-15 17:38 UTC by Joe Vlcek
Modified: 2019-02-11 13:59 UTC (History)
6 users (show)

Fixed In Version: 5.10.0.0
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
: 1552791 (view as bug list)
Environment:
Last Closed: 2019-02-11 13:59:48 UTC
Category: ---
Cloudforms Team: ---
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Joe Vlcek 2018-02-15 17:38:50 UTC
Description of problem:
The description of the bind-pwd argument is incorrect.
The basedn-domain argument should be simply domain

The below:

% miqldap_to_sssd --help
Usage: ruby tools/miqldap_to_sssd.rb [options]
  -d, --basedn-domain                        The Base DN domain name, e.g. example.com
  -b, --bind-dn                              The Bind DN, credential to use to authenticate against LDAP e.g. cn=Manager,dc=example,dc=com
  -p, --bind-pwd                             The Base DN domain name, e.g. example.com
  -c, --tls-cacert                           Path to certificate file
  -n, --only-change-userids                  normalize the userids then exit
  -s, --skip-post-conversion-userid-change   Do the MiqLdap to SSSD conversion but skip the normalizing of the userids
  -h, --help                                 Show this message

Should become:

miqldap_to_sssd --help
Usage: ruby tools/miqldap_to_sssd.rb [options]
  -d, --domain                               The domain name of the base DN, e.g. example.com
  -b, --bind-dn                              The Bind DN, credential to use to authenticate against LDAP e.g. cn=Manager,dc=example,dc=com
  -p, --bind-pwd                             The password for the Bind DN. 
  -c, --tls-cacert                           Path to certificate file
  -n, --only-change-userids                  normalize the userids then exit
  -s, --skip-post-conversion-userid-change   Do the MiqLdap to SSSD conversion but skip the normalizing of the userids
  -h, --help                                 Show this message

Comment 2 Dave Johnson 2018-02-15 17:45:49 UTC
Please assess the impact of this issue and update the severity accordingly.  Please refer to https://bugzilla.redhat.com/page.cgi?id=fields.html#bug_severity for a reminder on each severity's definition.

If it's something like a tracker bug where it doesn't matter, please set the severity to Low.

Comment 4 CFME Bot 2018-02-15 21:56:39 UTC
New commit detected on ManageIQ/manageiq/master:
https://github.com/ManageIQ/manageiq/commit/8d5fcab2553543dd5baa47e996a3dad9fd912198

commit 8d5fcab2553543dd5baa47e996a3dad9fd912198
Author:     Joe VLcek <jvlcek>
AuthorDate: Thu Feb 15 16:08:56 2018 -0500
Commit:     Joe VLcek <jvlcek>
CommitDate: Thu Feb 15 16:08:56 2018 -0500

    Fix errors in help message
    
    Fixes https://bugzilla.redhat.com/show_bug.cgi?id=1545861
    
    Update bind-pwd description in help message
    Change basedn-domain to domain
    Fix spelling error coversion to conversion for skip-post-conversion-userid-change

 spec/tools/miqldap_to_sssd/cli_spec.rb                   | 12 ++++++------
 spec/tools/miqldap_to_sssd/configure_apache_spec.rb      |  2 +-
 spec/tools/miqldap_to_sssd/miqldap_configuration_spec.rb | 14 +++++++-------
 tools/miqldap_to_sssd/cli.rb                             |  8 ++++----
 tools/miqldap_to_sssd/configure_apache.rb                |  2 +-
 tools/miqldap_to_sssd/converter.rb                       |  2 +-
 tools/miqldap_to_sssd/miqldap_configuration.rb           | 10 +++++-----
 tools/miqldap_to_sssd/sssd_conf.rb                       |  4 ++--
 tools/miqldap_to_sssd/sssd_conf/sssd.rb                  |  4 ++--
 9 files changed, 29 insertions(+), 29 deletions(-)

Comment 6 Mike Shriver 2018-08-03 15:42:14 UTC
Tested in 5.10.0.8.20180801220537_afb552b

The miqldap_to_sssd help content now maps '-d' and '--domain' for the Base DN domain.  --basedn-domain is no longer included in the help text.


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