landrush 1.0.0 → 1.1.0.beta.1

data/test/landrush/action/setup_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative '../../test_helper'
 require 'landrush/action/common'
 require 'landrush/action/setup'
 
@@ -14,6 +14,7 @@ module Landrush
       end
 
       it "calls the next app in the chain" do
+        skip('Not working on Windows, since it will also do the network config') if Vagrant::Util::Platform.windows?
         env = fake_environment
         app = -> (e) { e[:called] = true }
         setup = Setup.new(app, nil)
@@ -24,6 +25,7 @@ module Landrush
       end
 
       it "records the booting host as a dependent VM" do
+        skip('Not working on Windows, since it will also do the network config') if Vagrant::Util::Platform.windows?
         app = proc {}
         setup = Setup.new(app, nil)
         env = fake_environment
@@ -34,6 +36,7 @@ module Landrush
       end
 
       it "starts the landrush server if it's not already started" do
+        skip('Not working on Windows, since it will also do the network config') if Vagrant::Util::Platform.windows?
         app = proc {}
         setup = Setup.new(app, nil)
         env = fake_environment
@@ -44,6 +47,7 @@ module Landrush
       end
 
       it "does not attempt to start the server if it's already up" do
+        skip('Not working on Windows, since it will also do the network config') if Vagrant::Util::Platform.windows?
         app = proc {}
         setup = Setup.new(app, nil)
         env = fake_environment
@@ -58,6 +62,7 @@ module Landrush
       end
 
       it "does nothing if it is not enabled via config" do
+        skip('Not working on Windows, since it will also do the network config') if Vagrant::Util::Platform.windows?
         app = proc {}
         setup = Setup.new(app, nil)
         env = fake_environment
@@ -68,8 +73,45 @@ module Landrush
         DependentVMs.list.must_equal []
       end
 
+      it "for single private network IP host visible IP can be retrieved w/o starting the VM" do
+        skip('Not working on Windows, since it will also do the network config') if Vagrant::Util::Platform.windows?
+        app = proc {}
+        setup = Setup.new(app, nil)
+        env = fake_environment
+        env[:machine].config.vm.network :private_network, ip: '42.42.42.42'
+
+        setup.call(env)
+        Store.hosts.get('somehost.vagrant.test').must_equal '42.42.42.42'
+      end
+
+      it "for multiple private network IPs host visible IP cant be retrieved if host_ip_address is set" do
+        skip('Not working on Windows, since it will also do the network config') if Vagrant::Util::Platform.windows?
+        app = proc {}
+        setup = Setup.new(app, nil)
+        env = fake_environment
+
+        env[:machine].config.vm.network :private_network, ip: '42.42.42.41'
+        env[:machine].config.vm.network :private_network, ip: '42.42.42.42'
+        env[:machine].config.landrush.host_ip_address = '42.42.42.42'
+        setup.call(env)
+        Store.hosts.get('somehost.vagrant.test').must_equal '42.42.42.42'
+      end
+
+      it "is possible to add cnames via the config.landrush.host configuration option" do
+        skip('Not working on Windows, since it will also do the network config') if Vagrant::Util::Platform.windows?
+        app = proc {}
+        setup = Setup.new(app, nil)
+        env = fake_environment
+
+        env[:machine].config.landrush.host 'foo', 'bar'
+        setup.call(env)
+
+        Store.hosts.get('foo').must_equal 'bar'
+      end
+
       describe 'after boot' do
         it "stores the machine's hostname => ip address" do
+          skip('Not working on Windows, since it will also do the network config') if Vagrant::Util::Platform.windows?
           app = proc {}
           setup = Setup.new(app, nil)
           env = fake_environment
@@ -80,6 +122,7 @@ module Landrush
         end
 
         it "does nothing if it is not enabled via config" do
+          skip('Not working on Windows, since it will also do the network config') if Vagrant::Util::Platform.windows?
           app = proc {}
           setup = Setup.new(app, nil)
           env = fake_environment(enabled: false)

data/test/landrush/action/teardown_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative '../../test_helper'
 require 'landrush/action/common'
 require 'landrush/action/teardown'
 

data/test/landrush/cap/all/read_host_visible_ip_address_test.rb

@@ -0,0 +1,87 @@
+require_relative '../../../test_helper'
+
+module Landrush
+  module Cap
+    module All
+      describe ReadHostVisibleIpAddress do
+        let(:machine) { fake_machine }
+        let(:addresses) { fake_addresses }
+
+        def call_cap(machine)
+          Landrush::Cap::All::ReadHostVisibleIpAddress.read_host_visible_ip_address(machine)
+        end
+
+        before do
+          # TODO: Is there a way to only unstub it for read_host_visible_ip_address?
+          machine.guest.unstub(:capability)
+          machine.guest.stubs(:capability).with(:landrush_ip_get).returns(fake_addresses)
+        end
+
+        describe 'read_host_visible_ip_address' do
+          # First, test with an empty response (no addresses)
+          it 'should throw an error when there are no addresses' do
+            machine.guest.stubs(:capability).with(:landrush_ip_get).returns([])
+
+            lambda do
+              call_cap(machine)
+            end.must_raise(RuntimeError, 'No addresses found')
+          end
+
+          # Step 1: nothing excluded, nothing explicitly selected
+          it 'should return the last address' do
+            machine.config.landrush.host_interface          = nil
+            machine.config.landrush.host_interface_excludes = []
+
+            expected = addresses.last['ipv4']
+
+            # call_cap(machine).must_equal expected
+            call_cap(machine).must_equal expected
+          end
+
+          # Test exclusion mechanics; it should select the las
+          it 'should ignore interfaces that are excluded and select the last not excluded interface' do
+            machine.config.landrush.host_interface          = nil
+            machine.config.landrush.host_interface_excludes = [/exclude[0-9]+/]
+
+            expected = addresses.detect { |a| a['name'] == 'include3' }
+            expected = expected['ipv4']
+
+            call_cap(machine).must_equal expected
+          end
+
+          # Explicitly select one; this supersedes the exclusion mechanic
+          it 'should select the desired interface' do
+            machine.config.landrush.host_interface          = 'include1'
+            machine.config.landrush.host_interface_excludes = [/exclude[0-9]+/]
+
+            expected = addresses.detect { |a| a['name'] == 'include1' }
+            expected = expected['ipv4']
+
+            call_cap(machine).must_equal expected
+          end
+
+          # Now make sure it returns the last not excluded interface when the desired interface does not exist
+          it 'should return the last not excluded interface if the desired interface does not exist' do
+            machine.config.landrush.host_interface          = 'dummy'
+            machine.config.landrush.host_interface_excludes = [/exclude[0-9]+/]
+
+            expected = addresses.detect { |a| a['name'] == 'include3' }
+            expected = expected['ipv4']
+
+            call_cap(machine).must_equal expected
+          end
+
+          # Now make sure it returns the last interface overall when nothing is excluded
+          it 'should return the last interface if the desired interface does not exist' do
+            machine.config.landrush.host_interface          = 'dummy'
+            machine.config.landrush.host_interface_excludes = []
+
+            expected = addresses.last['ipv4']
+
+            call_cap(machine).must_equal expected
+          end
+        end
+      end
+    end
+  end
+end

data/test/landrush/cap/linux/configured_dns_servers_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative '../../../test_helper'
 
 describe Landrush::Cap::Linux::ConfiguredDnsServers do
   let(:machine) { fake_machine }

data/test/landrush/cap/linux/redirect_dns_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative '../../../test_helper'
 
 describe Landrush::Cap::Linux::RedirectDns do
   let(:machine) { fake_machine }

data/test/landrush/config_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative '../test_helper'
 
 describe 'Landrush::Config' do
   it "supports enabling via accessor style" do

data/test/landrush/dependent_vms_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative '../test_helper'
 
 module Landrush
   describe DependentVMs do

data/test/landrush/resolver_config_test.rb

@@ -1,12 +1,10 @@
-require 'test_helper'
+require_relative '../test_helper'
 
 module Landrush
   describe ResolverConfig do
     describe 'ensure_config_exists' do
       it 'writes a resolver config on the host if one is not already there' do
         resolver_config = ResolverConfig.new(fake_environment)
-        skip("Only supported on OSX") unless resolver_config.osx?
-
         resolver_config.config_file.exist?.must_equal false
         resolver_config.ensure_config_exists!
         resolver_config.config_file.exist?.must_equal true

data/test/landrush/server_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative '../test_helper'
 require 'resolv'
 
 module Landrush

data/test/landrush/store_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative '../test_helper'
 
 module Landrush
   describe Store do

data/test/landrush/util/rety_test.rb

@@ -0,0 +1,50 @@
+require_relative '../../test_helper'
+
+class DummyClass
+  include Landrush::Util::Retry
+end
+
+module Landrush
+  module Util
+    describe Retry do
+      before do
+        @dummy = DummyClass.new
+      end
+
+      describe 'retry' do
+        it 'retries the provided block up to the specified count' do
+          retries = 0
+          result = @dummy.retry(tries: 2) do
+            retries += 1
+            false
+          end
+          retries.must_equal 2
+          result.must_equal false
+        end
+
+        it 'does not retry if \'true\' is returned' do
+          retries = 0
+          result = @dummy.retry(tries: 2) do
+            retries += 1
+            true
+          end
+          retries.must_equal 1
+          result.must_equal true
+        end
+
+        it 'does sleep between executions if requested' do
+          retries = 0
+          t1 = Time.now
+          result = @dummy.retry(tries: 1, sleep: 1) do
+            retries += 1
+            false
+          end
+          t2 = Time.now
+          retries.must_equal 1
+          result.must_equal false
+          assert t2 - t1 > 1
+        end
+      end
+    end
+  end
+end

data/test/landrush/win_network_config_test.rb

@@ -0,0 +1,70 @@
+require_relative '../test_helper'
+
+module Landrush
+  TEST_IP = '10.42.42.42'.freeze
+
+  describe WinNetworkConfig do
+    before do
+      @vboxmanage_found = !Vagrant::Util::Which.which('VBoxManage').nil?
+      @has_admin_privileges = Landrush::WinNetworkConfig.admin_mode?
+    end
+
+    describe 'modify DNS settings of network adapter' do
+      it 'sets 127.0.0.1 as DNS server on the interface' do
+        skip('Only supported on Windows') unless Vagrant::Util::Platform.windows? && @vboxmanage_found && @has_admin_privileges
+
+        # VBoxManage uses the network description for its commands whereas netsh uses the name
+        # We need to get both
+        begin
+          old_network_state = network_state
+          network_description = create_test_interface
+          new_network_state = network_state
+          network_name = get_network_name(old_network_state, new_network_state)
+
+          get_dns_for_name(network_name).must_be_nil
+
+          config = Landrush::WinNetworkConfig.new(fake_environment)
+          config.ensure_prerequisites.must_equal true
+          config.update_network_adapter(TEST_IP, '127.0.0.1', 'landrush.test')
+
+          get_dns_for_name(network_name).must_equal '127.0.0.1'
+        rescue
+          delete_test_interface network_description
+        end
+      end
+    end
+
+    def network_state
+      `netsh interface ip show config`.split(/\n/).reject(&:empty?)
+    end
+
+    def get_network_name(old_network_state, new_network_state)
+      new_network_state.reject! { |line| old_network_state.include? line }
+      new_network_state[0].match(/.*\"(.*)\"$/).captures[0]
+    end
+
+    # Creates a test interface using VBoxMange and sets a known test IP
+    def create_test_interface
+      cmd_out = `VBoxManage hostonlyif create`
+      network_description = cmd_out.match(/.*'(.*)'.*/).captures[0]
+      `VBoxManage.exe hostonlyif ipconfig \"#{network_description}\" --ip #{TEST_IP}`
+      sleep 3
+      network_description
+    end
+
+    def delete_test_interface(name)
+      `VBoxManage hostonlyif remove \"#{name}\"`
+    end
+
+    def get_dns_for_name(name)
+      cmd_out = `netsh interface ip show config name=\"#{name}\"`
+      dns = cmd_out.split(/\n/).select { |settings| settings.match(/Statically Configured DNS Servers/m) }
+      # TODO: better error handling
+      begin
+        dns[0].match(/.* (\d{1,3}\.\d{1,3}\.\d{1,3}.\d{1,3}).*/).captures[0]
+      rescue
+        return nil
+      end
+    end
+  end
+end

data/test/support/fake_ui.rb

@@ -1,4 +1,5 @@
 class FakeUI
   def self.info(*args)
+    # puts "#{args.join(' ')}"
   end
 end

data/test/test_helper.rb

@@ -5,12 +5,27 @@ require 'minitest/spec'
 
 require 'landrush'
 require 'landrush/cap/linux/configured_dns_servers'
-require 'landrush/cap/linux/read_host_visible_ip_address'
 require 'landrush/cap/linux/redirect_dns'
+require 'landrush/cap/all/read_host_visible_ip_address'
+require 'landrush/win_network_config'
+require 'landrush/util/retry'
 
 require 'minitest/autorun'
 require 'mocha/mini_test'
 
+# Make sure to keep the numbering sequential here
+# Putting include/exclude out of order is kind of the point though ;)
+def fake_addresses
+  [
+    { 'name' => 'exclude1', 'ipv4' => '172.28.128.1', 'ipv6' => '::1' },
+    { 'name' => 'include1', 'ipv4' => '172.28.128.2', 'ipv6' => '::2' },
+    { 'name' => 'include2', 'ipv4' => '172.28.128.3', 'ipv6' => '::3' },
+    { 'name' => 'include3', 'ipv4' => '172.28.128.4', 'ipv6' => '::4' },
+    { 'name' => 'exclude2', 'ipv4' => '172.28.128.5', 'ipv6' => '::5' },
+    { 'name' => 'exclude3', 'ipv4' => '172.28.128.6', 'ipv6' => '::6' }
+  ]
+end
+
 def fake_environment(options = { enabled: true })
   # For the home_path we want the base Vagrant directory
   vagrant_test_home = Pathname(Landrush::Server.working_dir).parent.parent
@@ -97,14 +112,14 @@ def fake_machine(options={})
   )
 
   machine.instance_variable_set("@communicator", RecordingCommunicator.new)
-  machine.communicate.stub_command(
-    Landrush::Cap::Linux::ReadHostVisibleIpAddress.command,
-    "#{options.fetch(:ip, '1.2.3.4')}\n"
-  )
 
   machine.config.landrush.enabled = options.fetch(:enabled, false)
+  machine.config.landrush.host_interface = nil
+  machine.config.landrush.host_interface_excludes = [/exclude[0-9]+/]
   machine.config.vm.hostname = options.fetch(:hostname, 'somehost.vagrant.test')
 
+  machine.guest.stubs(:capability).with(:read_host_visible_ip_address).returns(options.fetch(:ip, '1.2.3.4'))
+
   machine
 end
 
@@ -120,12 +135,12 @@ module MiniTest
 end
 
 # order is important on these
-require 'support/create_fake_working_dir'
+require_relative 'support/create_fake_working_dir'
 
-require 'support/clear_dependent_vms'
+require_relative 'support/clear_dependent_vms'
 
-require 'support/fake_ui'
-require 'support/test_server_daemon'
-require 'support/fake_resolver_config'
+require_relative 'support/fake_ui'
+require_relative 'support/test_server_daemon'
+require_relative 'support/fake_resolver_config'
 
-require 'support/delete_fake_working_dir'
+require_relative 'support/delete_fake_working_dir'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: landrush
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.beta.1
 platform: ruby
 authors:
 - Paul Hinze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2016-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubydns
@@ -24,6 +24,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.8.5
+- !ruby/object:Gem::Dependency
+  name: win32-process
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: landrush-ip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.3
 description: |
   Forget about IPs in Vagrant - Automated DNS for your VMs
 
@@ -48,7 +76,6 @@ files:
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - NOTES.md
 - README.md
@@ -62,11 +89,11 @@ files:
 - doc/support/seqdiag.fontmap
 - doc/vagrant_dns_without_landrush.diag
 - doc/vagrant_dns_without_landrush.svg
-- examples/Vagrantfile
 - features/dns_resolution.feature
+- features/landrush-ip.feature
 - features/step_definitions/dns.rb
+- features/step_definitions/ip.rb
 - features/support/env.rb
-- issues/vbox/Vagrantfile
 - landrush.gemspec
 - lib/landrush.rb
 - lib/landrush/action/common.rb
@@ -74,33 +101,36 @@ files:
 - lib/landrush/action/redirect_dns.rb
 - lib/landrush/action/setup.rb
 - lib/landrush/action/teardown.rb
+- lib/landrush/cap/all/read_host_visible_ip_address.rb
 - lib/landrush/cap/debian/install_iptables.rb
 - lib/landrush/cap/debian/iptables_installed.rb
 - lib/landrush/cap/linux/add_iptables_rule.rb
 - lib/landrush/cap/linux/configured_dns_servers.rb
-- lib/landrush/cap/linux/read_host_visible_ip_address.rb
 - lib/landrush/cap/linux/redirect_dns.rb
 - lib/landrush/cap/redhat/install_iptables.rb
 - lib/landrush/cap/redhat/iptables_installed.rb
 - lib/landrush/command.rb
 - lib/landrush/config.rb
 - lib/landrush/dependent_vms.rb
-- lib/landrush/os.rb
 - lib/landrush/plugin.rb
 - lib/landrush/resolver_config.rb
 - lib/landrush/server.rb
 - lib/landrush/store.rb
+- lib/landrush/util/retry.rb
 - lib/landrush/version.rb
+- lib/landrush/win_network_config.rb
 - test/landrush/action/setup_test.rb
 - test/landrush/action/teardown_test.rb
+- test/landrush/cap/all/read_host_visible_ip_address_test.rb
 - test/landrush/cap/linux/configured_dns_servers_test.rb
-- test/landrush/cap/linux/read_host_visible_ip_address_test.rb
 - test/landrush/cap/linux/redirect_dns_test.rb
 - test/landrush/config_test.rb
 - test/landrush/dependent_vms_test.rb
 - test/landrush/resolver_config_test.rb
 - test/landrush/server_test.rb
 - test/landrush/store_test.rb
+- test/landrush/util/rety_test.rb
+- test/landrush/win_network_config_test.rb
 - test/support/clear_dependent_vms.rb
 - test/support/create_fake_working_dir.rb
 - test/support/delete_fake_working_dir.rb
@@ -108,7 +138,7 @@ files:
 - test/support/fake_ui.rb
 - test/support/test_server_daemon.rb
 - test/test_helper.rb
-homepage: https://github.com/phinze/landrush
+homepage: https://github.com/vagrant-landrush/landrush
 licenses:
 - MIT
 metadata: {}
@@ -123,9 +153,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.6
@@ -134,18 +164,22 @@ specification_version: 4
 summary: a vagrant plugin providing consistent DNS visible on host and guests
 test_files:
 - features/dns_resolution.feature
+- features/landrush-ip.feature
 - features/step_definitions/dns.rb
+- features/step_definitions/ip.rb
 - features/support/env.rb
 - test/landrush/action/setup_test.rb
 - test/landrush/action/teardown_test.rb
+- test/landrush/cap/all/read_host_visible_ip_address_test.rb
 - test/landrush/cap/linux/configured_dns_servers_test.rb
-- test/landrush/cap/linux/read_host_visible_ip_address_test.rb
 - test/landrush/cap/linux/redirect_dns_test.rb
 - test/landrush/config_test.rb
 - test/landrush/dependent_vms_test.rb
 - test/landrush/resolver_config_test.rb
 - test/landrush/server_test.rb
 - test/landrush/store_test.rb
+- test/landrush/util/rety_test.rb
+- test/landrush/win_network_config_test.rb
 - test/support/clear_dependent_vms.rb
 - test/support/create_fake_working_dir.rb
 - test/support/delete_fake_working_dir.rb