mirror of
https://github.com/inspec/inspec
synced 2024-11-23 21:23:29 +00:00
d0bc085412
When running InSpec with multiple profiles, and two or more of the profiles are read in using the "Flat" SourceReader (i.e. they are not actual profiles with a metadata file like inspec.yml, but rather just a folder containing .rb files with controls and tests in them), InSpec would throw a NilClass error when building the necessary objects for the formatter. The cause was in `#profile_contains_example` in the formatter code which checks to see if the profile name is the same as the profile_id in the given example. However, if both of those were nil, it would potentially match the wrong Flat-read profile. This change fixes this in two ways: refusing to match if the profile name or example profile ID is nil, and adding a default name to a profile if it doesn't have a title or name. This will solve the matching issue and also clean up the formatter output so users can more easily tell what tests are from which profile/path. Signed-off-by: Adam Leff <adam@leff.co>
251 lines
12 KiB
Ruby
251 lines
12 KiB
Ruby
# encoding: utf-8
|
||
# author: Dominik Richter
|
||
# author: Christoph Hartmann
|
||
|
||
require 'functional/helper'
|
||
|
||
describe 'inspec exec' do
|
||
include FunctionalHelper
|
||
|
||
it 'can execute the profile' do
|
||
out = inspec('exec ' + example_profile + ' --no-create-lockfile')
|
||
out.stderr.must_equal ''
|
||
out.exit_status.must_equal 0
|
||
stdout = out.stdout.force_encoding(Encoding::UTF_8)
|
||
stdout.must_include "\e[38;5;41m ✔ ssh-1: Allow only SSH Protocol 2\e[0m\n"
|
||
stdout.must_include "\e[38;5;41m ✔ tmp-1.0: Create /tmp directory\e[0m\n"
|
||
stdout.must_include "
|
||
\e[38;5;247m ↺ gordon-1.0: Verify the version number of Gordon (1 skipped)\e[0m
|
||
\e[38;5;247m ↺ Can't find file \"/tmp/gordon/config.yaml\"\e[0m
|
||
"
|
||
stdout.must_include "\nProfile Summary: \e[38;5;41m2 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m1 skipped\e[0m"
|
||
stdout.must_include "\nTest Summary: \e[38;5;41m4 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m1 skipped\e[0m\n"
|
||
end
|
||
|
||
it 'executes a minimum metadata-only profile' do
|
||
out = inspec('exec ' + File.join(profile_path, 'simple-metadata') + ' --no-create-lockfile')
|
||
out.stderr.must_equal ''
|
||
out.exit_status.must_equal 0
|
||
out.stdout.must_equal "
|
||
|
||
Profile: yumyum profile
|
||
Version: (not specified)
|
||
Target: local://
|
||
|
||
No tests executed.\e[0m
|
||
|
||
Test Summary: \e[38;5;41m0 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m0 skipped\e[0m
|
||
"
|
||
end
|
||
|
||
it 'executes a metadata-only profile' do
|
||
out = inspec('exec ' + File.join(profile_path, 'complete-metadata') + ' --no-create-lockfile')
|
||
out.stderr.must_equal ''
|
||
out.exit_status.must_equal 0
|
||
out.stdout.must_equal "
|
||
|
||
Profile: title (name)
|
||
Version: 1.2.3
|
||
Target: local://
|
||
|
||
No tests executed.\e[0m
|
||
|
||
Test Summary: \e[38;5;41m0 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m0 skipped\e[0m
|
||
"
|
||
end
|
||
|
||
it "executes a profile and reads attributes" do
|
||
out = inspec("exec #{File.join(examples_path, 'profile-attribute')} --no-create-lockfile --attrs #{File.join(examples_path, "profile-attribute.yml")}")
|
||
out.stderr.must_equal ''
|
||
out.exit_status.must_equal 0
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "Summary: \e[38;5;41m2 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m0 skipped\e[0m"
|
||
end
|
||
|
||
it 'executes a specs-only profile' do
|
||
out = inspec('exec ' + File.join(profile_path, 'spec_only') + ' --no-create-lockfile')
|
||
out.stderr.must_equal ''
|
||
out.exit_status.must_equal 1
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "Target: local://"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "working should"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "✔ eq \"working\""
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "skippy\n"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "↺ This will be skipped intentionally"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "failing should"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "∅ eq \"as intended\""
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "Test Summary: \e[38;5;41m1 successful\e[0m, \e[38;5;9m1 failures\e[0m, \e[38;5;247m1 skipped\e[0m"
|
||
end
|
||
|
||
it 'executes only specified controls' do
|
||
out = inspec('exec ' + example_profile + ' --no-create-lockfile --controls tmp-1.0')
|
||
out.stderr.must_equal ''
|
||
out.exit_status.must_equal 0
|
||
out.stdout.must_include "\nProfile Summary: \e[38;5;41m1 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m0 skipped\e[0m\n"
|
||
end
|
||
|
||
it 'can execute a simple file with the default formatter' do
|
||
out = inspec('exec ' + example_control + ' --no-create-lockfile')
|
||
out.stderr.must_equal ''
|
||
out.exit_status.must_equal 0
|
||
out.stdout.must_include "\nProfile Summary: \e[38;5;41m1 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m0 skipped\e[0m\n"
|
||
out.stdout.must_include "\nTest Summary: \e[38;5;41m2 successful\e[0m, \e[38;5;9m0 failures\e[0m"
|
||
end
|
||
|
||
describe 'with a profile that is not supported on this OS/platform' do
|
||
let(:out) { inspec('exec ' + File.join(profile_path, 'skippy-profile-os') + ' --no-create-lockfile') }
|
||
let(:json) { JSON.load(out.stdout) }
|
||
|
||
it 'exits with an error' do
|
||
out.stderr.must_match(/^This OS\/platform \(.+\) is not supported by this profile.$/)
|
||
out.exit_status.must_equal 1
|
||
end
|
||
end
|
||
|
||
describe 'with a profile that contains skipped controls' do
|
||
let(:out) { inspec('exec ' + File.join(profile_path, 'skippy-controls') + ' --no-create-lockfile') }
|
||
let(:json) { JSON.load(out.stdout) }
|
||
|
||
it 'exits with an error' do
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "skippy\e[0m\n\e[38;5;247m ↺ This will be skipped super intentionally.\e[0m\n"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include " ↺ CONTROL database: MySQL Session\e[0m\n\e[38;5;247m ↺ Can't run MySQL SQL checks without authentication\e[0m\n"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "Profile Summary: \e[38;5;41m0 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m2 skipped\e[0m"
|
||
out.exit_status.must_equal 0
|
||
end
|
||
end
|
||
|
||
describe 'with a profile that is supported on this version of inspec' do
|
||
let(:out) { inspec('exec ' + File.join(profile_path, 'supported_inspec') + ' --no-create-lockfile') }
|
||
|
||
it 'exits cleanly' do
|
||
out.stderr.must_equal ''
|
||
out.exit_status.must_equal 0
|
||
end
|
||
end
|
||
|
||
describe 'with a profile that is not supported on this version of inspec' do
|
||
let(:out) { inspec('exec ' + File.join(profile_path, 'unsupported_inspec') + ' --no-create-lockfile') }
|
||
|
||
it 'does not support this profile' do
|
||
out.exit_status.must_equal 1
|
||
out.stderr.must_equal "This profile requires InSpec version >= 99.0.0. You are running InSpec v#{Inspec::VERSION}.\n"
|
||
end
|
||
end
|
||
|
||
describe 'with a profile that loads a library and reference' do
|
||
let(:out) { inspec('exec ' + File.join(profile_path, 'library') + ' --no-create-lockfile') }
|
||
|
||
it 'executes the profile without error' do
|
||
out.exit_status.must_equal 0
|
||
end
|
||
end
|
||
|
||
describe 'given a profile with controls and anonymous describe blocks' do
|
||
let(:out) { inspec('exec ' + example_control + ' --no-create-lockfile') }
|
||
|
||
it 'prints the control results, then the anonymous describe block results' do
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_match(%r{Profile: tests from .*examples/profile/controls/example.rb})
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "
|
||
Version: (not specified)
|
||
Target: local://
|
||
|
||
\e[38;5;41m \xE2\x9C\x94 tmp-1.0: Create /tmp directory\e[0m
|
||
\e[38;5;41m \xE2\x9C\x94 File /tmp should be directory\e[0m
|
||
|
||
File /tmp
|
||
\e[38;5;41m \xE2\x9C\x94 should be directory\e[0m
|
||
|
||
Profile Summary: \e[38;5;41m1 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m0 skipped\e[0m
|
||
Test Summary: \e[38;5;41m2 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m0 skipped\e[0m
|
||
"
|
||
end
|
||
end
|
||
|
||
describe 'given a profile with an anonymous describe block' do
|
||
let(:out) { inspec('exec ' + failure_control + ' --no-create-lockfile') }
|
||
|
||
it 'prints the exception message when a test has a syntax error' do
|
||
out.stdout.must_include "undefined method `should_nota' "
|
||
end
|
||
end
|
||
|
||
describe 'given an inherited profile that has more that one test per control block' do
|
||
let(:out) { inspec('exec ' + simple_inheritance + ' --no-create-lockfile') }
|
||
|
||
it 'should print all the results' do
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "× tmp-1.0: Create /tmp directory (1 failed)\e[0m"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "∅ should not be directory\n"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "∅ undefined method `should_nota'"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "∅ should not be directory\n expected `File /tmp.directory?` to return false, got true\e[0m"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "× 7 should cmp >= 9\n"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "× 7 should not cmp == /^\\d$/\n"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "✔ 7 should cmp == \"7\""
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include " expected: \"01147\"
|
||
got: \"01777\"\n"
|
||
end
|
||
end
|
||
|
||
describe 'when passing in two profiles given an inherited profile that has more that one test per control block' do
|
||
let(:out) { inspec('exec ' + File.join(profile_path, 'dependencies', 'profile_d') + ' ' + simple_inheritance + ' --no-create-lockfile') }
|
||
|
||
it 'should print all the results' do
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "× tmp-1.0: Create /tmp directory (1 failed)\e[0m"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "∅ should not be directory"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "∅ undefined method `should_nota'"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "∅ should not be directory\n expected `File /tmp.directory?` to return false, got true\e[0m"
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "✔ profiled-1: Create /tmp directory (profile d)"
|
||
end
|
||
end
|
||
|
||
describe 'given an inherited profile' do
|
||
let(:out) { inspec('exec ' + simple_inheritance) }
|
||
|
||
it 'should print the profile information and then the test results' do
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "\e[38;5;9m × tmp-1.0: Create /tmp directory (1 failed)\e[0m\n\e[38;5;41m ✔ File /tmp should be directory\e[0m\n\e[38;5;9m × File /tmp should not be directory\n"
|
||
end
|
||
end
|
||
|
||
describe 'using namespaced resources' do
|
||
it 'works' do
|
||
out = inspec('exec ' + File.join(profile_path, 'dependencies', 'resource-namespace') + ' --no-create-lockfile')
|
||
out.stderr.must_equal ''
|
||
out.exit_status.must_equal 0
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "Summary: \e[38;5;41m5 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m0 skipped\e[0m\n"
|
||
end
|
||
end
|
||
|
||
describe 'with require_controls' do
|
||
it 'does not run rules you did not include' do
|
||
out = inspec('exec ' + File.join(profile_path, 'dependencies', 'require_controls_test') + ' --no-create-lockfile')
|
||
out.stderr.must_equal ''
|
||
out.exit_status.must_equal 0
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "Summary: \e[38;5;41m1 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m0 skipped\e[0m\n"
|
||
end
|
||
end
|
||
|
||
describe "with a 2-level dependency tree" do
|
||
it 'correctly runs tests from the whole tree' do
|
||
out = inspec('exec ' + File.join(profile_path, 'dependencies', 'inheritance') + ' --no-create-lockfile')
|
||
out.stderr.must_equal ''
|
||
out.exit_status.must_equal 0
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "Summary: \e[38;5;41m6 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m0 skipped\e[0m\n"
|
||
end
|
||
end
|
||
|
||
describe 'when using profiles on the supermarket' do
|
||
it 'can run supermarket profiles directly from the command line' do
|
||
out = inspec("exec supermarket://nathenharvey/tmp-compliance-profile --no-create-lockfile")
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "Summary: \e[38;5;41m2 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m0 skipped\e[0m\n"
|
||
end
|
||
|
||
it 'can run supermarket profiles from inspec.yml' do
|
||
out = inspec("exec #{File.join(profile_path, 'supermarket-dep')} --no-create-lockfile")
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "Summary: \e[38;5;41m2 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m0 skipped\e[0m\n"
|
||
end
|
||
end
|
||
|
||
describe 'when a dependency does not support our backend platform' do
|
||
it 'skips the controls from that profile' do
|
||
out = inspec("exec #{File.join(profile_path, 'profile-support-skip')} --no-create-lockfile")
|
||
out.stdout.force_encoding(Encoding::UTF_8).must_include "Summary: \e[38;5;41m0 successful\e[0m, \e[38;5;9m0 failures\e[0m, \e[38;5;247m2 skipped\e[0m\n"
|
||
end
|
||
end
|
||
end
|