vagrant-vbguest 0.1.1 → 0.2.0

data/Readme.md

@@ -4,31 +4,63 @@
 
 ## Installation
 
-Requires vagrant 0.9.0
+Requires vagrant 0.9.4 or later
 
     gem install vagrant-vbguest
 
-Compatibly for vagrant 0.8 is provided by version 0.0.3
+or, using vagrant's gem wrapper
+
+    vagrant gem install vagrant-vbguest
+
+Compatibly for vagrant 0.8 is provided by version 0.0.3 (which lacks a bunch of new options)
 
 ## Configuration / Usage
 
-In your `Vagrantfile`:
+If you're lucky, `vagrant-vbguest` does not require any configurations. 
+Hoever, here is an example for your `Vagrantfile`:
 
     Vagrant::Config.run do |config|
       # we will try to autodetect this path. 
-      # However, if we cannot or you have a special one you may pass it here
-      config.vbguest.iso_path = '/Applications/VirtualBox.app/Contents/MacOS/VBoxGuestAdditions.iso'
+      # However, if we cannot or you have a special one you may pass it like:
+      # config.vbguest.iso_path = "#{ENV['HOME']}/Downloads/VBoxGuestAdditions.iso"
+      # or
+      # config.vbguest.iso_path = "http://company.server/VirtualBox/$VBOX_VERSION/VBoxGuestAdditions.iso"
       
       # set auto_update to false, if do NOT want to check the correct additions 
-      # version on each 'vagrant up' (default: true)
+      # version when booting this machine
       config.vbguest.auto_update = false
+      
+      # do NOT download the iso file from a webserver
+      config.vbguest.no_remote = true
     end
     
+### Config options
+
+* `iso_path` : The full path or URL to the VBoxGuestAdditions.iso file. <br/>
+The `iso_path` may contain the optional placeholder `$VBOX_VERSION` for the detected version (e.g. `4.1.8`).
+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, dafault: `true`) : Whether to check the correct additions version on each start (where start is _not_ resuming a box).
+* `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!
+
+### 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). Those places will be checked in order:
+
+1. Checks your VirualBox "Virtual Media Maganger" for a DVD called "VBoxGuestAdditions.iso"
+2. Guess by your operating system:
+  * for linux : `/usr/share/virtualbox/VBoxGuestAdditions.iso`
+  * for Mac : `/Applications/VirtualBox.app/Contents/MacOS/VBoxGuestAdditions.iso`
+  * for Windows : `%PROGRAMFILES%/Oracle/VirtualBox/VBoxGuestAdditions.iso`
+    
 You may also run the installer manually:
 
-    $ vagrant vbguest [vm-name] [-f|--force]
+    $ vagrant vbguest [vm-name] [-f|--force] [-I|--no-install] [-R|--no-remote] [--iso VBoxGuestAdditions.iso]
 
 ## 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 host system
+* The installer script requires a directory `/mnt` on the host system
+* On multi vm boxes, the iso file will be downloaded for each vm

data/lib/vagrant-vbguest.rb

@@ -1,5 +1,6 @@
 require 'vagrant'
 require "vagrant-vbguest/config"
+require "vagrant-vbguest/download"
 require "vagrant-vbguest/installer"
 require 'vagrant-vbguest/command'
 require 'vagrant-vbguest/middleware'

data/lib/vagrant-vbguest/command.rb

@@ -9,11 +9,24 @@ module VagrantVbguest
     def execute
       options = {}
       opts = OptionParser.new do |opts|
-        opts.banner = "Usage: vagrant vbguest [vm-name] [-f|--force]"
+        puts opts.inspect
+        opts.banner = "Usage: vagrant vbguest [vm-name] [-f|--force] [-I|--no-install] [-R|--no-remote] [--iso VBoxGuestAdditions.iso]"
         opts.separator ""
 
-        opts.on("-f", "--force", "Whether to force the installation") do |f|
-          options[:force] = f
+        opts.on("-f", "--force", "Whether to force the installation") do
+          options[:force] = 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
+        
+        opts.on("--no-remote", "-R", "Do not attempt do download the iso file from a webserver") do
+          options[:no_remote] = true
+        end
+        
+        opts.on("--iso file_or_uri", "Full path or URI to the VBoxGuestAdditions.iso") do |file_or_uri|
+          options[:iso_path] = file_or_uri
         end
       end
 

data/lib/vagrant-vbguest/config.rb

@@ -5,32 +5,55 @@ module VagrantVbguest
   class Config < Vagrant::Config::Base
     attr_accessor :iso_path
     attr_accessor :auto_update
+    attr_accessor :no_install
+    attr_accessor :no_remote
     
-    def initialize
-      super
-      @auto_update = true
-      autodetect_iso!
-    end
-    
+    def iso_path; @iso_path ||= autodetect_iso; end
+    def auto_update; @auto_update.nil? ? (@auto_update = true) : @auto_update; end
+    def no_remote; @no_remote.nil? ? (@no_remote = false) : @no_remote; end
+    def no_install; @no_install.nil? ? (@no_install = false): @no_install; end
+        
     def validate(env, errors)
-      errors.add(I18n.t("vagrant.plugins.vbguest.missing_iso_path")) unless iso_path && iso_path.is_a?(String) && File.exists?(iso_path)
+      errors.add(I18n.t("vagrant.plugins.vbguest.missing_iso_path")) unless iso_path && iso_path.is_a?(String)
     end
 
     # explicit hash, to get symbols in hash keys
     def to_hash
       {
         :iso_path => iso_path,
-        :auto_update => auto_update
+        :auto_update => auto_update,
+        :no_install => no_install,
+        :no_remote => no_remote
       }
     end
     
     protected
     
-    def autodetect_iso!
+    def autodetect_iso
+      media_magager_iso || guess_iso || web_iso
+    end
+
+    def media_magager_iso
       dvd = VirtualBox::DVD.all.find do |d|
         !!(d.location =~ /VBoxGuestAdditions.iso$/)
       end
-      @iso_path = dvd.location if dvd
+      dvd ? dvd.location : nil
+    end
+
+    def guess_iso
+      guess_path = if Vagrant::Util::Platform.linux?
+        "/usr/share/virtualbox/VBoxGuestAdditions.iso"
+      elsif Vagrant::Util::Platform.darwin?
+        "/Applications/VirtualBox.app/Contents/MacOS/VBoxGuestAdditions.iso"
+      elsif Vagrant::Util::Platform.windows?
+        File.join((ENV["PROGRAM_FILES"] || ENV["PROGRAMFILES"]), "/Oracle/VirtualBox/VBoxGuestAdditions.iso")
+      end
+      File.exists?(guess_path) ? guess_path : nil
     end
+
+    def web_iso
+      "http://download.virtualbox.org/virtualbox/$VBOX_VERSION/VBoxGuestAdditions_$VBOX_VERSION.iso" unless !no_remote
+    end
+
   end
 end

data/lib/vagrant-vbguest/download.rb

@@ -0,0 +1,83 @@
+module VagrantVbguest
+
+  # This implementation is based on Action::Box::Download by vagrant
+  # 
+  # This adoption does not run as a action/middleware, but is called manually
+  #
+  # MIT License - Mitchell Hashimoto and John Bender - https://github.com/mitchellh/vagrant
+  #
+  #
+  #
+  class Download
+
+    BASENAME = "vbguest"
+
+    include Vagrant::Util
+
+    attr_reader :temp_path
+
+    def initialize(env)
+      @env = env
+      @env["download.classes"] ||= []
+      @env["download.classes"] += [Vagrant::Downloaders::HTTP, Vagrant::Downloaders::File]
+      @downloader = nil
+    end
+
+    def instantiate_downloader
+      # Assign to a temporary variable since this is easier to type out,
+      # since it is used so many times.
+      classes = @env["download.classes"]
+
+      # Find the class to use.
+      classes.each_index do |i|
+        klass = classes[i]
+
+        # Use the class if it matches the given URI or if this
+        # is the last class...
+        if classes.length == (i + 1) || klass.match?(@env[:iso_url])
+          @env[:ui].info I18n.t("vagrant.plugins.vbguest.download.with", :class => klass.to_s)
+          @downloader = klass.new(@env[:ui])
+          break
+        end
+      end
+
+      # This line should never be reached, but we'll keep this here
+      # just in case for now.
+      raise Errors::BoxDownloadUnknownType if !@downloader
+
+      @downloader.prepare(@env[:iso_url])
+      true
+    end
+
+    def download
+      if instantiate_downloader
+        with_tempfile do |tempfile|
+          download_to(tempfile)
+          @temp_path = @env["download.temp_path"] = tempfile.path
+        end
+      end
+    end
+
+    def cleanup
+      if temp_path && File.exist?(temp_path)
+        @env[:ui].info I18n.t("vagrant.plugins.vbguest.download.cleaning")
+        File.unlink(temp_path)
+      end
+    end
+
+    def with_tempfile
+      File.open(iso_temp_path, Platform.tar_file_options) do |tempfile|
+        yield tempfile
+      end
+    end
+
+    def iso_temp_path
+      @env[:tmp_path].join(BASENAME + Time.now.to_i.to_s)
+    end
+
+    def download_to(f)
+      @downloader.download!(@env[:iso_url], f)
+    end
+
+  end
+end

data/lib/vagrant-vbguest/installer.rb

@@ -5,8 +5,13 @@ module VagrantVbguest
   class Installer
 
     def initialize(vm, options = {})
+      @env = {
+        :ui => vm.ui,
+        :tmp_path => vm.env.tmp_path
+      }
       @vm = vm
       @options = options
+      @iso_path = nil
     end
     
     def run!
@@ -20,15 +25,17 @@ module VagrantVbguest
       raise Vagrant::Errors::VMNotRunningError if @vm.state != :running
 
       if @options[:auto_update]
+        
         @vm.ui.success(I18n.t("vagrant.plugins.vbguest.guest_ok", :version => guest_version)) unless needs_update?
+        @vm.ui.warn(I18n.t("vagrant.plugins.vbguest.check_failed", :host => vb_version, :guest => guest_version)) if @options[:no_install]
         
-        if @options[:force] || needs_update?
+        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))
           
           # :TODO: 
           # the whole installation process should be put into own classes
           # like the vagrant system loading
-          if i_script = installer_script
+          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)
             
@@ -52,8 +59,9 @@ module VagrantVbguest
             $stdout.puts
           end
         end
-        
       end
+    ensure
+      cleanup
     end
     
     def needs_update?
@@ -73,14 +81,14 @@ module VagrantVbguest
       plattform = @vm.guest.distro_dispatch
       case plattform
       when :debian, :ubuntu
-        return File.expand_path("../../../files/setup_debian.sh", __FILE__)
+        File.expand_path("../../../files/setup_debian.sh", __FILE__)
       when :gentoo, :redhat, :suse, :arch, :linux
         @vm.ui.warn(I18n.t("vagrant.plugins.vbguest.generic_install_script_for_plattform", :plattform => plattform.to_s))
-        return File.expand_path("../../../files/setup_linux.sh", __FILE__)
+        File.expand_path("../../../files/setup_linux.sh", __FILE__)
+      else
+        @vm.ui.error(I18n.t("vagrant.plugins.vbguest.no_install_script_for_plattform", :plattform => plattform.to_s))  
+        nil
       end
-      @vm.ui.error(I18n.t("vagrant.plugins.vbguest.no_install_script_for_plattform", :plattform => plattform.to_s))
-      
-      nil
     end
     
     def installer_destination
@@ -92,8 +100,26 @@ module VagrantVbguest
     end
 
     def iso_path
-      @options[:iso_path]
+      @iso_path ||= begin
+        @env[:iso_url] ||= @options[:iso_path].gsub '$VBOX_VERSION', vb_version
+
+        if local_iso?
+          @env[:iso_url]
+        else
+          @download = VagrantVbguest::Download.new(@env)
+          @download.download
+          @download.temp_path
+        end
+      end
     end
-  end
 
-end
+    def local_iso?
+      ::File.file?(@env[:iso_url])
+    end
+
+    def cleanup
+      @download.cleanup if @download
+    end
+
+  end
+end

data/lib/vagrant-vbguest/version.rb

@@ -1,3 +1,3 @@
 module VagrantVbguest
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/locales/en.yml

@@ -3,10 +3,22 @@ en:
     plugins:
       vbguest:
         guest_ok: "Detected Virtualbox Guest Additions %{version} --- OK."
+        check_failed: "Virtualbox Guest Additions on host: %{host} - guest's version is %{guest}"
         installing: "Installing Virtualbox Guest Additions %{host} - guest's version is %{guest}"
         installing_forced: "Forcing installation of Virtualbox Guest Additions %{host} - guest's version is %{guest}"
-        missing_iso_path: "Could not autodetect the correct location of the Virtualbox Guest Additions ISO File. Or the Path provided is not correct. \nPlease configure using `config.vbguest.iso_path`. \nOn Mac this is most likely: '/Applications/VirtualBox.app/Contents/MacOS/VBoxGuestAdditions.iso' "
         start_copy_iso: "Copy iso file %{from} into the box %{to}"
         start_copy_script: "Copy installer file %{from} into the box %{to}"
-        no_install_script_for_plattform: "Sorry, not shure how to install on a %{plattform} system. Stopping installation."
-        generic_install_script_for_plattform: "%{plattform} is currently not supported, but i'll try generic linux way ... "
+        no_install_script_for_plattform: "Sorry, don't know how to install on a %{plattform} system. Stopping installation."
+        generic_install_script_for_plattform: "%{plattform} is currently not supported, but i'll try generic linux way ... "
+        
+        validation_errors:
+          missing_iso_path: |-
+            Could not autodetect the correct location of the Virtualbox Guest Additions
+            ISO File. Please correct or configure using `config.vbguest.iso_path`.
+            If you think this is a bug in vbguest and we could guessed the iso_path,
+            please file a bug: https://github.com/dotless-de/vagrant-vbguest/issues
+
+        download:
+          with: "Downloading VirtualBox Guest Additions ISO with %{class}..."
+          cleaning: "Cleaning up downloaded VirtualBox Guest Additions ISO..."
+          unknown_type: "Unknown or unsupported URI type given for VirtualBox Guest Additions ISO download."

data/vagrant-vbguest.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   # s.add_runtime_dependency "rest-client"
   
   s.add_dependency "virtualbox", "~> 0.9.1"
-  s.add_dependency "vagrant", "~> 0.9.0"
+  s.add_dependency "vagrant", ">= 0.9.4"
   s.add_development_dependency "bundler", ">= 1.0.0"
   
   s.files         = `git ls-files`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-vbguest
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-31 00:00:00.000000000Z
+date: 2012-03-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtualbox
-  requirement: &70099278464040 !ruby/object:Gem::Requirement
+  requirement: &70295089810860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,21 +21,21 @@ dependencies:
         version: 0.9.1
   type: :runtime
   prerelease: false
-  version_requirements: *70099278464040
+  version_requirements: *70295089810860
 - !ruby/object:Gem::Dependency
   name: vagrant
-  requirement: &70099278463460 !ruby/object:Gem::Requirement
+  requirement: &70295089810380 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.4
   type: :runtime
   prerelease: false
-  version_requirements: *70099278463460
+  version_requirements: *70295089810380
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70099278462900 !ruby/object:Gem::Requirement
+  requirement: &70295089809920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70099278462900
+  version_requirements: *70295089809920
 description: A Vagrant plugin wich automatically installs the host's VirtualBox Guest
   Additions on the guest system.
 email:
@@ -62,6 +62,7 @@ files:
 - lib/vagrant-vbguest.rb
 - lib/vagrant-vbguest/command.rb
 - lib/vagrant-vbguest/config.rb
+- lib/vagrant-vbguest/download.rb
 - lib/vagrant-vbguest/installer.rb
 - lib/vagrant-vbguest/middleware.rb
 - lib/vagrant-vbguest/version.rb