Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] epicli: wrong informations in help messages #1881

Closed
rafzei opened this issue Dec 1, 2020 · 1 comment
Closed

[BUG] epicli: wrong informations in help messages #1881

rafzei opened this issue Dec 1, 2020 · 1 comment

Comments

@rafzei
Copy link
Contributor

rafzei commented Dec 1, 2020

Describe the bug
We have some discrepancies in epicli --help messages.
Example:

epicli prepare --help
usage: epicli <command> [<args>] prepare [-h] --os
                                         {ubuntu-18.04,redhat-7,centos-7}

Creates a folder with all prerequisites to setup the offline requirements to
install a cluster offline.

optional arguments:
  -h, --help            show this help message and exit
  --os {ubuntu-18.04,redhat-7,centos-7}
                        The OS to prepare the offline requirements for:
                        ubuntu-18.04|redhat-7|centos-7

--os argument is not optional, it's required to run epicli prepare:

(...)
    sub_parser.add_argument('--os', type=str, required=True, dest='os', choices=['ubuntu-18.04', 'redhat-7', 'centos-7'],
                            help='The OS to prepare the offline requirements for: ubuntu-18.04|redhat-7|centos-7')

Second example:

epicli apply --help
usage: epicli <command> [<args>] apply [-h] [-f FILE] [--no-infra]
                                       [--skip-config]
                                       [--offline-requirements OFFLINE_REQUIREMENTS]
                                       [--vault-password VAULT_PASSWORD]
                                       [--profile-ansible-tasks]

Applies configuration from file.

optional arguments:
  -h, --help            show this help message and exit
  -f FILE, --file FILE  File with infrastructure/configuration definitions to
                        use.

--file is required, epicli looking nowhere for a file if we don't specify it and error appears:
12:02:11 ERROR epicli - expected str, bytes or os.PathLike object, not NoneType

How to reproduce
epicli --help
epicli prepare --help
epicli apply --help
epicli init --help
and so on..

Expected behavior
The help messages should reflect reality (code 😬 ).

@rafzei rafzei added this to the S20201217 milestone Dec 1, 2020
@mkyc mkyc modified the milestones: S20201217, S20201231 Dec 4, 2020
@mkyc mkyc modified the milestones: S20201231, S20210114 Dec 18, 2020
@seriva seriva self-assigned this Jan 5, 2021
@mkyc mkyc modified the milestones: S20210114, S20210128 Jan 14, 2021
@mkyc mkyc modified the milestones: S20210128, S20210211 Jan 28, 2021
@mkyc mkyc modified the milestones: S20210211, S20210225 Feb 12, 2021
@przemyslavic przemyslavic self-assigned this Feb 16, 2021
@przemyslavic
Copy link
Collaborator

Help messages verified for:

  • epicli init
  • epicli prepare
  • epicli apply
  • epicli delete
  • epicli upgrade
  • epicli test
  • epicli backup
  • epicli recovery

The messages appear to reflect the actual state and correctly describe the required and optional parameters for each epicli command.

@mkyc mkyc closed this as completed Feb 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants