inspec/test/unit/resources/json_test.rb
Adam Leff 12fec238f7
json resource: ensure params is not nil in even of read/parse failure (#2354)
When the JSON resource (and those that subclass off of it) were modified
to properly throw exceptions in the event of failure, this caused the
`params` method to return nil instead of what it used to be, an empty
hash.

This is fine in the case of a describe block, but it's not okay when used
outside of a describe, as it will cause users trying to pluck from the
hash to throw a dreaded-and-unhelpful NilClass error.

This change pre-populates the params to be an empty hash, and if the
read/parse steps fail, it will still be one.

Signed-off-by: Adam Leff <adam@leff.co>
2017-11-29 16:31:06 -05:00

110 lines
3.4 KiB
Ruby

# encoding: utf-8
# author: Christoph Hartmann
# author: Dominik Richter
require 'helper'
require 'inspec/resource'
describe 'Inspec::Resources::JSON' do
describe 'when loading a valid json' do
let (:resource) { load_resource('json', 'policyfile.lock.json') }
it 'gets params as a hashmap' do
_(resource.params).must_be_kind_of Hash
end
it 'retrieves nil if a param is missing' do
_(resource.params['missing']).must_be_nil
end
it 'retrieves params by name' do
_(resource.send('name')).must_equal 'demo'
end
it 'retrieves an array by name' do
_(resource.send('run_list')).must_equal %w{a b}
end
it 'doesnt resolve dot-notation names' do
_(resource.send('x.y.z')).must_be_nil
end
it 'doesnt resolve symbol-notation names' do
_(resource.send(:'x.y.z')).must_be_nil
end
end
describe 'when loading a nonexistent file' do
let(:resource) { load_resource('json', 'nonexistent.json') }
it 'produces an error' do
_(resource.resource_exception_message).must_equal 'No such file: nonexistent.json'
end
it 'still provides an empty hash for params' do
_(resource.params).must_equal({})
end
end
describe '#load_raw_from_file' do
let(:path) { '/path/to/file.txt' }
let(:resource) { Inspec::Resources::JsonConfig.allocate }
let(:inspec) { mock }
let(:file) { mock }
before do
resource.stubs(:inspec).returns(inspec)
inspec.expects(:file).with(path).returns(file)
end
it 'raises an exception when the file does not exist' do
file.expects(:file?).returns(false)
proc { resource.send(:load_raw_from_file, path) }.must_raise Inspec::Exceptions::ResourceSkipped
end
it 'raises an exception if the file content is nil' do
file.expects(:file?).returns(true)
file.expects(:content).returns(nil)
proc { resource.send(:load_raw_from_file, path) }.must_raise Inspec::Exceptions::ResourceSkipped
end
it 'raises an exception if the file content is empty' do
file.expects(:file?).returns(true)
file.expects(:content).at_least_once.returns('')
proc { resource.send(:load_raw_from_file, path) }.must_raise Inspec::Exceptions::ResourceSkipped
end
it 'returns the file content' do
file.expects(:file?).returns(true)
file.expects(:content).at_least_once.returns('json goes here')
resource.send(:load_raw_from_file, path).must_equal 'json goes here'
end
end
describe '#load_raw_from_file' do
let(:cmd_str) { 'curl localhost' }
let(:resource) { Inspec::Resources::JsonConfig.allocate }
let(:inspec) { mock }
let(:command) { mock }
before do
resource.stubs(:inspec).returns(inspec)
inspec.expects(:command).with(cmd_str).returns(command)
end
it 'raises an exception if command stdout is nil' do
command.expects(:stdout).returns(nil)
proc { resource.send(:load_raw_from_command, cmd_str) }.must_raise Inspec::Exceptions::ResourceSkipped
end
it 'raises an exception if command stdout is empty' do
command.expects(:stdout).returns('')
proc { resource.send(:load_raw_from_command, cmd_str) }.must_raise Inspec::Exceptions::ResourceSkipped
end
it 'returns the command output' do
command.expects(:stdout).returns('json goes here')
resource.send(:load_raw_from_command, cmd_str).must_equal 'json goes here'
end
end
end