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.

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, chef_server_rest: nil) ⇒ CookbookVersion

Creates a new Chef::CookbookVersion object.

Returns

object<Chef::CookbookVersion>

Duh. :)



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/chef/cookbook_version.rb', line 113

def initialize(name, *root_paths, chef_server_rest: nil)
  @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

  # deprecated
  @status = :ready
  @file_vendor = nil
  @metadata = Chef::Cookbook::Metadata.new
  @chef_server_rest = chef_server_rest
end

Instance Attribute Details

#attribute_filenames ⇒ Object Also known as: attribute_files

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



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

def attribute_filenames
  @attribute_filenames
end

#attribute_filenames_by_short_filename ⇒ Object (readonly)

Returns the value of attribute attribute_filenames_by_short_filename.



77
78
79
 
# File 'lib/chef/cookbook_version.rb', line 77

def attribute_filenames_by_short_filename
  @attribute_filenames_by_short_filename
end

#chef_server_rest ⇒ Object

Returns the value of attribute chef_server_rest.



79
80
81
 
# File 'lib/chef/cookbook_version.rb', line 79

def chef_server_rest
  @chef_server_rest
end

#definition_filenames ⇒ Object

Returns the value of attribute definition_filenames.



43
44
45
 
# File 'lib/chef/cookbook_version.rb', line 43

def definition_filenames
  @definition_filenames
end

#file_filenames ⇒ Object

Returns the value of attribute file_filenames.



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

def file_filenames
  @file_filenames
end

#identifier ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The identifier field is used for cookbook_artifacts, which are organized on the chef server according to their content. If the policy_mode option to CookbookManifest is set to true it will include this field in the manifest Hash and in the upload URL.

This field may be removed or have different behavior in the future, don’t use it in 3rd party code.

API:

  • private



89
90
91
 
# File 'lib/chef/cookbook_version.rb', line 89

def identifier
  @identifier
end

#library_filenames ⇒ Object

Returns the value of attribute library_filenames.



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

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.



66
67
68
 
# File 'lib/chef/cookbook_version.rb', line 66

def metadata
  @metadata
end

#metadata_filenames ⇒ Object

Returns the value of attribute metadata_filenames.



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

def metadata_filenames
  @metadata_filenames
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#provider_filenames ⇒ Object

Returns the value of attribute provider_filenames.



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

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.



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

def recipe_filenames
  @recipe_filenames
end

#recipe_filenames_by_name ⇒ Object (readonly)

Returns the value of attribute recipe_filenames_by_name.



76
77
78
 
# File 'lib/chef/cookbook_version.rb', line 76

def recipe_filenames_by_name
  @recipe_filenames_by_name
end

#resource_filenames ⇒ Object

Returns the value of attribute resource_filenames.



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

def resource_filenames
  @resource_filenames
end

#root_filenames ⇒ Object

Returns the value of attribute root_filenames.



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

def root_filenames
  @root_filenames
end

#root_paths ⇒ Object

Returns the value of attribute root_paths.



42
43
44
 
# File 'lib/chef/cookbook_version.rb', line 42

def root_paths
  @root_paths
end

#template_filenames ⇒ Object

Returns the value of attribute template_filenames.



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

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.



575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/chef/cookbook_version.rb', line 575

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 



105
106
107
 
# File 'lib/chef/cookbook_version.rb', line 105

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.



98
99
100
101
102
103
 
# File 'lib/chef/cookbook_version.rb', line 98

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 



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

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

.from_cb_artifact_data(o) ⇒ Object 



471
472
473
474
475
476
477
478
 
# File 'lib/chef/cookbook_version.rb', line 471

def self.from_cb_artifact_data(o)
  cookbook_version = new(o["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
  cookbook_version.identifier = o["identifier"]
  cookbook_version
end

.json_create(o) ⇒ Object 



458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/chef/cookbook_version.rb', line 458

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



556
557
558
 
# File 'lib/chef/cookbook_version.rb', line 556

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

.list_all_versions ⇒ Object 



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

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

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



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

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:



588
589
590
591
592
593
594
 
# File 'lib/chef/cookbook_version.rb', line 588

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).



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

def checksums
  cookbook_manifest.checksums
end

#destroy ⇒ Object 



545
546
547
548
 
# File 'lib/chef/cookbook_version.rb', line 545

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

#force_save_url ⇒ Object 



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

def force_save_url
  # TODO: this should become deprecated when the API for CookbookManifest becomes stable
  cookbook_manifest.force_save_url
end

#freeze_version ⇒ Object 



148
149
150
 
# File 'lib/chef/cookbook_version.rb', line 148

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:



144
145
146
 
# File 'lib/chef/cookbook_version.rb', line 144

def frozen_version?
  @frozen
end

#full_name ⇒ Object 



157
158
159
 
# File 'lib/chef/cookbook_version.rb', line 157

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

#fully_qualified_recipe_names ⇒ Object

Return recipe names in the form of cookbook_name::recipe_name



196
197
198
199
200
201
202
 
# File 'lib/chef/cookbook_version.rb', line 196

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

Deprecated.

This method was used by the Ruby Chef Server and is no longer needed. There is no replacement.



482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/chef/cookbook_version.rb', line 482

def generate_manifest_with_urls(&url_generator)
  Chef::Log.deprecation("Deprecated method #generate_manifest_with_urls called from #{caller(1).first}")

  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:



278
279
280
 
# File 'lib/chef/cookbook_version.rb', line 278

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:



272
273
274
 
# File 'lib/chef/cookbook_version.rb', line 272

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/chef/cookbook_version.rb', line 215

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 



177
178
179
 
# File 'lib/chef/cookbook_version.rb', line 177

def manifest
  cookbook_manifest.manifest
end

#manifest=(new_manifest) ⇒ Object 



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

def manifest=(new_manifest)
  cookbook_manifest.update_from(new_manifest)
end

#manifest_records_by_path ⇒ Object 



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

def manifest_records_by_path
  cookbook_manifest.manifest_records_by_path
end

#metadata_json_file ⇒ Object 



509
510
511
 
# File 'lib/chef/cookbook_version.rb', line 509

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

#metadata_rb_file ⇒ Object 



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

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

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



327
328
329
330
331
332
333
334
 
# File 'lib/chef/cookbook_version.rb', line 327

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"




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

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:



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

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:



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

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 



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

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 



259
260
261
262
263
264
265
266
267
268
 
# File 'lib/chef/cookbook_version.rb', line 259

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



92
93
94
 
# File 'lib/chef/cookbook_version.rb', line 92

def root_dir
  root_paths[0]
end

#save_url ⇒ Object

REST API



527
528
529
530
 
# File 'lib/chef/cookbook_version.rb', line 527

def save_url
  # TODO: this should become deprecated when the API for CookbookManifest becomes stable
  cookbook_manifest.save_url
end

#segment_filenames(segment) ⇒ Object 



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

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

#status ⇒ Object 



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

def status
  Chef::Log.deprecation("Deprecated method `status' called from #{caller(1).first}. This method will be removed")
  @status
end

#status=(new_status) ⇒ Object 



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

def status=(new_status)
  Chef::Log.deprecation("Deprecated method `status' called from #{caller(1).first}. This method will be removed")
  @status = new_status
end

#to_hash ⇒ Object 



498
499
500
501
 
# File 'lib/chef/cookbook_version.rb', line 498

def to_hash
  # TODO: this should become deprecated when the API for CookbookManifest becomes stable
  cookbook_manifest.to_hash
end

#to_json(*a) ⇒ Object 



503
504
505
506
 
# File 'lib/chef/cookbook_version.rb', line 503

def to_json(*a)
  # TODO: this should become deprecated when the API for CookbookManifest becomes stable
  cookbook_manifest.to_json
end

#version ⇒ Object 



137
138
139
 
# File 'lib/chef/cookbook_version.rb', line 137

def version
  metadata.version
end

#version=(new_version) ⇒ Object 



152
153
154
155
 
# File 'lib/chef/cookbook_version.rb', line 152

def version=(new_version)
  cookbook_manifest.reset!
  metadata.version(new_version)
end