Class: Chef::Cookbook::Metadata

Inherits:
Object
  • Object
show all
Includes:
Mixin::FromFile, Mixin::ParamsValidate
Defined in:
lib/chef/cookbook/metadata.rb

Overview

== Chef::Cookbook::Metadata Chef::Cookbook::Metadata provides a convenient DSL for declaring metadata about Chef Cookbooks.

Direct Known Subclasses

MinimalMetadata

Constant Summary collapse

NAME =
"name".freeze
DESCRIPTION =
"description".freeze
LONG_DESCRIPTION =
"long_description".freeze
MAINTAINER =
"maintainer".freeze
MAINTAINER_EMAIL =
"maintainer_email".freeze
LICENSE =
"license".freeze
PLATFORMS =
"platforms".freeze
DEPENDENCIES =
"dependencies".freeze
PROVIDING =
"providing".freeze
ATTRIBUTES =
"attributes".freeze
RECIPES =
"recipes".freeze
VERSION =
"version".freeze
SOURCE_URL =
"source_url".freeze
ISSUES_URL =
"issues_url".freeze
PRIVACY =
"privacy".freeze
CHEF_VERSIONS =
"chef_versions".freeze
OHAI_VERSIONS =
"ohai_versions".freeze
GEMS =
"gems".freeze
COMPARISON_FIELDS =
[ :name, :description, :long_description, :maintainer,
:maintainer_email, :license, :platforms, :dependencies,
:providing, :attributes, :recipes, :version,
:source_url, :issues_url, :privacy, :chef_versions, :ohai_versions,
:gems ]
VERSION_CONSTRAINTS =
{ :depends      => DEPENDENCIES,
:provides     => PROVIDING,
:chef_version => CHEF_VERSIONS,
:ohai_version => OHAI_VERSIONS }

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Mixin::FromFile

#class_from_file, #from_file

Methods included from Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Constructor Details

#initializeMetadata

Builds a new Chef::Cookbook::Metadata object.

=== Parameters cookbook:: An optional cookbook object maintainer:: An optional maintainer maintainer_email:: An optional maintainer email license::An optional license. Default is Apache v2.0

=== Returns metadataChef::Cookbook::Metadata


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
# File 'lib/chef/cookbook/metadata.rb', line 96

def initialize
  @name = nil

  @description = ""
  @long_description = ""
  @license = "All rights reserved"

  @maintainer = nil
  @maintainer_email = nil

  @platforms = Mash.new
  @dependencies = Mash.new
  @providing = Mash.new
  @attributes = Mash.new
  @recipes = Mash.new
  @version = Version.new("0.0.0")
  @source_url = ""
  @issues_url = ""
  @privacy = false
  @chef_versions = []
  @ohai_versions = []
  @gems = []

  @errors = []
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object


616
617
618
619
620
621
622
# File 'lib/chef/cookbook/metadata.rb', line 616

def method_missing(method, *args, &block)
  if block_given?
    super
  else
    Chef::Log.debug "ignoring method #{method} on cookbook with name #{name}, possible typo or the ghosts of metadata past or future?"
  end
end

Instance Attribute Details

#attributesObject (readonly)

Returns the value of attribute attributes


75
76
77
# File 'lib/chef/cookbook/metadata.rb', line 75

def attributes
  @attributes
end

#chef_versionsArray<Gem::Dependency> (readonly)

Returns Array of supported Chef versions

Returns:

  • (Array<Gem::Dependency>)

    Array of supported Chef versions


80
81
82
# File 'lib/chef/cookbook/metadata.rb', line 80

def chef_versions
  @chef_versions
end

#dependenciesObject (readonly)

Returns the value of attribute dependencies


73
74
75
# File 'lib/chef/cookbook/metadata.rb', line 73

def dependencies
  @dependencies
end

#gemsArray<Array> (readonly)

Returns Array of gems to install with *args as an Array

Returns:

  • (Array<Array>)

    Array of gems to install with *args as an Array


84
85
86
# File 'lib/chef/cookbook/metadata.rb', line 84

def gems
  @gems
end

#ohai_versionsArray<Gem::Dependency> (readonly)

Returns Array of supported Ohai versions

Returns:

  • (Array<Gem::Dependency>)

    Array of supported Ohai versions


82
83
84
# File 'lib/chef/cookbook/metadata.rb', line 82

def ohai_versions
  @ohai_versions
end

#platformsObject (readonly)

Returns the value of attribute platforms


72
73
74
# File 'lib/chef/cookbook/metadata.rb', line 72

def platforms
  @platforms
end

#providingObject (readonly)

Returns the value of attribute providing


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

def providing
  @providing
end

#recipesObject (readonly)

Returns the value of attribute recipes


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

def recipes
  @recipes
end

#version(arg = nil) ⇒ Object (readonly)

Sets the current cookbook version, or returns it. Can be two or three digits, separated by dots. ie: '2.1', '1.5.4' or '0.9'.

=== Parameters version:: The current version, as a string

=== Returns version:: Returns the current version


237
238
239
# File 'lib/chef/cookbook/metadata.rb', line 237

def version
  @version
end

Class Method Details

.from_hash(o) ⇒ Object


496
497
498
499
500
# File 'lib/chef/cookbook/metadata.rb', line 496

def self.from_hash(o)
  cm = new()
  cm.from_hash(o)
  cm
end

.from_json(string) ⇒ Object


524
525
526
527
# File 'lib/chef/cookbook/metadata.rb', line 524

def self.from_json(string)
  o = Chef::JSONCompat.from_json(string)
  from_hash(o)
end

.validate_json(json_str) ⇒ Object


529
530
531
532
533
534
535
536
537
538
539
540
541
542
# File 'lib/chef/cookbook/metadata.rb', line 529

def self.validate_json(json_str)
  o = Chef::JSONCompat.from_json(json_str)
   = new()
  VERSION_CONSTRAINTS.each do |dependency_type, hash_key|
    if dependency_group = o[hash_key]
      dependency_group.each do |cb_name, constraints|
        if .respond_to?(dependency_type)
          .public_send(dependency_type, cb_name, *Array(constraints))
        end
      end
    end
  end
  true
end

Instance Method Details

#==(other) ⇒ Object


122
123
124
125
126
# File 'lib/chef/cookbook/metadata.rb', line 122

def ==(other)
  COMPARISON_FIELDS.inject(true) do |equal_so_far, field|
    equal_so_far && other.respond_to?(field) && (other.send(field) == send(field))
  end
end

#attribute(name, options) ⇒ Object

Adds an attribute that a user needs to configure for this cookbook. Takes a name (with the / notation for a nested attribute), followed by any of these options

display_name:: What a UI should show for this attribute description:: A hint as to what this attr is for choice:: An array of choices to present to the user. calculated:: If true, the default value is calculated by the recipe and cannot be displayed. type:: "string" or "array" - default is "string" ("hash" is supported for backwards compatibility) required:: Whether this attr is 'required', 'recommended' or 'optional' - default 'optional' (true/false values also supported for backwards compatibility) recipes:: An array of recipes which need this attr set. default,,:: The default value

=== Parameters name:: The name of the attribute ('foo', or 'apache2/log_dir') options:: The description of the options

=== Returns options:: Returns the current options hash


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
# File 'lib/chef/cookbook/metadata.rb', line 409

def attribute(name, options)
  validate(
    options,
    {
      :display_name => { :kind_of => String },
      :description => { :kind_of => String },
      :choice => { :kind_of => [ Array ], :default => [] },
      :calculated => { :equal_to => [ true, false ], :default => false },
      :type => { :equal_to => %w{string array hash symbol boolean numeric}, :default => "string" },
      :required => { :equal_to => [ "required", "recommended", "optional", true, false ], :default => "optional" },
      :recipes => { :kind_of => [ Array ], :default => [] },
      :default => { :kind_of => [ String, Array, Hash, Symbol, Numeric, TrueClass, FalseClass ] },
      :source_url => { :kind_of => String },
      :issues_url => { :kind_of => String },
      :privacy => { :kind_of => [ TrueClass, FalseClass ] },
    }
  )
  options[:required] = remap_required_attribute(options[:required]) unless options[:required].nil?
  validate_choice_array(options)
  validate_calculated_default_rule(options)
  validate_choice_default_rule(options)

  @attributes[name] = options
  @attributes[name]
end

#chef_version(*version_args) ⇒ Array<Gem::Dependency>

Metadata DSL to set a valid chef_version. May be declared multiple times with the result being 'OR'd such that if any statements match, the version is considered supported. Uses Gem::Requirement for its implementation.

Parameters:

  • version_args (Array<String>)

    Version constraint in String form

Returns:

  • (Array<Gem::Dependency>)

    Current chef_versions array


325
326
327
328
# File 'lib/chef/cookbook/metadata.rb', line 325

def chef_version(*version_args)
  @chef_versions << Gem::Dependency.new("chef", *version_args) unless version_args.empty?
  @chef_versions
end

#depends(cookbook, *version_args) ⇒ Object

Adds a dependency on another cookbook, with version checking strings.

=== Parameters cookbook:: The cookbook version:: A version constraint of the form "OP VERSION", where OP is one of < <= = > >= ~> and VERSION has the form x.y.z or x.y.

=== Returns versions:: Returns the list of versions for the platform


287
288
289
290
291
292
293
294
295
296
# File 'lib/chef/cookbook/metadata.rb', line 287

def depends(cookbook, *version_args)
  if cookbook == name
    raise "Cookbook depends on itself in cookbook #{name}, please remove the this unnecessary self-dependency"
  else
    version = new_args_format(:depends, cookbook, version_args)
    constraint = validate_version_constraint(:depends, cookbook, version)
    @dependencies[cookbook] = constraint.to_s
  end
  @dependencies[cookbook]
end

#description(arg = nil) ⇒ Object

Sets the current description, or returns it. Should be short - one line only!

=== Parameters description:: The new description

=== Returns description:: Returns the description


206
207
208
209
210
211
212
# File 'lib/chef/cookbook/metadata.rb', line 206

def description(arg = nil)
  set_or_return(
    :description,
    arg,
    :kind_of => [ String ]
  )
end

#errorsObject

A list of validation errors for this metadata object. See #valid? for comments about the validation criteria.

If there are any validation errors, one or more error strings will be returned. Otherwise an empty array is returned.

=== Returns error messages:: Whether this metadata object is valid


149
150
151
152
# File 'lib/chef/cookbook/metadata.rb', line 149

def errors
  run_validation
  @errors
end

#from_hash(o) ⇒ Object


502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
# File 'lib/chef/cookbook/metadata.rb', line 502

def from_hash(o)
  @name                         = o[NAME] if o.has_key?(NAME)
  @description                  = o[DESCRIPTION] if o.has_key?(DESCRIPTION)
  @long_description             = o[LONG_DESCRIPTION] if o.has_key?(LONG_DESCRIPTION)
  @maintainer                   = o[MAINTAINER] if o.has_key?(MAINTAINER)
  @maintainer_email             = o[MAINTAINER_EMAIL] if o.has_key?(MAINTAINER_EMAIL)
  @license                      = o[LICENSE] if o.has_key?(LICENSE)
  @platforms                    = o[PLATFORMS] if o.has_key?(PLATFORMS)
  @dependencies                 = handle_deprecated_constraints(o[DEPENDENCIES]) if o.has_key?(DEPENDENCIES)
  @providing                    = o[PROVIDING] if o.has_key?(PROVIDING)
  @attributes                   = o[ATTRIBUTES] if o.has_key?(ATTRIBUTES)
  @recipes                      = o[RECIPES] if o.has_key?(RECIPES)
  @version                      = o[VERSION] if o.has_key?(VERSION)
  @source_url                   = o[SOURCE_URL] if o.has_key?(SOURCE_URL)
  @issues_url                   = o[ISSUES_URL] if o.has_key?(ISSUES_URL)
  @privacy                      = o[PRIVACY] if o.has_key?(PRIVACY)
  @chef_versions                = gem_requirements_from_array("chef", o[CHEF_VERSIONS]) if o.has_key?(CHEF_VERSIONS)
  @ohai_versions                = gem_requirements_from_array("ohai", o[OHAI_VERSIONS]) if o.has_key?(OHAI_VERSIONS)
  @gems                         = o[GEMS] if o.has_key?(GEMS)
  self
end

#from_json(string) ⇒ Object


544
545
546
547
# File 'lib/chef/cookbook/metadata.rb', line 544

def from_json(string)
  o = Chef::JSONCompat.from_json(string)
  from_hash(o)
end

#gem(*args) ⇒ Array<Array>

Metadata DSL to set a gem to install from the cookbook metadata. May be declared multiple times. All the gems from all the cookbooks are combined into one Gemfile and depsolved together. Uses Bundler's DSL for its implementation.

Parameters:

  • args (Array<String>)

    Gem name and options to pass to Bundler's DSL

Returns:

  • (Array<Array>)

    Array of gem statements as args


347
348
349
350
# File 'lib/chef/cookbook/metadata.rb', line 347

def gem(*args)
  @gems << args unless args.empty?
  @gems
end

#gem_requirements_from_array(what, array) ⇒ Array<Gem::Dependency>

Convert an Array of Gem::Dependency objects (chef_version/ohai_version) to a hash.

This is the inverse of #gem_requirements_to_array

Parameters:

  • what (String)

    What version constraint we are constructing ('chef' or 'ohai' presently)

  • array (Array<Array<String>])

    Simple object representation of version constraints (from json)

Returns:

  • (Array<Gem::Dependency>)

    Multiple Gem-style version constraints


463
464
465
466
467
# File 'lib/chef/cookbook/metadata.rb', line 463

def gem_requirements_from_array(what, array)
  array.map do |dep|
    Gem::Dependency.new(what, *dep)
  end
end

#gem_requirements_to_array(*deps) ⇒ Array<Array<String>]

Convert an Array of Gem::Dependency objects (chef_version/ohai_version) to an Array.

Gem::Dependencey#to_s is not useful, and there is no #to_json defined on it or its component objets, so we have to write our own rendering method.

[ Gem::Dependency.new(">= 12.5"), Gem::Dependency.new(">= 11.18.0", "< 12.0") ]

results in:

[ [ ">= 12.5" ], [ ">= 11.18.0", "< 12.0" ] ]

Parameters:

  • deps (Array<Gem::Dependency>)

    Multiple Gem-style version constraints

Returns:

  • (Array<Array<String>])

    Simple object representation of version constraints (for json)


448
449
450
451
452
453
454
# File 'lib/chef/cookbook/metadata.rb', line 448

def gem_requirements_to_array(*deps)
  deps.map do |dep|
    dep.requirement.requirements.map do |op, version|
      "#{op} #{version}"
    end.sort
  end
end

#issues_url(arg = nil) ⇒ Object

Sets the cookbook's issues URL, or returns it.

=== Parameters issues_url:: The issues URL

=== Returns issues_url:: Returns the current issues URL.


571
572
573
574
575
576
577
# File 'lib/chef/cookbook/metadata.rb', line 571

def issues_url(arg = nil)
  set_or_return(
    :issues_url,
    arg,
    :kind_of => [ String ]
  )
end

#license(arg = nil) ⇒ Object

Sets the current license, or returns it.

=== Parameters license:: The current license.

=== Returns license:: Returns the current license


191
192
193
194
195
196
197
# File 'lib/chef/cookbook/metadata.rb', line 191

def license(arg = nil)
  set_or_return(
    :license,
    arg,
    :kind_of => [ String ]
  )
end

#long_description(arg = nil) ⇒ Object

Sets the current long description, or returns it. Might come from a README, say.

=== Parameters long_description:: The new long description

=== Returns long_description:: Returns the long description


221
222
223
224
225
226
227
# File 'lib/chef/cookbook/metadata.rb', line 221

def long_description(arg = nil)
  set_or_return(
    :long_description,
    arg,
    :kind_of => [ String ]
  )
end

#maintainer(arg = nil) ⇒ Object

Sets the cookbooks maintainer, or returns it.

=== Parameters maintainer:: The maintainers name

=== Returns maintainer:: Returns the current maintainer.


161
162
163
164
165
166
167
# File 'lib/chef/cookbook/metadata.rb', line 161

def maintainer(arg = nil)
  set_or_return(
    :maintainer,
    arg,
    :kind_of => [ String ]
  )
end

#maintainer_email(arg = nil) ⇒ Object

Sets the maintainers email address, or returns it.

=== Parameters maintainer_email:: The maintainers email address

=== Returns maintainer_email:: Returns the current maintainer email.


176
177
178
179
180
181
182
# File 'lib/chef/cookbook/metadata.rb', line 176

def maintainer_email(arg = nil)
  set_or_return(
    :maintainer_email,
    arg,
    :kind_of => [ String ]
  )
end

#name(arg = nil) ⇒ Object

Sets the name of the cookbook, or returns it.

=== Parameters name:: The current cookbook name.

=== Returns name:: Returns the current cookbook name.


252
253
254
255
256
257
258
# File 'lib/chef/cookbook/metadata.rb', line 252

def name(arg = nil)
  set_or_return(
    :name,
    arg,
    :kind_of => [ String ]
  )
end

#ohai_version(*version_args) ⇒ Array<Gem::Dependency>

Metadata DSL to set a valid ohai_version. May be declared multiple times with the result being 'OR'd such that if any statements match, the version is considered supported. Uses Gem::Requirement for its implementation.

Parameters:

  • version_args (Array<String>)

    Version constraint in String form

Returns:

  • (Array<Gem::Dependency>)

    Current ohai_versions array


336
337
338
339
# File 'lib/chef/cookbook/metadata.rb', line 336

def ohai_version(*version_args)
  @ohai_versions << Gem::Dependency.new("ohai", *version_args) unless version_args.empty?
  @ohai_versions
end

#privacy(arg = nil) ⇒ Object

Sets the cookbook's privacy flag, or returns it.

=== Parameters privacy:: Whether this cookbook is private or not

=== Returns privacy:: Whether this cookbook is private or not


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

def privacy(arg = nil)
  set_or_return(
    :privacy,
    arg,
    :kind_of => [ TrueClass, FalseClass ]
  )
end

#provides(cookbook, *version_args) ⇒ Object

Adds a recipe, definition, or resource provided by this cookbook.

Recipes are specified as normal Definitions are followed by (), and can include :params for prototyping Resources are the stringified version (service[apache2])

=== Parameters recipe, definition, resource:: The thing we provide version:: A version constraint of the form "OP VERSION", where OP is one of < <= = > >= ~> and VERSION has the form x.y.z or x.y.

=== Returns versions:: Returns the list of versions for the platform


312
313
314
315
316
317
# File 'lib/chef/cookbook/metadata.rb', line 312

def provides(cookbook, *version_args)
  version = new_args_format(:provides, cookbook, version_args)
  constraint = validate_version_constraint(:provides, cookbook, version)
  @providing[cookbook] = constraint.to_s
  @providing[cookbook]
end

#recipe(name, description) ⇒ Object

Adds a description for a recipe.

=== Parameters recipe:: The recipe description:: The description of the recipe

=== Returns description:: Returns the current description


360
361
362
# File 'lib/chef/cookbook/metadata.rb', line 360

def recipe(name, description)
  @recipes[name] = description
end

#recipes_from_cookbook_version(cookbook) ⇒ Object

Sets the cookbook's recipes to the list of recipes in the given +cookbook+. Any recipe that already has a description (if set by the

recipe method) will not be updated.

=== Parameters cookbook:: CookbookVersion object representing the cookbook description:: The description of the recipe

=== Returns recipe_unqualified_names:: An array of the recipe names given by the cookbook


374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
# File 'lib/chef/cookbook/metadata.rb', line 374

def recipes_from_cookbook_version(cookbook)
  cookbook.fully_qualified_recipe_names.map do |recipe_name|
    unqualified_name =
      if recipe_name =~ /::default$/
        name.to_s
      else
        recipe_name
      end

    @recipes[unqualified_name] ||= ""
    provides(unqualified_name)

    unqualified_name
  end
end

#source_url(arg = nil) ⇒ Object

Sets the cookbook's source URL, or returns it.

=== Parameters maintainer:: The source URL

=== Returns source_url:: Returns the current source URL.


556
557
558
559
560
561
562
# File 'lib/chef/cookbook/metadata.rb', line 556

def source_url(arg = nil)
  set_or_return(
    :source_url,
    arg,
    :kind_of => [ String ]
  )
end

#supports(platform, *version_args) ⇒ Object

Adds a supported platform, with version checking strings.

=== Parameters platform,:: The platform (like :ubuntu or :mac_os_x) version:: A version constraint of the form "OP VERSION", where OP is one of < <= = > >= ~> and VERSION has the form x.y.z or x.y.

=== Returns versions:: Returns the list of versions for the platform


270
271
272
273
274
275
# File 'lib/chef/cookbook/metadata.rb', line 270

def supports(platform, *version_args)
  version = new_args_format(:supports, platform, version_args)
  constraint = validate_version_constraint(:supports, platform, version)
  @platforms[platform] = constraint.to_s
  @platforms[platform]
end

#to_hashObject


469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
# File 'lib/chef/cookbook/metadata.rb', line 469

def to_hash
  {
    NAME                   => name,
    DESCRIPTION            => description,
    LONG_DESCRIPTION       => long_description,
    MAINTAINER             => maintainer,
    MAINTAINER_EMAIL       => maintainer_email,
    LICENSE                => license,
    PLATFORMS              => platforms,
    DEPENDENCIES           => dependencies,
    PROVIDING              => providing,
    ATTRIBUTES             => attributes,
    RECIPES                => recipes,
    VERSION                => version,
    SOURCE_URL             => source_url,
    ISSUES_URL             => issues_url,
    PRIVACY                => privacy,
    CHEF_VERSIONS          => gem_requirements_to_array(*chef_versions),
    OHAI_VERSIONS          => gem_requirements_to_array(*ohai_versions),
    GEMS                   => gems,
  }
end

#to_json(*a) ⇒ Object


492
493
494
# File 'lib/chef/cookbook/metadata.rb', line 492

def to_json(*a)
  Chef::JSONCompat.to_json(to_hash, *a)
end

#valid?Boolean

Whether this metadata is valid. In order to be valid, all required fields must be set. Chef's validation implementation checks the content of a given field when setting (and raises an error if the content does not meet the criteria), so the content of the fields is not considered when checking validity.

=== Returns valid:: Whether this metadata object is valid

Returns:

  • (Boolean)

136
137
138
139
# File 'lib/chef/cookbook/metadata.rb', line 136

def valid?
  run_validation
  @errors.empty?
end

#validate_chef_version!Object

Validates that the Chef::VERSION of the running chef-client matches one of the configured chef_version statements in this cookbooks metadata.


610
611
612
613
614
# File 'lib/chef/cookbook/metadata.rb', line 610

def validate_chef_version!
  unless gem_dep_matches?("chef", Gem::Version.new(Chef::VERSION), *chef_versions)
    raise Exceptions::CookbookChefVersionMismatch.new(Chef::VERSION, name, version, *chef_versions)
  end
end

#validate_ohai_version!Object

Validates that the Ohai::VERSION of the running chef-client matches one of the configured ohai_version statements in this cookbooks metadata.


600
601
602
603
604
# File 'lib/chef/cookbook/metadata.rb', line 600

def validate_ohai_version!
  unless gem_dep_matches?("ohai", Gem::Version.new(Ohai::VERSION), *ohai_versions)
    raise Exceptions::CookbookOhaiVersionMismatch.new(Ohai::VERSION, name, version, *ohai_versions)
  end
end