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



407
408
409
 
# File 'lib/kitchen/configurable.rb', line 407

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

#defaults ⇒ Hash

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



476
477
478
 
# File 'lib/kitchen/configurable.rb', line 476

def defaults
  @defaults ||= Hash.new.merge(super_defaults)
end

#diagnose ⇒ Hash

Returns a Hash of configuration and other useful diagnostic information.

Returns:

  • (Hash) —

    a diagnostic hash



377
378
379
380
381
382
383
 
# File 'lib/kitchen/configurable.rb', line 377

def diagnose
  {
    :class        => name,
    :version      => @plugin_version,
    :api_version  => @api_version
  }
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



437
438
439
 
# File 'lib/kitchen/configurable.rb', line 437

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

#expanded_paths ⇒ Hash

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



495
496
497
 
# File 'lib/kitchen/configurable.rb', line 495

def expanded_paths
  @expanded_paths ||= Hash.new.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



369
370
371
 
# File 'lib/kitchen/configurable.rb', line 369

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



460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/kitchen/configurable.rb', line 460

def required_config(attr, &block)
  if !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_defaults ⇒ Hash

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



483
484
485
486
487
488
489
 
# File 'lib/kitchen/configurable.rb', line 483

def super_defaults
  if superclass.respond_to?(:defaults)
    superclass.defaults
  else
    Hash.new
  end
end

#super_expanded_paths ⇒ Hash

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



502
503
504
505
506
507
508
 
# File 'lib/kitchen/configurable.rb', line 502

def super_expanded_paths
  if superclass.respond_to?(:expanded_paths)
    superclass.expanded_paths
  else
    Hash.new
  end
end

#super_validations ⇒ Hash

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



520
521
522
523
524
525
526
 
# File 'lib/kitchen/configurable.rb', line 520

def super_validations
  if superclass.respond_to?(:validations)
    superclass.validations
  else
    Hash.new
  end
end

#validations ⇒ Hash

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



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

def validations
  @validations ||= Hash.new.merge(super_validations)
end