inspec/test/unit/source_readers/inspec_test.rb
Adam Leff dfce561276 Provide better error message when inspec.yml is invalid
Currently, if the inspec.yml for a profile is invalid (such as including
an improperly-defined multi-line string), InSpec will throw an exception
from the YAML parser that does not given a clear indication that the
issue was encountered while parsing the inspec.yml file.

This change introduces a better exception message to clue the user into
where the problem actually lies.

Signed-off-by: Adam Leff <adam@leff.co>
2017-03-09 18:03:01 +01:00

49 lines
1.5 KiB
Ruby

# encoding: utf-8
# author: Dominik Richter
# author: Christoph Hartmann
require 'helper'
describe SourceReaders::InspecReader do
let(:reader) { SourceReaders::InspecReader }
it 'registers with the source readers registry' do
reg = Inspec::SourceReader.registry
_(reg['inspec']).must_equal reader
end
describe 'with a valid profile' do
let(:mock_file) { MockLoader.profile_tgz('complete-profile') }
let(:target) { Inspec::FileProvider.for_path(mock_file) }
let(:res) { Inspec::SourceReader.resolve(target) }
it 'resolves the target to inspec' do
_(res).must_be_kind_of reader
end
it 'retrieves metadata' do
_(res.metadata.params[:name]).must_equal 'complete'
end
it 'retrieves all files' do
_(res.tests.keys).must_equal %w{controls/filesystem_spec.rb}
_(res.tests.values[0]).must_match(/^control 'test01' do$/)
end
it 'retrieves all libraries' do
_(res.libraries.keys).must_equal %w{libraries/testlib.rb}
_(res.libraries.values[0]).must_match(/^# Library resource$/)
end
end
describe 'with an invalid inspec.yml' do
let(:mock_file) { MockLoader.profile_tgz('profile-with-bad-metadata') }
let(:target) { Inspec::FileProvider.for_path(mock_file) }
let(:res) { Inspec::SourceReader.resolve(target) }
it 'raises an exception' do
err = proc { _(res.metadata) }.must_raise RuntimeError
err.message.must_match(/Unable to parse inspec\.yml: line \d+/)
end
end
end