Class: Kitchen::Instance
- Inherits:
-
Object
- Object
- Kitchen::Instance
- Includes:
- Logging
- Defined in:
- lib/kitchen/instance.rb
Overview
An instance of a suite running on a platform. A created instance may be a local virtual machine, cloud instance, container, or even a bare metal server, which is determined by the platform’s driver.
Defined Under Namespace
Classes: FSM
Class Attribute Summary collapse
-
.mutexes ⇒ Hash
private
A hash of mutxes, arranged by Driver class names.
Instance Attribute Summary collapse
-
#driver ⇒ Driver::Base
Driver object which will manage this instance’s lifecycle actions.
-
#lifecycle_hooks ⇒ LifecycleHooks
Lifecycle hooks manager object.
-
#logger ⇒ Logger
readonly
The logger for this instance.
-
#name ⇒ String
readonly
Name of this instance.
-
#platform ⇒ Platform
readonly
The target platform configuration.
-
#provisioner ⇒ Provisioner::Base
Provisioner object which will the setup and invocation instructions for configuration management and other automation tools.
-
#suite ⇒ Suite
readonly
The test suite configuration.
-
#transport ⇒ Transport::Base
Transport object which will communicate with an instance.
-
#verifier ⇒ Verifier
Verifier object for instance to manage the verifier installation on this instance.
Class Method Summary collapse
-
.name_for(suite, platform) ⇒ String
Generates a name for an instance given a suite and platform.
Instance Method Summary collapse
-
#cleanup! ⇒ void
Clean up any per-instance resources before exiting.
-
#converge ⇒ self
Converges this running instance.
-
#create ⇒ self
Creates this instance.
-
#destroy ⇒ self
Destroys this instance.
-
#diagnose ⇒ Hash
Returns a Hash of configuration and other useful diagnostic information.
-
#diagnose_plugins ⇒ Hash
Returns a Hash of configuration and other useful diagnostic information associated with plugins (such as loaded version, class name, etc.).
-
#doctor_action ⇒ Object
Check system and configuration for common errors.
-
#initialize(options = {}) ⇒ Instance
constructor
Creates a new instance, given a suite and a platform.
-
#last_action ⇒ String
Returns the last successfully completed action state of the instance.
-
#last_error ⇒ String
Returns the error encountered on the last action on the instance.
-
#login ⇒ Object
Logs in to this instance by invoking a system command, provided by the instance’s transport.
-
#package_action ⇒ Object
Perform package.
-
#remote_exec(command) ⇒ Object
Executes an arbitrary command on this instance.
-
#setup ⇒ self
Sets up this converged instance for suite tests.
-
#test(destroy_mode = :passing) ⇒ self
Tests this instance by creating, converging and verifying.
-
#to_str ⇒ String
Returns a displayable representation of the instance.
-
#verify ⇒ self
Verifies this set up instance by executing suite tests.
Methods included from Logging
#debug, #error, #fatal, #info, #warn
Constructor Details
#initialize(options = {}) ⇒ Instance
Creates a new instance, given a suite and a platform.
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/kitchen/instance.rb', line 93 def initialize( = {}) () @suite = .fetch(:suite) @platform = .fetch(:platform) @name = self.class.name_for(@suite, @platform) @driver = .fetch(:driver) @lifecycle_hooks = .fetch(:lifecycle_hooks) @provisioner = .fetch(:provisioner) @transport = .fetch(:transport) @verifier = .fetch(:verifier) @logger = .fetch(:logger) { Kitchen.logger } @state_file = .fetch(:state_file) setup_driver setup_provisioner setup_transport setup_verifier setup_lifecycle_hooks end |
Class Attribute Details
.mutexes ⇒ 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 mutxes, arranged by Driver class names.
34 35 36 |
# File 'lib/kitchen/instance.rb', line 34 def mutexes @mutexes end |
Instance Attribute Details
#driver ⇒ Driver::Base
Returns driver object which will manage this instance’s lifecycle actions.
57 58 59 |
# File 'lib/kitchen/instance.rb', line 57 def driver @driver end |
#lifecycle_hooks ⇒ LifecycleHooks
Returns lifecycle hooks manager object.
60 61 62 |
# File 'lib/kitchen/instance.rb', line 60 def lifecycle_hooks @lifecycle_hooks end |
#logger ⇒ Logger (readonly)
Returns the logger for this instance.
76 77 78 |
# File 'lib/kitchen/instance.rb', line 76 def logger @logger end |
#name ⇒ String (readonly)
Returns name of this instance.
53 54 55 |
# File 'lib/kitchen/instance.rb', line 53 def name @name end |
#platform ⇒ Platform (readonly)
Returns the target platform configuration.
50 51 52 |
# File 'lib/kitchen/instance.rb', line 50 def platform @platform end |
#provisioner ⇒ Provisioner::Base
Returns provisioner object which will the setup and invocation instructions for configuration management and other automation tools.
65 66 67 |
# File 'lib/kitchen/instance.rb', line 65 def provisioner @provisioner end |
#suite ⇒ Suite (readonly)
Returns the test suite configuration.
47 48 49 |
# File 'lib/kitchen/instance.rb', line 47 def suite @suite end |
#transport ⇒ Transport::Base
Returns transport object which will communicate with an instance.
69 70 71 |
# File 'lib/kitchen/instance.rb', line 69 def transport @transport end |
#verifier ⇒ Verifier
Returns verifier object for instance to manage the verifier installation on this instance.
73 74 75 |
# File 'lib/kitchen/instance.rb', line 73 def verifier @verifier end |
Class Method Details
.name_for(suite, platform) ⇒ String
Generates a name for an instance given a suite and platform.
41 42 43 |
# File 'lib/kitchen/instance.rb', line 41 def name_for(suite, platform) "#{suite.name}-#{platform.name}".gsub(%r{[_,/]}, "-").delete(".") end |
Instance Method Details
#cleanup! ⇒ void
This method returns an undefined value.
Clean up any per-instance resources before exiting.
298 299 300 |
# File 'lib/kitchen/instance.rb', line 298 def cleanup! @transport.cleanup! if @transport end |
#converge ⇒ self
rescue Driver::ActionFailed and return some kind of null object to gracfully stop action chaining
Converges this running instance.
139 140 141 |
# File 'lib/kitchen/instance.rb', line 139 def converge transition_to(:converge) end |
#create ⇒ self
rescue Driver::ActionFailed and return some kind of null object to gracfully stop action chaining
Creates this instance.
128 129 130 |
# File 'lib/kitchen/instance.rb', line 128 def create transition_to(:create) end |
#destroy ⇒ self
rescue Driver::ActionFailed and return some kind of null object to gracfully stop action chaining
Destroys this instance.
172 173 174 |
# File 'lib/kitchen/instance.rb', line 172 def destroy transition_to(:destroy) end |
#diagnose ⇒ Hash
Returns a Hash of configuration and other useful diagnostic information.
253 254 255 256 257 258 259 260 261 262 |
# File 'lib/kitchen/instance.rb', line 253 def diagnose result = {} [ :platform, :state_file, :driver, :provisioner, :transport, :verifier ].each do |sym| obj = send(sym) result[sym] = obj.respond_to?(:diagnose) ? obj.diagnose : :unknown end result end |
#diagnose_plugins ⇒ Hash
Returns a Hash of configuration and other useful diagnostic information associated with plugins (such as loaded version, class name, etc.).
268 269 270 271 272 273 274 275 276 277 278 279 |
# File 'lib/kitchen/instance.rb', line 268 def diagnose_plugins result = {} [:driver, :provisioner, :verifier, :transport].each do |sym| obj = send(sym) result[sym] = if obj.respond_to?(:diagnose_plugin) obj.diagnose_plugin else :unknown end end result end |
#doctor_action ⇒ Object
Check system and configuration for common errors.
243 244 245 246 247 248 |
# File 'lib/kitchen/instance.rb', line 243 def doctor_action "The doctor is in" [driver, provisioner, transport, verifier].any? do |obj| obj.doctor(state_file.read) end end |
#last_action ⇒ String
Returns the last successfully completed action state of the instance.
284 285 286 |
# File 'lib/kitchen/instance.rb', line 284 def last_action state_file.read[:last_action] end |
#last_error ⇒ String
Returns the error encountered on the last action on the instance
291 292 293 |
# File 'lib/kitchen/instance.rb', line 291 def last_error state_file.read[:last_error] end |
#login ⇒ Object
Logs in to this instance by invoking a system command, provided by the instance’s transport. This could be an SSH command, telnet, or serial console session.
Note This method calls exec and will not return.
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/kitchen/instance.rb', line 208 def login state = state_file.read if state[:last_action].nil? raise UserError, "Instance #{to_str} has not yet been created" end lc = if legacy_ssh_base_driver? legacy_ssh_base_login(state) else transport.connection(state).login_command end debug(%{Login command: #{lc.command} #{lc.arguments.join(' ')} } \ "(Options: #{lc.})") Kernel.exec(*lc.exec_args) end |
#package_action ⇒ Object
Perform package.
236 237 238 239 |
# File 'lib/kitchen/instance.rb', line 236 def package_action "Packaging remote instance" driver.package(state_file.read) end |
#remote_exec(command) ⇒ Object
Executes an arbitrary command on this instance.
228 229 230 231 232 |
# File 'lib/kitchen/instance.rb', line 228 def remote_exec(command) transport.connection(state_file.read) do |conn| conn.execute(command) end end |
#setup ⇒ self
rescue Driver::ActionFailed and return some kind of null object to gracfully stop action chaining
Sets up this converged instance for suite tests.
150 151 152 |
# File 'lib/kitchen/instance.rb', line 150 def setup transition_to(:setup) end |
#test(destroy_mode = :passing) ⇒ self
rescue Driver::ActionFailed and return some kind of null object to gracfully stop action chaining
Tests this instance by creating, converging and verifying. If this instance is running, it will be pre-emptively destroyed to ensure a clean slate. The instance will be left post-verify in a running state.
186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/kitchen/instance.rb', line 186 def test(destroy_mode = :passing) elapsed = Benchmark.measure do "Cleaning up any prior instances of #{to_str}" destroy "Testing #{to_str}" verify destroy if destroy_mode == :passing end info "Finished testing #{to_str} #{Util.duration(elapsed.real)}." self ensure destroy if destroy_mode == :always end |
#to_str ⇒ String
Returns a displayable representation of the instance.
117 118 119 |
# File 'lib/kitchen/instance.rb', line 117 def to_str "<#{name}>" end |
#verify ⇒ self
rescue Driver::ActionFailed and return some kind of null object to gracfully stop action chaining
Verifies this set up instance by executing suite tests.
161 162 163 |
# File 'lib/kitchen/instance.rb', line 161 def verify transition_to(:verify) end |