omnibus/cli: Exit with non-zero code on failure

[legal90]

Description

Fixes #821

Omnibus CLI inherits the base of Thor, which returns 0 for failed commands by default. Refer to rails/thor#244 for more details.

[thommay]

This certainly mirrors the advice on the linked bug. @legal90 i presume you've verified that this works?

[legal90]

@thommay Yes, I've verified:
Both of Example n.2 and Example n.3 from #821 return 1 instead of 0 now:

$ bundle exec omnibus build with something
                    [CLI] I | 2018-02-12T14:46:51+01:00 | Using config from 'omnibus.rb'
ERROR: "omnibus build" was called with arguments ["with", "something"]
Usage: "omnibus build PROJECT"

$ echo $?
1

$ bundle exec omnibus help me
Could not find command "me".

$ echo $?
1

Example n.1 (bundle exec omnibus) still returns 0, but I guess that is an expected behavior in Thor, because that is just a usage call, without actual error occurred.

[schisamo]

Would it be possible to add some Aruba coverage for this change?
https://github.com/chef/omnibus/tree/master/features/commands

[legal90]

@schisamo I would like to, but I don't know how to get it working.

I've added this to build.feature:

  Scenario: When the command contains extra arguments
    When I run `omnibus build bacon eggs`

    Then the output should contain:
         """
         Usage: "omnibus build PROJECT"
         """
    And  the exit status should not be 0

But it fails with a weird error:

$ bundle exec cucumber --color features/commands/build.feature
Feature: omnibus build

  Background:                                      # features/commands/build.feature:2
    Given I have an omnibus project named "hamlet" # features/step_definitions/generator_steps.rb:3

  Scenario: When the project does not exist # features/commands/build.feature:5
    When I run `omnibus build bacon`        # aruba-0.14.2/lib/aruba/cucumber/command.rb:13
    Then the output should contain:         # aruba-0.14.2/lib/aruba/cucumber/command.rb:205
      """
      I could not find a project named `bacon' in any of the project locations:
      """
    And the exit status should not be 0     # aruba-0.14.2/lib/aruba/cucumber/command.rb:277

  Scenario: When the command contains extra arguments # features/commands/build.feature:14
    When I run `omnibus build bacon eggs`             # aruba-0.14.2/lib/aruba/cucumber/command.rb:13
      exit (SystemExit)
      ./lib/omnibus/cli.rb:42:in `execute!'
      features/commands/build.feature:15:in `When I run `omnibus build bacon eggs`'
    Then the output should contain:                   # aruba-0.14.2/lib/aruba/cucumber/command.rb:205
      """
      Usage: "omnibus build PROJECT"
      """
    And the exit status should not be 0               # aruba-0.14.2/lib/aruba/cucumber/command.rb:277

Failing Scenarios:
cucumber features/commands/build.feature:14 # Scenario: When the command contains extra arguments

2 scenarios (1 failed, 1 passed)
8 steps (1 failed, 2 skipped, 5 passed)
0m0.069s

[legal90]

@thommay @schisamo Do you guys have any suggestions how to fix cucumber error I've posted above?

[legal90]

Hi guys. I'm not interested in this PR anymore since I stopped working on Omnibus.
But I keep this branch available, so feel free to rebase it if you want this bug to be fixed. Cheers!

[scotthain]

Thanks @legal90! Appreciate the efforts you've put in to the project :)

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[vkarve-chef]

thanks for the fix, @legal90. we'll take up adding cucumber tests in our backlog.