Module: Kitchen::Configurable::ClassMethods

Defined in:
lib/kitchen/configurable.rb

Overview

Class methods which will be mixed in on inclusion of Configurable module.

Instance Method Summary collapse

Instance Method Details

#default_config(attr, value = nil) {|object| ... } ⇒ Object

Sets a sane default value for a configuration attribute. These values can be overridden by provided configuration or in a subclass with another default_config declaration.

Examples:

a nil default value


default_config :i_am_nil

a primitive default value


default_config :use_sudo, true

a block to compute a default value


default_config :box_name do |subject|
  subject.instance.platform.name
end

Parameters:

  • attr (String)

    configuration attribute name

  • value (Object, nil) (defaults to: nil)

    static default value for attribute

Yield Parameters:

  • object (Object)

    a reference to the instantiated object

Yield Returns:

  • (Object, nil)

    dynamically computed value for the attribute


462
463
464
# File 'lib/kitchen/configurable.rb', line 462

def default_config(attr, value = nil, &block)
  defaults[attr] = block_given? ? block : value
end

#defaultsHash

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.

Returns a hash of attribute keys and default values which has been merged with any superclass defaults.

Returns:

  • (Hash)

    a hash of attribute keys and default values which has been merged with any superclass defaults


551
552
553
# File 'lib/kitchen/configurable.rb', line 551

def defaults
  @defaults ||= {}.merge(super_defaults)
end

#deprecate_config_for(attr, value = nil) {|object| ... } ⇒ Object

Set the appropriate deprecation message for a given attribute name

Examples:

the default usage


deprecate_config_for :attribute_name, "Detailed deprecation message."

using a block


deprecate_config_for :attribute_name do |subject|
  "Detailed deprecation message." if subject == true
end

Parameters:

  • attr (String)

    configuration attribute name

  • value (Object, nil) (defaults to: nil)

    static default value for attribute

Yield Parameters:

  • object (Object)

    a reference to the instantiated object

Yield Returns:

  • (Object, nil)

    dynamically computed value for the attribute


512
513
514
# File 'lib/kitchen/configurable.rb', line 512

def deprecate_config_for(attr, value = nil, &block)
  deprecated_attributes[attr] = block_given? ? block : value
end

#deprecated_attributesObject


585
586
587
# File 'lib/kitchen/configurable.rb', line 585

def deprecated_attributes
  @deprecated_attributes ||= {}.merge(super_deprecated_attributes)
end

#diagnoseHash

Returns a Hash of configuration and other useful diagnostic information.

Returns:

  • (Hash)

    a diagnostic hash


432
433
434
435
436
437
438
# File 'lib/kitchen/configurable.rb', line 432

def diagnose
  {
    class: name,
    version: @plugin_version ||= nil,
    api_version: @api_version ||= nil,
  }
end

#expand_path_for(attr, value = true) {|object| ... } ⇒ Object

Ensures that an attribute which is a path will be fully expanded at the right time. This helps make the configuration unambiguous and much easier to debug and diagnose.

Note that the file path expansion is only intended for paths on the local workstation invking the Test Kitchen code.

Examples:

the default usage


expand_path_for :data_path

disabling path expansion with a falsey value


expand_path_for :relative_path, false

using a block to determine whether or not to expand


expand_path_for :relative_or_not_path do |subject|
  subject.instance.name =~ /default/
end

Parameters:

  • attr (String)

    configuration attribute name

  • value (Object, nil) (defaults to: true)

    whether or not to exand the file path

Yield Parameters:

  • object (Object)

    a reference to the instantiated object

Yield Returns:

  • (Object, nil)

    dynamically compute whether or not to perform the file expansion


492
493
494
# File 'lib/kitchen/configurable.rb', line 492

def expand_path_for(attr, value = true, &block)
  expanded_paths[attr] = block_given? ? block : value
end

#expanded_pathsHash

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.

Returns a hash of attribute keys and truthy/falsey values to determine if said attribute needs to be fully file path expanded, which has been merged with any superclass expanded paths.

Returns:

  • (Hash)

    a hash of attribute keys and truthy/falsey values to determine if said attribute needs to be fully file path expanded, which has been merged with any superclass expanded paths


570
571
572
# File 'lib/kitchen/configurable.rb', line 570

def expanded_paths
  @expanded_paths ||= {}.merge(super_expanded_paths)
end

#plugin_version(version) ⇒ Object

Sets the loaded version of this plugin, usually corresponding to the RubyGems version of the plugin's library. If the plugin does not set this value, then `nil` will be used and reported.

Examples:

setting a version used by RubyGems


require "kitchen/driver/vagrant_version"

module Kitchen
  module Driver
    class Vagrant < Kitchen::Driver::Base

      plugin_version Kitchen::Driver::VAGRANT_VERSION

    end
  end
end

Parameters:

  • version (String)

    a version string


424
425
426
# File 'lib/kitchen/configurable.rb', line 424

def plugin_version(version) # rubocop:disable Style/TrivialAccessors
  @plugin_version = version
end

#required_config(attr) {|attr, value, object| ... } ⇒ Object

Ensures that an attribute must have a non-nil, non-empty String value. The default behavior will be to raise a user error and thereby halting further configuration processing. Good use cases for require_config might be cloud provider credential keys and other similar data.

Examples:

a value that must not be nil or an empty String


required_config :cloud_api_token

using a block to use custom validation logic


required_config :email do |attr, value, subject|
  raise UserError, "Must be an email address" unless value =~ /@/
end

Parameters:

  • attr (String)

    configuration attribute name

Yield Parameters:

  • attr (Symbol)

    the attribute name

  • value (Object)

    the current value of the attribute

  • object (Object)

    a reference to the instantiated object


535
536
537
538
539
540
541
542
543
544
545
546
# File 'lib/kitchen/configurable.rb', line 535

def required_config(attr, &block)
  unless block_given?
    klass = self
    block = lambda do |_, value, thing|
      if value.nil? || value.to_s.empty?
        attribute = "#{klass}#{thing.instance.to_str}#config[:#{attr}]"
        raise UserError, "#{attribute} cannot be blank"
      end
    end
  end
  validations[attr] = block
end

#super_defaultsHash

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.

Returns a hash of defaults from the included class' superclass if defined in the superclass, or an empty hash otherwise.

Returns:

  • (Hash)

    a hash of defaults from the included class' superclass if defined in the superclass, or an empty hash otherwise


558
559
560
561
562
563
564
# File 'lib/kitchen/configurable.rb', line 558

def super_defaults
  if superclass.respond_to?(:defaults)
    superclass.defaults
  else
    {}
  end
end

#super_deprecated_attributesObject


589
590
591
592
593
594
595
# File 'lib/kitchen/configurable.rb', line 589

def super_deprecated_attributes
  if superclass.respond_to?(:deprecated_attributes)
    superclass.deprecated_attributes
  else
    {}
  end
end

#super_expanded_pathsHash

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.

Returns a hash of expanded paths from the included class' superclass if defined in the superclass, or an empty hash otherwise.

Returns:

  • (Hash)

    a hash of expanded paths from the included class' superclass if defined in the superclass, or an empty hash otherwise


577
578
579
580
581
582
583
# File 'lib/kitchen/configurable.rb', line 577

def super_expanded_paths
  if superclass.respond_to?(:expanded_paths)
    superclass.expanded_paths
  else
    {}
  end
end

#super_validationsHash

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.

Returns a hash of validations from the included class' superclass if defined in the superclass, or an empty hash otherwise.

Returns:

  • (Hash)

    a hash of validations from the included class' superclass if defined in the superclass, or an empty hash otherwise


607
608
609
610
611
612
613
# File 'lib/kitchen/configurable.rb', line 607

def super_validations
  if superclass.respond_to?(:validations)
    superclass.validations
  else
    {}
  end
end

#validationsHash

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.

Returns a hash of attribute keys and valudation callable blocks which has been merged with any superclass valudations.

Returns:

  • (Hash)

    a hash of attribute keys and valudation callable blocks which has been merged with any superclass valudations


600
601
602
# File 'lib/kitchen/configurable.rb', line 600

def validations
  @validations ||= {}.merge(super_validations)
end