vagrant-proxyconf 0.4.0 → 0.5.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.5.0 / 2013-09-11
+
+- Set default proxy configuration for all Chef provisioners ([GH-19][], [GH-21][])
+
 # 0.4.0 / 2013-09-04
 
 - BREAKING: Environment variables for Apt config renamed to `VAGRANT_APT_HTTP_PROXY` etc. ([GH-15][])
@@ -45,3 +49,5 @@
 [GH-14]: https://github.com/tmatilai/vagrant-proxyconf/issues/14 "Issue 14"
 [GH-15]: https://github.com/tmatilai/vagrant-proxyconf/issues/15 "Issue 15"
 [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"

data/Gemfile

@@ -7,7 +7,7 @@ gem 'rake'
 gem 'rspec', '~> 2.11'
 gem 'simplecov', '~> 0.7', :require => false
 gem 'tailor', '~> 1.2'
-gem 'vagrant', github: 'mitchellh/vagrant', ref: 'v1.2.7'
+gem 'vagrant', github: 'mitchellh/vagrant', ref: 'v1.3.1'
 
 group :development do
   gem 'guard-rspec'

data/README.md

@@ -12,12 +12,13 @@
 [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.
+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.
 
 At this state we support:
 
 * Generic `*_proxy` 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).
 
@@ -54,7 +55,7 @@ Project specific Vagrantfile overrides global settings. Environment variables ov
 
 ### 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'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.
 
 #### Example Vagrantfile
 
@@ -71,7 +72,7 @@ end
 
 * `config.proxy.http` - The proxy for HTTP URIs
 * `config.proxy.https` - The proxy for HTTPS URIs
-* `config.proxy.ftp` - The proxy for FTS URIs
+* `config.proxy.ftp` - The proxy for FTP URIs
 * `config.proxy.no_proxy` - A comma separated list of hosts or domains which do not use proxies.
 
 #### Possible values
@@ -114,7 +115,7 @@ end
 
 * `config.env_proxy.http` - The proxy for HTTP URIs
 * `config.env_proxy.https` - The proxy for HTTPS URIs
-* `config.env_proxy.ftp` - The proxy for FTS URIs
+* `config.env_proxy.ftp` - The proxy for FTP URIs
 * `config.env_proxy.no_proxy` - A comma separated list of hosts or domains which do not use proxies.
 
 #### Possible values

data/Rakefile

@@ -30,6 +30,7 @@ Tailor::RakeTask.new do |task|
 end
 
 Cane::RakeTask.new(:cane) do |task|
+  task.abc_max = 16
   task.style_measure = 140
   task.options[:color] = true
 end

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

@@ -0,0 +1,72 @@
+module VagrantPlugins
+  module ProxyConf
+    class Action
+      # Action for configuring Chef provisioners
+      class ConfigureChefProxy
+        attr_reader :logger
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant::proxyconf')
+        end
+
+        def call(env)
+          @app.call env
+
+          machine = env[:machine]
+          config  = config(machine)
+
+          if chef_provisioners(machine).empty?
+            logger.debug I18n.t("vagrant_proxyconf.chef_proxy.no_provisioners")
+          elsif !config.enabled?
+            logger.debug I18n.t("vagrant_proxyconf.chef_proxy.not_enabled")
+          else
+            env[:ui].info I18n.t("vagrant_proxyconf.chef_proxy.configuring")
+            configure_chef_provisioners(machine, config)
+          end
+        end
+
+        private
+
+        # @return [Config::Proxy] the `config.proxy` configuration
+        def config(machine)
+          config = machine.config.proxy
+          config.finalize! if Gem::Version.new(Vagrant::VERSION) < Gem::Version.new('1.2.5')
+          config
+        end
+
+        # @return [Array] all Chef provisioners
+        def chef_provisioners(machine)
+          machine.config.vm.provisioners.select { |prov| [:chef_solo, :chef_client].include?(prov.name) }
+        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) }
+        end
+
+        # Configures proxies for the 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)
+          if chef.http_proxy.nil?
+            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?
+            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?
+            chef.no_proxy = config.no_proxy
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+require 'uri'
 require 'vagrant'
 require_relative 'key_mixin'
 
@@ -27,6 +28,35 @@ module VagrantPlugins
         # @return [String] a comma separated list of hosts or domains which do not use proxies
         key :no_proxy, env_var: 'VAGRANT_NO_PROXY'
 
+        # @return [String] username for the HTTP proxy
+        def http_user
+          user(http)
+        end
+
+        # @return [String] password for the HTTP proxy
+        def http_pass
+          pass(http)
+        end
+
+        # @return [String] username for the HTTPS proxy
+        def https_user
+          user(https)
+        end
+
+        # @return [String] password for the HTTPS proxy
+        def https_pass
+          pass(https)
+        end
+
+        private
+
+        def user(uri)
+          URI.parse(uri).user if !uri.nil?
+        end
+
+        def pass(uri)
+          URI.parse(uri).password if !uri.nil?
+        end
       end
     end
   end

data/lib/vagrant-proxyconf/plugin.rb

@@ -29,9 +29,11 @@ module VagrantPlugins
 
       def self.register_hooks(hook, provision_action)
         require_relative 'action/configure_apt_proxy'
+        require_relative 'action/configure_chef_proxy'
         require_relative 'action/configure_env_proxy'
 
         hook.after provision_action, Action::ConfigureAptProxy
+        hook.after provision_action, Action::ConfigureChefProxy
         hook.after provision_action, Action::ConfigureEnvProxy
       end
 

data/lib/vagrant-proxyconf/version.rb

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

data/locales/en.yml

@@ -8,6 +8,14 @@ en:
       configuring: |-
         Configuring proxy for Apt...
 
+    chef_proxy:
+      no_provisioners: |-
+        No Chef provisioners configured.
+      not_enabled: |-
+        Default proxy not enabled or configured. Skipping Chef provisioner configuration.
+      configuring: |-
+        Configuring proxy for Chef provisioners...
+
     env_proxy:
       not_enabled: |-
         env_proxy not enabled or configured

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

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'vagrant-proxyconf/action/configure_chef_proxy'
+require 'ostruct'
+
+describe VagrantPlugins::ProxyConf::Action::ConfigureChefProxy do
+
+  describe '#configure_chef' do
+    let(:chef)   { OpenStruct.new }
+    let(:config) { OpenStruct.new }
+
+    def configure_chef
+      described_class.new(nil, nil).send(:configure_chef, chef, config)
+    end
+
+    context "with no configurations" do
+      it "leaves all to nil" do
+        configure_chef
+        expect(chef.http_proxy).to be_nil
+        expect(chef.http_proxy_user).to be_nil
+        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
+        expect(chef.no_proxy).to be_nil
+      end
+    end
+
+    context "with specified default configurations" do
+      before :each do
+        config.http      = 'http://foo:1234'
+        config.http_user = 'bar'
+
+        configure_chef
+      end
+
+      it "configures chef" 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
+      end
+    end
+
+    context "with specified chef configurations" do
+      before :each do
+        chef.http_proxy  = 'http://proxy:8080/'
+        chef.no_proxy    = 'localhost'
+
+        config.http      = 'http://default:7070/'
+        config.http_user = 'foo'
+        config.https     = 'http://sslproxy:3128/'
+
+        configure_chef
+      end
+
+      it "won't override chef config" do
+        expect(chef.http_proxy).to  eq 'http://proxy:8080/'
+        expect(chef.http_proxy_user).to be_nil
+        expect(chef.http_proxy_pass).to be_nil
+        expect(chef.no_proxy).to eq 'localhost'
+      end
+
+      it "configures unset proxies" do
+        expect(chef.https_proxy).to  eq 'http://sslproxy:3128/'
+      end
+    end
+  end
+
+end

data/spec/unit/vagrant-proxyconf/cap/linux/env_proxy_conf_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'vagrant-proxyconf/cap/linux/env_proxy_conf'
+
+describe VagrantPlugins::ProxyConf::Cap::Linux::EnvProxyConf do
+
+  describe '.env_proxy_conf' do
+    let(:subject) { described_class.env_proxy_conf(double) }
+    it { should eq '/etc/profile.d/proxy.sh' }
+  end
+
+end

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

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'vagrant-proxyconf/config/proxy'
+
+describe VagrantPlugins::ProxyConf::Config::Proxy do
+  before :each do
+    # Ensure tests are not affected by environment variables
+    %w[HTTP_PROXY HTTPS_PROXY FTP_PROXY NO_PROXY].each do |var|
+      ENV.delete("VAGRANT_#{var}")
+    end
+  end
+
+  subject do
+    described_class.new.tap do |config|
+      config.http  = http_proxy
+      config.https = https_proxy
+    end
+  end
+  let(:http_proxy)  { nil }
+  let(:https_proxy) { nil }
+
+  context "defaults" do
+    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
+
+  context "without userinfo" do
+    let(:http_proxy)  { 'http://proxy.example.com:8123/' }
+    let(:https_proxy) { '' }
+
+    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
+
+  context "with username" do
+    let(:http_proxy)  { 'http://foo@proxy.example.com:8123/' }
+    let(:https_proxy) { 'http://bar@localhost' }
+
+    its(:http_user)  { should eq 'foo' }
+    its(:http_pass)  { should be_nil }
+    its(:https_user) { should eq 'bar' }
+    its(:https_pass) { should be_nil }
+  end
+
+  context "with userinfo" do
+    let(:http_proxy)  { 'http://foo:bar@proxy.example.com:8123/' }
+    let(:https_proxy) { 'http://:baz@localhost' }
+
+    its(:http_user)  { should eq 'foo' }
+    its(:http_pass)  { should eq 'bar' }
+    its(:https_user) { should eq '' }
+    its(:https_pass) { should eq 'baz' }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-proxyconf
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-04 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies: []
 description: A Vagrant plugin that configures the virtual machine to use proxies
 email:
@@ -33,6 +33,7 @@ files:
 - lib/vagrant-proxyconf.rb
 - lib/vagrant-proxyconf/action/base.rb
 - lib/vagrant-proxyconf/action/configure_apt_proxy.rb
+- lib/vagrant-proxyconf/action/configure_chef_proxy.rb
 - lib/vagrant-proxyconf/action/configure_env_proxy.rb
 - lib/vagrant-proxyconf/cap/debian/apt_proxy_conf.rb
 - lib/vagrant-proxyconf/cap/linux/env_proxy_conf.rb
@@ -47,12 +48,15 @@ files:
 - spec/spec_helper.rb
 - spec/unit/support/shared/apt_proxy_config.rb
 - spec/unit/vagrant-proxyconf/action/configure_apt_proxy_spec.rb
+- spec/unit/vagrant-proxyconf/action/configure_chef_proxy_spec.rb
 - spec/unit/vagrant-proxyconf/action/configure_env_proxy_spec.rb
 - spec/unit/vagrant-proxyconf/cap/debian/apt_proxy_conf_spec.rb
+- spec/unit/vagrant-proxyconf/cap/linux/env_proxy_conf_spec.rb
 - spec/unit/vagrant-proxyconf/config/apt_proxy_spec.rb
 - spec/unit/vagrant-proxyconf/config/env_proxy_spec.rb
 - spec/unit/vagrant-proxyconf/config/key_mixin_spec.rb
 - spec/unit/vagrant-proxyconf/config/key_spec.rb
+- spec/unit/vagrant-proxyconf/config/proxy_spec.rb
 - spec/unit/vagrant-proxyconf/plugin_spec.rb
 - vagrant-proxyconf.gemspec
 homepage: http://tmatilai.github.io/vagrant-proxyconf/
@@ -70,7 +74,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4185901625898732467
+      hash: -2294529706068279185
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -79,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4185901625898732467
+      hash: -2294529706068279185
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -90,11 +94,14 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/support/shared/apt_proxy_config.rb
 - spec/unit/vagrant-proxyconf/action/configure_apt_proxy_spec.rb
+- spec/unit/vagrant-proxyconf/action/configure_chef_proxy_spec.rb
 - spec/unit/vagrant-proxyconf/action/configure_env_proxy_spec.rb
 - spec/unit/vagrant-proxyconf/cap/debian/apt_proxy_conf_spec.rb
+- spec/unit/vagrant-proxyconf/cap/linux/env_proxy_conf_spec.rb
 - spec/unit/vagrant-proxyconf/config/apt_proxy_spec.rb
 - spec/unit/vagrant-proxyconf/config/env_proxy_spec.rb
 - spec/unit/vagrant-proxyconf/config/key_mixin_spec.rb
 - spec/unit/vagrant-proxyconf/config/key_spec.rb
+- spec/unit/vagrant-proxyconf/config/proxy_spec.rb
 - spec/unit/vagrant-proxyconf/plugin_spec.rb
 has_rdoc: