vagrant-proxyconf 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle
+/Gemfile.lock
+/pkg
+/tmp

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 0.1.0 / 2013-06-27
+
+- Initial release
+- Support for Apt proxy configuration
+- Based heavily on [vagrant-cachier](https://github.com/fgrehm/vagrant-cachier) plugin

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rspec', '~> 2.11'
+gem 'tailor', '~> 1.2'
+gem 'vagrant', github: 'mitchellh/vagrant'
+
+group :development do
+  gem 'guard-rspec'
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec'  do
+  watch(%r{^spec/unit/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})          { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')       { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Vagrant Proxy Configuration Plugin
+
+[![Gem Version](https://badge.fury.io/rb/vagrant-proxyconf.png)][gem]
+[![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]
+
+[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
+
+A [Vagrant](http://www.vagrantup.com/) 1.1+ plugin that configures the virtual machine to use specified proxies for package managers etc.
+
+At this state we support:
+
+- [APT](http://en.wikipedia.org/wiki/Advanced_Packaging_Tool) proxy/cacher
+
+Support is planned for other package managers (at least yum).
+
+## Usage
+
+Install using standard Vagrant 1.1+ plugin installation method:
+```sh
+vagrant plugin install vagrant-proxyconf
+```
+
+### Apt
+
+The proxy for Apt can be specified in the Vagrantfile:
+```ruby
+Vagrant.configure("2") do |config|
+
+  config.apt_proxy.http = "192.168.33.1:3142"
+
+  # ... other stuff
+end
+```
+
+The proxy can be specified as an IP address, name or full URL, with optional port (defaults to 3142).
+
+You can also use `APT_PROXY_HTTP` and `APT_PROXY_HTTPS` environment variables. These override the Vagrantfile configuration. To disable or remove the proxy use "DIRECT" or an empty value.
+
+Proxy settings will be written to _/etc/apt/apt.conf.d/01proxy_ on the guest.
+
+## Related plugins and projects
+
+- [vagrant-cachier](https://github.com/fgrehm/vagrant-cachier)
+- [vagrant-proxy](https://github.com/clintoncwolfe/vagrant-proxy)

data/Rakefile

@@ -0,0 +1,28 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'tailor/rake_task'
+
+task :default => [:test, :tailor]
+
+# Remove 'install' task as the gem is installed to Vagrant, not to system
+Rake::Task[:install].clear
+
+namespace :test do
+  RSpec::Core::RakeTask.new('unit') do |task|
+    task.pattern = 'spec/unit/**/*_spec.rb'
+  end
+end
+desc "Run all tests"
+task :test => ['test:unit']
+
+Tailor::RakeTask.new do |task|
+  task.file_set('lib/**/*.rb', 'code') do |style|
+    style.max_line_length 100, level: :warn
+    style.max_line_length 140, level: :error
+  end
+  task.file_set('spec/**/*.rb', 'tests') do |style|
+    style.max_line_length 120, level: :warn
+    # allow vertical alignment of `let(:foo) { block }` blocks
+    style.spaces_before_lbrace 1, level: :off
+  end
+end

data/lib/vagrant-proxyconf.rb

@@ -0,0 +1,4 @@
+require 'vagrant'
+
+require_relative 'vagrant-proxyconf/version'
+require_relative 'vagrant-proxyconf/plugin'

data/lib/vagrant-proxyconf/action.rb

@@ -0,0 +1 @@
+require_relative 'action/configure_apt_proxy'

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

@@ -0,0 +1,53 @@
+require 'tempfile'
+
+module VagrantPlugins
+  module ProxyConf
+    class Action
+      class ConfigureAptProxy
+        attr_reader :logger
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant::proxyconf::action::configure_apt_proxy')
+        end
+
+        def call(env)
+          @app.call env
+
+          proxy_config = env[:machine].config.apt_proxy
+          if !proxy_config.enabled?
+            logger.debug "apt_proxy not enabled or configured"
+          elsif !proxy_conf_capability?(env[:machine])
+            env[:ui].info "Skipping Apt proxy config as the machine does not support it"
+          else
+            env[:ui].info "Configuring proxy for Apt..."
+            write_apt_proxy_conf(env[:machine], proxy_config)
+          end
+        end
+
+        def write_apt_proxy_conf(machine, config)
+          logger.debug "Configuration:\n#{config}"
+
+          temp = Tempfile.new("vagrant")
+          temp.binmode
+          temp.write(config)
+          temp.close
+
+          machine.communicate.tap do |comm|
+            comm.upload(temp.path, "/tmp/vagrant-apt-proxy-conf")
+            comm.sudo("cat /tmp/vagrant-apt-proxy-conf > #{proxy_conf_path(machine)}")
+            comm.sudo("rm /tmp/vagrant-apt-proxy-conf")
+          end
+        end
+
+        def proxy_conf_capability?(machine)
+          machine.guest.capability?(:apt_proxy_conf)
+        end
+
+        def proxy_conf_path(machine)
+          machine.guest.capability(:apt_proxy_conf)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-proxyconf/apt_proxy_config.rb

@@ -0,0 +1,88 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module ProxyConf
+    class AptProxyConfig < Vagrant.plugin('2', :config)
+      # HTTP proxy for Apt
+      attr_accessor :http
+
+      # HTTPS proxy for Apt
+      attr_accessor :https
+
+      def initialize
+        @http  = UNSET_VALUE
+        @https = UNSET_VALUE
+      end
+
+      def finalize!
+        @http = override_from_env_var('http', @http)
+        @http = nil if @http == UNSET_VALUE
+
+        @https = override_from_env_var('https', @https)
+        @https = nil if @https == UNSET_VALUE
+      end
+
+      def enabled?
+        !http.nil? || !https.nil?
+      end
+
+      # @return [String] the full configuration stanza
+      def to_s
+        "#{config_for('http')}#{config_for('https')}"
+      end
+
+      private
+
+      def override_from_env_var(proto, default)
+        ENV.fetch("APT_PROXY_#{proto.upcase}", default)
+      end
+
+      def config_for(proto)
+        ConfigValue.new(proto, send(proto.to_sym))
+      end
+
+      class ConfigValue
+
+        attr_reader :proto, :value
+
+        # @param proto [String] the protocol ("http", "https")
+        # @param value [Object] the configuration value
+        def initialize(proto, value)
+          @proto = proto
+          @value = value
+        end
+
+        # @return [String] the full Apt configuration line
+        def to_s
+          set? ? %Q{Acquire::#{proto}::Proxy "#{proxy_uri}";\n} : ""
+        end
+
+        private
+
+        def set?
+          value && !value.empty?
+        end
+
+        def direct?
+          value.upcase == "DIRECT"
+        end
+
+        def proxy_uri
+          direct? ? "DIRECT" : "#{prefix}#{value}#{suffix}"
+        end
+
+        def prefix
+          "#{proto}://" if value !~ %r{^.*://}
+        end
+
+        def suffix
+          ":#{default_port}" if value !~ %r{:\d+$}
+        end
+
+        def default_port
+          3142
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-proxyconf/cap/debian/apt_proxy_conf.rb

@@ -0,0 +1,13 @@
+module VagrantPlugins
+  module ProxyConf
+    module Cap
+      module Debian
+        module AptProxyConf
+          def self.apt_proxy_conf(machine)
+            '/etc/apt/apt.conf.d/01proxy'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-proxyconf/plugin.rb

@@ -0,0 +1,26 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module ProxyConf
+    class Plugin < Vagrant.plugin('2')
+      name 'vagrant-proxyconf'
+
+      config('apt_proxy') do
+        require_relative 'apt_proxy_config'
+        AptProxyConfig
+      end
+
+      guest_capability 'debian', 'apt_proxy_conf' do
+        require_relative 'cap/debian/apt_proxy_conf'
+        Cap::Debian::AptProxyConf
+      end
+
+      proxyconf_action_hook = lambda do |hook|
+        require_relative 'action'
+        hook.after Vagrant::Action::Builtin::Provision, Action::ConfigureAptProxy
+      end
+      action_hook 'proxyconf-machine-up', :machine_action_up, &proxyconf_action_hook
+      action_hook 'proxyconf-machine-reload', :machine_action_reload, &proxyconf_action_hook
+    end
+  end
+end

data/lib/vagrant-proxyconf/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module ProxyConf
+    VERSION = '0.1.0'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  config.color = true
+  config.tty = true
+end
+
+require 'tempfile'
+require 'vagrant-proxyconf'

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

@@ -0,0 +1,103 @@
+def config_with(options)
+  instance.tap do |c|
+    options.each_pair { |k, v| c.send("#{k}=".to_sym, v) }
+    c.finalize!
+  end
+end
+
+def conf_line(proto, name, port = 3142)
+  if name == :direct
+    %Q{Acquire::#{proto}::Proxy "DIRECT";\n}
+  else
+    %Q{Acquire::#{proto}::Proxy "#{proto}://#{name}:#{port}";\n}
+  end
+end
+
+def conf_line_pattern(proto, name, port = 3142)
+  "^#{Regexp.escape(conf_line(proto, name, port))}"
+end
+
+shared_examples "apt proxy config" do |proto|
+  context "#{proto} proxy" do
+
+    context "with ip" do
+      subject        { config_with(proto => "10.1.2.3") }
+      its(:enabled?) { should be_true }
+      its(:to_s)     { should eq conf_line(proto, "10.1.2.3") }
+    end
+
+    context "with name" do
+      subject        { config_with(proto => "proxy.example.com") }
+      its(:enabled?) { should be_true }
+      its(:to_s)     { should eq conf_line(proto, "proxy.example.com") }
+    end
+
+    context "with name and port" do
+      subject        { config_with(proto => "acng:8080") }
+      its(:enabled?) { should be_true }
+      its(:to_s)     { should eq conf_line(proto, "acng", 8080) }
+    end
+
+    context "with protocol and name" do
+      subject        { config_with(proto => "#{proto}://proxy.foo.tld") }
+      its(:enabled?) { should be_true }
+      its(:to_s)     { should eq conf_line(proto, "proxy.foo.tld") }
+    end
+
+    context "with protocol and name and port" do
+      subject        { config_with(proto => "#{proto}://prism.nsa.gov:666") }
+      its(:enabled?) { should be_true }
+      its(:to_s)     { should eq conf_line(proto, "prism.nsa.gov", 666) }
+    end
+
+    ["DIRECT", "direct"].each do |direct|
+      context "with #{direct.inspect}" do
+        subject        { config_with(proto => direct) }
+        its(:enabled?) { should be_true }
+        its(:to_s)     { should eq conf_line(proto, :direct) }
+      end
+    end
+
+    [false, ""].each do |unset|
+      context "with #{unset.inspect}" do
+        subject        { config_with(proto => unset) }
+        its(:enabled?) { should be_true }
+        its(:to_s)     { should eq "" }
+      end
+    end
+
+    context "with nil" do
+      subject        { config_with(proto => nil) }
+      its(:enabled?) { should be_false }
+      its(:to_s)     { should eq "" }
+    end
+
+  end
+end
+
+shared_examples "apt proxy env var" do |var, proto|
+  context var do
+    let(:conf) { config_with(http: "acng:8080", https: "ssl-proxy:8443") }
+
+    it "sets #{proto} proxy" do
+      ENV[var] = "myproxy"
+      expect(conf.to_s).to match conf_line_pattern(proto, "myproxy")
+    end
+
+    it "does not set other proxies" do
+      ENV[var] = "myproxy:2345"
+      conf = config_with({})
+      expect(conf.to_s).to eq conf_line(proto, "myproxy", 2345)
+    end
+
+    it "sets empty configuration" do
+      ENV[var] = ""
+      expect(conf.to_s).to_not match %r{#{proto}://}
+    end
+
+    it "sets direct configuration" do
+      ENV[var] = "direct"
+      expect(conf.to_s).to match conf_line_pattern(proto, :direct)
+    end
+  end
+end

data/spec/unit/vagrant-proxyconf/apt_proxy_config_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'unit/support/shared/apt_proxy_config'
+require 'vagrant-proxyconf/apt_proxy_config'
+
+describe VagrantPlugins::ProxyConf::AptProxyConfig do
+  let(:instance) { described_class.new }
+
+  before :each do
+    # Ensure tests are not affected by environment variables
+    %w[APT_PROXY_HTTP APT_PROXY_HTTPS].each { |k| ENV.delete(k) }
+  end
+
+  context "defaults" do
+    subject        { config_with({}) }
+    its(:enabled?) { should be_false }
+    its(:to_s)     { should eq "" }
+  end
+
+  include_examples "apt proxy config", "http"
+  include_examples "apt proxy config", "https"
+
+  context "with both http and https proxies" do
+    subject        { config_with(http: "10.2.3.4", https: "ssl-proxy:8443") }
+    its(:enabled?) { should be_true }
+    its(:to_s)     { should match conf_line_pattern("http", "10.2.3.4") }
+    its(:to_s)     { should match conf_line_pattern("https", "ssl-proxy", 8443) }
+  end
+
+  context "with env var" do
+    include_examples "apt proxy env var", "APT_PROXY_HTTP", "http"
+    include_examples "apt proxy env var", "APT_PROXY_HTTPS", "https"
+  end
+
+end

data/vagrant-proxyconf.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-proxyconf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-proxyconf"
+  spec.version       = VagrantPlugins::ProxyConf::VERSION
+  spec.authors       = ["Teemu Matilainen"]
+  spec.email         = ["teemu.matilainen@iki.fi"]
+  spec.description   = "A Vagrant Plugin that configures the virtual machine to use proxies"
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/tmatilai/vagrant-proxyconf"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-proxyconf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Teemu Matilainen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-27 00:00:00.000000000 Z
+dependencies: []
+description: A Vagrant Plugin that configures the virtual machine to use proxies
+email:
+- teemu.matilainen@iki.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-proxyconf.rb
+- lib/vagrant-proxyconf/action.rb
+- lib/vagrant-proxyconf/action/configure_apt_proxy.rb
+- lib/vagrant-proxyconf/apt_proxy_config.rb
+- lib/vagrant-proxyconf/cap/debian/apt_proxy_conf.rb
+- lib/vagrant-proxyconf/plugin.rb
+- lib/vagrant-proxyconf/version.rb
+- spec/spec_helper.rb
+- spec/unit/support/shared/apt_proxy_config.rb
+- spec/unit/vagrant-proxyconf/apt_proxy_config_spec.rb
+- vagrant-proxyconf.gemspec
+homepage: https://github.com/tmatilai/vagrant-proxyconf
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4265757349911692365
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4265757349911692365
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Vagrant Plugin that configures the virtual machine to use proxies
+test_files:
+- spec/spec_helper.rb
+- spec/unit/support/shared/apt_proxy_config.rb
+- spec/unit/vagrant-proxyconf/apt_proxy_config_spec.rb