vagrant-proxyconf 0.5.0 → 0.5.1

data/.yardopts

@@ -1,5 +1,7 @@
 --no-private
 --protected
+lib/vagrant-proxyconf/config/key_mixin.rb
+lib/**/*.rb
 -
 CHANGELOG.md
 LICENSE.txt

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.5.1 / 2013-09-17
+
+- Configure sudo to preserve the `*_proxy` environment variables ([GH-23][], [GH-25][])
+    * Requires that sudo in VM is configured to support "sudoers.d", i.e. _/etc/sudoers_ contains line `#includedir /etc/sudoers.d`
+- Fix Chef provisioner configuration if a proxy is set to `false` ([GH-24][])
+- Create the directories for configuration files if they don't exist ([GH-25][])
+
 # 0.5.0 / 2013-09-11
 
 - Set default proxy configuration for all Chef provisioners ([GH-19][], [GH-21][])
@@ -51,3 +58,6 @@
 [GH-17]: https://github.com/tmatilai/vagrant-proxyconf/issues/17 "Issue 17"
 [GH-19]: https://github.com/tmatilai/vagrant-proxyconf/issues/19 "Issue 19"
 [GH-21]: https://github.com/tmatilai/vagrant-proxyconf/issues/21 "Issue 21"
+[GH-23]: https://github.com/tmatilai/vagrant-proxyconf/issues/23 "Issue 23"
+[GH-24]: https://github.com/tmatilai/vagrant-proxyconf/issues/24 "Issue 24"
+[GH-25]: https://github.com/tmatilai/vagrant-proxyconf/issues/25 "Issue 25"

data/README.md

@@ -12,15 +12,32 @@
 [gemnasium]: https://gemnasium.com/tmatilai/vagrant-proxyconf
 [codeclimate]: https://codeclimate.com/github/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, or you have a caching proxy.
+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.
 
 At this state we support:
 
-* Generic `*_proxy` environment variables that many programs support
+* Generic `http_proxy` etc. environment variables that many programs support
 * APT proxy/cacher
 * Setting default proxy configuration for all Chef provisioners
 
-Support is planned for other package managers (at least yum).
+## Quick start
+
+Install the plugin:
+
+```sh
+vagrant plugin install vagrant-proxyconf
+```
+
+To configure all possible software on all Vagrant VMs, add the following to _$HOME/.vagrant.d/Vagrantfile_ (or to a project specific _Vagrantfile_):
+
+```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"
+  # ... other stuff
+end
+```
 
 ## Compatibility
 
@@ -35,18 +52,10 @@ The following providers are confirmed to work:
 
 For the proxy configuration to take effect for [vagrant-omnibus](https://github.com/schisamo/vagrant-omnibus) plugin, version 1.1.1 or newer of it should be used.
 
-## Installation
-
-Install using standard Vagrant plugin installation method:
-
-```sh
-vagrant plugin install vagrant-proxyconf
-```
-
-See the [wiki](https://github.com/tmatilai/vagrant-proxyconf/wiki) for instructions to install a pre-release version.
-
 ## Usage
 
+Install using standard Vagrant plugin installation method: `vagrant plugin install vagrant-proxyconf`. See the [wiki](https://github.com/tmatilai/vagrant-proxyconf/wiki) for instructions to install a pre-release version.
+
 The plugin hooks itself to all Vagrant commands triggering provisioning (e.g. `vagrant up`, `vagrant provision`, etc.). The proxy configurations are written just before provisioners are run.
 
 Proxy settings can be configured in Vagrantfile. In the common case that you want to use the same configuration in all Vagrant machines, you can use _$HOME/.vagrant.d/Vagrantfile_ or environment variables. Platform specific settings are only used on virtual machines that support them (i.e. Apt configuration on Debian based systems), so there is no harm using global configuration.
@@ -100,6 +109,8 @@ VAGRANT_HTTP_PROXY="http://proxy.example.com:8080" vagrant up
 
 Many programs (wget, curl, yum, etc.) can be configured to use proxies with `<protocol>_proxy` or `<PROTOCOL>_PROXY` environment variables. This configuration will be written to _/etc/profile.d/proxy.sh_ on the guest.
 
+Also sudo will be configured to preserve the variables. This requires that sudo in the VM is configured to support "sudoers.d", i.e. _/etc/sudoers_ contains line `#includedir /etc/sudoers.d`.
+
 #### Example Vagrantfile
 
 ```ruby

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

@@ -26,7 +26,7 @@ module VagrantPlugins
             env[:ui].info I18n.t("vagrant_proxyconf.#{config_name}.not_supported")
           else
             env[:ui].info I18n.t("vagrant_proxyconf.#{config_name}.configuring")
-            write_config(machine, config)
+            configure_machine(machine, config)
           end
         end
 
@@ -39,7 +39,7 @@ module VagrantPlugins
 
         # @return [Vagrant::Plugin::V2::Config] the configuration
         def config(machine)
-          config = machine.config.send(config_name.to_sym)
+          config = machine.config.public_send(config_name.to_sym)
           finalize_config(config)
           config.merge_defaults(default_config(machine))
         end
@@ -58,8 +58,19 @@ module VagrantPlugins
           config
         end
 
-        def write_config(machine, config)
-          logger.debug "Configuration:\n#{config}"
+        # Configures the VM based on the config
+        def configure_machine(machine, config)
+          write_config(machine, config)
+        end
+
+        # Writes the config to the VM
+        #
+        # @param opts [Hash] optional file options
+        # @option opts [String] :path (#config_path) the path of the configuration file
+        # @option opts [String] :mode the mode of the file
+        def write_config(machine, config, opts = {})
+          path = opts[:path] || config_path(machine)
+          logger.debug "Configuration (#{path}):\n#{config}"
 
           temp = Tempfile.new("vagrant")
           temp.binmode
@@ -68,7 +79,9 @@ module VagrantPlugins
 
           machine.communicate.tap do |comm|
             comm.upload(temp.path, "/tmp/vagrant-proxyconf")
-            comm.sudo("cat /tmp/vagrant-proxyconf > #{config_path(machine)}")
+            comm.sudo("mkdir -p #{File.dirname(path)}")
+            comm.sudo("cat /tmp/vagrant-proxyconf > #{path}")
+            comm.sudo("chmod #{opts[:mode]} #{path}") if opts[:mode]
             comm.sudo("rm /tmp/vagrant-proxyconf")
           end
         end

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

@@ -52,17 +52,17 @@ module VagrantPlugins
         # @param chef [VagrantPlugins::Chef::Config::Base] the Chef provisioner configuration
         # @param config [Config::Proxy] the default configuration
         def configure_chef(chef, config)
-          if chef.http_proxy.nil?
+          if !chef.http_proxy && config.http
             chef.http_proxy      = config.http
             chef.http_proxy_user = config.http_user
             chef.http_proxy_pass = config.http_pass
           end
-          if chef.https_proxy.nil?
+          if !chef.https_proxy && config.https
             chef.https_proxy      = config.https
             chef.https_proxy_user = config.https_user
             chef.https_proxy_pass = config.https_pass
           end
-          if chef.no_proxy.nil?
+          if !chef.no_proxy && config.no_proxy
             chef.no_proxy = config.no_proxy
           end
         end

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

@@ -8,6 +8,20 @@ module VagrantPlugins
         def config_name
           'env_proxy'
         end
+
+        private
+
+        def configure_machine(machine, config)
+          super
+          write_config(machine, sudo_config, path: '/etc/sudoers.d/proxy', mode: '0440')
+        end
+
+        def sudo_config
+          <<-CONFIG.gsub(/^\s+/, '')
+            Defaults env_keep += "HTTP_PROXY HTTPS_PROXY FTP_PROXY NO_PROXY"
+            Defaults env_keep += "http_proxy https_proxy ftp_proxy no_proxy"
+          CONFIG
+        end
       end
     end
   end

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

@@ -11,15 +11,12 @@ module VagrantPlugins
         include KeyMixin
         # @!parse extend KeyMixin::ClassMethods
 
-        # @!attribute
         # @return [String] the HTTP proxy
         key :http, env_var: 'VAGRANT_APT_HTTP_PROXY'
 
-        # @!attribute
         # @return [String] the HTTPS proxy
         key :https, env_var: 'VAGRANT_APT_HTTPS_PROXY'
 
-        # @!attribute
         # @return [String] the FTP proxy
         key :ftp, env_var: 'VAGRANT_APT_FTP_PROXY'
 

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

@@ -11,19 +11,15 @@ module VagrantPlugins
         include KeyMixin
         # @!parse extend KeyMixin::ClassMethods
 
-        # @!attribute
         # @return [String] the HTTP proxy
         key :http, env_var: 'VAGRANT_ENV_HTTP_PROXY'
 
-        # @!attribute
         # @return [String] the HTTPS proxy
         key :https, env_var: 'VAGRANT_ENV_HTTPS_PROXY'
 
-        # @!attribute
         # @return [String] the FTP proxy
         key :ftp, env_var: 'VAGRANT_ENV_FTP_PROXY'
 
-        # @!attribute
         # @return [String] a comma separated list of hosts or domains which do not use proxies
         key :no_proxy, env_var: 'VAGRANT_ENV_NO_PROXY'
 

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

@@ -21,6 +21,8 @@ module VagrantPlugins
           # Creates `attr_accessor` for the key name and adds a {Key} to {#keys}.
           # @param (see Key#initialize)
           # @option (see Key#initialize)
+          # @!macro [attach] key
+          #   @!attribute
           def key(name, opts = {})
             self.class_eval { attr_accessor name }
             keys << Key.new(name, opts)
@@ -97,7 +99,7 @@ module VagrantPlugins
         end
 
         def get(key)
-          send(key.name)
+          public_send(key.name)
         end
 
         def set?(key)
@@ -105,7 +107,7 @@ module VagrantPlugins
         end
 
         def set(key, value)
-          send(:"#{key.name}=", value)
+          public_send(:"#{key.name}=", value)
         end
 
         private

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

@@ -12,19 +12,15 @@ module VagrantPlugins
         include KeyMixin
         # @!parse extend KeyMixin::ClassMethods
 
-        # @!attribute
         # @return [String] the HTTP proxy
         key :http, env_var: 'VAGRANT_HTTP_PROXY'
 
-        # @!attribute
         # @return [String] the HTTPS proxy
         key :https, env_var: 'VAGRANT_HTTPS_PROXY'
 
-        # @!attribute
         # @return [String] the FTP proxy
         key :ftp, env_var: 'VAGRANT_FTP_PROXY'
 
-        # @!attribute
         # @return [String] a comma separated list of hosts or domains which do not use proxies
         key :no_proxy, env_var: 'VAGRANT_NO_PROXY'
 
@@ -51,11 +47,11 @@ module VagrantPlugins
         private
 
         def user(uri)
-          URI.parse(uri).user if !uri.nil?
+          URI.parse(uri).user if uri
         end
 
         def pass(uri)
-          URI.parse(uri).password if !uri.nil?
+          URI.parse(uri).password if uri
         end
       end
     end

data/lib/vagrant-proxyconf/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module ProxyConf
-    VERSION = '0.5.0'
+    VERSION = '0.5.1'
   end
 end

data/spec/unit/support/shared/apt_proxy_config.rb

@@ -1,6 +1,6 @@
 def config_with(options)
   instance.tap do |c|
-    options.each_pair { |k, v| c.send("#{k}=".to_sym, v) }
+    options.each_pair { |k, v| c.public_send("#{k}=".to_sym, v) }
     c.finalize!
   end
 end

data/spec/unit/vagrant-proxyconf/action/configure_chef_proxy_spec.rb

@@ -29,6 +29,7 @@ describe VagrantPlugins::ProxyConf::Action::ConfigureChefProxy do
       before :each do
         config.http      = 'http://foo:1234'
         config.http_user = 'bar'
+        config.https     = false
 
         configure_chef
       end
@@ -37,6 +38,9 @@ describe VagrantPlugins::ProxyConf::Action::ConfigureChefProxy do
         expect(chef.http_proxy).to  eq 'http://foo:1234'
         expect(chef.http_proxy_user).to eq 'bar'
         expect(chef.http_proxy_pass).to be_nil
+        expect(chef.https_proxy).to be_nil
+        expect(chef.https_proxy_user).to be_nil
+        expect(chef.https_proxy_pass).to be_nil
       end
     end
 
@@ -47,6 +51,7 @@ describe VagrantPlugins::ProxyConf::Action::ConfigureChefProxy do
 
         config.http      = 'http://default:7070/'
         config.http_user = 'foo'
+        config.http_pass = false
         config.https     = 'http://sslproxy:3128/'
 
         configure_chef

data/spec/unit/vagrant-proxyconf/config/env_proxy_spec.rb

@@ -3,7 +3,7 @@ require 'vagrant-proxyconf/config/env_proxy'
 
 def config_with(options)
   instance.tap do |c|
-    options.each_pair { |k, v| c.send("#{k}=".to_sym, v) }
+    options.each_pair { |k, v| c.public_send("#{k}=".to_sym, v) }
     c.finalize!
   end
 end

data/spec/unit/vagrant-proxyconf/config/proxy_spec.rb

@@ -54,4 +54,14 @@ describe VagrantPlugins::ProxyConf::Config::Proxy do
     its(:https_user) { should eq '' }
     its(:https_pass) { should eq 'baz' }
   end
+
+  context "with false" do
+    let(:http_proxy)  { false }
+    let(:https_proxy) { false }
+
+    its(:http_user)  { should be_nil }
+    its(:http_pass)  { should be_nil }
+    its(:https_user) { should be_nil }
+    its(:https_pass) { should be_nil }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-proxyconf
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-09-17 00:00:00.000000000 Z
 dependencies: []
 description: A Vagrant plugin that configures the virtual machine to use proxies
 email:
@@ -74,7 +74,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2294529706068279185
+      hash: -968959479372815338
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2294529706068279185
+      hash: -968959479372815338
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23