Deprecate and warn when comparing against OS name with capitals/spaces #2397
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
jquick
force-pushed
the
jq/platform_downcase_name
branch
4 times, most recently
from
80d8a54
to
d4ab29d
Compare
jquick
force-pushed
the
jq/platform_downcase_name
branch
from
d4ab29d
to
68c2f9f
Compare
jquick
changed the title
|
@adamleff - I think this is ready for review, it will want to go in tandem with the train release. inspec/train#228 Note: I will redo this to be off the platform resource once that gets merged in. |
adamleff
suggested changes
Dec 20, 2017
lib/resources/os.rb
Outdated
| cleaned = other.downcase.tr(' ', '_') | ||
| Inspec::Log.warn "[DEPRECATED] Platform names will become lowercase in InSpec 2.0. Please match on '#{cleaned}' instead of '#{other}'" | ||
| end | ||
| super(other) |
There was a problem hiding this comment.
We want to compare against cleaned if we had to translate, right?
lib/resources/os.rb
Outdated
| def [](name) | ||
| # convert string to symbol | ||
| name = name.to_sym if name.is_a? String | ||
| return self.name if name == :name |
There was a problem hiding this comment.
For clarity purposes, we should probably change the method parameter from name to key or something like that so we're not overloading the use of name here.
adamleff
suggested changes
Dec 21, 2017
test/unit/resources/os_test.rb
Outdated
| @@ -6,6 +6,24 @@ | |||
| require 'inspec/resource' | |||
|
|
|||
| describe 'Inspec::Resources::Os' do | |||
| it 'verify NamedCleaned with uppercase' do | |||
There was a problem hiding this comment.
Forgive the pun, but can we Clean this up a bit?
let(:cleaner) { Inspec::Resources::OSResource::NameCleaned }
it 'does something' do
cleaner.new('blah')
# some test here
endIt feels repetitious to be defining cleaner in each test like that. If you don't want to use a let, we should at least consolidate two lines per test:
it 'does something' do
name = Inspec::Resources::OSResource::NameCleaned.new('something')
# the test
end
adamleff
approved these changes
Jan 2, 2018
adamleff
changed the title
Signed-off-by: Jared Quick <jquick@chef.io>
Signed-off-by: Jared Quick <jquick@chef.io>
Signed-off-by: Jared Quick <jquick@chef.io>
jquick
force-pushed
the
jq/platform_downcase_name
branch
from
bfff11c
to
ba04e38
Compare
Signed-off-by: Jared Quick <jquick@chef.io>
jquick
force-pushed
the
jq/platform_downcase_name
branch
from
ba04e38
to
e45e634
Compare
16 tasks
adamleff
approved these changes
Jan 4, 2018
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.
This change supports the new train lowercase/underscored platform names. inspec/train#228
Fixes #2407
This change will auto convert any profiles using the wrong format and give a warning to fix by 2.0.
Signed-off-by: Jared Quick jquick@chef.io