summaryrefslogtreecommitdiff
path: root/spec/unit/resource/conditional_spec.rb
blob: 2a2e166e6c697243f741390940a96449d234d4d7 (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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
#
# Author:: Daniel DeLeo (<dan@chef.io>)
# Copyright:: Copyright 2011-2018, 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 "ostruct"

describe Chef::Resource::Conditional do
  before do
    allow_any_instance_of(Mixlib::ShellOut).to receive(:run_command).and_return(nil)
    @status = OpenStruct.new(success?: true)
    allow_any_instance_of(Mixlib::ShellOut).to receive(:status).and_return(@status)
    @parent_resource = Chef::Resource.new("", Chef::Node.new)
  end

  it "raises an exception when neither a block or command is given" do
    expect { Chef::Resource::Conditional.send(:new, :always, @parent_resource, nil, {}) }.to raise_error(ArgumentError, /requires either a command or a block/)
  end

  it "does not evaluate a guard interpreter on initialization of the conditional" do
    expect_any_instance_of(Chef::Resource::Conditional).not_to receive(:configure)
    expect(Chef::GuardInterpreter::DefaultGuardInterpreter).not_to receive(:new)
    expect(Chef::GuardInterpreter::ResourceGuardInterpreter).not_to receive(:new)
    Chef::Resource::Conditional.only_if(@parent_resource, "true")
  end

  describe "configure" do
    it "raises an exception when a guard_interpreter is specified and a block is given" do
      @parent_resource.guard_interpreter :canadian_mounties
      conditional = Chef::Resource::Conditional.send(:new, :always, @parent_resource, nil, {}) { True }
      expect { conditional.configure }.to raise_error(ArgumentError, /does not support blocks/)
    end
  end

  describe "when created as an `only_if`" do
    describe "after running a successful command given as a string" do
      before do
        @conditional = Chef::Resource::Conditional.only_if(@parent_resource, "true")
      end

      it "indicates that resource convergence should continue" do
        expect(@conditional.continue?).to be_truthy
      end
    end

    describe "after running a negative/false command given as a string" do
      before do
        @status.send("success?=", false)
        @conditional = Chef::Resource::Conditional.only_if(@parent_resource, "false")
      end

      it "indicates that resource convergence should not continue" do
        expect(@conditional.continue?).to be_falsey
      end
    end

    describe "after running a successful command given as an array" do
      before do
        @conditional = Chef::Resource::Conditional.only_if(@parent_resource, ["true"])
      end

      it "indicates that resource convergence should continue" do
        expect(@conditional.continue?).to be true
      end
    end

    describe "after running a negative/false command given as an array" do
      before do
        @status.send("success?=", false)
        @conditional = Chef::Resource::Conditional.only_if(@parent_resource, ["false"])
      end

      it "indicates that resource convergence should not continue" do
        expect(@conditional.continue?).to be false
      end
    end

    describe "after running a command which timed out" do
      before do
        @conditional = Chef::Resource::Conditional.only_if(@parent_resource, "false")
        allow_any_instance_of(Chef::GuardInterpreter::DefaultGuardInterpreter).to receive(:shell_out).and_raise(Chef::Exceptions::CommandTimeout)
      end

      it "indicates that resource convergence should not continue" do
        expect(@conditional.continue?).to be_falsey
      end

      it "logs a warning" do
        expect(Chef::Log).to receive(:warn).with("Command 'false' timed out")
        @conditional.continue?
      end
    end

    describe "after running a block that returns a truthy value" do
      before do
        @conditional = Chef::Resource::Conditional.only_if(@parent_resource) { Object.new }
      end

      it "indicates that resource convergence should continue" do
        expect(@conditional.continue?).to be_truthy
      end
    end

    describe "after running a block that returns a falsey value" do
      before do
        @conditional = Chef::Resource::Conditional.only_if(@parent_resource) { nil }
      end

      it "indicates that resource convergence should not continue" do
        expect(@conditional.continue?).to be_falsey
      end
    end

    describe "after running a block that returns a string value" do
      before do
        @conditional = Chef::Resource::Conditional.only_if(@parent_resource) { "some command" }
      end

      it "logs a warning" do
        expect(Chef::Log).to receive(:warn).with("only_if block for [] returned \"some command\", did you mean to run a command? If so use 'only_if \"some command\"' in your code.")
        @conditional.evaluate
      end
    end

    describe "after running a block that returns a string value on a sensitive resource" do
      before do
        @parent_resource.sensitive(true)
        @conditional = Chef::Resource::Conditional.only_if(@parent_resource) { "some command" }
      end

      it "logs a warning" do
        expect(Chef::Log).to receive(:warn).with("only_if block for [] returned a string, did you mean to run a command?")
        @conditional.evaluate
      end
    end
  end

  describe "when created as a `not_if`" do
    describe "after running a successful/true command given as a string" do
      before do
        @conditional = Chef::Resource::Conditional.not_if(@parent_resource, "true")
      end

      it "indicates that resource convergence should not continue" do
        expect(@conditional.continue?).to be_falsey
      end
    end

    describe "after running a failed/false command given as a string" do
      before do
        @status.send("success?=", false)
        @conditional = Chef::Resource::Conditional.not_if(@parent_resource, "false")
      end

      it "indicates that resource convergence should continue" do
        expect(@conditional.continue?).to be_truthy
      end
    end

    describe "after running a successful/true command given as an array" do
      before do
        @conditional = Chef::Resource::Conditional.not_if(@parent_resource, ["true"])
      end

      it "indicates that resource convergence should not continue" do
        expect(@conditional.continue?).to be false
      end
    end

    describe "after running a failed/false command given as an array" do
      before do
        @status.send("success?=", false)
        @conditional = Chef::Resource::Conditional.not_if(@parent_resource, ["false"])
      end

      it "indicates that resource convergence should continue" do
        expect(@conditional.continue?).to be true
      end
    end

    describe "after running a command which timed out" do
      before do
        @conditional = Chef::Resource::Conditional.not_if(@parent_resource, "false")
        allow_any_instance_of(Chef::GuardInterpreter::DefaultGuardInterpreter).to receive(:shell_out).and_raise(Chef::Exceptions::CommandTimeout)
      end

      it "indicates that resource convergence should continue" do
        expect(@conditional.continue?).to be_truthy
      end

      it "logs a warning" do
        expect(Chef::Log).to receive(:warn).with("Command 'false' timed out")
        @conditional.continue?
      end
    end

    describe "after running a block that returns a truthy value" do
      before do
        @conditional = Chef::Resource::Conditional.not_if(@parent_resource) { Object.new }
      end

      it "indicates that resource convergence should not continue" do
        expect(@conditional.continue?).to be_falsey
      end
    end

    describe "after running a block that returns a falsey value" do
      before do
        @conditional = Chef::Resource::Conditional.not_if(@parent_resource) { nil }
      end

      it "indicates that resource convergence should continue" do
        expect(@conditional.continue?).to be_truthy
      end
    end

    describe "after running a block that returns a string value" do
      before do
        @conditional = Chef::Resource::Conditional.not_if(@parent_resource) { "some command" }
      end

      it "logs a warning" do
        expect(Chef::Log).to receive(:warn).with("not_if block for [] returned \"some command\", did you mean to run a command? If so use 'not_if \"some command\"' in your code.")
        @conditional.evaluate
      end
    end

    describe "after running a block that returns a string value on a sensitive resource" do
      before do
        @parent_resource.sensitive(true)
        @conditional = Chef::Resource::Conditional.not_if(@parent_resource) { "some command" }
      end

      it "logs a warning" do
        expect(Chef::Log).to receive(:warn).with("not_if block for [] returned a string, did you mean to run a command?")
        @conditional.evaluate
      end
    end
  end
end