vagrant-proxyconf 1.0.1 → 1.1.0

data/lib/vagrant-proxyconf/action/configure_pear_proxy.rb

@@ -0,0 +1,29 @@
+require_relative 'base'
+
+module VagrantPlugins
+  module ProxyConf
+    class Action
+      # Action for configuring Pear on the guest
+      class ConfigurePearProxy < Base
+        def config_name
+          'pear_proxy'
+        end
+
+        private
+
+        # @return [Vagrant::Plugin::V2::Config] the configuration
+        def config
+          # Use global proxy config
+          @config ||= finalize_config(@machine.config.proxy)
+        end
+
+        def configure_machine
+          proxy = config.http || ''
+
+          @machine.communicate.sudo(
+            "pear config-set http_proxy #{escape(proxy)} system")
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-proxyconf/action/configure_yum_proxy.rb

@@ -13,15 +13,15 @@ module VagrantPlugins
 
         private
 
-        def configure_machine(machine, config)
+        def configure_machine
           tmp = "/tmp/vagrant-proxyconf"
-          path = config_path(machine)
+          path = config_path
 
-          machine.communicate.tap do |comm|
+          @machine.communicate.tap do |comm|
             comm.sudo("rm #{tmp}", error_check: false)
             comm.upload(ProxyConf.resource("yum_config.awk"), tmp)
             comm.sudo("touch #{path}")
-            comm.sudo("gawk -f #{tmp} #{proxy_params(config)} #{path} > #{path}.new")
+            comm.sudo("gawk -f #{tmp} #{proxy_params} #{path} > #{path}.new")
             comm.sudo("chmod 0644 #{path}.new")
             comm.sudo("chown root:root #{path}.new")
             comm.sudo("mv #{path}.new #{path}")
@@ -29,15 +29,10 @@ module VagrantPlugins
           end
         end
 
-        def proxy_params(config)
+        def proxy_params
           u = UserinfoURI.new(config.http)
           "-v proxy=#{escape(u.uri)} -v user=#{escape(u.user)} -v pass=#{escape(u.pass)}"
         end
-
-        # @param value [String, nil] the string to escape for shell usage
-        def escape(value)
-          value.to_s.shellescape
-        end
       end
     end
   end

data/lib/vagrant-proxyconf/action/is_enabled.rb

@@ -0,0 +1,24 @@
+module VagrantPlugins
+  module ProxyConf
+    class Action
+      # Action which checks if the plugin should be enabled
+      class IsEnabled
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = plugin_enabled?(env[:machine].config.proxy)
+
+          @app.call(env)
+        end
+
+        private
+
+        def plugin_enabled?(config)
+          config.enabled != false && config.enabled != ''
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-proxyconf/cap/linux/pear_proxy_conf.rb

@@ -0,0 +1,15 @@
+module VagrantPlugins
+  module ProxyConf
+    module Cap
+      module Linux
+        # Capability for PEAR proxy configuration
+        module PearProxyConf
+          # @return [Boolean] if PEAR is installed
+          def self.pear_proxy_conf(machine)
+            machine.communicate.test("which pear")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-proxyconf/capability.rb

@@ -0,0 +1,31 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module ProxyConf
+    class Plugin < Vagrant.plugin('2')
+      guest_capability 'debian', 'apt_proxy_conf' do
+        require_relative 'cap/debian/apt_proxy_conf'
+        Cap::Debian::AptProxyConf
+      end
+
+      guest_capability 'coreos', 'env_proxy_conf' do
+        # disabled on CoreOS
+      end
+
+      guest_capability 'linux', 'env_proxy_conf' do
+        require_relative 'cap/linux/env_proxy_conf'
+        Cap::Linux::EnvProxyConf
+      end
+
+      guest_capability 'linux', 'pear_proxy_conf' do
+        require_relative 'cap/linux/pear_proxy_conf'
+        Cap::Linux::PearProxyConf
+      end
+
+      guest_capability 'redhat', 'yum_proxy_conf' do
+        require_relative 'cap/redhat/yum_proxy_conf'
+        Cap::Redhat::YumProxyConf
+      end
+    end
+  end
+end

data/lib/vagrant-proxyconf/config.rb

@@ -0,0 +1,27 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module ProxyConf
+    class Plugin < Vagrant.plugin('2')
+      config 'apt_proxy' do
+        require_relative 'config/apt_proxy'
+        Config::AptProxy
+      end
+
+      config 'env_proxy' do
+        require_relative 'config/env_proxy'
+        Config::EnvProxy
+      end
+
+      config 'proxy' do
+        require_relative 'config/proxy'
+        Config::Proxy
+      end
+
+      config 'yum_proxy' do
+        require_relative 'config/yum_proxy'
+        Config::YumProxy
+      end
+    end
+  end
+end

data/lib/vagrant-proxyconf/config/apt_proxy.rb

@@ -20,56 +20,56 @@ module VagrantPlugins
         # @return [String] the FTP proxy
         key :ftp, env_var: 'VAGRANT_APT_FTP_PROXY'
 
+        def finalize!
+          super
+
+          keys.each do |key|
+            value = get(key)
+            set(key, finalize_uri(key, value)) if value
+          end
+        end
+
         private
 
         # (see KeyMixin#config_for)
         def config_for(key, value)
-          ConfigLine.new(key.name, value)
+          %Q{Acquire::#{key.name}::Proxy #{value.inspect};\n} if value
+        end
+
+        def finalize_uri(key, value)
+          AptProxyURI.new(key.name, value).to_s
         end
 
-        # Helper for constructing a configuration line for apt.conf
+        # Helper for constructing configuration values for apt.conf
         #
         # @api private
-        class ConfigLine
+        class AptProxyURI
 
-          attr_reader :proto, :value
+          attr_reader :scheme, :value
 
-          # @param proto [String] the protocol ("http", "https", ...)
+          # @param scheme [String] the protocol ("http", "https", ...)
           # @param value [Object] the configuration value
-          def initialize(proto, value)
-            @proto = proto
+          def initialize(scheme, value)
+            @scheme = scheme
             @value = value
           end
 
-          # @return [String] the full Apt configuration line
           def to_s
-            %Q{Acquire::#{proto}::Proxy "#{direct || proxy_uri}";\n} if set?
+            direct || "#{prefix}#{value}#{suffix}"
           end
 
           private
 
-          def set?
-            value && !value.empty?
-          end
-
           def direct
-            "DIRECT" if value.upcase == "DIRECT"
-          end
-
-          def proxy_uri
-            "#{prefix}#{value}#{suffix}"
+            'DIRECT' if value.upcase == 'DIRECT'
           end
 
           def prefix
-            "#{proto}://" if value !~ %r{^.*://}
+            "#{scheme}://" if value !~ %r{^.*://}
           end
 
           def suffix
-            ":#{default_port}" if value !~ %r{:\d+$} && value !~ %r{/}
-          end
-
-          def default_port
-            3142
+            ':3142' if value !~ %r{:\d+$} && value !~ %r{/}
           end
         end
       end

data/lib/vagrant-proxyconf/config/env_proxy.rb

@@ -27,8 +27,15 @@ module VagrantPlugins
 
         # (see KeyMixin#config_for)
         def config_for(key, value)
-          if value && !value.empty?
+          if value
             var = env_variable_name(key)
+
+            # Quote the `no_proxy` value in case there are spaces and special
+            # characters. Unfortunately we can't escape other values before
+            # v2.0 as even the README had an example of using shell variables
+            # still in v1.0.x.
+            value = value.inspect if key.name == :no_proxy
+
             [var.upcase, var.downcase].map { |v| "export #{v}=#{value}\n" }.join
           end
         end

data/lib/vagrant-proxyconf/config/key_mixin.rb

@@ -70,7 +70,7 @@ module VagrantPlugins
         # @param value [String, nil] the configuration value
         # @return [#to_s] the configuration line(s)
         def config_for(key, value)
-          "#{key}=#{value}\n"
+          "#{key}=#{value && value}\n"
         end
 
         # Returns a new instance of this class where all nil keys are
@@ -113,10 +113,11 @@ module VagrantPlugins
         private
 
         def resolve_value(key)
-          key.value_from_env_var do |default|
+          ret = key.value_from_env_var do |default|
             value = get(key)
             value == self.class::UNSET_VALUE ? default : value
           end
+          ret == '' ? false : ret
         end
       end
     end

data/lib/vagrant-proxyconf/config/proxy.rb

@@ -11,6 +11,9 @@ module VagrantPlugins
         include KeyMixin
         # @!parse extend KeyMixin::ClassMethods
 
+        # Defines the mode of the plugin
+        key :enabled, env_var: 'VAGRANT_PROXY'
+
         # @return [String] the HTTP proxy
         key :http, env_var: 'VAGRANT_HTTP_PROXY'
 

data/lib/vagrant-proxyconf/hook.rb

@@ -0,0 +1,41 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module ProxyConf
+    class Plugin < Vagrant.plugin('2')
+      # Actions to run before any provisioner or other plugin
+      action_hook 'proxyconf_configure' do |hook|
+        require_relative 'action'
+
+        # the standard provision action
+        hook.after Vagrant::Action::Builtin::Provision, Action.configure
+
+        # Vagrant 1.5+ can install NFS client
+        if check_vagrant_version('>= 1.5.0.dev')
+          hook.after Vagrant::Action::Builtin::SyncedFolders, Action.configure
+        end
+
+        # vagrant-aws < 0.4.0 uses a non-standard provision action
+        if defined?(VagrantPlugins::AWS::Action::TimedProvision)
+          hook.after VagrantPlugins::AWS::Action::TimedProvision, Action.configure
+        end
+
+        # configure the proxies before vagrant-omnibus
+        if defined?(VagrantPlugins::Omnibus::Action::InstallChef)
+          hook.after VagrantPlugins::Omnibus::Action::InstallChef, Action.configure
+        end
+
+        # configure the proxies before vagrant-vbguest
+        if defined?(VagrantVbguest::Middleware)
+          hook.before VagrantVbguest::Middleware, Action.configure(before: true)
+        end
+      end
+
+      # Actions to run after each provisioner run
+      action_hook 'proxyconf_configure', :provisioner_run do |hook|
+        require_relative 'action'
+        hook.after :run_provisioner, Action.configure_after_provisoner
+      end
+    end
+  end
+end

data/lib/vagrant-proxyconf/plugin.rb

@@ -1,4 +1,5 @@
 require 'vagrant'
+require_relative 'logger'
 
 module VagrantPlugins
   module ProxyConf
@@ -6,19 +7,30 @@ module VagrantPlugins
     #
     # @!parse class Plugin < Vagrant::Plugin::V2::Plugin; end
     class Plugin < Vagrant.plugin('2')
-      # The minimum compatible Vagrant version
-      MIN_VAGRANT_VERSION = '1.2.0'
+      # Compatible Vagrant versions
+      VAGRANT_VERSION_REQUIREMENT = '>= 1.2.0'
 
       # A list of plugins whose action classes we hook to if installed
       OPTIONAL_PLUGIN_DEPENDENCIES = %w[vagrant-aws vagrant-omnibus vagrant-vbguest]
 
+      # Returns true if the Vagrant version fulfills the requirements
+      #
+      # @param requirements [String, Array<String>] the version requirement
+      # @return [Boolean]
+      def self.check_vagrant_version(*requirements)
+        Gem::Requirement.new(*requirements).satisfied_by?(
+          Gem::Version.new(Vagrant::VERSION))
+      end
+
       # Verifies that the Vagrant version fulfills the requirements
       #
       # @raise [VagrantPlugins::ProxyConf::VagrantVersionError] if this plugin
       # is incompatible with the Vagrant version
       def self.check_vagrant_version!
-        if Gem::Version.new(Vagrant::VERSION) < Gem::Version.new(MIN_VAGRANT_VERSION)
-          msg = I18n.t('vagrant_proxyconf.errors.vagrant_version', min_version: MIN_VAGRANT_VERSION)
+        if !check_vagrant_version(VAGRANT_VERSION_REQUIREMENT)
+          msg = I18n.t(
+            'vagrant_proxyconf.errors.vagrant_version',
+            requirement: VAGRANT_VERSION_REQUIREMENT.inspect)
           $stderr.puts msg
           raise msg
         end
@@ -31,19 +43,36 @@ module VagrantPlugins
       end
 
       # Ensures a dependent plugin is loaded before us if it is installed.
-      # Ignores {Vagrant::Errors::PluginLoadError} but passes other exceptions.
+      # Ignores Errors while loading, as Vagrant itself anyway shows them to
+      # used when *it* tries to load the plugin.
       #
       # @param plugin [String] the plugin name
       def self.load_optional_dependency(plugin)
-        begin
-          Vagrant.require_plugin plugin
-        rescue Vagrant::Errors::PluginLoadError; end
+        logger = ProxyConf.logger
+        logger.info "Trying to load #{plugin}"
+
+        if check_vagrant_version('< 1.5.0.dev')
+          begin
+            Vagrant.require_plugin plugin
+          rescue Vagrant::Errors::PluginLoadError
+            logger.info "Ignoring the load error of #{plugin}"
+          end
+        else
+          begin
+            require plugin
+          rescue Exception => e
+            logger.info "Failed to load #{plugin}: #{e.inspect}"
+            logger.info "Ignoring the error"
+          end
+        end
       end
 
       # Loads the plugins to ensure their action hooks are registered before us.
       # Uses alphabetical order to not change the default behaviour otherwise.
       def self.load_optional_dependencies
-        OPTIONAL_PLUGIN_DEPENDENCIES.sort.each { |plugin| load_optional_dependency plugin }
+        OPTIONAL_PLUGIN_DEPENDENCIES.sort.each do |plugin|
+          load_optional_dependency plugin
+        end
       end
 
       setup_i18n
@@ -51,67 +80,10 @@ module VagrantPlugins
       load_optional_dependencies
 
       name 'vagrant-proxyconf'
-
-      config 'apt_proxy' do
-        require_relative 'config/apt_proxy'
-        Config::AptProxy
-      end
-
-      config 'env_proxy' do
-        require_relative 'config/env_proxy'
-        Config::EnvProxy
-      end
-
-      config 'proxy' do
-        require_relative 'config/proxy'
-        Config::Proxy
-      end
-
-      config 'yum_proxy' do
-        require_relative 'config/yum_proxy'
-        Config::YumProxy
-      end
-
-      guest_capability 'debian', 'apt_proxy_conf' do
-        require_relative 'cap/debian/apt_proxy_conf'
-        Cap::Debian::AptProxyConf
-      end
-
-      guest_capability 'linux', 'env_proxy_conf' do
-        require_relative 'cap/linux/env_proxy_conf'
-        Cap::Linux::EnvProxyConf
-      end
-
-      guest_capability 'coreos', 'env_proxy_conf' do
-        # disabled on CoreOS
-      end
-
-      guest_capability 'redhat', 'yum_proxy_conf' do
-        require_relative 'cap/redhat/yum_proxy_conf'
-        Cap::Redhat::YumProxyConf
-      end
-
-      action_hook 'proxyconf_configure' do |hook|
-        require_relative 'action'
-
-        # the standard provision action
-        hook.after Vagrant::Action::Builtin::Provision, Action.configure
-
-        # vagrant-aws < 0.4.0 uses a non-standard provision action
-        if defined?(VagrantPlugins::AWS::Action::TimedProvision)
-          hook.after VagrantPlugins::AWS::Action::TimedProvision, Action.configure
-        end
-
-        # configure the proxies before vagrant-omnibus
-        if defined?(VagrantPlugins::Omnibus::Action::InstallChef)
-          hook.after VagrantPlugins::Omnibus::Action::InstallChef, Action.configure
-        end
-
-        # configure the proxies before vagrant-vbguest
-        if defined?(VagrantVbguest::Middleware)
-          hook.before VagrantVbguest::Middleware, Action.configure(before: true)
-        end
-      end
     end
   end
 end
+
+require_relative "capability"
+require_relative "config"
+require_relative "hook"