Class: Kitchen::Driver::Vagrant

Inherits:
Base
  • Object
show all
Includes:
HypervHelpers, ShellOut
Defined in:
lib/kitchen/driver/vagrant.rb

Overview

Vagrant driver for Kitchen. It communicates to Vagrant via the CLI.

Author:

Class Attribute Summary collapse

Instance Method Summary collapse

Methods included from HypervHelpers

#encode_command, #execute_command, #hyperv_default_switch_ps, #hyperv_switch, #is_32bit?, #is_64bit?, #powershell_64_bit, #run_ps, #sanitize_stdout, #wrap_command

Class Attribute Details

.vagrant_version ⇒ String

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 the version of Vagrant installed on the workstation.

Returns:

  • (String) —

    the version of Vagrant installed on the workstation



236
237
238
 
# File 'lib/kitchen/driver/vagrant.rb', line 236

def vagrant_version
  @vagrant_version
end

Instance Method Details

#cache_directory ⇒ Object

Setting up the ‘cache_directory` to store omnibus packages in cache and share a local folder to that directory so that we don’t pull them down every single time



220
221
222
223
224
225
226
 
# File 'lib/kitchen/driver/vagrant.rb', line 220

def cache_directory
  if enable_cache?
    config[:cache_directory]
  else
    false
  end
end

#create(state) ⇒ Object

Creates a Vagrant VM instance.

Parameters:

  • state (Hash) —

    mutable instance state

Raises:

  • (ActionFailed) —

    if the action could not be completed



116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/kitchen/driver/vagrant.rb', line 116

def create(state)
  create_vagrantfile
  run_pre_create_command
  check_box_outdated
  run_box_auto_update
  run_box_auto_prune
  run_vagrant_up
  update_state(state)
  instance.transport.connection(state).wait_until_ready
  info("Vagrant instance #{instance.to_str} created.")
end

#default_box ⇒ String?

Returns the Vagrant box for this Instance.

Returns:

  • (String, nil) —

    the Vagrant box for this Instance



129
130
131
132
133
134
135
 
# File 'lib/kitchen/driver/vagrant.rb', line 129

def default_box
  if bento_box?(instance.platform.name)
    "bento/#{instance.platform.name}"
  else
    instance.platform.name
  end
end

#default_box_url ⇒ String?

Returns the Vagrant box URL for this Instance.

Returns:

  • (String, nil) —

    the Vagrant box URL for this Instance



138
139
140
 
# File 'lib/kitchen/driver/vagrant.rb', line 138

def default_box_url
  nil
end

#destroy(state) ⇒ Object

Destroys an instance.

Parameters:

  • state (Hash) —

    mutable instance state

Raises:

  • (ActionFailed) —

    if the action could not be completed



146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/kitchen/driver/vagrant.rb', line 146

def destroy(state)
  return if state[:hostname].nil?

  create_vagrantfile
  @vagrantfile_created = false
  instance.transport.connection(state).close
  run("#{config[:vagrant_binary]} destroy -f")
  FileUtils.rm_rf(vagrant_root)
  info("Vagrant instance #{instance.to_str} destroyed.")
  state.delete(:hostname)
end

#finalize_config!(instance) ⇒ self

A lifecycle method that should be invoked when the object is about ready to be used. A reference to an Instance is required as configuration dependant data may be access through an Instance. This also acts as a hook point where the object may wish to perform other last minute checks, validations, or configuration expansions.

Parameters:

  • instance (Instance) —

    an associated instance

Returns:

  • (self) —

    itself, for use in chaining

Raises:

  • (ClientError) —

    if instance parameter is nil



182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/kitchen/driver/vagrant.rb', line 182

def finalize_config!(instance)
  super
  finalize_vm_hostname!
  finalize_box_auto_update!
  finalize_box_auto_prune!
  finalize_pre_create_command!
  finalize_synced_folders!
  finalize_ca_cert!
  finalize_network!
  self
end

#package(state) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/kitchen/driver/vagrant.rb', line 158

def package(state)
  if state[:hostname].nil?
    raise UserError, "Vagrant instance not created!"
  end

  unless config[:ssh] && config[:ssh][:insert_key] == false
    m = "Disable vagrant ssh key replacement to preserve the default key!"
    warn(m)
  end
  instance.transport.connection(state).close
  box_name = File.join(Dir.pwd, instance.name + ".box")
  run("#{config[:vagrant_binary]} package --output #{box_name}")
  destroy(state)
end

#verify_dependencies ⇒ Object

Performs whatever tests that may be required to ensure that this driver will be able to function in the current environment. This may involve checking for the presence of certain directories, software installed, etc.

Raises:

  • (UserError) —

    if the driver will not be able to perform or if a documented dependency is missing from the system



201
202
203
204
205
206
207
208
 
# File 'lib/kitchen/driver/vagrant.rb', line 201

def verify_dependencies
  super
  if Gem::Version.new(vagrant_version) < Gem::Version.new(MIN_VER.dup)
    raise UserError, "Detected an old version of Vagrant " \
      "(#{vagrant_version})." \
      " Please upgrade to version #{MIN_VER} or higher from #{WEBSITE}."
  end
end

#winrm_transport? ⇒ TrueClass, FalseClass

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 whether or not the transport’s name implies a WinRM-based transport.

Returns:

  • (TrueClass, FalseClass) —

    whether or not the transport’s name implies a WinRM-based transport



213
214
215
 
# File 'lib/kitchen/driver/vagrant.rb', line 213

def winrm_transport?
  instance.transport.name.downcase =~ /win_?rm/
end