kitchen-vagrant 1.5.2 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d0dbeeece80627d7a63d112b4b4102ef9b1ef9386887f7b2ddabd0b3872a4c3
-  data.tar.gz: 44a5f9401545f08acc50d6b5e7e29fd1aeee5603e31400b2b63dc8c7d042e485
+  metadata.gz: 3c72511abbc2ebaecf070000334cfb6007e2ea9d4b7b37510dc37cb615ef6683
+  data.tar.gz: cc7d51dd336a7834f4a41cef38ac61a5ee032b04ede79ee0e5bd49c73152f4dd
 SHA512:
-  metadata.gz: 0d6ecfb995d271e318c217ee9294b57bb2d9578b228cd6593a3a8addff97756b98c68fdb9d1886bc3f87e3386fa69ab04f8d55a2ecb75d22bd365a6136754367
-  data.tar.gz: 0a7dfbdbbd941e9144476006117d3e0e8e291d4f5c0a7b77728e3d7ba5ad0e3d5242fa2486156fccc71d73a3955291db098b17dde8bd848a081442c2527326a7
+  metadata.gz: 412f726eac124fed8de34891cef4156d54de487db7a25464f6d6fe95f6076273333c5328bcfab8a1288e262a5bcdebffda329ebdb81ea1efdbebf1035ff22f76
+  data.tar.gz: 44f6fac1806fada336fb1cb6ceb2fd36bb416833ec59cc213076f89c2f24e4ed79c92b049275a9d91c11105a79195dba4fabb76005a2cd6bc42c7c1298082bf4

data/lib/kitchen/driver/helpers.rb

@@ -15,9 +15,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "mixlib/shellout"
-require "fileutils"
-require "json"
+require "mixlib/shellout" unless defined?(Mixlib::ShellOut)
+require "fileutils" unless defined?(FileUtils)
+require "json" unless defined?(JSON)
 
 module Kitchen
   module Driver
@@ -76,6 +76,7 @@ module Kitchen
         sh.run_command
         debug("Local Command END #{Util.duration(sh.execution_time)}")
         raise "Failed: #{sh.stderr}" if sh.error?
+
         stdout = sanitize_stdout(sh.stdout)
         JSON.parse(stdout) if stdout.length > 2
       end
@@ -91,12 +92,13 @@ module Kitchen
             default_switch_object["Name"].empty?
           raise "Failed to find a default VM Switch."
         end
+
         default_switch_object["Name"]
       end
 
       def hyperv_default_switch_ps
         <<-VMSWITCH
-          Get-DefaultVMSwitch #{ENV['KITCHEN_HYPERV_SWITCH']} | ConvertTo-Json
+          Get-DefaultVMSwitch #{ENV["KITCHEN_HYPERV_SWITCH"]} | ConvertTo-Json
         VMSWITCH
       end
 
@@ -104,6 +106,7 @@ module Kitchen
 
       def ruby_array_to_ps_array(list)
         return "@()" if list.nil? || list.empty?
+
         list.to_s.tr("[]", "()").prepend("@")
       end
     end

data/lib/kitchen/driver/vagrant.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,13 +15,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "erb"
-require "fileutils"
+require "erb" unless defined?(Erb)
+require "fileutils" unless defined?(FileUtils)
 require "rubygems/version"
 
 require "kitchen"
-require "kitchen/driver/vagrant_version"
-require "kitchen/driver/helpers"
+require_relative "vagrant_version"
+require_relative "helpers"
 
 module Kitchen
 
@@ -40,16 +39,20 @@ module Kitchen
 
       plugin_version Kitchen::Driver::VAGRANT_VERSION
 
-      default_config(:box) { |driver| driver.default_box }
+      default_config(:box, &:default_box)
       required_config :box
 
       default_config :box_check_update, nil
 
+      default_config :box_auto_update, nil
+
+      default_config :box_auto_prune, nil
+
       default_config :box_download_insecure, nil
 
       default_config :box_download_ca_cert, nil
 
-      default_config(:box_url) { |driver| driver.default_box_url }
+      default_config(:box_url, &:default_box_url)
 
       default_config :box_version, nil
 
@@ -109,6 +112,8 @@ module Kitchen
       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
@@ -149,7 +154,8 @@ module Kitchen
         if state[:hostname].nil?
           raise UserError, "Vagrant instance not created!"
         end
-        if not (config[:ssh] && config[:ssh][:insert_key] == false)
+
+        unless config[:ssh] && config[:ssh][:insert_key] == false
           m = "Disable vagrant ssh key replacement to preserve the default key!"
           warn(m)
         end
@@ -171,6 +177,8 @@ module Kitchen
       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!
@@ -246,8 +254,9 @@ module Kitchen
       #   shared folders
       # @api private
       def safe_share?(box)
-        return false if config[:provider] =~ /(hyperv|libvirt)/
-        box =~ /^bento\/(centos|debian|fedora|opensuse|ubuntu|oracle|amazonlinux)-/
+        return false if /(hyperv|libvirt)/.match?(config[:provider])
+
+        box =~ %r{^bento/(centos|debian|fedora|opensuse|ubuntu|oracle|amazonlinux)-}
       end
 
       # Return true if we found the criteria to enable the cache_directory
@@ -255,6 +264,7 @@ module Kitchen
       def enable_cache?
         return false unless config[:cache_directory]
         return true if safe_share?(config[:box])
+
         # Otherwise
         false
       end
@@ -291,10 +301,25 @@ module Kitchen
       def finalize_ca_cert!
         unless config[:box_download_ca_cert].nil?
           config[:box_download_ca_cert] = File.expand_path(
-            config[:box_download_ca_cert], config[:kitchen_root])
+            config[:box_download_ca_cert], config[:kitchen_root]
+          )
         end
       end
 
+      # Create vagrant command to update box to the latest version
+      def finalize_box_auto_update!
+        return if config[:box_auto_update].nil?
+
+        config[:box_auto_update] = "vagrant box update #{"--insecure " if config[:box_download_insecure]}--box #{config[:box]}"
+      end
+
+      # Create vagrant command to remove older versions of the box
+      def finalize_box_auto_prune!
+        return if config[:box_auto_prune].nil?
+
+        config[:box_auto_prune] = "vagrant box prune --keep-active-boxes --name #{config[:box]}"
+      end
+
       # Replaces any `{{vagrant_root}}` tokens in the pre create command.
       #
       # @api private
@@ -344,8 +369,8 @@ module Kitchen
       def finalize_vm_hostname!
         string = config[:vm_hostname]
 
-        if windows_os? && string.is_a?(String) && string.size >= 12
-          config[:vm_hostname] = "#{string[0...10]}-#{string[-1]}"
+        if windows_os? && string.is_a?(String) && string.size > 15
+          config[:vm_hostname] = "#{string[0...12]}-#{string[-1]}"
         end
       end
 
@@ -382,10 +407,11 @@ module Kitchen
       # @api private
       def render_template
         template = File.expand_path(
-          config[:vagrantfile_erb], config[:kitchen_root])
+          config[:vagrantfile_erb], config[:kitchen_root]
+        )
 
         if File.exist?(template)
-          ERB.new(IO.read(template)).result(binding).gsub(%r{^\s*$\n}, "")
+          ERB.new(IO.read(template)).result(binding).gsub(/^\s*$\n/, "")
         else
           raise ActionFailed, "Could not find Vagrantfile template #{template}"
         end
@@ -432,8 +458,8 @@ module Kitchen
         env = merged[:environment]
         %w{BUNDLE_BIN_PATH BUNDLE_GEMFILE GEM_HOME GEM_PATH GEM_ROOT RUBYLIB
            RUBYOPT _ORIGINAL_GEM_PATH}.each do |var|
-          env[var] = nil
-        end
+             env[var] = nil
+           end
 
         # Altering the path seems to break vagrant. When the :environment
         # is passed to a windows process with a PATH, Vagrant's batch installer
@@ -456,6 +482,26 @@ module Kitchen
       end
       # rubocop:enable Metrics/CyclomaticComplexity
 
+      # Tell vagrant to update vagrant box to latest version
+      def run_box_auto_update
+        if config[:box_auto_update]
+          begin
+            run(config[:box_auto_update])
+          rescue Kitchen::ShellOut::ShellCommandFailed => e
+            # If the box has never been downloaded, the update command will fail with this message.
+            # Just ignore it and move on. Re-raise all other errors.
+            raise e unless e.message.match?(/The box '.*' does not exist/m)
+          end
+        end
+      end
+
+      # Tell vagrant to remove older vagrant boxes
+      def run_box_auto_prune
+        if config[:box_auto_prune]
+          run(config[:box_auto_prune])
+        end
+      end
+
       # Runs a local command before `vagrant up` has been called.
       #
       # @api private
@@ -529,9 +575,9 @@ module Kitchen
       def vagrant_config(type)
         lines = run_silently("#{config[:vagrant_binary]} #{type}-config")
           .split("\n").map do |line|
-          tokens = line.strip.partition(" ")
-          [tokens.first, tokens.last.delete('"')]
-        end
+            tokens = line.strip.partition(" ")
+            [tokens.first, tokens.last.delete('"')]
+          end
         Hash[lines]
       end
 
@@ -540,7 +586,8 @@ module Kitchen
       # @api private
       def vagrant_version
         self.class.vagrant_version ||= run_silently(
-          "#{config[:vagrant_binary]} --version", cwd: Dir.pwd)
+          "#{config[:vagrant_binary]} --version", cwd: Dir.pwd
+        )
           .chomp.split(" ").last
       rescue Errno::ENOENT
         raise UserError, "Vagrant #{MIN_VER} or higher is not installed." \
@@ -583,7 +630,8 @@ module Kitchen
         return true if self.class.winrm_plugin_passed
 
         self.class.winrm_plugin_passed = run_silently(
-          "#{config[:vagrant_binary]} plugin list", cwd: Dir.pwd)
+          "#{config[:vagrant_binary]} plugin list", cwd: Dir.pwd
+        )
           .split("\n").find { |line| line =~ /vagrant-winrm\s+/ }
       end
     end

data/lib/kitchen/driver/vagrant_version.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -21,6 +20,6 @@ module Kitchen
   module Driver
 
     # Version string for Vagrant Kitchen driver
-    VAGRANT_VERSION = "1.5.2".freeze
+    VAGRANT_VERSION = "1.7.2".freeze
   end
 end

data/templates/Vagrantfile.erb

@@ -108,7 +108,7 @@ Vagrant.configure("2") do |c|
     p.linked_clone = <%= config[:linked_clone] %>
 <%   end
    when "hyperv" %>
-    p.vmname = "kitchen-<%= File.basename(config[:kitchen_root]) %>-<%= instance.name %>-<%= SecureRandom.uuid %>"
+    p.vmname = "<%="kitchen-#{File.basename(config[:kitchen_root])}-#{instance.name}-#{SecureRandom.uuid}"[0..99].chomp('-') %>"
 <%   if config[:linked_clone] == true || config[:linked_clone] == false %>
     p.linked_clone = <%= config[:linked_clone] %>
 <%   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vagrant
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.7.2
 platform: ruby
 authors:
 - Fletcher Nichol
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-02 00:00:00.000000000 Z
+date: 2020-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -117,7 +117,7 @@ homepage: https://github.com/test-kitchen/kitchen-vagrant/
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,15 +125,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Kitchen::Driver::Vagrant - A Vagrant Driver for Test Kitchen.
 test_files: []