Class: Kitchen::Provisioner::Base
- Inherits:
-
Object
- Object
- Kitchen::Provisioner::Base
- Includes:
- Configurable, Logging
- Defined in:
- lib/kitchen/provisioner/base.rb
Overview
Base class for a provisioner.
Instance Attribute Summary
Attributes included from Configurable
Class Method Summary collapse
-
.kitchen_provisioner_api_version(version) ⇒ Object
Sets the API version for this provisioner.
Instance Method Summary collapse
-
#call(state) ⇒ Object
Runs the provisioner on the instance.
-
#check_license ⇒ Object
Certain products that Test Kitchen uses to provision require accepting a license to use.
-
#cleanup_sandbox ⇒ Object
Deletes the sandbox path.
-
#create_sandbox ⇒ Object
Creates a temporary directory on the local workstation into which provisioner related files and directories can be copied or created.
-
#doctor(state) ⇒ Object
Check system and configuration for common errors.
-
#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.
-
#initialize(config = {}) ⇒ Base
constructor
Constructs a new provisioner by providing a configuration hash.
-
#install_command ⇒ String
Generates a command string which will install and configure the provisioner software on an instance.
-
#prepare_command ⇒ String
Generates a command string which will perform any commands or configuration required just before the main provisioner run command but after the sandbox has been transferred to the instance.
-
#run_command ⇒ String
Generates a command string which will invoke the main provisioner command on the prepared instance.
-
#sandbox_path ⇒ String
Returns the absolute path to the sandbox directory or raises an exception if ‘#create_sandbox` has not yet been called.
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 = {}) ⇒ Base
Constructs a new provisioner by providing a configuration hash.
61 62 63 |
# File 'lib/kitchen/provisioner/base.rb', line 61 def initialize(config = {}) init_config(config) end |
Class Method Details
.kitchen_provisioner_api_version(version) ⇒ Object
Sets the API version for this provisioner. If the provisioner does not set this value, then ‘nil` will be used and reported.
Sets the API version for this provisioner
216 217 218 |
# File 'lib/kitchen/provisioner/base.rb', line 216 def self.kitchen_provisioner_api_version(version) @api_version = version end |
Instance Method Details
#call(state) ⇒ Object
Runs the provisioner on the instance.
rubocop:disable Metrics/AbcSize
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/kitchen/provisioner/base.rb', line 70 def call(state) create_sandbox sandbox_dirs = Util.list_directory(sandbox_path) instance.transport.connection(state) do |conn| conn.execute(install_command) conn.execute(init_command) info("Transferring files to #{instance.to_str}") conn.upload(sandbox_dirs, config[:root_path]) debug("Transfer complete") conn.execute(prepare_command) conn.execute_with_retry( run_command, config[:retry_on_exit_code], config[:max_retries], config[:wait_for_retry] ) info("Downloading files from #{instance.to_str}") config[:downloads].to_h.each do |remotes, local| debug("Downloading #{Array(remotes).join(', ')} to #{local}") conn.download(remotes, local) end debug("Download complete") end rescue Kitchen::Transport::TransportFailed => ex raise ActionFailed, ex. ensure cleanup_sandbox end |
#check_license ⇒ Object
Certain products that Test Kitchen uses to provision require accepting a license to use. Overwrite this method in the specific provisioner to implement this check.
111 112 |
# File 'lib/kitchen/provisioner/base.rb', line 111 def check_license end |
#cleanup_sandbox ⇒ Object
Deletes the sandbox path. Without calling this method, the sandbox path will persist after the process terminates. In other words, cleanup is explicit. This method is safe to call multiple times.
190 191 192 193 194 195 |
# File 'lib/kitchen/provisioner/base.rb', line 190 def cleanup_sandbox return if sandbox_path.nil? debug("Cleaning up local sandbox in #{sandbox_path}") FileUtils.rmtree(sandbox_path) end |
#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:
166 167 168 169 170 171 |
# File 'lib/kitchen/provisioner/base.rb', line 166 def create_sandbox @sandbox_path = Dir.mktmpdir("#{instance.name}-sandbox-") File.chmod(0755, sandbox_path) info("Preparing files for transfer") debug("Creating local sandbox in #{sandbox_path}") end |
#doctor(state) ⇒ Object
Check system and configuration for common errors.
104 105 106 |
# File 'lib/kitchen/provisioner/base.rb', line 104 def doctor(state) false 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.
128 129 |
# File 'lib/kitchen/provisioner/base.rb', line 128 def 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.
119 120 |
# File 'lib/kitchen/provisioner/base.rb', line 119 def install_command end |
#prepare_command ⇒ String
Generates a command string which will perform any commands or configuration required just before the main provisioner run command but after the sandbox has been transferred to the instance. If no work is required, then ‘nil` will be returned.
137 138 |
# File 'lib/kitchen/provisioner/base.rb', line 137 def prepare_command end |
#run_command ⇒ String
Generates a command string which will invoke the main provisioner command on the prepared instance. If no work is required, then ‘nil` will be returned.
145 146 |
# File 'lib/kitchen/provisioner/base.rb', line 145 def run_command end |
#sandbox_path ⇒ String
Returns the absolute path to the sandbox directory or raises an exception if ‘#create_sandbox` has not yet been called.
179 180 181 182 183 184 185 |
# File 'lib/kitchen/provisioner/base.rb', line 179 def sandbox_path @sandbox_path ||= begin raise ClientError, "Sandbox directory has not yet " \ "been created. Please run #{self.class}#create_sandox before " \ "trying to access the path." end end |