vagrant-vbguest-update 0.10.1.dev

data/lib/vagrant-vbguest.rb

@@ -0,0 +1,57 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The Vagrant VBGuest plugin must be run within Vagrant."
+end
+
+# Add our custom translations to the load path
+I18n.load_path << File.expand_path("../../locales/en.yml", __FILE__)
+I18n.reload!
+
+require "vagrant-vbguest/errors"
+require 'vagrant-vbguest/vagrant_compat'
+
+require 'vagrant-vbguest/machine'
+
+require 'vagrant-vbguest/hosts/base'
+require 'vagrant-vbguest/hosts/virtualbox'
+
+require 'vagrant-vbguest/installer'
+require 'vagrant-vbguest/installers/base'
+require 'vagrant-vbguest/installers/linux'
+require 'vagrant-vbguest/installers/debian'
+require 'vagrant-vbguest/installers/ubuntu'
+require 'vagrant-vbguest/installers/redhat'
+
+require 'vagrant-vbguest/middleware'
+
+module VagrantVbguest
+
+  class Plugin < Vagrant.plugin("2")
+
+    name "vagrant-vbguest"
+    description <<-DESC
+    Provides automatic and/or manual management of the
+    VirtualBox Guest Additions inside the Vagrant environment.
+    DESC
+
+    config('vbguest') do
+      require File.expand_path("../vagrant-vbguest/config", __FILE__)
+      Config
+    end
+
+    command('vbguest') do
+      Command
+    end
+
+    # hook after anything that boots:
+    # that's all middlewares which will run the buildin "VM::Boot" action
+    action_hook('vbguest') do |hook|
+      if defined?(VagrantPlugins::ProviderVirtualBox::Action::CheckGuestAdditions)
+        hook.before(VagrantPlugins::ProviderVirtualBox::Action::CheckGuestAdditions, VagrantVbguest::Middleware)
+      else
+        hook.after(VagrantPlugins::ProviderVirtualBox::Action::Boot, VagrantVbguest::Middleware)
+      end
+    end
+  end
+end

data/lib/vagrant-vbguest/command.rb

@@ -0,0 +1,95 @@
+require 'optparse'
+
+module VagrantVbguest
+
+  module CommandCommons
+    include VagrantVbguest::Helpers::Rebootable
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # Runs the vbguest installer on the VMs that are represented
+    # by this environment.
+    def execute
+      options = {
+        :_method => :run,
+        :_rebootable => true,
+        :auto_reboot => false
+      }
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: vagrant vbguest [vm-name] [--do start|rebuild|install] [--status] [-f|--force] [-b|--auto-reboot] [-R|--no-remote] [--iso VBoxGuestAdditions.iso]"
+        opts.separator ""
+
+        opts.on("--do COMMAND", [:start, :rebuild, :install], "Manually `start`, `rebuild` or `install` GuestAdditions.") do |command|
+          options[:_method] = command
+          options[:force] = true
+        end
+
+        opts.on("--status", "Print current GuestAdditions status and exit.") do
+          options[:_method] = :status
+          options[:_rebootable] = false
+        end
+
+        opts.on("-f", "--force", "Whether to force the installation. (Implied by --do start|rebuild|install)") do
+          options[:force] = true
+        end
+
+        opts.on("--auto-reboot", "-b", "Allow rebooting the VM after installation. (when GuestAdditions won't start)") do
+          options[:auto_reboot] = 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
+
+        build_start_options(opts, options)
+      end
+
+
+      argv = parse_options(opts)
+      return if !argv
+
+      if argv.empty?
+        with_target_vms(nil) { |vm| execute_on_vm(vm, options) }
+      else
+        argv.each do |vm_name|
+          with_target_vms(vm_name) { |vm| execute_on_vm(vm, options) }
+        end
+      end
+
+    end
+
+    protected
+
+    # Executes a command on a specific VM.
+    def execute_on_vm(vm, options)
+      check_runable_on(vm)
+
+      options     = options.clone
+      _method     = options.delete(:_method)
+      _rebootable = options.delete(:_rebootable)
+
+      options = vm.config.vbguest.to_hash.merge(options)
+      machine = VagrantVbguest::Machine.new(vm, options)
+      status  = machine.state
+      vm.env.ui.send((:ok == status ? :success : :warn), I18n.t("vagrant_vbguest.status.#{status}", machine.info))
+
+      if _method != :status
+        machine.send(_method)
+      end
+
+      reboot!(vm, options) if _rebootable && machine.reboot?
+    rescue VagrantVbguest::Installer::NoInstallerFoundError => e
+      vm.env.ui.error e.message
+    end
+
+    def check_runable_on(vm)
+      raise NotImplementedError
+    end
+  end
+
+end

data/lib/vagrant-vbguest/config.rb

@@ -0,0 +1,51 @@
+module VagrantVbguest
+
+  class Config <( Vagrant::VERSION < "1.1.0" ? Vagrant::Config::Base : Vagrant.plugin("2", :config) )
+
+    module Attributes
+      attr_accessor :iso_path, :auto_update, :auto_reboot, :no_install, :no_remote, :installer, :installer_arguments
+    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
+      def installer_arguments; @installer_arguments.nil? ? '--nox11' : @installer_arguments end
+
+      def iso_path
+        return nil if !@iso_path || @iso_path == :auto
+        @iso_path
+      end
+    end
+
+    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
+    def installer_arguments; @installer_arguments.nil? ? self.class.installer_arguments : @installer_arguments end
+
+    def iso_path
+      return self.class.iso_path if !@iso_path || @iso_path == :auto
+      @iso_path
+    end
+
+    # explicit hash, to get symbols in hash keys
+    def to_hash
+      {
+        :installer => installer,
+        :installer_arguments => installer_arguments,
+        :iso_path => iso_path,
+        :auto_update => auto_update,
+        :auto_reboot => auto_reboot,
+        :no_install => no_install,
+        :no_remote => no_remote
+      }
+    end
+
+  end
+end

data/lib/vagrant-vbguest/core_ext/string/interpolate.rb

@@ -0,0 +1,110 @@
+# This backports the Ruby 1.9 String interpolation syntax to Ruby 1.8.
+#
+# This file is a copy from I18n
+# https://github.com/mattetti/i18n/blob/master/lib/i18n/core_ext/string/interpolate.rb
+# Copyright (c) 2008 The Ruby I18n team
+# It's copied here for the resons given below:
+#
+# This backport has been shipped with I18n for a number of versions. Meanwhile
+# Rails has started to rely on it and we are going to move it to ActiveSupport.
+# See https://rails.lighthouseapp.com/projects/8994/tickets/6013-move-19-string-interpolation-syntax-backport-from-i18n-to-activesupport
+#
+# Once the above patch has been applied to Rails the following code will be
+# removed from I18n.
+
+=begin
+  heavily based on Masao Mutoh's gettext String interpolation extension
+  http://github.com/mutoh/gettext/blob/f6566738b981fe0952548c421042ad1e0cdfb31e/lib/gettext/core_ext/string.rb
+  Copyright (C) 2005-2009 Masao Mutoh
+  You may redistribute it and/or modify it under the same license terms as Ruby.
+=end
+
+begin
+  raise ArgumentError if ("a %{x}" % {:x=>'b'}) != 'a b'
+rescue ArgumentError
+  # KeyError is raised by String#% when the string contains a named placeholder
+  # that is not contained in the given arguments hash. Ruby 1.9 includes and
+  # raises this exception natively. We define it to mimic Ruby 1.9's behaviour
+  # in Ruby 1.8.x
+  class KeyError < IndexError
+    def initialize(message = nil)
+      super(message || "key not found")
+    end
+  end unless defined?(KeyError)
+
+  # Extension for String class. This feature is included in Ruby 1.9 or later but not occur TypeError.
+  #
+  # String#% method which accept "named argument". The translator can know
+  # the meaning of the msgids using "named argument" instead of %s/%d style.
+  class String
+    # For older ruby versions, such as ruby-1.8.5
+    alias :bytesize :size unless instance_methods.find {|m| m.to_s == 'bytesize'}
+    alias :interpolate_without_ruby_19_syntax :% # :nodoc:
+
+    INTERPOLATION_PATTERN = Regexp.union(
+      /%\{(\w+)\}/,                               # matches placeholders like "%{foo}"
+      /%<(\w+)>(.*?\d*\.?\d*[bBdiouxXeEfgGcps])/  # matches placeholders like "%<foo>.d"
+    )
+
+    INTERPOLATION_PATTERN_WITH_ESCAPE = Regexp.union(
+      /%%/,
+      INTERPOLATION_PATTERN
+    )
+
+    # % uses self (i.e. the String) as a format specification and returns the
+    # result of applying it to the given arguments. In other words it interpolates
+    # the given arguments to the string according to the formats the string
+    # defines.
+    #
+    # There are three ways to use it:
+    #
+    # * Using a single argument or Array of arguments.
+    #
+    #   This is the default behaviour of the String class. See Kernel#sprintf for
+    #   more details about the format string.
+    #
+    #   Example:
+    #
+    #     "%d %s" % [1, "message"]
+    #     # => "1 message"
+    #
+    # * Using a Hash as an argument and unformatted, named placeholders.
+    #
+    #   When you pass a Hash as an argument and specify placeholders with %{foo}
+    #   it will interpret the hash values as named arguments.
+    #
+    #   Example:
+    #
+    #     "%{firstname}, %{lastname}" % {:firstname => "Masao", :lastname => "Mutoh"}
+    #     # => "Masao Mutoh"
+    #
+    # * Using a Hash as an argument and formatted, named placeholders.
+    #
+    #   When you pass a Hash as an argument and specify placeholders with %<foo>d
+    #   it will interpret the hash values as named arguments and format the value
+    #   according to the formatting instruction appended to the closing >.
+    #
+    #   Example:
+    #
+    #     "%<integer>d, %<float>.1f" % { :integer => 10, :float => 43.4 }
+    #     # => "10, 43.3"
+    def %(args)
+      if args.kind_of?(Hash)
+        dup.gsub(INTERPOLATION_PATTERN_WITH_ESCAPE) do |match|
+          if match == '%%'
+            '%'
+          else
+            key = ($1 || $2).to_sym
+            raise KeyError unless args.has_key?(key)
+            $3 ? sprintf("%#{$3}", args[key]) : args[key]
+          end
+        end
+      elsif self =~ INTERPOLATION_PATTERN
+        raise ArgumentError.new('one hash required')
+      else
+        result = gsub(/%([{<])/, '%%\1')
+        result.send :'interpolate_without_ruby_19_syntax', args
+      end
+    end
+  end
+end

data/lib/vagrant-vbguest/download.rb

@@ -0,0 +1,28 @@
+module VagrantVbguest
+
+  class DownloadBase
+    attr_reader :source, :destination, :downloader
+
+    def initialize(source, destination, options=nil)
+      @downloader = nil
+      @source = source
+      @destination = destination
+      if File.directory?(destination)
+        @destination = File.join(destination, "vbguest_download_#{Time.now.to_i.to_s}")
+      end
+      @ui = options[:ui]
+    end
+
+    def download!
+      raise NotImplementedError
+    end
+
+    def cleanup
+      if destination && File.exist?(destination)
+        @ui.info I18n.t("vagrant_vbguest.download.cleaning")
+        File.unlink(destination)
+      end
+    end
+  end
+
+end

data/lib/vagrant-vbguest/errors.rb

@@ -0,0 +1,18 @@
+module VagrantVbguest
+
+  class VbguestError < Vagrant::Errors::VagrantError
+    def error_namespace; "vagrant_vbguest.errors"; end
+  end
+
+  class IsoPathAutodetectionError < VagrantVbguest::VbguestError
+    error_key :autodetect_iso_path
+  end
+
+  class DownloadingDisabledError < VagrantVbguest::VbguestError
+    error_key :downloading_disabled
+  end
+
+  class NoVirtualBoxMachineError < VagrantVbguest::VbguestError
+    error_key :no_virtualbox_machine
+  end
+end

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

@@ -0,0 +1,118 @@
+require 'uri'
+
+module VagrantVbguest
+  module Hosts
+    class Base
+      include VagrantVbguest::Helpers::VmCompatible
+
+      attr_reader :env, :vm, :options
+
+      def initialize(vm, options=nil)
+        @vm = vm
+        @env = vm.env
+        @options = options
+      end
+
+      # Determinates the host's version
+      #
+      # @return [String] The version code of the *host*'s virtualisation
+      def version
+        @version ||= driver.version
+      end
+
+
+      # Additions-file-detection-magig.
+      #
+      # Detection runs in those stages:
+      # 1. Uses the +iso_path+ config option, if present and not set to +:auto+
+      # 2. Look out for a local additions file
+      # 3. Use the default web URI
+      #
+      # If the detected or configured path is not a local file and remote downloads
+      # are allowed (the config option +:no_remote+ is NOT set) it will try to
+      # download that file into a temp file using Vagrants Downloaders.
+      # If remote downloads are prohibited (the config option +:no_remote+ IS set)
+      # a +VagrantVbguest::IsoPathAutodetectionError+ will be thrown
+      #
+      # @return [String] A absolute path to the GuestAdditions iso file.
+      #                  This might be a temp-file, e.g. when downloaded from web.
+      def additions_file
+        return @additions_file if @additions_file
+
+        path = options[:iso_path]
+        if !path || path.empty? || path == :auto
+          path = local_path
+          path = web_path if !options[:no_remote] && !path
+        end
+        raise VagrantVbguest::IsoPathAutodetectionError if !path || path.empty?
+
+        path = versionize(path)
+
+        if file_match? path
+          @additions_file = path
+        else
+          # :TODO: This will also raise, if the iso_url points to an invalid local path
+          raise VagrantVbguest::DownloadingDisabledError.new(:from => path) if options[:no_remote]
+          @additions_file = download path
+        end
+      end
+
+      # If needed, remove downloaded temp file
+      def cleanup
+        @download.cleanup if @download
+      end
+
+      protected
+
+        # fix bug when the vagrant version is higher than 1.2, by moving method Vagrant::Vagrant::File.match? here
+        def file_match?(uri)
+          extracted = ::URI.extract(uri, "file")
+
+          return true if extracted && extracted.include?(uri)
+
+          return ::File.file?(::File.expand_path(uri))
+        end
+
+        # Default web URI, where "additions file" can be downloaded.
+        #
+        # @return [String] A URI template containing the versions placeholder.
+        def web_path
+          raise NotImplementedError
+        end
+
+        # Finds the "additions file" on the host system.
+        # Returns +nil+ if none found.
+        #
+        # @return [String] Absolute path to the local "additions file", or +nil+ if not found.
+        def local_path
+          raise NotImplementedError
+        end
+
+        # replaces the veriosn placeholder with the additions
+        # version string
+        #
+        # @param [String] A path or URL (or any other String)
+        #
+        # @retrun [String] A copy of the passed string, with verision
+        #                  placeholder replaced
+        def versionize(path)
+          path % {:version => version}
+        end
+
+        # Kicks off +VagrantVbguest::Download+ to download the additions file
+        # into a temp file.
+        #
+        # To remove the created tempfile call +cleanup+
+        #
+        # @param [String] The path or URI to download
+        #
+        # @return [String] The path to the downloaded file
+        def download(path)
+          @download = VagrantVbguest::Download.new(path, @env.tmp_path, :ui => @env.ui)
+          @download.download!
+          @download.destination
+        end
+
+    end
+  end
+end