2017-12-06 21:22:11 +00:00
|
|
|
# encoding: utf-8
|
|
|
|
# copyright: 2017, Chef Software Inc.
|
|
|
|
|
|
|
|
require 'helper'
|
|
|
|
require 'thor'
|
|
|
|
|
|
|
|
describe 'BaseCLI' do
|
|
|
|
let(:cli) { Inspec::BaseCLI.new }
|
|
|
|
|
|
|
|
describe 'merge_options' do
|
2018-02-09 16:46:09 +00:00
|
|
|
let(:default_options) do
|
|
|
|
{ exec: { 'reporter' => ['json'], 'backend_cache' => false }}
|
|
|
|
end
|
|
|
|
|
2017-12-06 21:22:11 +00:00
|
|
|
it 'cli defaults populate correctly' do
|
|
|
|
Inspec::BaseCLI.stubs(:default_options).returns(default_options)
|
|
|
|
|
2017-12-07 12:19:36 +00:00
|
|
|
opts = cli.send(:merged_opts, :exec)
|
2018-04-05 12:51:51 +00:00
|
|
|
expected = {"backend_cache"=>false, "reporter"=>{"json"=>{"stdout"=>true}}, "type"=>:exec}
|
2017-12-06 21:22:11 +00:00
|
|
|
opts.must_equal expected
|
|
|
|
end
|
|
|
|
|
2018-02-20 12:37:23 +00:00
|
|
|
it 'verify platform detect' do
|
|
|
|
hash = { name: 'test-os', families: 'aws, cloud', release: 'aws-sdk-v1' }
|
|
|
|
expect = <<EOF
|
|
|
|
Name: \e[1m\e[35mtest-os\e[0m
|
|
|
|
Families: \e[1m\e[35maws, cloud\e[0m
|
|
|
|
Release: \e[1m\e[35maws-sdk-v1\e[0m
|
|
|
|
EOF
|
|
|
|
_(Inspec::BaseCLI.detect(params: hash, indent: 2, color: 35)).must_equal expect
|
|
|
|
end
|
|
|
|
|
2017-12-06 21:22:11 +00:00
|
|
|
it 'json-config options override cli defaults' do
|
|
|
|
Inspec::BaseCLI.stubs(:default_options).returns(default_options)
|
|
|
|
|
|
|
|
parsed_json = { 'backend_cache' => true }
|
|
|
|
cli.expects(:options_json).returns(parsed_json)
|
|
|
|
|
2017-12-07 12:19:36 +00:00
|
|
|
opts = cli.send(:merged_opts, :exec)
|
2018-04-05 12:51:51 +00:00
|
|
|
expected = {"backend_cache"=>true, "reporter"=>{"json"=>{"stdout"=>true}}, "type"=>:exec}
|
2017-12-06 21:22:11 +00:00
|
|
|
opts.must_equal expected
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'cli options override json-config and default' do
|
|
|
|
Inspec::BaseCLI.stubs(:default_options).returns(default_options)
|
|
|
|
|
|
|
|
parsed_json = { 'backend_cache' => false }
|
|
|
|
cli.expects(:options_json).returns(parsed_json)
|
|
|
|
|
|
|
|
cli_options = { 'backend_cache' => true }
|
|
|
|
cli.instance_variable_set(:@options, cli_options)
|
|
|
|
|
2017-12-07 12:19:36 +00:00
|
|
|
opts = cli.send(:merged_opts, :exec)
|
2018-04-05 12:51:51 +00:00
|
|
|
expected = {"backend_cache"=>true, "reporter"=>{"json"=>{"stdout"=>true}}, "type"=>:exec}
|
2017-12-06 21:22:11 +00:00
|
|
|
opts.must_equal expected
|
|
|
|
end
|
2017-12-07 12:19:36 +00:00
|
|
|
|
|
|
|
it 'make sure shell does not get exec defaults' do
|
|
|
|
Inspec::BaseCLI.stubs(:default_options).returns(default_options)
|
|
|
|
|
|
|
|
opts = cli.send(:merged_opts)
|
|
|
|
expected = {}
|
|
|
|
opts.must_equal expected
|
|
|
|
end
|
2018-02-09 16:46:09 +00:00
|
|
|
|
|
|
|
it 'make sure default reporter is overriden by json-config format' do
|
|
|
|
default_options['reporter'] = ['cli']
|
|
|
|
Inspec::BaseCLI.stubs(:default_options).returns(default_options)
|
|
|
|
parsed_json = { 'format' => 'json' }
|
|
|
|
cli.expects(:options_json).returns(parsed_json)
|
|
|
|
|
|
|
|
opts = cli.send(:merged_opts, :exec)
|
2018-04-05 12:51:51 +00:00
|
|
|
expected = {"backend_cache"=>false, "reporter"=>{"json"=>{"stdout"=>true}}, "type"=>:exec}
|
2018-02-09 16:46:09 +00:00
|
|
|
opts.must_equal expected
|
|
|
|
end
|
2017-12-06 21:22:11 +00:00
|
|
|
end
|
2018-02-08 09:06:58 +00:00
|
|
|
|
2018-02-09 14:14:40 +00:00
|
|
|
describe 'configure_logger' do
|
|
|
|
let(:options) do
|
|
|
|
o = {
|
|
|
|
'log_location' => STDERR,
|
|
|
|
'log_level' => 'debug',
|
2018-02-09 16:19:52 +00:00
|
|
|
'reporter' => {
|
|
|
|
'json' => {
|
|
|
|
'stdout' => true,
|
|
|
|
},
|
|
|
|
},
|
2018-02-09 14:14:40 +00:00
|
|
|
}
|
|
|
|
Thor::CoreExt::HashWithIndifferentAccess.new(o)
|
|
|
|
end
|
2018-02-09 16:19:52 +00:00
|
|
|
let(:format) do
|
|
|
|
device = options[:logger].instance_variable_get(:"@logdev")
|
|
|
|
device.instance_variable_get(:"@dev")
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'sets to stderr for log_location' do
|
|
|
|
cli.send(:configure_logger, options)
|
|
|
|
format.must_equal STDERR
|
|
|
|
end
|
2018-02-09 14:14:40 +00:00
|
|
|
|
2018-02-09 16:46:09 +00:00
|
|
|
it 'sets to stderr for json' do
|
2018-02-09 16:19:52 +00:00
|
|
|
options.delete('log_location')
|
|
|
|
options.delete('log_level')
|
|
|
|
cli.send(:configure_logger, options)
|
2018-02-09 16:46:09 +00:00
|
|
|
format.must_equal STDERR
|
2018-02-09 16:19:52 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
it 'sets defaults to stdout for everything else' do
|
|
|
|
options.delete('log_location')
|
|
|
|
options.delete('log_level')
|
|
|
|
options.delete('reporter')
|
|
|
|
|
2018-02-09 14:14:40 +00:00
|
|
|
cli.send(:configure_logger, options)
|
2018-02-09 16:19:52 +00:00
|
|
|
format.must_equal STDOUT
|
2018-02-09 14:14:40 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2018-02-08 09:06:58 +00:00
|
|
|
describe 'parse_reporters' do
|
|
|
|
it 'parse cli reporters' do
|
|
|
|
opts = { 'reporter' => ['cli'] }
|
|
|
|
parsed = Inspec::BaseCLI.parse_reporters(opts)
|
|
|
|
assert = { 'reporter' => { 'cli' => { 'stdout' => true }}}
|
|
|
|
parsed.must_equal assert
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'parse cli reporters with format' do
|
|
|
|
opts = { 'format' => 'json' }
|
|
|
|
parsed = Inspec::BaseCLI.parse_reporters(opts)
|
|
|
|
assert = { 'reporter' => { 'json' => { 'stdout' => true }}}
|
|
|
|
parsed.must_equal assert
|
|
|
|
end
|
2018-02-18 11:17:00 +00:00
|
|
|
|
|
|
|
it 'parse cli reporters with format and output' do
|
2018-02-19 16:52:56 +00:00
|
|
|
error = "[DEPRECATED] The option --format is being deprecated and will be removed in inspec 3.0. Please use --reporter\n"
|
|
|
|
error += "[DEPRECATED] The option 'output' is being deprecated and will be removed in inspec 3.0. Please use --reporter name:path\n"
|
2018-02-18 11:17:00 +00:00
|
|
|
proc {
|
|
|
|
opts = { 'format' => 'json', 'output' => '/tmp/inspec_out.json' }
|
|
|
|
parsed = Inspec::BaseCLI.parse_reporters(opts)
|
|
|
|
assert = { 'reporter' => { 'json' => { 'file' => '/tmp/inspec_out.json', 'stdout' => false }}}
|
|
|
|
parsed.must_equal assert
|
|
|
|
}.must_output nil, error end
|
|
|
|
end
|
2018-02-08 09:06:58 +00:00
|
|
|
|
|
|
|
describe 'validate_reporters' do
|
|
|
|
it 'valid reporter' do
|
|
|
|
stdout = { 'stdout' => true }
|
|
|
|
reporters = { 'json' => stdout }
|
|
|
|
Inspec::BaseCLI.validate_reporters(reporters)
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'invalid reporter type' do
|
|
|
|
reporters = ['json', 'magenta']
|
|
|
|
proc { Inspec::BaseCLI.validate_reporters(reporters) }.must_raise NotImplementedError
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'two reporters outputting to stdout' do
|
|
|
|
stdout = { 'stdout' => true }
|
|
|
|
reporters = { 'json' => stdout, 'cli' => stdout }
|
|
|
|
proc { Inspec::BaseCLI.validate_reporters(reporters) }.must_raise ArgumentError
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
describe 'suppress_log_output?' do
|
|
|
|
it 'suppresses json' do
|
|
|
|
opts = { 'reporter' => { 'json' => { 'stdout' => true }}}
|
|
|
|
cli.send(:suppress_log_output?, opts).must_equal true
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'do not suppresses json-min when going to file' do
|
|
|
|
opts = { 'reporter' => { 'json-min' => { 'file' => '/tmp/json' }}}
|
|
|
|
cli.send(:suppress_log_output?, opts).must_equal false
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'suppresses json-rspec' do
|
|
|
|
opts = { 'reporter' => { 'json-rspec' => { 'stdout' => true }}}
|
|
|
|
cli.send(:suppress_log_output?, opts).must_equal true
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'suppresses junit' do
|
|
|
|
opts = { 'reporter' => { 'junit' => { 'stdout' => true }}}
|
|
|
|
cli.send(:suppress_log_output?, opts).must_equal true
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'do not suppresses cli' do
|
|
|
|
opts = { 'reporter' => { 'cli' => nil } }
|
|
|
|
cli.send(:suppress_log_output?, opts).must_equal false
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'do not suppresses cli' do
|
|
|
|
opts = { 'reporter' => { 'cli' => nil, 'json' => {'file' => '/tmp/json' }}}
|
|
|
|
cli.send(:suppress_log_output?, opts).must_equal false
|
|
|
|
end
|
|
|
|
end
|
2017-12-06 21:22:11 +00:00
|
|
|
end
|