summaryrefslogtreecommitdiff
path: root/spec/unit/cookbook_version_spec.rb
blob: d213cfd86f913f80e480e65752e9c0d1792a494d (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
#
# Author:: Daniel DeLeo (<dan@opscode.com>)
# Copyright:: Copyright 2010-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"

describe Chef::CookbookVersion do
  describe "when first created" do
    before do
      @cookbook_version = Chef::CookbookVersion.new("tatft", "/tmp/blah")
    end

    it "has a name" do
      expect(@cookbook_version.name).to eq("tatft")
    end

    it "has no attribute files" do
      expect(@cookbook_version.attribute_filenames).to be_empty
    end

    it "has no resource definition files" do
      expect(@cookbook_version.definition_filenames).to be_empty
    end

    it "has no cookbook files" do
      expect(@cookbook_version.file_filenames).to be_empty
    end

    it "has no recipe files" do
      expect(@cookbook_version.recipe_filenames).to be_empty
    end

    it "has no library files" do
      expect(@cookbook_version.library_filenames).to be_empty
    end

    it "has no LWRP resource files" do
      expect(@cookbook_version.resource_filenames).to be_empty
    end

    it "has no LWRP provider files" do
      expect(@cookbook_version.provider_filenames).to be_empty
    end

    it "has no metadata files" do
      expect(@cookbook_version.metadata_filenames).to be_empty
    end

    it "is not frozen" do
      expect(@cookbook_version).not_to be_frozen_version
    end

    it "can be frozen" do
      @cookbook_version.freeze_version
      expect(@cookbook_version).to be_frozen_version
    end

    it "has empty metadata" do
      expect(@cookbook_version.metadata).to eq(Chef::Cookbook::Metadata.new)
    end

  end

  describe "with a cookbook directory named tatft" do
    MD5 = /[0-9a-f]{32}/

    before do
      @cookbook = Hash.new { |hash, key| hash[key] = [] }

      @cookbook_root = File.join(CHEF_SPEC_DATA, "cb_version_cookbooks", "tatft")

      # Dunno if the paths here are representitive of what is set by CookbookLoader...
      @cookbook[:attribute_filenames]   = Dir[File.join(@cookbook_root, "attributes", "**", "*.rb")]
      @cookbook[:definition_filenames]  = Dir[File.join(@cookbook_root, "definitions", "**", "*.rb")]
      @cookbook[:file_filenames]        = Dir[File.join(@cookbook_root, "files", "**", "*.tgz")]
      @cookbook[:recipe_filenames]      = Dir[File.join(@cookbook_root, "recipes", "**", "*.rb")]
      @cookbook[:template_filenames]    = Dir[File.join(@cookbook_root, "templates", "**", "*.erb")]
      @cookbook[:library_filenames]     = Dir[File.join(@cookbook_root, "libraries", "**", "*.rb")]
      @cookbook[:resource_filenames]    = Dir[File.join(@cookbook_root, "resources", "**", "*.rb")]
      @cookbook[:provider_filenames]    = Dir[File.join(@cookbook_root, "providers", "**", "*.rb")]
      @cookbook[:root_filenames]        = Array(File.join(@cookbook_root, "README.rdoc"))
      @cookbook[:metadata_filenames]    = Array(File.join(@cookbook_root, "metadata.json"))
    end

    describe "and a cookbook with the same name" do
      before do
        # Currently the cookbook loader finds all the files then tells CookbookVersion
        # where they are.
        @cookbook_version = Chef::CookbookVersion.new("tatft", @cookbook_root)

        @cookbook_version.attribute_filenames  = @cookbook[:attribute_filenames]
        @cookbook_version.definition_filenames = @cookbook[:definition_filenames]
        @cookbook_version.recipe_filenames     = @cookbook[:recipe_filenames]
        @cookbook_version.template_filenames   = @cookbook[:template_filenames]
        @cookbook_version.file_filenames       = @cookbook[:file_filenames]
        @cookbook_version.library_filenames    = @cookbook[:library_filenames]
        @cookbook_version.resource_filenames   = @cookbook[:resource_filenames]
        @cookbook_version.provider_filenames   = @cookbook[:provider_filenames]
        @cookbook_version.root_filenames       = @cookbook[:root_filenames]
        @cookbook_version.metadata_filenames   = @cookbook[:metadata_filenames]

        # Used to test file-specificity related file lookups
        @node = Chef::Node.new
        @node.set[:platform] = "ubuntu"
        @node.set[:platform_version] = "13.04"
        @node.name("testing")
      end

      it "determines whether a template is available for a given node" do
        expect(@cookbook_version).to have_template_for_node(@node, "configuration.erb")
        expect(@cookbook_version).not_to have_template_for_node(@node, "missing.erb")
      end

      it "determines whether a cookbook_file is available for a given node" do
        expect(@cookbook_version).to have_cookbook_file_for_node(@node, "giant_blob.tgz")
        expect(@cookbook_version).not_to have_cookbook_file_for_node(@node, "missing.txt")
      end

      describe "raises an error when attempting to load a missing cookbook_file and" do
        before do
          node = Chef::Node.new.tap do |n|
            n.name("sample.node")
            n.automatic_attrs[:fqdn] = "sample.example.com"
            n.automatic_attrs[:platform] = "ubuntu"
            n.automatic_attrs[:platform_version] = "10.04"
          end
          @attempt_to_load_file = lambda { @cookbook_version.preferred_manifest_record(node, :files, "no-such-thing.txt") }
        end

        it "describes the cookbook and version" do
          useful_explanation = Regexp.new(Regexp.escape("Cookbook 'tatft' (0.0.0) does not contain"))
          expect(@attempt_to_load_file).to raise_error(Chef::Exceptions::FileNotFound, useful_explanation)
        end

        it "lists suggested places to look" do
          useful_explanation = Regexp.new(Regexp.escape("files/default/no-such-thing.txt"))
          expect(@attempt_to_load_file).to raise_error(Chef::Exceptions::FileNotFound, useful_explanation)
        end
      end
    end

  end

  describe "with a cookbook directory named cookbook2 that has unscoped files" do
    before do
      @cookbook = Hash.new { |hash, key| hash[key] = [] }

      @cookbook_root = File.join(CHEF_SPEC_DATA, "cb_version_cookbooks", "cookbook2")

      # Dunno if the paths here are representitive of what is set by CookbookLoader...
      @cookbook[:attribute_filenames]   = Dir[File.join(@cookbook_root, "attributes", "**", "*.rb")]
      @cookbook[:definition_filenames]  = Dir[File.join(@cookbook_root, "definitions", "**", "*.rb")]
      @cookbook[:file_filenames]        = Dir[File.join(@cookbook_root, "files", "**", "*.*")]
      @cookbook[:recipe_filenames]      = Dir[File.join(@cookbook_root, "recipes", "**", "*.rb")]
      @cookbook[:template_filenames]    = Dir[File.join(@cookbook_root, "templates", "**", "*.*")]
      @cookbook[:library_filenames]     = Dir[File.join(@cookbook_root, "libraries", "**", "*.rb")]
      @cookbook[:resource_filenames]    = Dir[File.join(@cookbook_root, "resources", "**", "*.rb")]
      @cookbook[:provider_filenames]    = Dir[File.join(@cookbook_root, "providers", "**", "*.rb")]
      @cookbook[:root_filenames]        = Array(File.join(@cookbook_root, "README.rdoc"))
      @cookbook[:metadata_filenames]    = Array(File.join(@cookbook_root, "metadata.json"))

      @cookbook_version = Chef::CookbookVersion.new("cookbook2", @cookbook_root)
      @cookbook_version.attribute_filenames  = @cookbook[:attribute_filenames]
      @cookbook_version.definition_filenames = @cookbook[:definition_filenames]
      @cookbook_version.recipe_filenames     = @cookbook[:recipe_filenames]
      @cookbook_version.template_filenames   = @cookbook[:template_filenames]
      @cookbook_version.file_filenames       = @cookbook[:file_filenames]
      @cookbook_version.library_filenames    = @cookbook[:library_filenames]
      @cookbook_version.resource_filenames   = @cookbook[:resource_filenames]
      @cookbook_version.provider_filenames   = @cookbook[:provider_filenames]
      @cookbook_version.root_filenames       = @cookbook[:root_filenames]
      @cookbook_version.metadata_filenames   = @cookbook[:metadata_filenames]

      # Used to test file-specificity related file lookups
      @node = Chef::Node.new
      @node.set[:platform] = "ubuntu"
      @node.set[:platform_version] = "13.04"
      @node.name("testing")
    end

    it "should see a template" do
      expect(@cookbook_version).to have_template_for_node(@node, "test.erb")
    end

    it "should see a template using an array lookup" do
      expect(@cookbook_version).to have_template_for_node(@node, ["test.erb"])
    end

    it "should see a template using an array lookup with non-existent elements" do
      expect(@cookbook_version).to have_template_for_node(@node, ["missing.txt", "test.erb"])
    end

    it "should see a file" do
      expect(@cookbook_version).to have_cookbook_file_for_node(@node, "test.txt")
    end

    it "should see a file using an array lookup" do
      expect(@cookbook_version).to have_cookbook_file_for_node(@node, ["test.txt"])
    end

    it "should see a file using an array lookup with non-existent elements" do
      expect(@cookbook_version).to have_cookbook_file_for_node(@node, ["missing.txt", "test.txt"])
    end

    it "should not see a non-existent template" do
      expect(@cookbook_version).not_to have_template_for_node(@node, "missing.erb")
    end

    it "should not see a non-existent template using an array lookup" do
      expect(@cookbook_version).not_to have_template_for_node(@node, ["missing.erb"])
    end

    it "should not see a non-existent file" do
      expect(@cookbook_version).not_to have_cookbook_file_for_node(@node, "missing.txt")
    end

    it "should not see a non-existent file using an array lookup" do
      expect(@cookbook_version).not_to have_cookbook_file_for_node(@node, ["missing.txt"])
    end

  end


  describe "<=>" do

    it "should sort based on the version number" do
      examples = [
                  # smaller, larger
                  ["1.0", "2.0"],
                  ["1.2.3", "1.2.4"],
                  ["1.2.3", "1.3.0"],
                  ["1.2.3", "1.3"],
                  ["1.2.3", "2.1.1"],
                  ["1.2.3", "2.1"],
                  ["1.2", "1.2.4"],
                  ["1.2", "1.3.0"],
                  ["1.2", "1.3"],
                  ["1.2", "2.1.1"],
                  ["1.2", "2.1"],
                 ]
      examples.each do |smaller, larger|
        sm = Chef::CookbookVersion.new("foo", "/tmp/blah")
        lg = Chef::CookbookVersion.new("foo", "/tmp/blah")
        sm.version = smaller
        lg.version = larger
        expect(sm).to be < lg
        expect(lg).to be > sm
        expect(sm).not_to eq(lg)
      end
    end

    it "should equate versions 1.2 and 1.2.0" do
      a = Chef::CookbookVersion.new("foo", "/tmp/blah")
      b = Chef::CookbookVersion.new("foo", "/tmp/blah")
      a.version = "1.2"
      b.version = "1.2.0"
      expect(a).to eq(b)
    end


    it "should not allow you to sort cookbooks with different names" do
      apt = Chef::CookbookVersion.new "apt", "/tmp/blah"
      apt.version = "1.0"
      god = Chef::CookbookVersion.new "god", "/tmp/blah"
      god.version = "2.0"
      expect {apt <=> god}.to raise_error(Chef::Exceptions::CookbookVersionNameMismatch)
    end
  end

  describe "when you set a version" do
    before do
      @cbv = Chef::CookbookVersion.new("version validation", "/tmp/blah")
    end
    it "should accept valid cookbook versions" do
      good_versions = %w{1.2 1.2.3 1000.80.50000 0.300.25}
      good_versions.each do |v|
        @cbv.version = v
      end
    end

    it "should raise InvalidVersion for bad cookbook versions" do
      bad_versions = ["1.2.3.4", "1.2.a4", "1", "a", "1.2 3", "1.2 a",
                      "1 2 3", "1-2-3", "1_2_3", "1.2_3", "1.2-3"]
      the_error = Chef::Exceptions::InvalidCookbookVersion
      bad_versions.each do |v|
        expect {@cbv.version = v}.to raise_error(the_error)
      end
    end

  end

  describe "when deprecation warnings are errors" do

    subject(:cbv) { Chef::CookbookVersion.new("version validation", "/tmp/blah") }

    it "errors on #status and #status=" do
      expect { cbv.status = :wat }.to raise_error(Chef::Exceptions::DeprecatedFeatureError)
      expect { cbv.status }.to raise_error(Chef::Exceptions::DeprecatedFeatureError)
    end

  end

  describe "deprecated features" do

    subject(:cbv) { Chef::CookbookVersion.new("tatft", "/tmp/blah").tap { |c| c.version = "1.2.3" } }

    before do
      Chef::Config[:treat_deprecation_warnings_as_errors] = false
    end

    it "gives a save URL for the standard cookbook API" do
      expect(cbv.save_url).to eq("cookbooks/tatft/1.2.3")
    end

    it "gives a force save URL for the standard cookbook API" do
      expect(cbv.force_save_url).to eq("cookbooks/tatft/1.2.3?force=true")
    end

    it "is \"ready\"" do
      # WTF is this? what are the valid states? and why aren't they set with encapsulating methods?
      # [Dan 15-Jul-2010]
      expect(cbv.status).to eq(:ready)
    end


    include_examples "to_json equivalent to Chef::JSONCompat.to_json" do
      let(:jsonable) { Chef::CookbookVersion.new("tatft", "/tmp/blah") }
    end

  end
end