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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
|
#
# Author:: Daniel DeLeo (<dan@getchef.com>)
# Copyright:: Copyright 2014 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 'chef/policy_builder'
describe Chef::PolicyBuilder::Policyfile do
let(:node_name) { "joe_node" }
let(:ohai_data) { {"platform" => "ubuntu", "platform_version" => "13.04", "fqdn" => "joenode.example.com"} }
let(:json_attribs) { {"custom_attr" => "custom_attr_value"} }
let(:override_runlist) { nil }
let(:events) { Chef::EventDispatch::Dispatcher.new }
let(:policy_builder) { Chef::PolicyBuilder::Policyfile.new(node_name, ohai_data, json_attribs, override_runlist, events) }
# Convert a SHA1 (160 bit) hex string into an x.y.z version number where the
# maximum value is smaller than a postgres BIGINT (signed 64bit, so 63 usable
# bits). This requires enterprise Chef or open source server 11.1.0+ (currently not released)
#
# The SHA1 is devided as follows:
# * "major": first 14 chars (56 bits)
# * "minor": next 14 chars (56 bits)
# * "patch": last 12 chars (48 bits)
def id_to_dotted(sha1_id)
major = sha1_id[0...14]
minor = sha1_id[14...28]
patch = sha1_id[28..40]
decimal_integers =[major, minor, patch].map {|hex| hex.to_i(16) }
decimal_integers.join(".")
end
let(:example1_lock_data) do
# based on https://github.com/danielsdeleo/chef-workflow2-prototype/blob/master/skeletons/basic_policy/Policyfile.lock.json
{
"identifier" => "168d2102fb11c9617cd8a981166c8adc30a6e915",
"version" => "2.3.5",
# NOTE: for compatibility mode we include the dotted id in the policyfile to enhance discoverability.
"dotted_decimal_identifier" => id_to_dotted("168d2102fb11c9617cd8a981166c8adc30a6e915"),
"source" => { "path" => "./cookbooks/demo" },
"scm_identifier"=> {
"vcs"=> "git",
"rev_id"=> "9d5b09026470c322c3cb5ca8a4157c4d2f16cef3",
"remote"=> nil
}
}
end
let(:example2_lock_data) do
{
"identifier" => "feab40e1fca77c7360ccca1481bb8ba5f919ce3a",
"version" => "4.2.0",
# NOTE: for compatibility mode we include the dotted id in the policyfile to enhance discoverability.
"dotted_decimal_identifier" => id_to_dotted("feab40e1fca77c7360ccca1481bb8ba5f919ce3a"),
"source" => { "api" => "https://community.getchef.com/api/v1/cookbooks/example2" }
}
end
let(:policyfile_default_attributes) { {"policyfile_default_attr" => "policyfile_default_value"} }
let(:policyfile_override_attributes) { {"policyfile_override_attr" => "policyfile_override_value"} }
let(:policyfile_run_list) { ["recipe[example1::default]", "recipe[example2::server]"] }
let(:parsed_policyfile_json) do
{
"run_list" => policyfile_run_list,
"cookbook_locks" => {
"example1" => example1_lock_data,
"example2" => example2_lock_data
},
"default_attributes" => policyfile_default_attributes,
"override_attributes" => policyfile_override_attributes
}
end
let(:err_namespace) { Chef::PolicyBuilder::Policyfile }
it "configures a Chef HTTP API client" do
http = double("Chef::REST")
server_url = "https://api.opscode.com/organizations/example"
Chef::Config[:chef_server_url] = server_url
expect(Chef::REST).to receive(:new).with(server_url).and_return(http)
expect(policy_builder.http_api).to eq(http)
end
describe "reporting unsupported features" do
def initialize_pb
Chef::PolicyBuilder::Policyfile.new(node_name, ohai_data, json_attribs, override_runlist, events)
end
it "always gives `false` for #temporary_policy?" do
expect(initialize_pb.temporary_policy?).to be_falsey
end
context "chef-solo" do
before { Chef::Config[:solo] = true }
it "errors on create" do
expect { initialize_pb }.to raise_error(err_namespace::UnsupportedFeature)
end
end
context "when given an override run_list" do
let(:override_runlist) { "recipe[foo],recipe[bar]" }
it "errors on create" do
expect { initialize_pb }.to raise_error(err_namespace::UnsupportedFeature)
end
end
context "when json_attribs contains a run_list" do
let(:json_attribs) { {"run_list" => []} }
it "errors on create" do
expect { initialize_pb }.to raise_error(err_namespace::UnsupportedFeature)
end
end
context "when an environment is configured" do
before { Chef::Config[:environment] = "blurch" }
it "errors when an environment is configured" do
expect { initialize_pb }.to raise_error(err_namespace::UnsupportedFeature)
end
end
end
describe "loading policy data" do
let(:http_api) { double("Chef::REST") }
let(:configured_environment) { nil }
let(:override_runlist) { nil }
let(:primary_runlist) { nil }
let(:original_default_attrs) { {"default_key" => "default_value"} }
let(:original_override_attrs) { {"override_key" => "override_value"} }
let(:node) do
node = Chef::Node.new
node.name(node_name)
node.default_attrs = original_default_attrs
node.override_attrs = original_override_attrs
node.run_list(primary_runlist) if primary_runlist
node
end
before do
# TODO: agree on this name and logic.
Chef::Config[:deployment_group] = "example-policy-stage"
allow(policy_builder).to receive(:http_api).and_return(http_api)
end
describe "when using compatibility mode (policy_document_native_api == false)" do
context "when the deployment group cannot be loaded" do
let(:error404) { Net::HTTPServerException.new("404 message", :body) }
before do
expect(Chef::Node).to receive(:find_or_create).with(node_name).and_return(node)
expect(http_api).to receive(:get).
with("data/policyfiles/example-policy-stage").
and_raise(error404)
end
it "raises an error" do
expect { policy_builder.load_node }.to raise_error(err_namespace::ConfigurationError)
end
it "sends error message to the event system" do
expect(events).to receive(:node_load_failed).with(node_name, an_instance_of(err_namespace::ConfigurationError), Chef::Config)
expect { policy_builder.load_node }.to raise_error(err_namespace::ConfigurationError)
end
end
context "when the deployment_group is not configured" do
before do
Chef::Config[:deployment_group] = nil
expect(Chef::Node).to receive(:find_or_create).with(node_name).and_return(node)
end
it "errors while loading the node" do
expect { policy_builder.load_node }.to raise_error(err_namespace::ConfigurationError)
end
it "passes error information to the event system" do
# TODO: also make sure something acceptable happens with the error formatters
err_class = err_namespace::ConfigurationError
expect(events).to receive(:node_load_failed).with(node_name, an_instance_of(err_class), Chef::Config)
expect { policy_builder.load_node }.to raise_error(err_class)
end
end
context "when deployment_group is correctly configured" do
let(:policy_relative_url) { "data/policyfiles/example-policy-stage" }
before do
expect(http_api).to receive(:get).with(policy_relative_url).and_return(parsed_policyfile_json)
end
it "fetches the policy file from a data bag item" do
expect(policy_builder.policy).to eq(parsed_policyfile_json)
end
it "extracts the run_list from the policyfile" do
expect(policy_builder.run_list).to eq(policyfile_run_list)
end
end
end
context "and policy_document_native_api is configured" do
before do
Chef::Config[:policy_document_native_api] = true
Chef::Config[:policy_group] = "policy-stage"
Chef::Config[:policy_name] = "example"
end
context "and policy_name or policy_group are not configured" do
it "raises a Configuration error for policy_group" do
Chef::Config[:policy_group] = nil
expect { policy_builder.policy }.to raise_error(err_namespace::ConfigurationError)
end
it "raises a Configuration error for policy_name" do
Chef::Config[:policy_name] = nil
expect { policy_builder.policy }.to raise_error(err_namespace::ConfigurationError)
end
end
context "and policy_name and policy_group are configured" do
let(:policy_relative_url) { "policy_groups/policy-stage/policies/example" }
before do
expect(http_api).to receive(:get).with(policy_relative_url).and_return(parsed_policyfile_json)
end
it "fetches the policy file from a data bag item" do
expect(policy_builder.policy).to eq(parsed_policyfile_json)
end
it "extracts the run_list from the policyfile" do
expect(policy_builder.run_list).to eq(policyfile_run_list)
end
end
end
describe "building policy from the policyfile" do
before do
allow(policy_builder).to receive(:policy).and_return(parsed_policyfile_json)
end
it "fetches the policy file from a data bag item" do
expect(policy_builder.policy).to eq(parsed_policyfile_json)
end
it "extracts the run_list from the policyfile" do
expect(policy_builder.run_list).to eq(policyfile_run_list)
end
it "extracts the cookbooks and versions for display from the policyfile" do
expected = [
"example1::default@2.3.5 (168d210)",
"example2::server@4.2.0 (feab40e)"
]
expect(policy_builder.run_list_with_versions_for_display).to eq(expected)
end
it "generates a RunListExpansion-alike object for feeding to the CookbookCompiler" do
expect(policy_builder.run_list_expansion_ish).to respond_to(:recipes)
expect(policy_builder.run_list_expansion_ish.recipes).to eq(["example1::default", "example2::server"])
end
it "implements #expand_run_list in a manner compatible with ExpandNodeObject" do
expect(Chef::Node).to receive(:find_or_create).with(node_name).and_return(node)
policy_builder.load_node
expect(policy_builder.expand_run_list).to respond_to(:recipes)
expect(policy_builder.expand_run_list.recipes).to eq(["example1::default", "example2::server"])
expect(policy_builder.expand_run_list.roles).to eq([])
end
describe "validating the Policyfile.lock" do
it "errors if the policyfile json contains any non-recipe items" do
parsed_policyfile_json["run_list"] = ["role[foo]"]
expect { policy_builder.validate_policyfile }.to raise_error(err_namespace::PolicyfileError)
end
it "errors if the policyfile json contains non-fully qualified recipe items" do
parsed_policyfile_json["run_list"] = ["recipe[foo]"]
expect { policy_builder.validate_policyfile }.to raise_error(err_namespace::PolicyfileError)
end
it "errors if the policyfile doesn't have a run_list key" do
parsed_policyfile_json.delete("run_list")
expect { policy_builder.validate_policyfile }.to raise_error(err_namespace::PolicyfileError)
end
it "error if the policyfile doesn't have a cookbook_locks key" do
parsed_policyfile_json.delete("cookbook_locks")
expect { policy_builder.validate_policyfile }.to raise_error(err_namespace::PolicyfileError)
end
it "accepts a valid policyfile" do
policy_builder.validate_policyfile
end
end
describe "building the node object" do
before do
expect(Chef::Node).to receive(:find_or_create).with(node_name).and_return(node)
policy_builder.load_node
policy_builder.build_node
end
it "resets default and override data" do
expect(node["default_key"]).to be_nil
expect(node["override_key"]).to be_nil
end
it "applies ohai data" do
expect(ohai_data).to_not be_empty # ensure test is testing something
ohai_data.each do |key, value|
expect(node.automatic_attrs[key]).to eq(value)
end
end
it "applies attributes from json file" do
expect(node["custom_attr"]).to eq("custom_attr_value")
end
it "applies attributes from the policyfile" do
expect(node["policyfile_default_attr"]).to eq("policyfile_default_value")
expect(node["policyfile_override_attr"]).to eq("policyfile_override_value")
end
it "sets the policyfile's run_list on the node object" do
expect(node.run_list).to eq(policyfile_run_list)
end
it "creates node.automatic_attrs[:roles]" do
expect(node.automatic_attrs[:roles]).to eq([])
end
it "create node.automatic_attrs[:recipes]" do
expect(node.automatic_attrs[:recipes]).to eq(["example1::default", "example2::server"])
end
end
describe "fetching the desired cookbook set" do
let(:example1_cookbook_data) { double("CookbookVersion Hash for example1 cookbook") }
let(:example2_cookbook_data) { double("CookbookVersion Hash for example2 cookbook") }
let(:example1_cookbook_object) { double("Chef::CookbookVersion for example1 cookbook", version: "0.1.2") }
let(:example2_cookbook_object) { double("Chef::CookbookVersion for example2 cookbook", version: "1.2.3") }
let(:expected_cookbook_hash) do
{ "example1" => example1_cookbook_object, "example2" => example2_cookbook_object }
end
let(:example1_xyz_version) { example1_lock_data["dotted_decimal_identifier"] }
let(:example2_xyz_version) { example2_lock_data["dotted_decimal_identifier"] }
let(:example1_identifier) { example1_lock_data["identifier"] }
let(:example2_identifier) { example2_lock_data["identifier"] }
let(:cookbook_synchronizer) { double("Chef::CookbookSynchronizer") }
shared_examples "fetching cookbooks when they don't exist" do
context "and a cookbook is missing" do
let(:error404) { Net::HTTPServerException.new("404 message", :body) }
before do
expect(Chef::Node).to receive(:find_or_create).with(node_name).and_return(node)
policy_builder.load_node
policy_builder.build_node
expect(http_api).to receive(:get).with(cookbook1_url).
and_raise(error404)
end
it "raises an error indicating which cookbook is missing" do
expect { policy_builder.cookbooks_to_sync }.to raise_error(Chef::Exceptions::CookbookNotFound)
end
end
end
shared_examples_for "fetching cookbooks when they exist" do
context "and the cookbooks can be fetched" do
before do
expect(Chef::Node).to receive(:find_or_create).with(node_name).and_return(node)
policy_builder.load_node
policy_builder.build_node
allow(Chef::CookbookSynchronizer).to receive(:new).
with(expected_cookbook_hash, events).
and_return(cookbook_synchronizer)
end
it "builds a Hash of the form 'cookbook_name' => Chef::CookbookVersion" do
expect(policy_builder.cookbooks_to_sync).to eq(expected_cookbook_hash)
end
it "syncs the desired cookbooks via CookbookSynchronizer" do
expect(cookbook_synchronizer).to receive(:sync_cookbooks)
policy_builder.sync_cookbooks
end
it "builds a run context" do
expect(cookbook_synchronizer).to receive(:sync_cookbooks)
expect_any_instance_of(Chef::RunContext).to receive(:load).with(policy_builder.run_list_expansion_ish)
run_context = policy_builder.setup_run_context
expect(run_context.node).to eq(node)
expect(run_context.cookbook_collection.keys).to match_array(["example1", "example2"])
end
end
end # shared_examples_for "fetching cookbooks"
context "when using compatibility mode (policy_document_native_api == false)" do
let(:cookbook1_url) { "cookbooks/example1/#{example1_xyz_version}" }
let(:cookbook2_url) { "cookbooks/example2/#{example2_xyz_version}" }
context "when the cookbooks don't exist on the server" do
include_examples "fetching cookbooks when they don't exist"
end
context "when the cookbooks exist on the server" do
before do
expect(http_api).to receive(:get).with(cookbook1_url).
and_return(example1_cookbook_object)
expect(http_api).to receive(:get).with(cookbook2_url).
and_return(example2_cookbook_object)
end
include_examples "fetching cookbooks when they exist"
end
end
context "when using native API mode (policy_document_native_api == true)" do
before do
Chef::Config[:policy_document_native_api] = true
Chef::Config[:policy_group] = "policy-stage"
Chef::Config[:policy_name] = "example"
end
let(:cookbook1_url) { "cookbook_artifacts/example1/#{example1_identifier}" }
let(:cookbook2_url) { "cookbook_artifacts/example2/#{example2_identifier}" }
context "when the cookbooks don't exist on the server" do
include_examples "fetching cookbooks when they don't exist"
end
context "when the cookbooks exist on the server" do
before do
expect(http_api).to receive(:get).with(cookbook1_url).
and_return(example1_cookbook_data)
expect(http_api).to receive(:get).with(cookbook2_url).
and_return(example2_cookbook_data)
expect(Chef::CookbookVersion).to receive(:from_cb_artifact_data).with(example1_cookbook_data).
and_return(example1_cookbook_object)
expect(Chef::CookbookVersion).to receive(:from_cb_artifact_data).with(example2_cookbook_data).
and_return(example2_cookbook_object)
end
include_examples "fetching cookbooks when they exist"
end
end
end
end
end
end
|