Class: Kitchen::Driver::Vagrant
- Inherits:
-
Base
- Object
- Base
- Kitchen::Driver::Vagrant
- Includes:
- HypervHelpers, ShellOut
- Defined in:
- lib/kitchen/driver/vagrant.rb
Overview
Vagrant driver for Kitchen. It communicates to Vagrant via the CLI.
Class Attribute Summary collapse
-
.vagrant_version ⇒ String
private
The version of Vagrant installed on the workstation.
-
.winrm_plugin_passed ⇒ true, false
private
Whether or not the vagrant-winrm plugin is installed.
Instance Method Summary collapse
-
#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.
-
#create(state) ⇒ Object
Creates a Vagrant VM instance.
-
#default_box ⇒ String?
The Vagrant box for this Instance.
-
#default_box_url ⇒ String?
The Vagrant box URL for this Instance.
-
#destroy(state) ⇒ Object
Destroys an instance.
-
#finalize_config!(instance) ⇒ self
A lifecycle method that should be invoked when the object is about ready to be used.
- #package(state) ⇒ Object
-
#verify_dependencies ⇒ Object
Performs whatever tests that may be required to ensure that this driver will be able to function in the current environment.
-
#winrm_transport? ⇒ TrueClass, FalseClass
private
Whether or not the transport’s name implies a WinRM-based transport.
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.
238 239 240 |
# File 'lib/kitchen/driver/vagrant.rb', line 238 def vagrant_version @vagrant_version end |
.winrm_plugin_passed ⇒ true, false
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 vagrant-winrm plugin is installed.
234 235 236 |
# File 'lib/kitchen/driver/vagrant.rb', line 234 def winrm_plugin_passed @winrm_plugin_passed 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
216 217 218 219 220 221 222 |
# File 'lib/kitchen/driver/vagrant.rb', line 216 def cache_directory if enable_cache? config[:cache_directory] else false end end |
#create(state) ⇒ Object
Creates a Vagrant VM instance.
113 114 115 116 117 118 119 120 121 122 |
# File 'lib/kitchen/driver/vagrant.rb', line 113 def create(state) create_vagrantfile run_pre_create_command 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.
125 126 127 128 129 130 131 |
# File 'lib/kitchen/driver/vagrant.rb', line 125 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.
134 135 136 |
# File 'lib/kitchen/driver/vagrant.rb', line 134 def default_box_url nil end |
#destroy(state) ⇒ Object
Destroys an instance.
142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/kitchen/driver/vagrant.rb', line 142 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.
178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/kitchen/driver/vagrant.rb', line 178 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
154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/kitchen/driver/vagrant.rb', line 154 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.
197 198 199 200 201 202 203 204 |
# File 'lib/kitchen/driver/vagrant.rb', line 197 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.
209 210 211 |
# File 'lib/kitchen/driver/vagrant.rb', line 209 def winrm_transport? instance.transport.name.downcase =~ /win_?rm/ end |