Module: Kitchen::Terraform::ConfigAttribute::PluginDirectory

Extended by:
Kitchen::Terraform::ConfigAttributeCacher
Included in:
Driver::Terraform
Defined in:
lib/kitchen/terraform/config_attribute/plugin_directory.rb

Overview

This attribute contains the path to the directory which contains customized Terraform provider plugins to install in place of the official Terraform provider plugins.

Type

Scalar

Required

False

Default

There is no default value because any value will disable the normal Terraform plugin retrieval process.

Example

plugin_directory: /path/to/terraform/plugins

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Kitchen::Terraform::ConfigAttributeCacher

define_cache, extended

Class Method Details

.included(plugin_class) ⇒ void

This method returns an undefined value.

A callback to define the configuration attribute which is invoked when this module is included in a plugin class.

Parameters:

  • plugin_class (Kitchen::Configurable) —

    A plugin class.



41
42
43
44
45
46
 
# File 'lib/kitchen/terraform/config_attribute/plugin_directory.rb', line 41

def included(plugin_class)
  ::Kitchen::Terraform::FilePathConfigAttributeDefiner.new(
    attribute: self,
    schema: ::Kitchen::Terraform::ConfigAttributeContract::OptionalString.new,
  ).define plugin_class: plugin_class
end

.to_sym ⇒ Symbol

Returns the symbol corresponding to this attribute.

Returns:

  • (Symbol) —

    the symbol corresponding to this attribute.



49
50
51
 
# File 'lib/kitchen/terraform/config_attribute/plugin_directory.rb', line 49

def to_sym
  :plugin_directory
end

Instance Method Details

#config_plugin_directory_default_value ⇒ nil

Returns:

  • (nil) 


57
58
59
 
# File 'lib/kitchen/terraform/config_attribute/plugin_directory.rb', line 57

def config_plugin_directory_default_value
  nil
end