enforce option values where needed #1918
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arlimus
force-pushed
the
dr/mandatory-opts-args
branch
from
04c0122
to
12a3875
Compare
arlimus
commented
Jun 11, 2017
lib/inspec/base_cli.rb
Outdated
| if o[v.to_sym] == -1 | ||
| raise ArgumentError, "Please provide a value for --#{v}. For example: --#{v}=hello." | ||
| end | ||
| end |
There was a problem hiding this comment.
The trick here is that due to the type constraint these values will never reach -1, even if called with --password=-1 as it's turned into "-1". We can't use nil because it just says the default is not defined (or really it's empty, since it cannot check for "not defined"), so this looked like a nice alternative. We could also take the golang approach and pass a {}, but since it's a full hash in ruby unlike Golang's empty interface I just picked the next best thing...
Due to limitations in Thor it is not possible to set an argument to be both optional and its value to be mandatory. E.g. the user supplying the --password argument is optional and not always required, but whenever it is used, it requires a value. Handle options that were defined with mandatory values in a way that fails with an `ArgumentError` if the value is missing, i.e.: ``` > inspec exec examples/profile --password ArgumentError: Please provide a value for --password. For example: --password=hello. ``` It works without `--password` or with `--password=arg`. Also handled for `--sudo-password`. Fixes: #1901 As suggested: #1904 Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
arlimus
force-pushed
the
dr/mandatory-opts-args
branch
from
12a3875
to
eb1a9cd
Compare
adamleff
added
Type: Enhancement
adamleff
changed the title
adamleff
added
Type: Bug
|
😁 kudos Adam!! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Due to limitations in Thor it is not possible to set an argument to be both optional and its value to be mandatory. E.g. the user supplying the --password argument is optional and not always required, but whenever it is used, it requires a value. Handle options that were defined with mandatory values in a way that fails with an
ArgumentErrorif the value is missing, i.e.:It works without
--passwordor with--password=arg. Also handled for--sudo-password.Fixes: #1901
An alternative approach: #1904