mirror of
https://github.com/inspec/inspec
synced 2024-12-18 09:03:12 +00:00
75f39e74f2
shadow file. After much thought the deprecations from #2642 were for the wrong methods. Plural method names feel much more natural when working with this resource because you can have more than a single result. Consider a match like `shadow.user(/^www/)`, this could return multiple users, so `shadow.users` feels more natural here. The problem is that the fields we're matching in the shadow file itself are singular. Each entry is for a user, which has a password, and some other fields. A user never has `passwords` in the shadow file, only a `password`. This is made more obvious when you use the `filter` method. When we use this filter: `shadow.filter(min_days: 20, max_days: 30)` we are matching fields in the shadow file and not using our matcher methods. This means that if there is a discrepancy between our matcher methods, and the shadow fields the user could end up confused. Like I did =) This PR changes: Changed matchers to match shadow fields. Updated documentation to reflect changes. Updated tests to reflect changes. Re-add `filter` method, and add a test for it. Renamed variable for FilterTable to be less confusing. Renamed query argument for methods to be consistent. Cleanup docs based on comments from @jerryaldrichiii Make Rubocop happy <3 Signed-off-by: Miah Johnson <miah@chia-pet.org>
128 lines
3.9 KiB
Ruby
128 lines
3.9 KiB
Ruby
# encoding: utf-8
|
|
|
|
require 'helper'
|
|
require 'inspec/resource'
|
|
|
|
describe 'Inspec::Resources::Shadow' do
|
|
let(:shadow) { load_resource('shadow') }
|
|
|
|
it 'content should be mapped correctly' do
|
|
_(shadow.content).must_equal "root:x:1:2:3\nwww-data:!!:10:20:30:40:50:60"
|
|
end
|
|
|
|
it 'retrieve users via field' do
|
|
_(shadow.user).must_equal %w{root www-data}
|
|
_(shadow.count).must_equal 2
|
|
end
|
|
|
|
it 'retrieve passwords via field' do
|
|
_(shadow.password).must_equal %w{x !!}
|
|
end
|
|
|
|
it 'retrieve last password change via field' do
|
|
_(shadow.last_change).must_equal %w{1 10}
|
|
end
|
|
|
|
it 'retrieve min password days via field' do
|
|
_(shadow.min_days).must_equal %w{2 20}
|
|
end
|
|
|
|
it 'retrieve max password days via field' do
|
|
_(shadow.max_days).must_equal %w{3 30}
|
|
end
|
|
|
|
it 'retrieve warning days for password expiry via field' do
|
|
_(shadow.warn_days).must_equal [nil, "40"]
|
|
end
|
|
|
|
it 'retrieve days before account is inactive via field' do
|
|
_(shadow.inactive_days).must_equal [nil, "50"]
|
|
end
|
|
|
|
it 'retrieve dates when account will expire via field' do
|
|
_(shadow.expiry_date).must_equal [nil, "60"]
|
|
end
|
|
|
|
it 'access all lines of the file' do
|
|
_(shadow.lines[0]).must_equal 'root:x:1:2:3::::'
|
|
end
|
|
|
|
it 'access all params of the file' do
|
|
_(shadow.params[0]).must_equal({
|
|
'user' => 'root', 'password' => 'x', 'last_change' => '1',
|
|
'min_days' => '2', 'max_days' => '3', 'warn_days' => nil,
|
|
'inactive_days' => nil, 'expiry_date' => nil, 'reserved' => nil,
|
|
})
|
|
end
|
|
|
|
it 'returns deprecation notice on user property' do
|
|
proc { _(shadow.users).must_equal %w{root www-data} }.must_output nil,
|
|
'[DEPRECATION] The shadow `users` property is deprecated and will' \
|
|
" be removed in InSpec 3.0. Please use `user` instead.\n"
|
|
end
|
|
|
|
it 'returns deprecatation notice on password property' do
|
|
proc { _(shadow.passwords).must_equal %w{x !!} }.must_output nil,
|
|
'[DEPRECATION] The shadow `passwords` property is deprecated and will' \
|
|
" be removed in InSpec 3.0. Please use `password` instead.\n"
|
|
end
|
|
|
|
it 'returns deprecation notice on last_change property' do
|
|
proc { _(shadow.last_changes).must_equal %w{1 10} }.must_output nil,
|
|
'[DEPRECATION] The shadow `last_changes` property is deprecated and will' \
|
|
" be removed in InSpec 3.0. Please use `last_change` instead.\n"
|
|
end
|
|
|
|
it 'returns deprecation notice on expiry_dates property' do
|
|
proc { _(shadow.expiry_dates).must_equal [nil, "60"] }.must_output nil,
|
|
'[DEPRECATION] The shadow `expiry_dates` property is deprecated and will' \
|
|
" be removed in InSpec 3.0. Please use `expiry_date` instead.\n"
|
|
end
|
|
|
|
describe 'multiple filters' do
|
|
it 'filters with min_days and max_days' do
|
|
_(shadow.filter(min_days: 20, max_days: 30).user).must_equal ['www-data']
|
|
_(shadow.filter(last_change: 1, min_days: 2).user).must_equal ['root']
|
|
end
|
|
end
|
|
|
|
describe 'filter via name =~ /^www/' do
|
|
let(:child) { shadow.user(/^www/) }
|
|
|
|
it 'filters by user via name (regex)' do
|
|
_(child.user).must_equal ['www-data']
|
|
_(child.count).must_equal 1
|
|
end
|
|
|
|
it 'prints a nice to_s string' do
|
|
_(child.to_s).must_equal '/etc/shadow with user == /^www/'
|
|
end
|
|
end
|
|
|
|
describe 'filter via name = root' do
|
|
let(:child) { shadow.user('root') }
|
|
|
|
it 'filters by user name' do
|
|
_(child.user).must_equal %w{root}
|
|
_(child.count).must_equal 1
|
|
end
|
|
end
|
|
|
|
describe 'filter via min_days' do
|
|
let(:child) { shadow.min_days('20') }
|
|
|
|
it 'filters by property' do
|
|
_(child.user).must_equal %w{www-data}
|
|
_(child.count).must_equal 1
|
|
end
|
|
end
|
|
|
|
describe 'it raises errors' do
|
|
it 'raises error on unsupported os' do
|
|
resource = MockLoader.new(:windows).load_resource('shadow')
|
|
_(resource.resource_skipped?).must_equal true
|
|
_(resource.resource_exception_message)
|
|
.must_equal 'Resource Shadow is not supported on platform windows/6.2.9200.'
|
|
end
|
|
end
|
|
end
|