vagrant-proxyconf 1.0.1 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ccc0113cc7339765e4d71dc0a34b5c4ea9bbf29b
+  data.tar.gz: 820756398111a78c3e13eaf1412c5e2dc394657c
+SHA512:
+  metadata.gz: cfe68c260b981d6e806c9fd0b49ce502cadac5938697903f634c14b4d85d7d0682e09abd587344e4848ab756dae78475fe72e7e289ab11243f655652ecc1f1c3
+  data.tar.gz: f0add4636c11c68fc4b264fd0454113be6091baa0f5581d32cd3b84eb7b4830b217bef0c8e3d03078ae174b40af55550bbf443546af1b866aef222ac8d5a80cf

data/.gitignore

@@ -2,5 +2,5 @@
 /.yardoc
 /Gemfile.lock
 /doc
-/pkg
 /tmp
+vagrant-proxyconf-*.gem

data/.travis.yml

@@ -1,4 +1,18 @@
 language: ruby
+
+before_install: gem install bundler --version '>= 1.5.2'
 bundler_args: --without=development
+
 rvm:
-  - 1.9.3
+  - 2.0.0
+env:
+  - VAGRANT_VERSION=v1.4.3
+matrix:
+  include:
+    - env: VAGRANT_VERSION=v1.3.5
+      rvm: 1.9.3
+    - env: VAGRANT_VERSION=v1.2.7
+      rvm: 1.9.3
+    - env: VAGRANT_VERSION=master
+  allow_failures:
+    - env: VAGRANT_VERSION=master

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+# 1.1.0 / 2014-02-06
+
+Features:
+
+  - Add `config.proxy.enabled` option which can be set to `false` to disable the plugin ([GH-39][])
+  - Support for configuring PEAR ([GH-34][])
+
+Improvements:
+
+  - Compatibility with Vagrant v1.5:
+    * `Vagrant.require_plugin` deprecated ([GH-44][])
+    * Hook before `SyncedFolders` action as it can install NFS client ([GH-45][])
+    * Vagrant 1.5.0 is not released at the time of this release, so compatibility can't be guaranteed yet
+  - Run Travis tests against all supported Vagrant minor versions with correct Ruby version
+  - Decrease noise level, don't print messages when configuring something
+
+Bug fixes:
+
+  - Quote `no_proxy` in _/etc/profile.d/proxy.sh_ to protect it from spaces ([GH-42][])
+
 # 1.0.1 / 2013-12-01
 
 - Ensure that Yum configuration includes the (default) port ([GH-36][])
@@ -94,5 +114,10 @@
 [GH-29]: https://github.com/tmatilai/vagrant-proxyconf/issues/29 "Issue 29"
 [GH-30]: https://github.com/tmatilai/vagrant-proxyconf/issues/30 "Issue 30"
 [GH-32]: https://github.com/tmatilai/vagrant-proxyconf/issues/32 "Issue 32"
+[GH-34]: https://github.com/tmatilai/vagrant-proxyconf/issues/34 "Issue 34"
 [GH-35]: https://github.com/tmatilai/vagrant-proxyconf/issues/35 "Issue 35"
 [GH-36]: https://github.com/tmatilai/vagrant-proxyconf/issues/36 "Issue 36"
+[GH-39]: https://github.com/tmatilai/vagrant-proxyconf/issues/39 "Issue 39"
+[GH-42]: https://github.com/tmatilai/vagrant-proxyconf/issues/42 "Issue 42"
+[GH-44]: https://github.com/tmatilai/vagrant-proxyconf/issues/44 "Issue 44"
+[GH-45]: https://github.com/tmatilai/vagrant-proxyconf/issues/45 "Issue 45"

data/Gemfile

@@ -2,12 +2,15 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'vagrant',
+  github: 'mitchellh/vagrant',
+  ref: ENV.fetch('VAGRANT_VERSION', 'v1.4.3')
+
 gem 'cane', '~> 2.6'
+gem 'coveralls', require: false
 gem 'rake'
 gem 'rspec', '~> 2.11'
-gem 'simplecov', '~> 0.7', :require => false
-gem 'tailor', '~> 1.2'
-gem 'vagrant', github: 'mitchellh/vagrant', ref: 'v1.3.5'
+gem 'tailor', '~> 1.4'
 
 group :development do
   gem 'guard-rspec'

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2013 Teemu Matilainen <teemu.matilainen@iki.fi>
+Copyright (c) 2013-2014 Teemu Matilainen <teemu.matilainen@iki.fi>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -5,12 +5,14 @@
 [![Build Status](https://travis-ci.org/tmatilai/vagrant-proxyconf.png?branch=master)][travis]
 [![Dependency Status](https://gemnasium.com/tmatilai/vagrant-proxyconf.png)][gemnasium]
 [![Code Climate](https://codeclimate.com/github/tmatilai/vagrant-proxyconf.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/tmatilai/vagrant-proxyconf/badge.png)][coveralls]
 </span>
 
 [gem]: https://rubygems.org/gems/vagrant-proxyconf
 [travis]: https://travis-ci.org/tmatilai/vagrant-proxyconf
 [gemnasium]: https://gemnasium.com/tmatilai/vagrant-proxyconf
 [codeclimate]: https://codeclimate.com/github/tmatilai/vagrant-proxyconf
+[coveralls]: https://coveralls.io/r/tmatilai/vagrant-proxyconf
 
 A [Vagrant](http://www.vagrantup.com/) plugin that configures the virtual machine to use specified proxies. This is useful for example in case you are behind a corporate proxy server, or you have a caching proxy (for example [polipo](https://github.com/tmatilai/polipo-box)).
 
@@ -20,6 +22,7 @@ The plugin can set:
 * default proxy configuration for all Chef provisioners
 * proxy configuration for Apt
 * proxy configuration for Yum
+* proxy configuration for PEAR
 
 ## Quick start
 
@@ -33,9 +36,11 @@ To configure all possible software on all Vagrant VMs, add the following to _$HO
 
 ```ruby
 Vagrant.configure("2") do |config|
-  config.proxy.http     = "http://192.168.0.2:3128/"
-  config.proxy.https    = "http://192.168.0.2:3128/"
-  config.proxy.no_proxy = "localhost,127.0.0.1,.example.com"
+  if Vagrant.has_plugin?("vagrant-proxyconf")
+    config.proxy.http     = "http://192.168.0.2:3128/"
+    config.proxy.https    = "http://192.168.0.2:3128/"
+    config.proxy.no_proxy = "localhost,127.0.0.1,.example.com"
+  end
   # ... other stuff
 end
 ```
@@ -62,6 +67,8 @@ Proxy settings can be configured in Vagrantfile. In the common case that you wan
 
 Project specific Vagrantfile overrides global settings. Environment variables override both.
 
+It is a good practise to wrap plugin specific configuration with `Vagrant.has_plugin?` checks so the user's Vagrantfiles do not break if plugin is uninstalled or Vagrantfile shared with people not having the plugin installed. (For Vagrant 1.2 you have to use `if defined?(VagrantPlugins::ProxyConf)` instead.)
+
 ### Default/global configuration
 
 It's a common case that you want all possible connections to pass through the same proxy. This will set the default values for all other proxy configuration keys. It also sets default proxy configuration for all Chef Solo and Chef Client provisioners.
@@ -70,9 +77,11 @@ It's a common case that you want all possible connections to pass through the sa
 
 ```ruby
 Vagrant.configure("2") do |config|
-  config.proxy.http     = "http://192.168.0.2:3128/"
-  config.proxy.https    = "http://192.168.0.2:3128/"
-  config.proxy.no_proxy = "localhost,127.0.0.1,.example.com"
+  if Vagrant.has_plugin?("vagrant-proxyconf")
+    config.proxy.http     = "http://192.168.0.2:3128/"
+    config.proxy.https    = "http://192.168.0.2:3128/"
+    config.proxy.no_proxy = "localhost,127.0.0.1,.example.com"
+  end
   # ... other stuff
 end
 ```
@@ -105,6 +114,23 @@ For example to spin up a VM, run:
 VAGRANT_HTTP_PROXY="http://proxy.example.com:8080" vagrant up
 ```
 
+### Disabling the plugin
+
+The plugin can be totally skipped by setting `config.proxy.enabled` to `false` or empty string (`""`). This can be useful to for example disable it for some provider.
+
+#### Example Vagrantfile
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.proxy.http = "http://192.168.0.2:3128/"
+
+  config.vm.provider :my_cloud do |cloud, override|
+    override.proxy.enabled = false
+  end
+  # ... other stuff
+end
+```
+
 ### Global `*_proxy` environment variables
 
 Many programs (wget, curl, yum, etc.) can be configured to use proxies with `http_proxy` or `HTTP_PROXY` etc. environment variables. This configuration will be written to _/etc/profile.d/proxy.sh_ on the guest.
@@ -116,7 +142,7 @@ Also sudo will be configured to preserve the variables. This requires that sudo
 ```ruby
 Vagrant.configure("2") do |config|
   config.env_proxy.http     = "http://192.168.33.200:8888/"
-  config.env_proxy.https    = "$http_proxy"
+  config.env_proxy.https    = "http://192.168.33.200:8888/"
   config.env_proxy.no_proxy = "localhost,127.0.0.1,.example.com"
   # ... other stuff
 end
@@ -174,7 +200,7 @@ end
 #### Possible values
 
 * If all keys are unset or `nil`, no configuration is written or modified.
-* A proxy can be specified in the form of _[http://][user:pass@]host[:port]_. So all but the _host_ part are optional. The default port is 3142 and scheme is the same as the key.
+* A proxy can be specified in the form of _http://[user:pass@]host:port_.
 * Empty string (`""`) or `false` in any key also force the configuration file to be written, but without configuration for that scheme. Can be used to clear the old configuration and/or override a global setting.
 * `"DIRECT"` can be used to specify that no proxy should be used. This is mostly useful for disabling proxy for HTTPS URIs when HTTP proxy is set (as Apt defaults to the latter).
 * Please refer to [apt.conf(5)](http://manpages.debian.net/man/5/apt.conf) manual for more information.

data/Rakefile

@@ -19,10 +19,12 @@ task :spec => :test
 
 Tailor::RakeTask.new do |task|
   task.file_set('lib/**/*.rb', 'code') do |style|
+    style.allow_unnecessary_double_quotes false, level: :off
     style.max_line_length 100, level: :warn
     style.max_line_length 140, level: :error
   end
   task.file_set('spec/**/*.rb', 'tests') do |style|
+    style.allow_unnecessary_double_quotes false, level: :off
     style.max_line_length 120, level: :warn
     # allow vertical alignment of `let(:foo) { block }` blocks
     style.spaces_before_lbrace 1, level: :off

data/lib/vagrant-proxyconf/action.rb

@@ -1,13 +1,19 @@
+require 'vagrant/action/builtin/call'
 require_relative 'action/configure_apt_proxy'
 require_relative 'action/configure_chef_proxy'
 require_relative 'action/configure_env_proxy'
+require_relative 'action/configure_pear_proxy'
 require_relative 'action/configure_yum_proxy'
+require_relative 'action/is_enabled'
 require_relative 'action/only_once'
 
 module VagrantPlugins
   module ProxyConf
     # Middleware stack builders
     class Action
+      # Shortcut
+      Builtin = Vagrant::Action::Builtin
+
       # Returns an action middleware stack that configures the VM
       #
       # @param opts [Hash] the options to be passed to {OnlyOnce}
@@ -16,16 +22,33 @@ module VagrantPlugins
         Vagrant::Action::Builder.build(OnlyOnce, opts, &config_actions)
       end
 
+      # Returns an action middleware stack that configures the VM
+      # after provisioner runs.
+      def self.configure_after_provisoner
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Builtin::Call, IsEnabled do |env, b2|
+            next if !env[:result]
+
+            b2.use ConfigurePearProxy
+          end
+        end
+      end
+
       private
 
       # @return [Proc] the block that adds config actions to the specified
       #   middleware builder
       def self.config_actions
-        @actions ||= Proc.new do |builder|
-          builder.use ConfigureAptProxy
-          builder.use ConfigureChefProxy
-          builder.use ConfigureEnvProxy
-          builder.use ConfigureYumProxy
+        @config_actions ||= Proc.new do |b|
+          b.use Builtin::Call, IsEnabled do |env, b2|
+            next if !env[:result]
+
+            b2.use ConfigureAptProxy
+            b2.use ConfigureChefProxy
+            b2.use ConfigureEnvProxy
+            b2.use ConfigurePearProxy
+            b2.use ConfigureYumProxy
+          end
         end
       end
     end

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

@@ -12,16 +12,15 @@ module VagrantPlugins
         end
 
         def call(env)
-          machine = env[:machine]
-          config  = config(machine)
+          @machine = env[:machine]
 
           if !config.enabled?
             logger.info I18n.t("vagrant_proxyconf.#{config_name}.not_enabled")
-          elsif !supported?(machine)
-            env[:ui].info I18n.t("vagrant_proxyconf.#{config_name}.not_supported")
+          elsif !supported?
+            logger.info I18n.t("vagrant_proxyconf.#{config_name}.not_supported")
           else
             env[:ui].info I18n.t("vagrant_proxyconf.#{config_name}.configuring")
-            configure_machine(machine, config)
+            configure_machine
           end
 
           @app.call env
@@ -40,15 +39,17 @@ module VagrantPlugins
         end
 
         # @return [Vagrant::Plugin::V2::Config] the configuration
-        def config(machine)
-          config = machine.config.public_send(config_name.to_sym)
+        def config
+          return @config if @config
+
+          config = @machine.config.public_send(config_name.to_sym)
           finalize_config(config)
-          config.merge_defaults(default_config(machine))
+          @config = config.merge_defaults(default_config)
         end
 
         # @return [Vagrant::Plugin::V2::Config] the default configuration
-        def default_config(machine)
-          config = machine.config.proxy
+        def default_config
+          config = @machine.config.proxy
           finalize_config(config)
         end
 
@@ -61,8 +62,8 @@ module VagrantPlugins
         end
 
         # Configures the VM based on the config
-        def configure_machine(machine, config)
-          write_config(machine, config)
+        def configure_machine
+          write_config(config)
         end
 
         # Writes the config to the VM
@@ -71,13 +72,13 @@ module VagrantPlugins
         # @option opts [String] :path (#config_path) the path of the configuration file
         # @option opts [String] :mode ("0644") the mode of the file
         # @option opts [String] :owner ("root:root") the owner (and group) of the file
-        def write_config(machine, config, opts = {})
+        def write_config(config, opts = {})
           tmp = "/tmp/vagrant-proxyconf"
-          path = opts[:path] || config_path(machine)
+          path = opts[:path] || config_path
           local_tmp = tempfile(config)
 
           logger.debug "Configuration (#{path}):\n#{config}"
-          machine.communicate.tap do |comm|
+          @machine.communicate.tap do |comm|
             comm.sudo("rm #{tmp}", error_check: false)
             comm.upload(local_tmp.path, tmp)
             comm.sudo("chmod #{opts[:mode] || '0644'} #{tmp}")
@@ -87,6 +88,11 @@ module VagrantPlugins
           end
         end
 
+        # @param value [String, nil] the string to escape for shell usage
+        def escape(value)
+          value.to_s.shellescape
+        end
+
         # @return [Tempfile] a temporary file with the specified content
         def tempfile(content)
           Tempfile.new("vagrant").tap do |temp|
@@ -100,12 +106,13 @@ module VagrantPlugins
           "#{config_name}_conf".to_sym
         end
 
-        def supported?(machine)
-          machine.guest.capability?(cap_name)
+        def supported?
+          @machine.guest.capability?(cap_name) &&
+            @machine.guest.capability(cap_name)
         end
 
-        def config_path(machine)
-          machine.guest.capability(cap_name)
+        def config_path
+          @machine.guest.capability(cap_name)
         end
       end
     end

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

@@ -11,16 +11,15 @@ module VagrantPlugins
         end
 
         def call(env)
-          machine = env[:machine]
-          config  = config(machine)
+          @machine = env[:machine]
 
-          if chef_provisioners(machine).empty?
+          if chef_provisioners.empty?
             logger.info I18n.t("vagrant_proxyconf.chef_proxy.no_provisioners")
           elsif !config.enabled?
             logger.info I18n.t("vagrant_proxyconf.chef_proxy.not_enabled")
           else
             env[:ui].info I18n.t("vagrant_proxyconf.chef_proxy.configuring")
-            configure_chef_provisioners(machine, config)
+            configure_chef_provisioners
           end
 
           @app.call env
@@ -34,29 +33,30 @@ module VagrantPlugins
         end
 
         # @return [Config::Proxy] the `config.proxy` configuration
-        def config(machine)
-          config = machine.config.proxy
+        def config
+          return @config if @config
+
+          config = @machine.config.proxy
           config.finalize! if Gem::Version.new(Vagrant::VERSION) < Gem::Version.new('1.2.5')
-          config
+          @config = config
         end
 
         # @return [Array] all Chef provisioners
-        def chef_provisioners(machine)
-          machine.config.vm.provisioners.select { |prov| [:chef_solo, :chef_client].include?(prov.name) }
+        def chef_provisioners
+          @machine.config.vm.provisioners.select do |prov|
+            [:chef_solo, :chef_client].include?(prov.name)
+          end
         end
 
         # Configures all Chef provisioner based on the default config
-        #
-        # @param config [Config::Proxy] the default configuration
-        def configure_chef_provisioners(machine, config)
-          chef_provisioners(machine).each { |prov| configure_chef(prov.config, config) }
+        def configure_chef_provisioners
+          chef_provisioners.each { |prov| configure_chef(prov.config) }
         end
 
         # Configures proxies for a Chef provisioner if they are not set
         #
         # @param chef [VagrantPlugins::Chef::Config::Base] the Chef provisioner configuration
-        # @param config [Config::Proxy] the default configuration
-        def configure_chef(chef, config)
+        def configure_chef(chef)
           configure_chef_proxy(chef, 'http', config.http)
           configure_chef_proxy(chef, 'https', config.https)
           chef.no_proxy ||= config.no_proxy if config.no_proxy

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

@@ -11,9 +11,9 @@ module VagrantPlugins
 
         private
 
-        def configure_machine(machine, config)
+        def configure_machine
           super
-          write_config(machine, sudo_config, path: '/etc/sudoers.d/proxy', mode: '0440')
+          write_config(sudo_config, path: '/etc/sudoers.d/proxy', mode: '0440')
         end
 
         def sudo_config