Class: Kitchen::Provisioner::ChefBase

Inherits:
Base
  • Object
show all
Defined in:
lib/kitchen/provisioner/chef_base.rb

Overview

Common implementation details for Chef-related provisioners.

Author:

Direct Known Subclasses

ChefApply, ChefSolo, ChefZero

Instance Attribute Summary

Attributes included from Configurable

#instance

Instance Method Summary collapse

Methods inherited from Base

#call, #cleanup_sandbox, kitchen_provisioner_api_version, #prepare_command, #run_command, #sandbox_path

Methods included from Logging

#banner, #debug, #error, #fatal, #info, #warn

Methods included from Configurable

#[], #bourne_shell?, #calculate_path, #config_keys, #diagnose, #diagnose_plugin, #finalize_config!, included, #name, #powershell_shell?, #remote_path_join, #unix_os?, #verify_dependencies, #windows_os?

Constructor Details

#initialize(config = {}) ⇒ ChefBase

Reads the local Chef::Config object (if present). We do this because we want to start bring Chef config and ChefDK tool config closer together. For example, we want to configure proxy settings in 1 location instead of 3 configuration files.

Parameters:

  • config (Hash) (defaults to: {}) —

    initial provided configuration



107
108
109
110
111
112
113
114
115
116
 
# File 'lib/kitchen/provisioner/chef_base.rb', line 107

def initialize(config = {})
  super(config)

  if defined?(ChefConfig::WorkstationConfigLoader)
    ChefConfig::WorkstationConfigLoader.new(config[:config_path]).load
  end
  # This exports any proxy config present in the Chef config to
  # appropriate environment variables, which Test Kitchen respects
  ChefConfig::Config.export_proxies if defined?(ChefConfig::Config.export_proxies)
end

Instance Method Details

#create_sandbox ⇒ Object

Creates a temporary directory on the local workstation into which provisioner related files and directories can be copied or created. The contents of this directory will be copied over to the instance before invoking the provisioner's run command. After this method completes, it is expected that the contents of the sandbox is complete and ready for copy to the remote instance.

Note: any subclasses would be well advised to call super first when overriding this method, for example:

Examples:

overriding #create_sandbox


class MyProvisioner < Kitchen::Provisioner::Base
  def create_sandbox
    super
    # any further file copies, preparations, etc.
  end
end



119
120
121
122
123
 
# File 'lib/kitchen/provisioner/chef_base.rb', line 119

def create_sandbox
  super
  sanity_check_sandbox_options!
  Chef::CommonSandbox.new(config, sandbox_path, instance).populate
end

#init_command ⇒ String

Generates a command string which will perform any data initialization or configuration required after the provisioner software is installed but before the sandbox has been transferred to the instance. If no work is required, then nil will be returned.

Returns:

  • (String) —

    a command string



126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/kitchen/provisioner/chef_base.rb', line 126

def init_command
  dirs = %w[
    cookbooks data data_bags environments roles clients
    encrypted_data_bag_secret
  ].sort.map { |dir| remote_path_join(config[:root_path], dir) }

  vars = if powershell_shell?
    init_command_vars_for_powershell(dirs)
  else
    init_command_vars_for_bourne(dirs)
  end

  prefix_command(shell_code_from_file(vars, "chef_base_init_command"))
end

#install_command ⇒ String

Generates a command string which will install and configure the provisioner software on an instance. If no work is required, then nil will be returned.

Returns:

  • (String) —

    a command string



142
143
144
145
 
# File 'lib/kitchen/provisioner/chef_base.rb', line 142

def install_command
  return unless config[:require_chef_omnibus] || config[:product_name]
  prefix_command(sudo(install_script_contents))
end