fix(help command): RHMAP-19895 - Fix issues and allow use fhc command…

[camilamacedo86]

JIRA:

https://issues.jboss.org/browse/RHMAP-19895

WHAT:

• Fix some issues related to fhc help command
• Allow users call the fhc help command by fhc <commands> --help OR fhc <commands> help
• Upgrade version of yargs from 9.0.1 to 12.0.1
• Removing support from NodeJS versions < 6

WHY:

• Solve bugs in the fhc help command
• Allow users use --help and help at the end which is more intuitive and according to the code/message text shows that already should work

HOW:

• Fixing points of the code which was calling the old doc implementation
• Fixing points to show the desc when is the last command of a tree which did not require params

Break changes checks:

Following the details about the break changes from 9.0.1 to 12.0.1

10.0.0

• .usage() no longer accepts an options object as the second argument. It can instead be used as an alias for configuring a default command. (the commands are using alias)
• previously hidden options were simply implied using a falsy description (no hidden options are used here)
• help command now only executes if it's the last positional in argv._ ( it is not using the help from yargs and instead of it a help command is implemented in the project, shows that it is a new feature which was not available when it was implemented in the project )

11.0.0

• requiresArg now has significantly different error output, matching nargs. ( not used in the project )

12.0.0

• Options absent from argv (not set via CLI argument) are now absent from the parsed result object rather than being set with undefined (it is not using options absent from argv)
• drop Node 4 from testing matrix, such that we'll gradually start drifting away from supporting Node 4. - (It is something that affect the eng of this project. The "node": ">=4.4" need to be replace for "node": ">=6". However, the NodeJS 4 is deprecated and this project is not so long tested via Jenkins with it)
• yargs-parser does not populate 'false' when boolean flag is not passed - (not used)
• tests that assert against help output will need to be updated (help fetaure from yargs is not used)

Ref: https://github.com/yargs/yargs/blob/master/CHANGELOG.md

Steps to verify it:

• Check if the fhc help works
• Check if the fhc help command works
• Check if the fhc help command --help works
• Check if the fhc help command help works
• Check if the CI finish with success ( project with a good coverage )

(To validate yargs)

• Check if when a final command that can be executed without parameter still work ( E.g users list )
  • Check if the commands still getting the parameters.

Following the tests performed locally.

• Check if the fhc help works

  

• Check if the fhc help command works

  

• Check if the fhc help command command works

  

• Check if the fhc help command command command works

  

• Check if the fhc command --help works

  

• Check if the fhc command command --help works

  

• Check if the fhc command command command --help works

  

• Check if the fhc command help works

  

• Check if the fhc command command help works

  

• Check if the fhc command command command help works

  

  • Check if when a final command that can be executed without parameter still work ( E.g users list )

    

  • Check if when a final command that can be executed without parameter still work ( E.g users list )

• Check if the commands still getting the parameters.

[damienomurchu]

Just verified this according to the verification steps above. All seems to function as expected. Just want to test around edge cases and will approve then if all ok :)

[camilamacedo86]

@damienomurchu tks for the collaboration 👍 🥇

[damienomurchu]

@camilamacedo86 there seems to be a regression introduced with these changes where help output is no longer been output from the below commands:

• fhc 4.25 (latest published version):

  
  ╭─ ~/work/fh-fhc ‹706f3eb*› 
  ╰─$ fhc ping --help                                               
  Options:
  --help     Show help                                        [boolean]
  --version  Show version number                              [boolean]

fhc ERR! cb() never called! fhc ERR!
fhc Command executed with error ╭─ ~/work/fh-fhc ‹706f3eb*› ╰─$ fhc ping help
Usage: fhc ping --app= --env=

Options: --help Show help [boolean] --version Show version number [boolean] --app, -a Unique 24 character GUID of your cloud application. [required] --env, -e Unique 24 character GUID of the environment where this cloud application is deployed. [required]

Examples: fhc ping --app= Ping the cloud application --env=

Missing required argument: env fhc ERR! YError: Missing required argument: env fhc ERR! fhc ERR! System Linux 4.14.11-200.fc26.x86_64 fhc ERR! command "/home/damienmurphy/.nvm/versions/node/v6.9.5/bin/node" "/home/damienmurphy/.nvm/versions/node/v6.9.5/bin/fhc" "ping" "help" fhc Command executed with error

- fhc changes from this PR

╭─ ~/work/fh-fhc ‹706f3eb› ╰─$ node ./bin/fhc.js ping --help
Ping a cloud app ╭─ ~/work/fh-fhc ‹706f3eb› ╰─$ node ./bin/fhc.js help ping
Ping a cloud app

[camilamacedo86]

@damienomurchu it is not a regression it is a fix.

When the command node ./bin/fhc.js ping --help runs should show the help/desc of the ping command. In the published version it is returning the --help desc instead of the ping command desc which was fixed in this pr.

Note, How can be useful for the user run fhc command --help and receive the following/current message?

╭─ ~/work/fh-fhc ‹706f3eb*› 
╰─$ fhc ping --help                                               
Options:
  --help     Show help                                        [boolean]
  --version  Show version number                              [boolean]

fhc ERR! cb() never called!
fhc ERR!  
fhc Command executed with error

The goal of using the help command is to receive a message with the description of the command to know what does it.

$ node ./bin/fhc.js ping --help                                                                   
Ping a cloud app

c/c @davidffrench

[davidffrench]

@camilamacedo86 Unfortunately JIRA is currently down so I can't look at the original ticket opened by peter.

The expectation of running --help is to see what the usage and parameters should be. I would expect and a normal user would expect to see the following on a --help

Usage:
 fhc ping --app=<app> --env=<env>

Options:
  --help     Show help                                        [boolean]
  --version  Show version number                              [boolean]
  --app, -a  Unique 24 character GUID of your cloud application.
                                                             [required]
  --env, -e  Unique 24 character GUID of the environment where this
             cloud application is deployed.                  [required]

[camilamacedo86]

@davidffrench and @damienomurchu thank you for the collab. I catcher what you mean. It is fixed now. Please, feel free to re-check. Following some tests.

[camilamacedo86]

@damienomurchu the changes requested were made. Regards the break changes just the support of the NodeJS 4 which is deprecated that affects this project since in the project eng it was defined as >= 4.4 then it was changed and the bumped version is 6.0.0. However, note that in the reality this project has not been checked with versions lower than 6 a while and it should already be changed. Also, all analyse was added in the first comment of this PR.

Please, could you check?

[camilamacedo86]

Hi folks (@damienomurchu, @davidffrench, @austincunningham)

The changes requested here were made. Please, could you check this one? Could we move forward?