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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
|
#
# Author:: Adam Leff (<adamleff@chef.io)
#
# Copyright:: Copyright 2012-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 "ffi_yajl"
require "chef/data_collector/messages/helpers"
describe Chef::DataCollector::Messages do
describe "#run_start_message" do
let(:run_status) { Chef::RunStatus.new(Chef::Node.new, Chef::EventDispatch::Dispatcher.new) }
let(:required_fields) do
%w{
chef_server_fqdn
entity_uuid
id
message_version
message_type
node_name
organization_name
run_id
source
start_time
}
end
let(:optional_fields) { [] }
before do
allow(run_status).to receive(:start_time).and_return(Time.now)
end
it "is not missing any required fields" do
missing_fields = required_fields.select do |key|
!Chef::DataCollector::Messages.run_start_message(run_status).key?(key)
end
expect(missing_fields).to eq([])
end
it "does not have any extra fields" do
extra_fields = Chef::DataCollector::Messages.run_start_message(run_status).keys.select do |key|
!required_fields.include?(key) && !optional_fields.include?(key)
end
expect(extra_fields).to eq([])
end
end
describe "#run_end_message" do
let(:node) { Chef::Node.new }
let(:run_status) { Chef::RunStatus.new(node, Chef::EventDispatch::Dispatcher.new) }
let(:report1) { double("report1", report_data: { "status" => "updated" }) }
let(:report2) { double("report2", report_data: { "status" => "skipped" }) }
let(:reporter_data) do
{
run_status: run_status,
resources: [report1, report2],
}
end
before do
allow(run_status).to receive(:start_time).and_return(Time.now)
allow(run_status).to receive(:end_time).and_return(Time.now)
end
it "includes a valid node object in the payload" do
message = Chef::DataCollector::Messages.run_end_message(reporter_data)
expect(message["node"]).to be_an_instance_of(Chef::Node)
end
it "returns a sane JSON representation of the node object" do
node.chef_environment = "my_test_environment"
node.run_list.add("recipe[my_test_cookbook::default]")
message = FFI_Yajl::Parser.parse(Chef::DataCollector::Messages.run_end_message(reporter_data).to_json)
expect(message["node"]["chef_environment"]).to eq("my_test_environment")
expect(message["node"]["run_list"]).to eq(["recipe[my_test_cookbook::default]"])
end
context "when the run was successful" do
let(:required_fields) do
%w{
chef_server_fqdn
entity_uuid
id
end_time
expanded_run_list
message_type
message_version
node
node_name
organization_name
resources
run_id
run_list
source
start_time
status
total_resource_count
updated_resource_count
deprecations
}
end
let(:optional_fields) { %w{error policy_group policy_name} }
before do
allow(run_status).to receive(:exception).and_return(nil)
end
it "is not missing any required fields" do
missing_fields = required_fields.select do |key|
!Chef::DataCollector::Messages.run_end_message(reporter_data).key?(key)
end
expect(missing_fields).to eq([])
end
it "does not have any extra fields" do
extra_fields = Chef::DataCollector::Messages.run_end_message(reporter_data).keys.select do |key|
!required_fields.include?(key) && !optional_fields.include?(key)
end
expect(extra_fields).to eq([])
end
it "only includes updated resources in its count" do
message = Chef::DataCollector::Messages.run_end_message(reporter_data)
expect(message["total_resource_count"]).to eq(2)
expect(message["updated_resource_count"]).to eq(1)
end
end
context "when the run was not successful" do
let(:required_fields) do
%w{
chef_server_fqdn
entity_uuid
id
end_time
error
expanded_run_list
message_type
message_version
node
node_name
organization_name
resources
run_id
run_list
source
start_time
status
total_resource_count
updated_resource_count
deprecations
}
end
let(:optional_fields) { %w{policy_group policy_name} }
before do
allow(run_status).to receive(:exception).and_return(RuntimeError.new("an error happened"))
end
it "is not missing any required fields" do
missing_fields = required_fields.select do |key|
!Chef::DataCollector::Messages.run_end_message(reporter_data).key?(key)
end
expect(missing_fields).to eq([])
end
it "does not have any extra fields" do
extra_fields = Chef::DataCollector::Messages.run_end_message(reporter_data).keys.select do |key|
!required_fields.include?(key) && !optional_fields.include?(key)
end
expect(extra_fields).to eq([])
end
end
end
describe "#run_end_message in policy mode" do
let(:node) { Chef::Node.new }
let(:run_status) { Chef::RunStatus.new(node, Chef::EventDispatch::Dispatcher.new) }
let(:report1) { double("report1", report_data: { "status" => "updated" }) }
let(:report2) { double("report2", report_data: { "status" => "skipped" }) }
let(:reporter_data) do
{
run_status: run_status,
resources: [report1, report2],
}
end
before do
allow(run_status).to receive(:start_time).and_return(Time.now)
allow(run_status).to receive(:end_time).and_return(Time.now)
node.policy_group = "test"
node.policy_name = "policy-test"
end
it "includes a valid node object in the payload" do
message = Chef::DataCollector::Messages.run_end_message(reporter_data)
expect(message["node"]).to be_an_instance_of(Chef::Node)
end
it "returns a sane JSON representation of the node object" do
node.chef_environment = "my_test_environment"
node.run_list.add("recipe[my_test_cookbook::default]")
message = FFI_Yajl::Parser.parse(Chef::DataCollector::Messages.run_end_message(reporter_data).to_json)
expect(message["node"]["chef_environment"]).to eq("my_test_environment")
expect(message["node"]["run_list"]).to eq(["recipe[my_test_cookbook::default]"])
expect(message["node"]["policy_name"]).to eq("policy-test")
expect(message["node"]["policy_group"]).to eq("test")
end
context "when the run was successful" do
let(:required_fields) do
%w{
chef_server_fqdn
entity_uuid
id
end_time
expanded_run_list
message_type
message_version
node
node_name
organization_name
resources
run_id
run_list
source
start_time
status
total_resource_count
updated_resource_count
deprecations
policy_name
policy_group
}
end
let(:optional_fields) { %w{error} }
before do
allow(run_status).to receive(:exception).and_return(nil)
end
it "is not missing any required fields" do
missing_fields = required_fields.select do |key|
!Chef::DataCollector::Messages.run_end_message(reporter_data).key?(key)
end
expect(missing_fields).to eq([])
end
it "does not have any extra fields" do
extra_fields = Chef::DataCollector::Messages.run_end_message(reporter_data).keys.select do |key|
!required_fields.include?(key) && !optional_fields.include?(key)
end
expect(extra_fields).to eq([])
end
it "only includes updated resources in its count" do
message = Chef::DataCollector::Messages.run_end_message(reporter_data)
expect(message["total_resource_count"]).to eq(2)
expect(message["updated_resource_count"]).to eq(1)
end
end
context "when the run was not successful" do
let(:required_fields) do
%w{
chef_server_fqdn
entity_uuid
id
end_time
error
expanded_run_list
message_type
message_version
node
node_name
organization_name
resources
run_id
run_list
source
start_time
status
total_resource_count
updated_resource_count
deprecations
policy_name
policy_group
}
end
let(:optional_fields) { [] }
before do
allow(run_status).to receive(:exception).and_return(RuntimeError.new("an error happened"))
end
it "is not missing any required fields" do
missing_fields = required_fields.select do |key|
!Chef::DataCollector::Messages.run_end_message(reporter_data).key?(key)
end
expect(missing_fields).to eq([])
end
it "does not have any extra fields" do
extra_fields = Chef::DataCollector::Messages.run_end_message(reporter_data).keys.select do |key|
!required_fields.include?(key) && !optional_fields.include?(key)
end
expect(extra_fields).to eq([])
end
end
end
end
|
