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

Help output is truncated #2733

Closed
mperry2 opened this issue Jun 23, 2020 · 1 comment · Fixed by #2768
Closed

Help output is truncated #2733

mperry2 opened this issue Jun 23, 2020 · 1 comment · Fixed by #2768
Assignees
Labels

Comments

@mperry2
Copy link
Contributor

mperry2 commented Jun 23, 2020

Issue Type

  • Bug report

Molecule and Ansible details

ansible 2.9.9
  config file = /export/home/mperry/.ansible.cfg
  configured module search path = ['/export/home/mperry/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /export/home/mperry/.local/lib/python3.7/site-packages/ansible
  executable location = /export/home/mperry/.local/bin/ansible
  python version = 3.7.3 (default, Dec 20 2019, 18:57:59) [GCC 8.3.0]
molecule 3.0.4
   ansible==2.9.9 python==3.7

Molecule installation method (one of):

  • pip

Ansible installation method (one of):

  • pip

Detail any linters or test runners used:

  • n/a

Desired Behavior

The help output should have complete sentences and describe the function of each command. The output should continue on to a new line if necessary similar to the help output of the -c and -e options listed in the "Options" section of the help.

Actual Behaviour

Some of the help output for the molecule commands is truncated with an ellipsis. Many of these are incomplete sentences, so the help output for those commands is not useful.

Example output is reproduced below where you can see the check, cleanup, converge, idempotence, prepare, and test commands have incomplete output.

$ molecule --help
Usage: molecule [OPTIONS] COMMAND [ARGS]...

  Molecule aids in the development and testing of Ansible roles.

  Enable autocomplete issue:

    eval "$(_MOLECULE_COMPLETE=source molecule)"

Options:
  --debug / --no-debug    Enable or disable debug mode. Default is disabled.
  -c, --base-config TEXT  Path to a base config.  If provided Molecule will
                          load this config first, and deep merge each
                          scenario's molecule.yml on top. By default is
                          looking for config in current VCS repository and if
                          not found it will look on user home.
                          (/export/home/mperry/.config/molecule/config.yml)

  -e, --env-file TEXT     The file to read variables from when rendering
                          molecule.yml. (.env.yml)

  --version               Show the version and exit.
  --help                  Show this message and exit.

Commands:
  check        Use the provisioner to perform a Dry-Run (destroy,...
  cleanup      Use the provisioner to cleanup any changes made to external...
  converge     Use the provisioner to configure instances (dependency,...
  create       Use the provisioner to start the instances.
  dependency   Manage the role's dependencies.
  destroy      Use the provisioner to destroy the instances.
  drivers      List drivers.
  idempotence  Use the provisioner to configure the instances and parse the...
  init         Initialize a new role or scenario.
  lint         Lint the role (dependency, lint).
  list         List status of instances.
  login        Log in to one instance.
  matrix       List matrix of steps used to test instances.
  prepare      Use the provisioner to prepare the instances into a...
  reset        Reset molecule temporary folders.
  side-effect  Use the provisioner to perform side-effects to the instances.
  syntax       Use the provisioner to syntax check the role.
  test         Test (dependency, lint, cleanup, destroy, syntax, create,...
  verify       Run automated tests against instances.
@mperry2 mperry2 added the bug label Jun 23, 2020
@ssbarnea
Copy link
Member

This is caused by a mind-blowing upstream bug in pallets/click#486 -- somehow "help" is truncated while "short_help" is not.

@ssbarnea ssbarnea self-assigned this Jul 30, 2020
ssbarnea added a commit to ssbarnea/molecule that referenced this issue Jul 30, 2020
ssbarnea added a commit that referenced this issue Aug 10, 2020
* Avoid abridged click output

Fixes: #2733
Related: pallets/click#486

* Update base.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants