Class: Chef::CookbookVersion

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/chef/cookbook_version.rb

Overview

Chef::CookbookVersion

CookbookVersion is a model object encapsulating the data about a Chef cookbook. Chef supports maintaining multiple versions of a cookbook on a single server; each version is represented by a distinct instance of this class. – TODO: timh/cw: 5-24-2010: mutators for files (e.g., recipe_filenames=, recipe_filenames.insert) should dirty the manifest so it gets regenerated.

Constant Summary collapse

COOKBOOK_SEGMENTS = 
[ :resources, :providers, :recipes, :definitions, :libraries, :attributes, :files, :templates, :root_files ]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, *root_paths) ⇒ CookbookVersion

Creates a new Chef::CookbookVersion object.

Returns

object<Chef::CookbookVersion>

Duh. :)



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/chef/cookbook_version.rb', line 95

def initialize(name, *root_paths)
  @name = name
  @root_paths = root_paths
  @frozen = false
  @attribute_filenames = Array.new
  @definition_filenames = Array.new
  @template_filenames = Array.new
  @file_filenames = Array.new
  @recipe_filenames = Array.new
  @recipe_filenames_by_name = Hash.new
  @library_filenames = Array.new
  @resource_filenames = Array.new
  @provider_filenames = Array.new
  @metadata_filenames = Array.new
  @root_filenames = Array.new
  @status = :ready
  @manifest = nil
  @file_vendor = nil
  @metadata = Chef::Cookbook::Metadata.new
end

Instance Attribute Details

#attribute_filenames ⇒ Object Also known as: attribute_files

attribute_filenames also has a setter that has non-default functionality.



64
65
66
 
# File 'lib/chef/cookbook_version.rb', line 64

def attribute_filenames
  @attribute_filenames
end

#attribute_filenames_by_short_filename ⇒ Object (readonly)

Returns the value of attribute attribute_filenames_by_short_filename.



71
72
73
 
# File 'lib/chef/cookbook_version.rb', line 71

def attribute_filenames_by_short_filename
  @attribute_filenames_by_short_filename
end

#definition_filenames ⇒ Object

Returns the value of attribute definition_filenames.



46
47
48
 
# File 'lib/chef/cookbook_version.rb', line 46

def definition_filenames
  @definition_filenames
end

#file_filenames ⇒ Object

Returns the value of attribute file_filenames.



48
49
50
 
# File 'lib/chef/cookbook_version.rb', line 48

def file_filenames
  @file_filenames
end

#library_filenames ⇒ Object

Returns the value of attribute library_filenames.



49
50
51
 
# File 'lib/chef/cookbook_version.rb', line 49

def library_filenames
  @library_filenames
end

#metadata ⇒ Object

A Chef::Cookbook::Metadata object. It has a setter that fixes up the metadata to add descriptions of the recipes contained in this CookbookVersion.



60
61
62
 
# File 'lib/chef/cookbook_version.rb', line 60

def metadata
  @metadata
end

#metadata_filenames ⇒ Object

Returns the value of attribute metadata_filenames.



54
55
56
 
# File 'lib/chef/cookbook_version.rb', line 54

def metadata_filenames
  @metadata_filenames
end

#name ⇒ Object

Returns the value of attribute name.



53
54
55
 
# File 'lib/chef/cookbook_version.rb', line 53

def name
  @name
end

#provider_filenames ⇒ Object

Returns the value of attribute provider_filenames.



51
52
53
 
# File 'lib/chef/cookbook_version.rb', line 51

def provider_filenames
  @provider_filenames
end

#recipe_filenames ⇒ Object Also known as: recipe_files

recipe_filenames also has a setter that has non-default functionality.



68
69
70
 
# File 'lib/chef/cookbook_version.rb', line 68

def recipe_filenames
  @recipe_filenames
end

#recipe_filenames_by_name ⇒ Object (readonly)

Returns the value of attribute recipe_filenames_by_name.



70
71
72
 
# File 'lib/chef/cookbook_version.rb', line 70

def recipe_filenames_by_name
  @recipe_filenames_by_name
end

#resource_filenames ⇒ Object

Returns the value of attribute resource_filenames.



50
51
52
 
# File 'lib/chef/cookbook_version.rb', line 50

def resource_filenames
  @resource_filenames
end

#root_filenames ⇒ Object

Returns the value of attribute root_filenames.



52
53
54
 
# File 'lib/chef/cookbook_version.rb', line 52

def root_filenames
  @root_filenames
end

#root_paths ⇒ Object

Returns the value of attribute root_paths.



45
46
47
 
# File 'lib/chef/cookbook_version.rb', line 45

def root_paths
  @root_paths
end

#status ⇒ Object

Returns the value of attribute status.



55
56
57
 
# File 'lib/chef/cookbook_version.rb', line 55

def status
  @status
end

#template_filenames ⇒ Object

Returns the value of attribute template_filenames.



47
48
49
 
# File 'lib/chef/cookbook_version.rb', line 47

def template_filenames
  @template_filenames
end

Class Method Details

.available_versions(cookbook_name) ⇒ Object

Given a cookbook_name, get a list of all versions that exist on the server.

Returns

[String]

Array of cookbook versions, which are strings like ‘x.y.z’

nil

if the cookbook doesn’t exist. an error will also be logged.



583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/chef/cookbook_version.rb', line 583

def self.available_versions(cookbook_name)
  chef_server_rest.get_rest("cookbooks/#{cookbook_name}")[cookbook_name]["versions"].map do |cb|
    cb["version"]
  end
rescue Net::HTTPServerException => e
  if e.to_s =~ /^404/
    Chef::Log.error("Cannot find a cookbook named #{cookbook_name}")
    nil
  else
    raise
  end
end

.cache ⇒ Object 



87
88
89
 
# File 'lib/chef/cookbook_version.rb', line 87

def self.cache
  Chef::FileCache
end

.checksum_cookbook_file(filepath) ⇒ Object

This is the one and only method that knows how cookbook files’ checksums are generated.



80
81
82
83
84
85
 
# File 'lib/chef/cookbook_version.rb', line 80

def self.checksum_cookbook_file(filepath)
  Chef::Digester.generate_md5_checksum_for_file(filepath)
rescue Errno::ENOENT
  Chef::Log.debug("File #{filepath} does not exist, so there is no checksum to generate")
  nil
end

.chef_server_rest ⇒ Object

REST API



531
532
533
 
# File 'lib/chef/cookbook_version.rb', line 531

def self.chef_server_rest
  Chef::REST.new(Chef::Config[:chef_server_url])
end

.json_create(o) ⇒ Object 



488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/chef/cookbook_version.rb', line 488

def self.json_create(o)
  cookbook_version = new(o["cookbook_name"])
  # We want the Chef::Cookbook::Metadata object to always be inflated
  cookbook_version.metadata = Chef::Cookbook::Metadata.from_hash(o["metadata"])
  cookbook_version.manifest = o

  # We don't need the following step when we decide to stop supporting deprecated operators in the metadata (e.g. <<, >>)
  cookbook_version.manifest["metadata"] = Chef::JSONCompat.from_json(Chef::JSONCompat.to_json(cookbook_version.metadata))

  cookbook_version.freeze_version if o["frozen?"]
  cookbook_version
end

.list ⇒ Object Also known as: latest_cookbooks

The API returns only a single version of each cookbook in the result from the cookbooks method



564
565
566
 
# File 'lib/chef/cookbook_version.rb', line 564

def self.list
  chef_server_rest.get_rest('cookbooks')
end

.list_all_versions ⇒ Object 



573
574
575
 
# File 'lib/chef/cookbook_version.rb', line 573

def self.list_all_versions
  chef_server_rest.get_rest('cookbooks?num_versions=all')
end

.load(name, version = "_latest") ⇒ Object 



558
559
560
561
 
# File 'lib/chef/cookbook_version.rb', line 558

def self.load(name, version="_latest")
  version = "_latest" if version == "latest"
  chef_server_rest.get_rest("cookbooks/#{name}/#{version}")
end

Instance Method Details

#<=>(o) ⇒ Object

Raises:



596
597
598
599
600
601
602
 
# File 'lib/chef/cookbook_version.rb', line 596

def <=>(o)
  raise Chef::Exceptions::CookbookVersionNameMismatch if self.name != o.name
  # FIXME: can we change the interface to the Metadata class such
  # that metadata.version returns a Chef::Version instance instead
  # of a string?
  Chef::Version.new(self.version) <=> Chef::Version.new(o.version)
end

#checksums ⇒ Object

Returns a hash of checksums to either nil or the on disk path (which is done by generate_manifest).



180
181
182
183
184
185
 
# File 'lib/chef/cookbook_version.rb', line 180

def checksums
  unless @checksums
    generate_manifest
  end
  @checksums
end

#chef_server_rest ⇒ Object 



535
536
537
 
# File 'lib/chef/cookbook_version.rb', line 535

def chef_server_rest
  self.class.chef_server_rest
end

#destroy ⇒ Object 



553
554
555
556
 
# File 'lib/chef/cookbook_version.rb', line 553

def destroy
  chef_server_rest.delete_rest("cookbooks/#{name}/#{version}")
  self
end

#force_save_url ⇒ Object

Adds the ‘force=true` parameter to the upload URL. This allows the user to overwrite a frozen cookbook (a PUT against the normal #save_url raises a 409 Conflict in this case).



549
550
551
 
# File 'lib/chef/cookbook_version.rb', line 549

def force_save_url
  "cookbooks/#{name}/#{version}?force=true"
end

#freeze_version ⇒ Object 



127
128
129
 
# File 'lib/chef/cookbook_version.rb', line 127

def freeze_version
  @frozen = true
end

#frozen_version? ⇒ Boolean

Indicates if this version is frozen or not. Freezing a coobkook version indicates that a new cookbook with the same name and version number shoule

Returns:

  • (Boolean) 


123
124
125
 
# File 'lib/chef/cookbook_version.rb', line 123

def frozen_version?
  @frozen
end

#full_name ⇒ Object 



192
193
194
 
# File 'lib/chef/cookbook_version.rb', line 192

def full_name
  "#{name}-#{version}"
end

#fully_qualified_recipe_names ⇒ Object

Return recipe names in the form of cookbook_name::recipe_name



213
214
215
216
217
218
219
 
# File 'lib/chef/cookbook_version.rb', line 213

def fully_qualified_recipe_names
  results = Array.new
  recipe_filenames_by_name.each_key do |rname|
    results << "#{name}::#{rname}"
  end
  results
end

#generate_manifest_with_urls(&url_generator) ⇒ Object 



501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/chef/cookbook_version.rb', line 501

def generate_manifest_with_urls(&url_generator)
  rendered_manifest = manifest.dup
  COOKBOOK_SEGMENTS.each do |segment|
    if rendered_manifest.has_key?(segment)
      rendered_manifest[segment].each do |manifest_record|
        url_options = { :cookbook_name => name.to_s, :cookbook_version => version, :checksum => manifest_record["checksum"] }
        manifest_record["url"] = url_generator.call(url_options)
      end
    end
  end
  rendered_manifest
end

#has_cookbook_file_for_node?(node, cookbook_filename) ⇒ Boolean

Query whether a cookbook_file file cookbook_filename is available. File specificity for the given node is obeyed in the lookup.

Returns:

  • (Boolean) 


295
296
297
 
# File 'lib/chef/cookbook_version.rb', line 295

def has_cookbook_file_for_node?(node, cookbook_filename)
  !!find_preferred_manifest_record(node, :files, cookbook_filename)
end

#has_template_for_node?(node, template_filename) ⇒ Boolean

Query whether a template file template_filename is available. File specificity for the given node is obeyed in the lookup.

Returns:

  • (Boolean) 


289
290
291
 
# File 'lib/chef/cookbook_version.rb', line 289

def has_template_for_node?(node, template_filename)
  !!find_preferred_manifest_record(node, :templates, template_filename)
end

#load_recipe(recipe_name, run_context) ⇒ Object

called from DSL



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/chef/cookbook_version.rb', line 232

def load_recipe(recipe_name, run_context)
  unless recipe_filenames_by_name.has_key?(recipe_name)
    raise Chef::Exceptions::RecipeNotFound, "could not find recipe #{recipe_name} for cookbook #{name}"
  end

  Chef::Log.debug("Found recipe #{recipe_name} in cookbook #{name}")
  recipe = Chef::Recipe.new(name, recipe_name, run_context)
  recipe_filename = recipe_filenames_by_name[recipe_name]

  unless recipe_filename
    raise Chef::Exceptions::RecipeNotFound, "could not find #{recipe_name} files for cookbook #{name}"
  end

  recipe.from_file(recipe_filename)
  recipe
end

#manifest ⇒ Object

A manifest is a Mash that maps segment names to arrays of manifest records (see #preferred_manifest_record for format of manifest records), as well as describing cookbook metadata. The manifest follows a form like the following:

{
  :cookbook_name = "apache2",
  :version = "1.0",
  :name = "Apache 2"
  :metadata = ???TODO: timh/cw: 5-24-2010: describe this format,

  :files => [
    {
      :name => "afile.rb",
      :path => "files/ubuntu-9.10/afile.rb",
      :checksum => "2222",
      :specificity => "ubuntu-9.10"
    },
  ],
  :templates => [ manifest_record1, ... ],
  ...
}



158
159
160
161
162
163
 
# File 'lib/chef/cookbook_version.rb', line 158

def manifest
  unless @manifest
    generate_manifest
  end
  @manifest
end

#manifest=(new_manifest) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/chef/cookbook_version.rb', line 165

def manifest=(new_manifest)
  @manifest = Mash.new new_manifest
  @checksums = extract_checksums_from_manifest(@manifest)
  @manifest_records_by_path = extract_manifest_records_by_path(@manifest)

  COOKBOOK_SEGMENTS.each do |segment|
    next unless @manifest.has_key?(segment)
    filenames = @manifest[segment].map{|manifest_record| manifest_record['name']}

    replace_segment_filenames(segment, filenames)
  end
end

#manifest_records_by_path ⇒ Object 



187
188
189
190
 
# File 'lib/chef/cookbook_version.rb', line 187

def manifest_records_by_path
  @manifest_records_by_path || generate_manifest
  @manifest_records_by_path
end

#metadata_json_file ⇒ Object 



514
515
516
 
# File 'lib/chef/cookbook_version.rb', line 514

def metadata_json_file
  File.join(root_paths[0], "metadata.json")
end

#metadata_rb_file ⇒ Object 



518
519
520
 
# File 'lib/chef/cookbook_version.rb', line 518

def metadata_rb_file
  File.join(root_paths[0], "metadata.rb")
end

#preferred_filename_on_disk_location(node, segment, filename, current_filepath = nil) ⇒ Object 



344
345
346
347
348
349
350
351
 
# File 'lib/chef/cookbook_version.rb', line 344

def preferred_filename_on_disk_location(node, segment, filename, current_filepath=nil)
  manifest_record = preferred_manifest_record(node, segment, filename)
  if current_filepath && (manifest_record['checksum'] == self.class.checksum_cookbook_file(current_filepath))
    nil
  else
    file_vendor.get_filename(manifest_record['path'])
  end
end

#preferred_manifest_record(node, segment, filename) ⇒ Object

Determine the most specific manifest record for the given segment/filename, given information in the node. Throws FileNotFound if there is no such segment and filename in the manifest.

A manifest record is a Mash that follows the following form: 

:name => "example.rb",
:path => "files/default/example.rb",
:specificity => "default",
:checksum => "1234"




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
 
# File 'lib/chef/cookbook_version.rb', line 311

def preferred_manifest_record(node, segment, filename)
  found_pref = find_preferred_manifest_record(node, segment, filename)
  if found_pref
    @manifest_records_by_path[found_pref]
  else
    if segment == :files || segment == :templates
      error_message = "Cookbook '#{name}' (#{version}) does not contain a file at any of these locations:\n"
      error_locations = if filename.is_a?(Array)
        filename.map{|name| "  #{File.join(segment.to_s, name)}"}
      else
        [
          "  #{segment}/#{node[:platform]}-#{node[:platform_version]}/#{filename}",
          "  #{segment}/#{node[:platform]}/#{filename}",
          "  #{segment}/default/#{filename}",
          "  #{segment}/#{filename}",
        ]
      end
      error_message << error_locations.join("\n")
      existing_files = segment_filenames(segment)
      # Strip the root_dir prefix off all files for readability
      existing_files.map!{|path| path[root_dir.length+1..-1]} if root_dir
      # Show the files that the cookbook does have. If the user made a typo,
      # hopefully they'll see it here.
      unless existing_files.empty?
        error_message << "\n\nThis cookbook _does_ contain: ['#{existing_files.join("','")}']"
      end
      raise Chef::Exceptions::FileNotFound, error_message
    else
      raise Chef::Exceptions::FileNotFound, "cookbook #{name} does not contain file #{segment}/#{filename}"
    end
  end
end

#preferred_manifest_records_for_directory(node, segment, dirname) ⇒ Object

Determine the manifest records from the most specific directory for the given node. See #preferred_manifest_record for a description of entries of the returned Array.

Raises:



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
 
# File 'lib/chef/cookbook_version.rb', line 394

def preferred_manifest_records_for_directory(node, segment, dirname)
  preferences = preferences_for_path(node, segment, dirname)
  records_by_pref = Hash.new
  preferences.each { |pref| records_by_pref[pref] = Array.new }

  manifest[segment].each do |manifest_record|
    manifest_record_path = manifest_record[:path]

    # extract the preference part from the path.
    if manifest_record_path =~ /(#{Regexp.escape(segment.to_s)}\/[^\/]+\/#{Regexp.escape(dirname)})\/.+$/
      # Note the specificy_dirname includes the segment and
      # dirname argument as above, which is what
      # preferences_for_path returns. It could be
      # "files/ubuntu-9.10/dirname", for example.
      specificity_dirname = $1

      # Record the specificity_dirname only if it's in the list of
      # valid preferences
      if records_by_pref[specificity_dirname]
        records_by_pref[specificity_dirname] << manifest_record
      end
    end
  end

  best_pref = preferences.find { |pref| !records_by_pref[pref].empty? }

  raise Chef::Exceptions::FileNotFound, "cookbook #{name} (#{version}) has no directory #{segment}/default/#{dirname}" unless best_pref

  records_by_pref[best_pref]
end

#relative_filenames_in_preferred_directory(node, segment, dirname) ⇒ Object

Raises:



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
 
# File 'lib/chef/cookbook_version.rb', line 353

def relative_filenames_in_preferred_directory(node, segment, dirname)
  preferences = preferences_for_path(node, segment, dirname)
  filenames_by_pref = Hash.new
  preferences.each { |pref| filenames_by_pref[pref] = Array.new }

  manifest[segment].each do |manifest_record|
    manifest_record_path = manifest_record[:path]

    # find the NON SPECIFIC filenames, but prefer them by filespecificity.
    # For example, if we have a file:
    # 'files/default/somedir/somefile.conf' we only keep
    # 'somedir/somefile.conf'. If there is also
    # 'files/$hostspecific/somedir/otherfiles' that matches the requested
    # hostname specificity, that directory will win, as it is more specific.
    #
    # This is clearly ugly b/c the use case is for remote directory, where
    # we're just going to make cookbook_files out of these and make the
    # cookbook find them by filespecificity again. but it's the shortest
    # path to "success" for now.
    if manifest_record_path =~ /(#{Regexp.escape(segment.to_s)}\/[^\/]+\/#{Regexp.escape(dirname)})\/.+$/
      specificity_dirname = $1
      non_specific_path = manifest_record_path[/#{Regexp.escape(segment.to_s)}\/[^\/]+\/#{Regexp.escape(dirname)}\/(.+)$/, 1]
      # Record the specificity_dirname only if it's in the list of
      # valid preferences
      if filenames_by_pref[specificity_dirname]
        filenames_by_pref[specificity_dirname] << non_specific_path
      end
    end
  end

  best_pref = preferences.find { |pref| !filenames_by_pref[pref].empty? }

  raise Chef::Exceptions::FileNotFound, "cookbook #{name} has no directory #{segment}/default/#{dirname}" unless best_pref

  filenames_by_pref[best_pref]

end

#reload_metadata! ⇒ Object 



522
523
524
525
526
 
# File 'lib/chef/cookbook_version.rb', line 522

def reload_metadata!
  if File.exists?(metadata_json_file)
    metadata.from_json(IO.read(metadata_json_file))
  end
end

#replace_segment_filenames(segment, filenames) ⇒ Object 



276
277
278
279
280
281
282
283
284
285
 
# File 'lib/chef/cookbook_version.rb', line 276

def replace_segment_filenames(segment, filenames)
  case segment.to_sym
  when :recipes
    self.recipe_filenames = filenames
  when :attributes
    self.attribute_filenames = filenames
  else
    segment_filenames(segment).replace(filenames)
  end
end

#root_dir ⇒ Object

The first root path is the primary cookbook dir, from which metadata is loaded



74
75
76
 
# File 'lib/chef/cookbook_version.rb', line 74

def root_dir
  root_paths[0]
end

#save_url ⇒ Object

Return the URL to save (PUT) this object to the server via the REST api. If there is an existing document on the server and it is marked frozen, a PUT will result in a 409 Conflict.



542
543
544
 
# File 'lib/chef/cookbook_version.rb', line 542

def save_url
  "cookbooks/#{name}/#{version}"
end

#segment_filenames(segment) ⇒ Object 



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
 
# File 'lib/chef/cookbook_version.rb', line 249

def segment_filenames(segment)
  unless COOKBOOK_SEGMENTS.include?(segment)
    raise ArgumentError, "invalid segment #{segment}: must be one of #{COOKBOOK_SEGMENTS.join(', ')}"
  end

  case segment.to_sym
  when :resources
    @resource_filenames
  when :providers
    @provider_filenames
  when :recipes
    @recipe_filenames
  when :libraries
    @library_filenames
  when :definitions
    @definition_filenames
  when :attributes
    @attribute_filenames
  when :files
    @file_filenames
  when :templates
    @template_filenames
  when :root_files
    @root_filenames
  end
end

#to_hash ⇒ Object 



475
476
477
478
479
480
 
# File 'lib/chef/cookbook_version.rb', line 475

def to_hash
  result = manifest.dup
  result['frozen?'] = frozen_version?
  result['chef_type'] = 'cookbook_version'
  result.to_hash
end

#to_json(*a) ⇒ Object 



482
483
484
485
486
 
# File 'lib/chef/cookbook_version.rb', line 482

def to_json(*a)
  result = to_hash
  result['json_class'] = self.class.name
  Chef::JSONCompat.to_json(result, *a)
end

#version ⇒ Object 



116
117
118
 
# File 'lib/chef/cookbook_version.rb', line 116

def version
  metadata.version
end

#version=(new_version) ⇒ Object 



131
132
133
134
 
# File 'lib/chef/cookbook_version.rb', line 131

def version=(new_version)
  manifest["version"] = new_version
  metadata.version(new_version)
end