summaryrefslogtreecommitdiff
path: root/spec/unit/environment_spec.rb
blob: 42906ef77221b23b9ab953ee5568fac8cfc9bb88 (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
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
#
# Author:: Stephen Delano (<stephen@ospcode.com>)
# Author:: Seth Falcon (<seth@ospcode.com>)
# Author:: John Keiser (<jkeiser@ospcode.com>)
# Author:: Kyle Goodwin (<kgoodwin@primerevenue.com>)
# Copyright:: Copyright 2010-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 "chef/environment"

describe Chef::Environment do
  before(:each) do
    @environment = Chef::Environment.new
  end

  describe "initialize" do
    it "should be a Chef::Environment" do
      expect(@environment).to be_a_kind_of(Chef::Environment)
    end
  end

  describe "name" do
    it "should let you set the name to a string" do
      expect(@environment.name("production")).to eq("production")
    end

    it "should return the current name" do
      @environment.name("production")
      expect(@environment.name).to eq("production")
    end

    it "should not accept spaces" do
      expect { @environment.name("production environment") }.to raise_error(ArgumentError)
    end

    it "should not accept anything but strings" do
      expect { @environment.name([]) }.to raise_error(ArgumentError)
      expect { @environment.name({}) }.to raise_error(ArgumentError)
      expect { @environment.name(2) }.to raise_error(ArgumentError)
    end
  end

  describe "description" do
    it "should let you set the description to a string" do
      expect(@environment.description("this is my test environment")).to eq("this is my test environment")
    end

    it "should return the correct description" do
      @environment.description("I like running tests")
      expect(@environment.description).to eq("I like running tests")
    end

    it "should not accept anything but strings" do
      expect { @environment.description([]) }.to raise_error(ArgumentError)
      expect { @environment.description({}) }.to raise_error(ArgumentError)
      expect { @environment.description(42) }.to raise_error(ArgumentError)
    end
  end

  describe "default attributes" do
    it "should let you set the attributes hash explicitly" do
      expect(@environment.default_attributes({ one: "two" })).to eq({ one: "two" })
    end

    it "should let you return the attributes hash" do
      @environment.default_attributes({ one: "two" })
      expect(@environment.default_attributes).to eq({ one: "two" })
    end

    it "should throw an ArgumentError if we aren't a kind of hash" do
      expect { @environment.default_attributes([]) }.to raise_error(ArgumentError)
    end
  end

  describe "override attributes" do
    it "should let you set the attributes hash explicitly" do
      expect(@environment.override_attributes({ one: "two" })).to eq({ one: "two" })
    end

    it "should let you return the attributes hash" do
      @environment.override_attributes({ one: "two" })
      expect(@environment.override_attributes).to eq({ one: "two" })
    end

    it "should throw an ArgumentError if we aren't a kind of hash" do
      expect { @environment.override_attributes([]) }.to raise_error(ArgumentError)
    end
  end

  describe "cookbook_versions" do
    before(:each) do
      @cookbook_versions = {
        "apt" => "= 1.0.0",
        "god" => "= 2.0.0",
        "apache2" => "= 4.2.0",
      }
    end

    it "should let you set the cookbook versions in a hash" do
      expect(@environment.cookbook_versions(@cookbook_versions)).to eq(@cookbook_versions)
    end

    it "should return the cookbook versions" do
      @environment.cookbook_versions(@cookbook_versions)
      expect(@environment.cookbook_versions).to eq(@cookbook_versions)
    end

    it "should not accept anything but a hash" do
      expect { @environment.cookbook_versions("I am a string!") }.to raise_error(ArgumentError)
      expect { @environment.cookbook_versions([]) }.to raise_error(ArgumentError)
      expect { @environment.cookbook_versions(42) }.to raise_error(ArgumentError)
    end

    it "should validate the hash" do
      expect(Chef::Environment).to receive(:validate_cookbook_versions).with(@cookbook_versions).and_return true
      @environment.cookbook_versions(@cookbook_versions)
    end
  end

  describe "cookbook" do
    it "should set the version of the cookbook in the cookbook_versions hash" do
      @environment.cookbook("apt", "~> 1.2.3")
      expect(@environment.cookbook_versions["apt"]).to eq("~> 1.2.3")
    end

    it "should validate the cookbook version it is passed" do
      expect(Chef::Environment).to receive(:validate_cookbook_version).with(">= 1.2.3").and_return true
      @environment.cookbook("apt", ">= 1.2.3")
    end
  end

  describe "update_from!" do
    before(:each) do
      @environment.name("prod")
      @environment.description("this is prod")
      @environment.cookbook_versions({ "apt" => "= 1.2.3" })

      @example = Chef::Environment.new
      @example.name("notevenprod")
      @example.description("this is pre-prod")
      @example.cookbook_versions({ "apt" => "= 2.3.4" })
    end

    it "should update everything but name" do
      @environment.update_from!(@example)
      expect(@environment.name).to eq("prod")
      expect(@environment.description).to eq(@example.description)
      expect(@environment.cookbook_versions).to eq(@example.cookbook_versions)
    end
  end

  describe "to_hash" do
    before(:each) do
      @environment.name("spec")
      @environment.description("Where we run the spec tests")
      @environment.cookbook_versions({ apt: "= 1.2.3" })
      @hash = @environment.to_hash
    end

    %w{name description cookbook_versions}.each do |t|
      it "should include '#{t}'" do
        expect(@hash[t]).to eq(@environment.send(t.to_sym))
      end
    end

    it "should include 'json_class'" do
      expect(@hash["json_class"]).to eq("Chef::Environment")
    end

    it "should include 'chef_type'" do
      expect(@hash["chef_type"]).to eq("environment")
    end
  end

  describe "to_json" do
    before(:each) do
      @environment.name("spec")
      @environment.description("Where we run the spec tests")
      @environment.cookbook_versions({ apt: "= 1.2.3" })
      @json = @environment.to_json
    end

    %w{name description cookbook_versions}.each do |t|
      it "should include '#{t}'" do
        expect(@json).to match(/"#{t}":#{Regexp.escape(Chef::JSONCompat.to_json(@environment.send(t.to_sym)))}/)
      end
    end

    it "should include 'json_class'" do
      expect(@json).to match(/"json_class":"Chef::Environment"/)
    end

    it "should include 'chef_type'" do
      expect(@json).to match(/"chef_type":"environment"/)
    end

    include_examples "to_json equivalent to Chef::JSONCompat.to_json" do
      let(:jsonable) { @environment }
    end
  end

  describe "from_json" do
    before(:each) do
      @data = {
        "name" => "production",
        "description" => "We are productive",
        "cookbook_versions" => {
          "apt" => "= 1.2.3",
          "god" => ">= 4.2.0",
          "apache2" => "= 2.0.0",
        },
        "json_class" => "Chef::Environment",
        "chef_type" => "environment",
      }
      @environment = Chef::Environment.from_hash(Chef::JSONCompat.parse(Chef::JSONCompat.to_json(@data)))
    end

    it "should return a Chef::Environment" do
      expect(@environment).to be_a_kind_of(Chef::Environment)
    end

    %w{name description cookbook_versions}.each do |t|
      it "should match '#{t}'" do
        expect(@environment.send(t.to_sym)).to eq(@data[t])
      end
    end
  end

  describe "self.validate_cookbook_versions" do
    before(:each) do
      @cookbook_versions = {
        "apt" => "= 1.0.0",
        "god" => "= 2.0.0",
        "apache2" => "= 4.2.0",
      }
    end

    it "should validate the version string of each cookbook" do
      @cookbook_versions.each_value do |version|
        expect(Chef::Environment).to receive(:validate_cookbook_version).with(version).and_return true
      end
      Chef::Environment.validate_cookbook_versions(@cookbook_versions)
    end

    it "should return false if anything other than a hash is passed as the argument" do
      expect(Chef::Environment.validate_cookbook_versions([])).to eq(false)
      expect(Chef::Environment.validate_cookbook_versions(42)).to eq(false)
      expect(Chef::Environment.validate_cookbook_versions(Chef::CookbookVersion.new("meta"))).to eq(false)
      expect(Chef::Environment.validate_cookbook_versions("cookbook => 1.2.3")).to eq(false)
    end
  end

  describe "self.validate_cookbook_version" do
    it "should validate correct version numbers" do
      expect(Chef::Environment.validate_cookbook_version("= 1.2.3")).to eq(true)
      expect(Chef::Environment.validate_cookbook_version("=1.2.3")).to eq(true)
      expect(Chef::Environment.validate_cookbook_version(">= 0.0.3")).to eq(true)
      expect(Chef::Environment.validate_cookbook_version(">=0.0.3")).to eq(true)
      # A lone version is allowed, interpreted as implicit '='
      expect(Chef::Environment.validate_cookbook_version("1.2.3")).to eq(true)
    end

    it "should return false when an invalid version is given" do
      expect(Chef::Environment.validate_cookbook_version(Chef::CookbookVersion.new("meta"))).to eq(false)
      expect(Chef::Environment.validate_cookbook_version("= 1.2.3a")).to eq(false)
      expect(Chef::Environment.validate_cookbook_version("=1.2.3a")).to eq(false)
      expect(Chef::Environment.validate_cookbook_version("= 1")).to eq(false)
      expect(Chef::Environment.validate_cookbook_version("=1")).to eq(false)
      expect(Chef::Environment.validate_cookbook_version("= a")).to eq(false)
      expect(Chef::Environment.validate_cookbook_version("=a")).to eq(false)
      expect(Chef::Environment.validate_cookbook_version("= 1.2.3.4")).to eq(false)
      expect(Chef::Environment.validate_cookbook_version("=1.2.3.4")).to eq(false)
    end

    describe "in solo mode" do
      before do
        Chef::Config[:solo_legacy_mode] = true
      end

      after do
        Chef::Config[:solo_legacy_mode] = false
      end

      it "should raise an exception" do
        expect do
          Chef::Environment.validate_cookbook_version("= 1.2.3.4")
        end.to raise_error Chef::Exceptions::IllegalVersionConstraint,
          /Environment cookbook version constraints not allowed in .*/
      end
    end

  end

  describe "when updating from a parameter hash" do
    before do
      @environment = Chef::Environment.new
    end

    it "updates the name from parameters[:name]" do
      @environment.update_from_params(name: "kurrupt")
      expect(@environment.name).to eq("kurrupt")
    end

    it "validates the name given in the params" do
      expect(@environment.update_from_params(name: "@$%^&*()")).to be_falsey
      expect(@environment.invalid_fields[:name]).to eq(%q{Property name's value @$%^&*() does not match regular expression /^[\-[:alnum:]_]+$/})
    end

    it "updates the description from parameters[:description]" do
      @environment.update_from_params(description: "wow, writing your own object mapper is kinda painful")
      expect(@environment.description).to eq("wow, writing your own object mapper is kinda painful")
    end

    it "updates cookbook version constraints from the hash in parameters[:cookbook_version_constraints]" do
      # NOTE: I'm only choosing this (admittedly weird) structure for the hash b/c the better more obvious
      # one, i.e, {:cookbook_version_constraints => {COOKBOOK_NAME => CONSTRAINT}} is difficult to implement
      # the way merb does params
      params = { name: "superbowl", cookbook_version: { "0" => "apache2 ~> 1.0.0", "1" => "nginx < 2.0.0" } }
      @environment.update_from_params(params)
      expect(@environment.cookbook_versions).to eq({ "apache2" => "~> 1.0.0", "nginx" => "< 2.0.0" })
    end

    it "validates the cookbook constraints" do
      params = { cookbook_version: { "0" => "apache2 >>> 1.0.0" } }
      expect(@environment.update_from_params(params)).to be_falsey
      err_msg = @environment.invalid_fields[:cookbook_version]["0"]
      expect(err_msg).to eq("apache2 >>> 1.0.0 is not a valid cookbook constraint")
    end

    it "is not valid if the name is not present" do
      expect(@environment.validate_required_attrs_present).to be_falsey
      expect(@environment.invalid_fields[:name]).to eq("name cannot be empty")
    end

    it "is not valid after updating from params if the name is not present" do
      expect(@environment.update_from_params({})).to be_falsey
      expect(@environment.invalid_fields[:name]).to eq("name cannot be empty")
    end

    it "updates default attributes from a JSON string in params[:attributes]" do
      @environment.update_from_params(name: "fuuu", default_attributes: %q|{"fuuu":"RAGE"}|)
      expect(@environment.default_attributes).to eq({ "fuuu" => "RAGE" })
    end

    it "updates override attributes from a JSON string in params[:attributes]" do
      @environment.update_from_params(name: "fuuu", override_attributes: %q|{"foo":"override"}|)
      expect(@environment.override_attributes).to eq({ "foo" => "override" })
    end

  end

  describe "api model" do
    before(:each) do
      @rest = double("Chef::ServerAPI")
      allow(Chef::ServerAPI).to receive(:new).and_return(@rest)
      @query = double("Chef::Search::Query")
      allow(Chef::Search::Query).to receive(:new).and_return(@query)
    end

    describe "list" do
      describe "inflated" do
        it "should return a hash of environment names and objects" do
          e1 = double("Chef::Environment", name: "one")
          expect(@query).to receive(:search).with(:environment).and_yield(e1)
          r = Chef::Environment.list(true)
          expect(r["one"]).to eq(e1)
        end
      end

      it "should return a hash of environment names and urls" do
        expect(@rest).to receive(:get).and_return({ "one" => "http://foo" })
        r = Chef::Environment.list
        expect(r["one"]).to eq("http://foo")
      end
    end
  end

  describe "when loading" do
    describe "in solo mode" do
      before do
        Chef::Config[:solo_legacy_mode] = true
        Chef::Config[:environment_path] = "/var/chef/environments"
      end

      after do
        Chef::Config[:solo_legacy_mode] = false
      end

      it "should get the environment from the environment_path" do
        expect(File).to receive(:directory?).with(Chef::Config[:environment_path]).and_return(true)
        expect(File).to receive(:exists?).with(File.join(Chef::Config[:environment_path], "foo.json")).and_return(false)
        expect(File).to receive(:exists?).with(File.join(Chef::Config[:environment_path], "foo.rb")).exactly(1).times.and_return(true)
        expect(File).to receive(:readable?).with(File.join(Chef::Config[:environment_path], "foo.rb")).and_return(true)
        expect(File).to receive(:file?).with(File.join(Chef::Config[:environment_path], "foo.rb")).and_return(true)
        role_dsl = "name \"foo\"\ndescription \"desc\"\n"
        expect(IO).to receive(:read).with(File.join(Chef::Config[:environment_path], "foo.rb")).and_return(role_dsl)
        Chef::Environment.load("foo")
      end

      it "should return a Chef::Environment object from JSON" do
        expect(File).to receive(:directory?).with(Chef::Config[:environment_path]).and_return(true)
        expect(File).to receive(:exists?).with(File.join(Chef::Config[:environment_path], "foo.json")).and_return(true)
        environment_hash = {
          "name" => "foo",
          "default_attributes" => {
            "foo" => {
              "bar" => 1,
            },
          },
          "json_class" => "Chef::Environment",
          "description" => "desc",
          "chef_type" => "environment",
        }
        expect(IO).to receive(:read).with(File.join(Chef::Config[:environment_path], "foo.json")).and_return(Chef::JSONCompat.to_json(environment_hash))
        environment = Chef::Environment.load("foo")

        expect(environment).to be_a_kind_of(Chef::Environment)
        expect(environment.name).to eq(environment_hash["name"])
        expect(environment.description).to eq(environment_hash["description"])
        expect(environment.default_attributes).to eq(environment_hash["default_attributes"])
      end

      it "should return a Chef::Environment object from Ruby DSL" do
        expect(File).to receive(:directory?).with(Chef::Config[:environment_path]).and_return(true)
        expect(File).to receive(:exists?).with(File.join(Chef::Config[:environment_path], "foo.json")).and_return(false)
        expect(File).to receive(:exists?).with(File.join(Chef::Config[:environment_path], "foo.rb")).exactly(1).times.and_return(true)
        expect(File).to receive(:readable?).with(File.join(Chef::Config[:environment_path], "foo.rb")).and_return(true)
        expect(File).to receive(:file?).with(File.join(Chef::Config[:environment_path], "foo.rb")).and_return(true)
        role_dsl = "name \"foo\"\ndescription \"desc\"\n"
        expect(IO).to receive(:read).with(File.join(Chef::Config[:environment_path], "foo.rb")).and_return(role_dsl)
        environment = Chef::Environment.load("foo")

        expect(environment).to be_a_kind_of(Chef::Environment)
        expect(environment.name).to eq("foo")
        expect(environment.description).to eq("desc")
      end

      it "should raise an error if the configured environment_path is invalid" do
        expect(File).to receive(:directory?).with(Chef::Config[:environment_path]).and_return(false)

        expect do
          Chef::Environment.load("foo")
        end.to raise_error Chef::Exceptions::InvalidEnvironmentPath, "Environment path '/var/chef/environments' is invalid"
      end

      it "should raise an error if the file does not exist" do
        expect(File).to receive(:directory?).with(Chef::Config[:environment_path]).and_return(true)
        expect(File).to receive(:exists?).with(File.join(Chef::Config[:environment_path], "foo.json")).and_return(false)
        expect(File).to receive(:exists?).with(File.join(Chef::Config[:environment_path], "foo.rb")).and_return(false)

        expect do
          Chef::Environment.load("foo")
        end.to raise_error Chef::Exceptions::EnvironmentNotFound, "Environment 'foo' could not be loaded from disk"
      end
    end
  end

end