vagrant-vbguest 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44a151b1f54cf71bf74136930643a59a6d1be529273fa43186dfccaf4cb39e4a
-  data.tar.gz: 6daf1818af365093140ab387a37ec760b328c5ff8bcf4e74bf076a204507de23
+  metadata.gz: fe9b19c92b1f9e06b0e17defbb0b412cfec21fd0b2bb75c9508f2901e70a972f
+  data.tar.gz: 8e856da6367fcd028b1a98e21a17daf32a7090d627d2d55893b7b17ea6f8b330
 SHA512:
-  metadata.gz: 04ae3fb888ff4e75728e56e76cfd2f413fce56728823d75992639cff74bfa57bafe95b7af95573ea0712556233dea6c159c266eaa67a2a5f24ad6138710b43de
-  data.tar.gz: 1917aca9323da9545380f5eb8be9276a9617072e17162932783cca7a987a64883931c4a78c44dc94dd9b129da3c29840492a2e525e267bbd7de07db05b46db9f
+  metadata.gz: 1189d19dda9bdb84b82c4fdec404bbc1192429ee7d9ba985a0a63f394099f717ee23bd78a950c62de9bdc5657eb03bf33a05dbc642f122ddaa8b0f867ac200f0
+  data.tar.gz: dd9fce0ae08011b8c58a8588bf4e4fce03e5d0fefc6ad59b591436ac50772fcc76ba9969e380862ab6eec63659e98494433ac3636c7720975be73a48fdad8584

data/CHANGELOG.md

@@ -1,6 +1,12 @@
+## 0.20.0 (2019-09-27)
+
+- Add Windows support. @thumperward [GH-343]
+- Add `allow_downgrade` config. Set it to `false` to prevent downgrades. [GH-310]
+- the gem version is now hold in a plain text file `VERSION` (additionally to the ruby constant `VagrantVbguest::VERSION`)
+
 ## 0.19.0 (2019-07-09)
 
-- Relax verion pin on micormachine dependency. Allow 2.x to 3.x. @johanneskastl [GH-341]
+- Relax version pin on micromachine dependency. Allow 2.x to 3.x. @johanneskastl [GH-341]
 
 ## 0.18.0 (2019-05-20)
 

data/Gemfile

@@ -6,9 +6,6 @@ group :development do
   # Vagrant environment itself using `vagrant plugin`.
   gem "vagrant", :git => "https://github.com/hashicorp/vagrant.git"
   gem "rake", "~> 10.0"
-
-  gem "ed25519"
-  gem "bcrypt_pbkdf"
 end
 
 group :plugins do

data/Readme.md

@@ -53,6 +53,7 @@ vbguest will try to autodetect the best option for your system. WTF? see below.
 * `iso_mount_point` (String, default: `/mnt`): Where to mount the VBoxGuestAdditions.iso file on the guest system.
 * `auto_update` (Boolean, default: `true`) : Whether to check the correct additions version on each start (where start is _not_ resuming a box).
 * `auto_reboot` (Boolean, default: `true` when running as a middleware, `false` when running as a command) : Whether to reboot the box after GuestAdditions has been installed, but not loaded.
+* `allow_downgrade` (Boolean, default: `true`) : Allow to install an older version of Guest Additions onto the guest. (Eg. your are running a host with VirtualBox 5 and the box is already on 6).
 * `no_install` (Boolean, default: `false`) : Whether to check the correct additions version only. This will warn you about version mis-matches, but will not try to install anything.
 * `no_remote` (Boolean, default: `false`) : Whether to _not_ download the iso file from a remote location. This includes any `http` location!
 * `installer` (`VagrantVbguest::Installers::Base`, optional) : Reference to a (custom) installer class
@@ -259,6 +260,14 @@ If you find yourself copying the same installer in each of your vagrant project,
 
 This project contains a [sample installer gem](https://github.com/dotless-de/vagrant-vbguest/tree/master/testdrive/vagrant-vbguest-unikorn) which might serve as an boilerplate. 
 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dotless-de/vagrant-vbguest.
+
+For the forseeable future, no more pull requests will be accepted which add new guest support/installers. Please build your gem as a plugin to vbguest (see "Very Advanced Usage" section of this file). In fact, please open a pull request to remove support for a guest system if feel confident that your sulution is any better.
+
+
 ## Known Issues
 
 * The installer script, which mounts and runs the GuestAdditions Installer Binary, works on Linux only. Most likely it will run on most Unix-like platforms.
@@ -266,3 +275,5 @@ This project contains a [sample installer gem](https://github.com/dotless-de/vag
 * The installer script requires a valid mount point on the guest system. This defaults to `/mnt` but can be overwritten with the `iso_mount_point` option.
 * On multi vm boxes, the iso file will be downloaded for each vm.
 * The plugin installation on Windows host systems may not work as expected (using `vagrant gem install vagrant-vbguest`). Try `C:\vagrant\vagrant\embedded\bin\gem.bat install vagrant-vbguest` instead. (See [issue #19](https://github.com/dotless-de/vagrant-vbguest/issues/19#issuecomment-7040304))
+* The Windows guest additions installer will only properly install virtual drivers (enabling e.g. seamless resizing) if a user is logged in during the install. Automatic login is recommended for Windows Vagrant boxes.
+* Uploading GuestAdditions into a Windows guest might take longer than expected.

data/VERSION

@@ -0,0 +1 @@
+0.20.0

data/lib/vagrant-vbguest.rb

@@ -5,9 +5,10 @@ rescue LoadError
 end
 
 # Add our custom translations to the load path
-I18n.load_path << File.expand_path("../../locales/en.yml", __FILE__)
+I18n.load_path += Dir[File.expand_path("../../locales/*.yml", __FILE__)]
 I18n.reload!
 
+require "vagrant-vbguest/version"
 require "vagrant-vbguest/errors"
 require 'vagrant-vbguest/download'
 require 'vagrant-vbguest/command'
@@ -28,6 +29,7 @@ require 'vagrant-vbguest/installers/fedora'
 require 'vagrant-vbguest/installers/opensuse'
 require 'vagrant-vbguest/installers/suse'
 require 'vagrant-vbguest/installers/archlinux'
+require 'vagrant-vbguest/installers/windows'
 
 require 'vagrant-vbguest/middleware'
 

data/lib/vagrant-vbguest/config.rb

@@ -4,7 +4,7 @@ module VagrantVbguest
 
     module Attributes
       attr_accessor :auto_update, :auto_reboot, :no_install, :no_remote,
-                    :installer, :installer_arguments,
+                    :installer, :installer_arguments, :allow_downgrade,
                     :iso_path, :iso_upload_path, :iso_mount_point, :yes
     end
 
@@ -22,6 +22,8 @@ module VagrantVbguest
         return nil if !@iso_path || @iso_path == :auto
         @iso_path
       end
+
+      def allow_downgrade; @allow_downgrade.nil? ? false : @allow_downgrade end
     end
 
     include Attributes
@@ -38,6 +40,8 @@ module VagrantVbguest
       @iso_path
     end
 
+    def allow_downgrade; @allow_downgrade.nil? ? self.class.allow_downgrade : @allow_downgrade end
+
     # explicit hash, to get symbols in hash keys
     def to_hash
       {
@@ -50,7 +54,8 @@ module VagrantVbguest
         :auto_reboot => auto_reboot,
         :no_install => no_install,
         :no_remote => no_remote,
-        :yes => yes
+        :yes => yes,
+        :allow_downgrade => allow_downgrade
       }
     end
 

data/lib/vagrant-vbguest/installer.rb

@@ -94,7 +94,7 @@ module VagrantVbguest
     def host_version
       installer = guest_installer
       raise NoInstallerFoundError, :method => 'check host version of' if !installer
-      installer.host.version
+      installer.host_version
     end
 
     def running?
@@ -103,16 +103,32 @@ module VagrantVbguest
       installer.running?
     end
 
+    def reboot_after_install?
+      if (installer = guest_installer)
+        guest_installer.reboot_after_install?
+      end
+    end
+
     # Returns an installer instance for the current vm
     # This is either the one configured via `installer` option or
     # detected from all registered installers (see {Installer.detect})
     #
     # @return [Installers::Base]
     def guest_installer
-      @guest_installer ||= if @options[:installer].is_a? Class
-        @options[:installer].new(@vm, @options)
+      return @guest_installer if @guest_installer
+
+      if (klass = guest_installer_class)
+        @guest_installer = klass.new(@vm, @options)
+      end
+
+      @guest_installer
+    end
+
+    def guest_installer_class
+      if @options[:installer].is_a?(Class)
+        @options[:installer]
       else
-        installer_klass = Installer.detect(@vm, @options) and installer_klass.new(@vm, @options)
+        Installer.detect(@vm, @options)
       end
     end
 

data/lib/vagrant-vbguest/installers/base.rb

@@ -113,7 +113,7 @@ module VagrantVbguest
 
       # Determinates if the GuestAdditions kernel module is loaded.
       # This method tests if there is a working GuestAdditions
-      # kernel module. If there is none, {#rebuild} is beeing called.
+      # kernel module. If there is none, {#rebuild} is being called.
       # If there is no way of telling if there is a working
       # GuestAddition for a specific system, this method should
       # return `true`.
@@ -124,32 +124,43 @@ module VagrantVbguest
         true
       end
 
+      # This manipulate the run-list of a the vbguest machine.
+      def reboot_after_install?(opts=nil, &block)
+        false
+      end
+
       # Determinates the GuestAdditions version installed on the
       # guest system.
       #
       # @param reload [Boolean] Whether to read the value again or use
-      #                  the cached value form an erlier call.
-      # @return [String] The version code of the VirtualBox Guest Additions
+      #                  the cached value form an earlier call.
+      # @return [Gem::Version] The version code of the VirtualBox Guest Additions
       #                  available on the guest, or `nil` if none installed.
       def guest_version(reload=false)
         return @guest_version if @guest_version && !reload
 
-        guest_version = @host.read_guest_additions_version
-        guest_version = !guest_version ? nil : guest_version[/\d+\.\d+\.\d+/]
+        @guest_version = VagrantVbguest::Version(@host.read_guest_additions_version)
+      end
 
-        @guest_version = guest_version
+      # Determinates the host (eg VirtualBox) version
+      # @param reload [Boolean] Whether to read the value again or use
+      #                  the cached value form an earlier call.
+      # @return [Gem::Version] The version code of the host provider
+      def host_version(reload=false)
+        return @host_version if @host_version && !reload
+
+        @host_version = VagrantVbguest::Version(@host.version)
       end
 
 
       # Determinates the version of the GuestAdditions installer in use
       #
-      # @return [String] The version code of the GuestAdditions installer
+      # @return [Gem::Version] The version code of the GuestAdditions installer
       def installer_version(path_to_installer)
         version = nil
         communicate.sudo("#{path_to_installer} --info", :error_check => false) do |type, data|
-          if (v = data.to_s.match(/\AIdentification.*\s(\d+\.\d+.\d+)/i))
-            version = v[1]
-          end
+          v = VagrantVbguest::Version(data, /\AIdentification.*\s(\d+\.\d+.\d+)/i)
+          version = v if v
         end
         version
       end

data/lib/vagrant-vbguest/installers/centos.rb

@@ -39,8 +39,10 @@ module VagrantVbguest
       def release_version
         unless instance_variable_defined?(:@release_version)
           @release_version = nil
+          version_pattern = /(\d+\.\d+(\.\d+)?)/
           communicate.sudo('cat /etc/centos-release') do |type, data|
-            @release_version = data.to_s[/(\d+\.\d+(\.\d+)?)/, 1]
+            v = VagrantVbguest::Version(data, version_pattern)
+            @release_version = v if v
           end
         end
         @release_version

data/lib/vagrant-vbguest/installers/linux.rb

@@ -88,14 +88,14 @@ module VagrantVbguest
       # additions installed on the host may differ. If this happens, we
       # assume, that the host binaries are right and yield a warning message.
       #
-      # @return [String] The version code of the VirtualBox Guest Additions
-      #                  available on the guest, or `nil` if none installed.
+      # @return [Gem::Version] The version code of the VirtualBox Guest Additions
+      #   available on the guest, or `nil` if none installed.
       def guest_version(reload = false)
         return @guest_version if @guest_version && !reload
-        driver_version = super.to_s[/^(\d+\.\d+.\d+)/, 1]
+        driver_version = VagrantVbguest::Version(super)
 
         communicate.sudo('VBoxService --version', :error_check => false) do |type, data|
-          service_version = data.to_s[/^(\d+\.\d+.\d+)/, 1]
+          service_version = VagrantVbguest::Version(data)
           if service_version
             if driver_version != service_version
               @env.ui.warn(I18n.t("vagrant_vbguest.guest_version_reports_differ", :driver => driver_version, :service => service_version))
@@ -126,7 +126,7 @@ module VagrantVbguest
           communicate.sudo("#{find_tool('vboxadd')} start", opts, &block)
         end
 
-        if Gem::Version.new("#{guest_version}") >= Gem::Version.new('5.1')
+        if guest_version && guest_version >= Gem::Version.new('5.1')
           if systemd_tool
             communicate.sudo("#{systemd_tool[:path]} vboxadd-service #{systemd_tool[:up]}", opts, &block)
           else

data/lib/vagrant-vbguest/installers/windows.rb

@@ -0,0 +1,125 @@
+require "vagrant-vbguest/helpers/os_release"
+
+module VagrantVbguest
+  module Installers
+
+    class Windows < Base
+      def self.match?(vm)
+        raise Error, _key: :do_not_inherit_match_method if self != Windows
+        communicate_to(vm).test("(Get-WMIObject win32_operatingsystem).name")
+      end
+
+      def self.os_release(vm)
+        @@os_release_info ||= {}
+        if !@@os_release_info.has_key?(vm_id(vm)) && communicate_to(vm).test("(Get-WMIObject win32_operatingsystem).Name")
+          communicate.execute("(Get-WMIObject win32_operatingsystem).Name") do |type, data|
+            @@os_release_info[vm_id(vm)] = data
+          end
+        end
+        @@os_release_info[vm_id(vm)]
+      end
+
+      def os_release
+        self.class.os_release(vm)
+      end
+
+      def tmp_path
+        options[:iso_upload_path] || "$env:TEMP/VBoxGuestAdditions.iso"
+      end
+
+      def mount_point
+        communicate.execute(<<-SHELL) do |type, data|
+        (Get-DiskImage -DevicePath (
+          Get-DiskImage -ImagePath #{tmp_path}
+        ).DevicePath | Get-Volume).DriveLetter
+        SHELL
+          return data.strip
+        end
+      end
+
+      def installer_version(path_to_installer)
+        version = nil
+        communicate.execute("(get-item #{path_to_installer}).VersionInfo.ProductVersion") do |type, data|
+          if (v = data.to_s.match(/(\d+\.\d+.\d+)/i))
+            version = v[1]
+          end
+        end
+        version
+      end
+
+      def install(opts = nil, &block)
+        upload(iso_file)
+        mount_iso(opts, &block)
+        execute_installer(opts, &block)
+        unmount_iso(opts, &block) unless options[:no_cleanup]
+      end
+
+      def reboot_after_install?(opts = nil, &block)
+        true
+      end
+
+      def running?(opts = nil, &block)
+        communicate.test("'Running' -eq (Get-Service VBoxService)")
+      end
+
+      def guest_version(reload = false)
+        return @guest_version if @guest_version && !reload
+        driver_version = VagrantVbguest::Version(super)
+
+        communicate.execute("VBoxService --version", error_check: false) do |type,data|
+          service_version = VagrantVbguest::Version(data)
+
+          if service_version
+            if driver_version != service_version
+              @env.ui.warn(I18n.t(
+                "vagrant_vbguest.guest_version_reports_differ",
+                driver: driver_version, service: service_version
+              ))
+            end
+            @guest_version = service_version
+          end
+        end
+        @guest_version
+      end
+
+      def execute_installer(opts = nil, &block)
+        cert_dir  = File.join("#{mount_point}:", 'cert')
+        installer = File.join("#{mount_point}:", "VBoxWindowsAdditions.exe")
+
+        yield_installation_warning(installer)
+        opts = { elevated: true }.merge(opts || {})
+
+        # ignore "CRYPT_E_EXISTS" error when re-installing
+        communicate.execute(<<-SHELL, opts.merge(error_check: false), &block)
+          cd #{cert_dir}; ./VBoxCertUtil.exe add-trusted-publisher *.cer --root *.cer
+        SHELL
+
+        exit_status = communicate.execute(<<-SHELL, opts, &block)
+          cd #{cert_dir}; #{installer} /S
+        SHELL
+
+        yield_installation_error_warning(installer) unless exit_status == 0
+        exit_status
+      end
+
+      def mount_iso(opts = nil, &block)
+        communicate.execute("Mount-DiskImage -ImagePath #{tmp_path}", opts, &block)
+        env.ui.info(I18n.t("vagrant_vbguest.mounting_iso", mount_point: mount_point))
+      end
+
+      def unmount_iso(opts = nil, &block)
+        env.ui.info(I18n.t("vagrant_vbguest.unmounting_iso",mount_point: mount_point))
+        communicate.execute("Dismount-DiskImage -ImagePath #{tmp_path}", opts, &block)
+        communicate.execute("Remove-Item -Path #{tmp_path}", opts, &block)
+      end
+
+      def yield_installation_error_warning(path_to_installer)
+        @env.ui.warn I18n.t(
+          "vagrant_vbguest.windows.install_error",
+          installer_version: installer_version(path_to_installer) || I18n.t("vagrant_vbguest.unknown")
+        )
+      end
+    end
+  end
+end
+VagrantVbguest::Installer.register(VagrantVbguest::Installers::Windows, 2)

data/lib/vagrant-vbguest/machine.rb

@@ -13,7 +13,7 @@ module VagrantVbguest
       @logger = Log4r::Logger.new("vagrant::plugins::vbguest-machine")
       @logger.debug("initialize vbguest machine for VM '#{vm.name}' (#{vm.to_s})")
 
-      @installer = Installer.new vm, options
+      @installer = Installer.new(vm, options)
     end
 
     def run
@@ -55,7 +55,7 @@ module VagrantVbguest
     def steps(state)
       case state
       when :clean, :unmatched
-        [:install]
+        [:install].tap { |l| l << :reboot if installer.reboot_after_install? }
       when :not_running
         installation_ran? ? [:reboot] : [:start, :rebuild, :reboot]
       else
@@ -69,8 +69,14 @@ module VagrantVbguest
       running = installer.running?
       @logger.debug("Current states for VM '#{vm.name}' are : guest_version=#{guest_version} : host_version=#{host_version} : running=#{running}")
 
-      return :clean       if !guest_version
-      return :unmatched   if host_version != guest_version
+      return :clean if !guest_version
+
+      if host_version != guest_version
+        return :unmatched if host_version > guest_version || options[:allow_downgrade] || options[:force]
+        return :not_running if !running # still need to check this here, so we don't miss it before running into "skipped_downgrade"
+        return :skipped_downgrade if host_version < guest_version
+      end
+
       return :not_running if !running
       return :ok
     end

data/lib/vagrant-vbguest/version.rb

@@ -1,3 +1,22 @@
+require "delegate"
+
 module VagrantVbguest
-  VERSION = "0.19.0"
+  VERSION = File.read(File.expand_path("../../../VERSION", __FILE__)).chop
+
+  # Helper to create a new Gem::Version by parsing the common version pattern.
+  # When overwriting the pattern, make sure that the matched version string is
+  # the capture `1`
+  #
+  # @param input [String] The text to parse for a version.
+  # @param pattern [Regexp] The optional overwrite of the version string pattern (see +PATTERN+)
+  # @return [nil|Gem::Version] returns `nil` if the input could not been pared
+  def self.Version(input, pattern = /(\d+\.\d+\.\d+)/)
+    if input.nil?
+      nil
+    elsif Gem::Version === input
+      input
+    else
+      Gem::Version.create(input[pattern, 1])
+    end
+  end
 end

data/locales/en.yml

@@ -31,6 +31,7 @@ en:
       unmatched: "[%{vm_name}] GuestAdditions versions on your host (%{host_version}) and guest (%{guest_version}) do not match."
       not_running: "[%{vm_name}] GuestAdditions seems to be installed (%{guest_version}) correctly, but not running."
       ok: "[%{vm_name}] GuestAdditions %{guest_version} running --- OK."
+      skipped_downgrade: "GuestAdditions are newer than your host but, downgrades are disabled. Skipping."
 
     errors:
       autodetect_iso_path: |-

data/locales/en_windows.yml

@@ -0,0 +1,4 @@
+en:
+  vagrant_vbguest:
+    windows:
+      install_error: An error occurred during installation of VirtualBox Guest Additions %{installer_version}. Some functionality may not work as intended.

data/vagrant-vbguest.gemspec

@@ -1,9 +1,7 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/vagrant-vbguest/version', __FILE__)
-
 Gem::Specification.new do |s|
   s.name        = "vagrant-vbguest"
-  s.version     = VagrantVbguest::VERSION
+  s.version     = File.read('VERSION').chop
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Robert Schulze"]
   s.email       = ["robert@dotless.de"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-vbguest
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Robert Schulze
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-09 00:00:00.000000000 Z
+date: 2019-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: micromachine
@@ -73,6 +73,7 @@ files:
 - LICENSE
 - Rakefile
 - Readme.md
+- VERSION
 - lib/vagrant-vbguest.rb
 - lib/vagrant-vbguest/command.rb
 - lib/vagrant-vbguest/config.rb
@@ -95,10 +96,12 @@ files:
 - lib/vagrant-vbguest/installers/redhat.rb
 - lib/vagrant-vbguest/installers/suse.rb
 - lib/vagrant-vbguest/installers/ubuntu.rb
+- lib/vagrant-vbguest/installers/windows.rb
 - lib/vagrant-vbguest/machine.rb
 - lib/vagrant-vbguest/middleware.rb
 - lib/vagrant-vbguest/version.rb
 - locales/en.yml
+- locales/en_windows.yml
 - vagrant-vbguest.gemspec
 homepage: https://github.com/dotless-de/vagrant-vbguest
 licenses: