vagrant-vbguest 0.4.0 → 0.5.0

data/CHANGELOG.md

@@ -0,0 +1,63 @@
+## 0.5.0 (2012-11-19)
+
+  - Box will be rebooted if the GuestAdditions installation
+    process does not load the kernel module [GH-25], [GH-24]
+  - Adds this Changelog
+
+## 0.4.0 (2012-10-21)
+
+  - Add global configuration options [GH-22]
+  - Add `iso_path` option `:auto` to rest a previously
+    configured path [GH-22]
+
+## 0.3.5
+
+  - Fix iso detection for windows hosts [GH-20]
+
+## 0.3.4
+
+  - Fix installer shell script invocation [GH-18]
+
+## 0.3.3
+
+  - Add Fedora to the list of supported plattforms [GH-17]
+  - Add system package update (`apt-get update`) to the
+    debian installer if package installation fails [GH-16]
+  - Drop dependency on `vagrant` gem [GH-15]
+
+## 0.3.2
+
+  - Stop GuestAdditions installation and fail with an error
+    when installation of dependency packes fails [GH-13]
+
+## 0.3.1
+
+  - Ruby 1.8.7 compatibility [GH-12]
+
+## 0.3.0
+
+  - Removed dependency to the `virtualbox` gem by using 
+    `vagrant`s vm driver [GH-8]
+
+## 0.2.1
+
+  - Typo fixes in readme and internal renamings. [GH-9], [GH-7]
+
+## 0.2.0
+
+  - Makes a guess on where to look for a `VBoxGuestAdditions.iso` file
+    based on the host system (when VirtualBox does not tell). [GH-6]
+  - Adds command line options `--no-install`, `--no-remote`, `--iso`
+  - Requires vagrant v0.9.4 or later
+
+## 0.1.1
+
+  - Fix vagrant 0.9.4 compatibility [GH-4]
+
+## 0.1.0
+
+  - Vagrant 0.9 compatibility (drops 0.8 support) [GH-3]
+
+## Previous (≤ 0.0.3)
+
+  - Vagrant 0.8 support

data/Readme.md

@@ -49,6 +49,7 @@ The `iso_path` may contain the optional placeholder `$VBOX_VERSION` for the dete
 The URI for the actual iso download reads: `http://download.virtualbox.org/virtualbox/$VBOX_VERSION/VBoxGuestAdditions_$VBOX_VERSION.iso`<br/>
 vbguest will try to autodetect the best option for your system. WTF? see below.
 * `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, dafult: `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.
 * `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!
 
@@ -131,7 +132,7 @@ When everything is fine, and no update is needed, you see log like:
 When you switched off the middleware auto update, or you have a box up and running you may also run the installer manually.
 
 ```bash
-$ vagrant vbguest [vm-name] [-f|--force] [-I|--no-install] [-R|--no-remote] [--iso VBoxGuestAdditions.iso]
+$ vagrant vbguest [vm-name] [-f|--force] [--auto-reboot] [-I|--no-install] [-R|--no-remote] [--iso VBoxGuestAdditions.iso]
 ```
 
 For example, when you just updated Virtual Box on your host system, you should update the gust additions right away. However, you may need to reload the box to get the guest additions working.
@@ -150,6 +151,14 @@ or a match:
 
     [default] Detected Virtualbox Guest Additions 4.1.14 --- OK
 
+
+The `auto-reboot` is tured off by default, when running as a command. Vbguest will suggest you to reboot the box when needed. To turn it on simply pass the `--auto-reboot` parameter:
+
+```bash
+$ vagrant vbguest --auto-reboot
+```
+
+
 ### ISO autodetection
 
 *vagrant-vbguest* will try to autodetect a VirtualBox GuestAdditions iso file on your system, which usually matches your installed version of VirtualBox. If it cannot find one, it downloads one from the web (virtualbox.org).   
@@ -162,9 +171,16 @@ Those places will be checked in order:
   * for Windows : `%PROGRAMFILES%/Oracle/VirtualBox/VBoxGuestAdditions.iso`
 
 
+### Automatic reboot
+
+The VirtualBox GuestAdditions Installer will try to load the newly build kernel module. However the installer my fail to do, just as it is happening when updating GuestAdditions from version 4.1 to 4.2.
+
+Hency, vbguest will check for a loaded kernel module after the installation has finished and reboots the box, if it could not find one.
+
+
 ## Knows 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 plattform. 
 * The installer script requires a directory `/mnt` on the guest system
 * On multi vm boxes, the iso file will be downloaded for each vm
-* The plugin installation on Windows host systems my not work as expected (using `vagrant gem install vagrant-vbguest`). Try `C:\vagrant\vagrant\embedded\bin\gem.bat install vagrant-vbguest` instead. (See issue #5)
+* The plugin installation on Windows host systems my 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))

data/lib/vagrant-vbguest.rb

@@ -1,7 +1,7 @@
 require 'vagrant'
 require "vagrant-vbguest/errors"
 require "vagrant-vbguest/config"
-require "vagrant-vbguest/detector"
+require "vagrant-vbguest/helpers"
 require "vagrant-vbguest/download"
 require "vagrant-vbguest/installer"
 require 'vagrant-vbguest/command'

data/lib/vagrant-vbguest/command.rb

@@ -7,15 +7,21 @@ module VagrantVbguest
     # Runs the vbguest installer on the VMs that are represented
     # by this environment.
     def execute
-      options = {}
+      options = {
+        :auto_reboot => false
+      }
       opts = OptionParser.new do |opts|
-        opts.banner = "Usage: vagrant vbguest [vm-name] [-f|--force] [-I|--no-install] [-R|--no-remote] [--iso VBoxGuestAdditions.iso]"
+        opts.banner = "Usage: vagrant vbguest [vm-name] [-f|--force] [--auto-reboot] [-I|--no-install] [-R|--no-remote] [--iso VBoxGuestAdditions.iso]"
         opts.separator ""
 
         opts.on("-f", "--force", "Whether to force the installation") do
           options[:force] = true
         end
 
+        opts.on("--auto-reboot", "Reboot VM after installation") do
+          options[:auto_reboot] = true
+        end
+
         opts.on("--no-install", "-I", "Only check for the installed version. Do not attempt to install anything") do
           options[:no_install] = true
         end

data/lib/vagrant-vbguest/config.rb

@@ -3,13 +3,14 @@ module VagrantVbguest
   class Config < Vagrant::Config::Base
 
     module Attributes
-      attr_accessor :iso_path, :auto_update, :no_install, :no_remote
+      attr_accessor :iso_path, :auto_update, :auto_reboot, :no_install, :no_remote
     end
 
     class << self
       include Attributes
 
       def auto_update; @auto_update.nil? ? true  : @auto_update end
+      def auto_reboot; @auto_reboot.nil? ? true  : @auto_reboot end
       def no_install;  @no_install.nil?  ? false : @no_install  end
       def no_remote;   @no_remote.nil?   ? false : @no_remote   end
 
@@ -22,6 +23,7 @@ module VagrantVbguest
     include Attributes
 
     def auto_update; @auto_update.nil? ? self.class.auto_update : @auto_update end
+    def auto_reboot; @auto_reboot.nil? ? self.class.auto_reboot : @auto_reboot end
     def no_install;  @no_install.nil?  ? self.class.no_install  : @no_install  end
     def no_remote;   @no_remote.nil?   ? self.class.no_remote   : @no_remote   end
 
@@ -35,6 +37,7 @@ module VagrantVbguest
       {
         :iso_path => iso_path,
         :auto_update => auto_update,
+        :auto_reboot => auto_reboot,
         :no_install => no_install,
         :no_remote => no_remote
       }

data/lib/vagrant-vbguest/{detector.rb → helpers.rb}

@@ -1,29 +1,23 @@
 module VagrantVbguest
+  module Helpers
+    class << self
 
-  class Detector
-
-    def initialize(vm, options)
-      @vm = vm
-      @options = options
-    end
-
-    def iso_path
-      @iso_path ||= autodetect_iso
-    end
-
-    private
+      def local_iso_path_for(vm, options = nil)
+        options ||= {}
+        @local_iso_paths ||= Hash.new
+        @local_iso_paths[vm.uuid] ||= media_manager_iso(vm) || guess_iso(vm)
+      end
 
-      def autodetect_iso
-        path = media_manager_iso || guess_iso || web_iso
-        raise VagrantVbguest::IsoPathAutodetectionError if !path || path.empty?
-        path
+      def web_iso_path_for(vm, options = nil)
+        options ||= {}
+        "http://download.virtualbox.org/virtualbox/$VBOX_VERSION/VBoxGuestAdditions_$VBOX_VERSION.iso"
       end
 
-      def media_manager_iso
-        (m = @vm.driver.execute('list', 'dvds').match(/^.+:\s+(.*VBoxGuestAdditions.iso)$/i)) && m[1]
+      def media_manager_iso(vm)
+        (m = vm.driver.execute('list', 'dvds').match(/^.+:\s+(.*VBoxGuestAdditions.iso)$/i)) && m[1]
       end
 
-      def guess_iso
+      def guess_iso(vm)
         path_platform = if Vagrant::Util::Platform.linux?
           "/usr/share/virtualbox/VBoxGuestAdditions.iso"
         elsif Vagrant::Util::Platform.darwin?
@@ -38,9 +32,10 @@ module VagrantVbguest
         File.exists?(path_platform) ? path_platform : nil
       end
 
-      def web_iso
-        "http://download.virtualbox.org/virtualbox/$VBOX_VERSION/VBoxGuestAdditions_$VBOX_VERSION.iso" unless @options[:no_remote]
+      def kernel_module_running?(vm, &block)
+        vm.channel.test('lsmod | grep vboxsf', :sudo => true, &block)
       end
 
+    end
   end
 end

data/lib/vagrant-vbguest/installer.rb

@@ -3,6 +3,7 @@ module VagrantVbguest
   # Handles the guest addins installation process
 
   class Installer
+    @@rebooted = {}
 
     def initialize(vm, options = {})
       @env = {
@@ -31,35 +32,59 @@ module VagrantVbguest
       @vm.ui.warn(I18n.t("vagrant.plugins.vbguest.check_failed", :host => vb_version, :guest => guest_version)) if @options[:no_install]
 
       if @options[:force] || (!@options[:no_install] && needs_update?)
-        @vm.ui.warn(I18n.t("vagrant.plugins.vbguest.installing#{@options[:force] ? '_forced' : ''}", :host => vb_version, :guest => guest_version))
+        if rebooted?
+          @vm.ui.error(I18n.t("vagrant.plugins.vbguest.restart_loop_guard_activated"))
+        else
+          @vm.ui.warn(I18n.t("vagrant.plugins.vbguest.installing#{@options[:force] ? '_forced' : ''}", :host => vb_version, :guest => guest_version))
+          install
+        end
+      end
+    ensure
+      cleanup
+    end
+
+    def install
+      # :TODO:
+      # the whole installation process should be put into own classes
+      # like the vagrant system loading
+      if (i_script = installer_script)
+        @vm.ui.info(I18n.t("vagrant.plugins.vbguest.start_copy_iso", :from => iso_path, :to => iso_destination))
+        @vm.channel.upload(iso_path, iso_destination)
 
-        # :TODO:
-        # the whole installation process should be put into own classes
-        # like the vagrant system loading
-        if (i_script = installer_script)
-          @options[:iso_path] ||= VagrantVbguest::Detector.new(@vm, @options).iso_path
+        @vm.ui.info(I18n.t("vagrant.plugins.vbguest.start_copy_script", :from => File.basename(i_script), :to => installer_destination))
+        @vm.channel.upload(i_script, installer_destination)
 
-          @vm.ui.info(I18n.t("vagrant.plugins.vbguest.start_copy_iso", :from => iso_path, :to => iso_destination))
-          @vm.channel.upload(iso_path, iso_destination)
+        @vm.channel.sudo("chmod 0755 #{installer_destination}") do |type, data|
+          @vm.ui.info(data, :prefix => false, :new_line => false)
+        end
 
-          @vm.ui.info(I18n.t("vagrant.plugins.vbguest.start_copy_script", :from => File.basename(i_script), :to => installer_destination))
-          @vm.channel.upload(i_script, installer_destination)
+        @vm.channel.sudo("#{installer_destination}") do |type, data|
+          @vm.ui.info(data, :prefix => false, :new_line => false)
+        end
 
-          @vm.channel.sudo("chmod 0755 #{installer_destination}") do |type, data|
-            @vm.ui.info(data, :prefix => false, :new_line => false)
-          end
+        @vm.channel.execute("rm #{installer_destination} #{iso_destination}") do |type, data|
+          @vm.ui.error(data.chomp, :prefix => false)
+        end
 
-          @vm.channel.sudo("#{installer_destination}") do |type, data|
-            @vm.ui.info(data, :prefix => false, :new_line => false)
-          end
+        cleanup
+        reboot
+      end
+    end
 
-          @vm.channel.execute("rm #{installer_destination} #{iso_destination}") do |type, data|
-            @vm.ui.error(data.chomp, :prefix => false)
-          end
+    def reboot
+      if !VagrantVbguest::Helpers.kernel_module_running?(@vm)
+        if @options[:auto_reboot]
+          @vm.ui.warn(I18n.t("vagrant.plugins.vbguest.restart_vm"))
+          @@rebooted[@vm.name] = true
+          @vm.reload(@options[:run_env])
+        else
+          @vm.ui.warn(I18n.t("vagrant.plugins.vbguest.suggest_restart", :name => @vm.name))
         end
       end
-    ensure
-      cleanup
+    end
+
+    def rebooted?
+      !!@@rebooted[@vm.name]
     end
 
     def needs_update?
@@ -99,6 +124,11 @@ module VagrantVbguest
 
     def iso_path
       @iso_path ||= begin
+        @options[:iso_path] ||= VagrantVbguest::Helpers.local_iso_path_for @vm, @options
+        if !@options[:iso_path] || @options[:iso_path].empty? && !@options[:no_remote]
+          @options[:iso_path] = VagrantVbguest::Helpers.web_iso_path_for @vm, @options
+        end
+        raise VagrantVbguest::IsoPathAutodetectionError if !@options[:iso_path] || @options[:iso_path].empty?
         @env[:iso_url] ||= @options[:iso_path].gsub '$VBOX_VERSION', vb_version
 
         if local_iso?

data/lib/vagrant-vbguest/middleware.rb

@@ -13,9 +13,11 @@ module VagrantVbguest
 
     def call(env)
       options = @vm.config.vbguest.to_hash
+      options[:run_env] = env
       VagrantVbguest::Installer.new(@vm, options).run
+
       @app.call(env)
     end
-  end
 
+  end
 end

data/lib/vagrant-vbguest/version.rb

@@ -1,3 +1,3 @@
 module VagrantVbguest
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/locales/en.yml

@@ -8,6 +8,9 @@ en:
         installing_forced: "Forcing installation of Virtualbox Guest Additions %{host} - guest's version is %{guest}"
         start_copy_iso: "Copy iso file %{from} into the box %{to}"
         start_copy_script: "Copy installer file %{from} into the box %{to}"
+        restart_vm: "Restarting VM to apply changes..."
+        suggest_restart: "Guest Additions got installed. However, they seem not be loaded correctly. Please restart the box runing `vagrant reload %{name}`"
+        restart_loop_guard_activated: "Guest Additions will not load, even after reboot."
         no_install_script_for_platform: "Sorry, don't know how to install on a %{platform} system. Stopping installation."
         generic_install_script_for_platform: "%{platform} is currently not supported, will try generic Linux method..."
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-vbguest
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-21 00:00:00.000000000 Z
+date: 2012-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -36,6 +36,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - Rakefile
@@ -45,9 +46,9 @@ files:
 - lib/vagrant-vbguest.rb
 - lib/vagrant-vbguest/command.rb
 - lib/vagrant-vbguest/config.rb
-- lib/vagrant-vbguest/detector.rb
 - lib/vagrant-vbguest/download.rb
 - lib/vagrant-vbguest/errors.rb
+- lib/vagrant-vbguest/helpers.rb
 - lib/vagrant-vbguest/installer.rb
 - lib/vagrant-vbguest/middleware.rb
 - lib/vagrant-vbguest/version.rb