summaryrefslogtreecommitdiff
path: root/spec/functional/audit/runner_spec.rb
blob: dcfa69c3492e737aaed3d1c8f3baa4c31efcf7c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
#
# Author:: Tyler Ball (<tball@chef.io>)
# Copyright:: Copyright 2014-2016, Chef Software, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

require "spec_helper"
require "rspec/core/sandbox"
require "chef/audit/runner"
require "rspec/support/spec/in_sub_process"
require "rspec/support/spec/stderr_splitter"
require "tempfile"

##
# This functional test ensures that our runner can be setup to not interfere with existing RSpec
# configuration and world objects.  When normally running Chef, there is only 1 RSpec instance
# so this isn't needed.  In unit testing the Runner should be mocked appropriately.

describe Chef::Audit::Runner do

  # The functional tests must be run in a sub_process.  Including Serverspec includes the Serverspec DSL - this
  # conflicts with our `package` DSL (among others) when we try to test `package` inside an RSpec example.
  # Our DSL leverages `method_missing` while the Serverspec DSL defines a method on the RSpec::Core::ExampleGroup.
  # The defined method wins our and returns before our `method_missing` DSL can be called.
  #
  # Running in a sub_process means the serverspec libraries will only be included in a forked process, not the main one.
  include RSpec::Support::InSubProcess

  let(:events) { double("events").as_null_object }
  let(:runner) { Chef::Audit::Runner.new(run_context) }
  let(:stdout) { StringIO.new }

  around(:each) do |ex|
    RSpec::Core::Sandbox.sandboxed { ex.run }
  end

  describe "#run" do

    let(:audits) { {} }
    let(:run_context) { instance_double(Chef::RunContext, :events => events, :audits => audits) }
    let(:control_group_name) { "control_group_name" }

    # Set cookbook path to include our parent, so that it will recognize this
    # rspec file as one that should show up in the backtrace.
    before(:each) { Chef::Config[:cookbook_path] = File.dirname(__FILE__) }

    shared_context "passing audit" do
      let(:audits) do
        should_pass = lambda do
          it "should pass" do
            expect(2 - 2).to eq(0)
          end
        end
        { control_group_name => Struct.new(:args, :block).new([control_group_name], should_pass)}
      end
    end

    shared_context "failing audit" do
      let(:audits) do
        should_fail = lambda do
          it "should fail" do
            expect(2 - 1).to eq(0)
          end
        end
        { control_group_name => Struct.new(:args, :block).new([control_group_name], should_fail)}
      end
    end

    describe "log location is stdout" do
      before do
        allow(Chef::Log).to receive(:info) do |msg|
          stdout.puts(msg)
        end
      end

      it "Correctly runs an empty controls block" do
        in_sub_process do
          runner.run
        end
      end

      context "there is a single successful control" do
        include_context "passing audit"
        it "correctly runs" do
          in_sub_process do
            runner.run

            expect(stdout.string).to match(/1 example, 0 failures/)
          end
        end
      end

      context "there is a single failing control" do
        include_context "failing audit"
        it "correctly runs" do
          in_sub_process do
            runner.run

            expect(stdout.string).to match(/Failure\/Error: expect\(2 - 1\)\.to eq\(0\)/)
            expect(stdout.string).to match(/1 example, 1 failure/)
            expect(stdout.string).to match(/# control_group_name should fail/)
          end
        end
      end
    end

  end

end