landrush 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d31f07ae3a474d9a5e399e15ce9bffa3cce616651a999437094d1aece8c617d2
-  data.tar.gz: 6e91547880229bdd51b4df747d8dde2fc9d48b167ff0a7acf3e83a56a0df1ce3
+  metadata.gz: 53b5666e9dffc5e0dfdc9992ecf961380f115ad40d2286cdfee46fcb00dac52b
+  data.tar.gz: bac8ef15e393c51e6833aa0797e83d18b4807cab8174c1f3c9c39c8f0a66d03b
 SHA512:
-  metadata.gz: c6c01e67c9d8f55d8f0f4d9a42e959e4005840fce1d6f2d86f6060973a0313158beaa1bdfadec68ba7ef8da18da56824ebee27482a2498688f2f6b21f4bf00c3
-  data.tar.gz: dbf7d7cbc7ba989a89408468c567b1036ebaefa634422f93aeba540783fcf0b9851d450300de2dcbcf3b5e8366cbfac4f10a6c7e657363469af23bde19f6a1f8
+  metadata.gz: d145a063094fbf0cafd6f3a18e771d0308d738f634e76dc06f3c473a7d15971a3d288444f1ef938db71df902a57952a049561a64e12a55589ecdd8e5ca1985f0
+  data.tar.gz: 5b8fb77e369b300ec7bb18982085d363fb5d7c4b8ed643e50fe8663dc66759200358034b79b6ac8c017a65651453fad845b2026ed0ada06619c178b2834174c5

data/.rubocop.yml

@@ -8,3 +8,11 @@ AllCops:
 
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+Metrics/BlockLength:
+  Max: 50
+  ExcludedMethods: ['describe', 'context']
+
+Metrics/ModuleLength:
+  Exclude:
+    - !ruby/regexp /^test\//

data/.rubocop_todo.yml

@@ -10,12 +10,6 @@
 Metrics/AbcSize:
   Max: 47
 
-# Offense count: 13
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
-Metrics/BlockLength:
-  Max: 89
-
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/ClassLength:

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [1.3.2] - 2019-05-06
+
+- Issue [#339](https://github.com/vagrant-landrush/landrush/issues/339) - Update link to TravisCI badge in README
+- Issue [#344](https://github.com/vagrant-landrush/landrush/issues/344) - Unable to determine network interface on non-English Windows
+- Issue [#346](https://github.com/vagrant-landrush/landrush/issues/346) - Upgrade Vagrant development version
+
 ## [1.3.1] - 2018-12-04
 
 - Issue [#11](https://github.com/vagrant-landrush/landrush/issues/11)   - Landrush prevents the machine from reaching internet

data/CONTRIBUTING.adoc

@@ -83,10 +83,6 @@ $ git push origin master
 
 == Maintainers
 
-* Brian Exelbierd (@bexelbie)
-* Eric Sorenson (@ahpook)
-* Florian Holzhauer (@fh)
+* Davi Koscianski Vidal (@davividal)
 * Hardy Ferentschik (@hferentschik)
-* Josef Strzibny (@strzibny)
-* Paul Hinze (@phinze)
-* Reto Kaiser (@njam)
+

data/Gemfile

@@ -19,5 +19,5 @@ group :development do
   gem 'rubocop', '~> 0.59.0'
   gem 'vagrant',
       git: 'https://github.com/mitchellh/vagrant.git',
-      ref: 'v2.1.2'
+      ref: 'v2.2.4'
 end

data/README.adoc

@@ -2,7 +2,7 @@
 :toc:
 :toc-placement!:
 
-https://travis-ci.org/vagrant-landrush/landrush[image:https://travis-ci.org/vagrant-landrush/landrush.png[Build Status]]
+image:https://travis-ci.org/vagrant-landrush/landrush.svg?branch=master["Build Status", link="https://travis-ci.org/vagrant-landrush/landrush"]
 https://ci.appveyor.com/project/hferentschik/landrush-3agrx/branch/master[image:https://ci.appveyor.com/api/projects/status/3iv8sv5v73s15mt6/branch/master?svg=true[Build Status]]
 image:https://badge.fury.io/rb/landrush.svg["Gem Version", link="https://badge.fury.io/rb/landrush"]
 

data/doc/Development.adoc

@@ -127,7 +127,7 @@ If you have an account you can setup the API key using:
 
 [source,bash]
 ----
-curl -u carlos https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials
+curl -u <user> https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials
 ----
 ====
 

data/features/dns_resolution.feature

@@ -36,4 +36,4 @@ Feature: DNS resolution
       | box              | provider   |
       | debian/jessie64  | virtualbox |
       | ubuntu/xenial64  | virtualbox |
-      | ubuntu/bionic64  | virtualbox |
+#      | ubuntu/bionic64  | virtualbox |

data/features/step_definitions/landrush_custom_steps.rb

@@ -14,24 +14,24 @@ Then(/^the hostname "([^"]+)" should resolve to "([^"]+)" on the host$/) do |hos
 end
 
 Then(/^the hostname "([^"]+)" should resolve to "([^"]+)" on the guest/) do |host, ip|
-  run("bundle exec vagrant ssh -c \"dig +short '#{host}' A\"")
+  run_command("bundle exec vagrant ssh -c \"dig +short '#{host}' A\"")
   expect(last_command_started).to have_output(/^#{ip}$/)
 end
 
 Then(/^the host visible IP address of the guest is the IP of interface "([^"]+)"/) do |interface|
   cmd = "bundle exec vagrant ssh -c \"ip addr list #{interface} | grep 'inet ' | cut -d' ' -f6| cut -d/ -f1\""
-  run(cmd)
+  run_command(cmd)
   expect(last_command_started).to have_output(/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/)
 
   ip = last_command_started.output.split("\n").last
 
-  run('bundle exec vagrant landrush list')
+  run_command('bundle exec vagrant landrush list')
 
   expect(last_command_started).to have_output(/#{ip}$/)
 end
 
 Then(/^Landrush is( not)? running$/) do |negated|
-  run('bundle exec vagrant landrush status')
+  run_command('bundle exec vagrant landrush status')
   if negated
     expect(last_command_started).to have_output(/Daemon status: stopped/)
   else

data/lib/landrush/cap/host/windows/configure_visibility_on_host.rb

@@ -1,5 +1,6 @@
 # This file needs to be able to execute out of the Vagrant context. Do not require any non core or non relative files
 require 'ipaddr'
+require 'English'
 require_relative '../../../util/retry'
 
 module Landrush
@@ -19,46 +20,101 @@ module Landrush
 
           # If this registry query succeeds we assume we have Admin rights
           # http://stackoverflow.com/questions/8268154/run-ruby-script-in-elevated-mode/27954953
+          # https://stackoverflow.com/a/2400/1040571
+          # "[...] $?, which is the same as $CHILD_STATUS,
+          # accesses the status of the last system executed command if you use
+          # the backticks, system() or %x{} [...]"
           def admin_mode?
-            (`reg query HKU\\S-1-5-19 2>&1` =~ /ERROR/).nil?
+            `reg query HKU\\S-1-5-19 2>&1`
+            $CHILD_STATUS.exitstatus.zero?
           end
 
-          # Given an IP determines the network name, if any. Uses netsh which generates output like this:
-          #
-          # ...
-          # \n\n
-          # Configuration for interface "Ethernet 2"
-          #    DHCP enabled:                         Yes
-          #    IP Address:                           10.10.10.1
-          #    Subnet Prefix:                        10.10.10.0/24 (mask 255.255.255.0)
-          #    InterfaceMetric:                      10
-          #    DNS servers configured through DHCP:  None
-          #    Register with which suffix:           Primary only
-          #    WINS servers configured through DHCP: None
-          # \n\n
-          # ...
-          def get_network_name(ip)
-            cmd_out = `netsh interface ip show config`
-            network_details = cmd_out.split(/^$/).reject(&:empty?).select do |settings|
-              begin
-                lines = settings.split(/\n/).reject(&:empty?)
-                subnet = lines[3]
-                next false unless subnet =~ /Subnet Prefix/
-
-                mask = IPAddr.new(subnet.match(%r{.* (\d{1,3}\.\d{1,3}\.\d{1,3}.\d{1,3}/\d{1,3}).*}).captures[0])
-                address = IPAddr.new(ip)
-
-                mask.include?(address)
-              rescue StandardError
-                false
+          # Given an IP determines the network adapter guid, if any.
+          # We can't use netsh due to its output being locale dependant.
+          # Using Windows registry we achieve the same result of netsh in
+          # whatever language Windows is.
+          def get_network_guid(address)
+            address = IPAddr.new(address.to_s)
+
+            interfaces do |interface_guid|
+              interface = open_interface("#{INTERFACES}\\#{interface_guid}")
+              if_ip, if_mask = interface_address(interface)
+
+              next if if_ip.nil?
+
+              if_net = IPAddr.new("#{if_ip}/#{if_mask}")
+              return interface_guid if if_net.include?(address)
+            end
+          rescue StandardError
+            nil
+          end
+
+          private
+
+          # Fetch interfaces from registry
+          # This is a separate method to make testing easier
+          def interfaces
+            Win32::Registry::HKEY_LOCAL_MACHINE.open(INTERFACES) do |interfaces|
+              interfaces.each_key do |guid, _|
+                yield guid
               end
             end
-            return nil if network_details[0].nil? || network_details[0].empty?
+          end
 
-            network_details[0].split(/\n/).reject(&:empty?)[0].match(/Configuration for interface "(.*)"/).captures[0].strip
+          # Opens an interface key from registry
+          # This is a separate method to make testing easier
+          def open_interface(guid_path)
+            Win32::Registry::HKEY_LOCAL_MACHINE.open(guid_path)
           end
 
-          private
+          # Fetches IP/mask info from registry from a given registry entry
+          # This is a separate method to make testing easier
+          #
+          # The registry may look like this:
+          # {46666082-84ff-4888-8d75-31079e325934}:
+          #         EnableDHCP => 1
+          #         DhcpIPAddress => 172.29.5.24
+          #         DhcpSubnetMask => 255.255.254.0
+          # {61e509a1-cffa-4b7f-8e7f-5a6991deba2b}:
+          #         EnableDHCP => 0
+          #         IPAddress => ["192.168.56.1"]
+          #         SubnetMask => ["255.255.255.0"]
+          # {6c902ac7-4845-46d4-843e-2707e2270b0d}:
+          #         EnableDHCP => 0
+          #         IPAddress => ["0.0.0.0"]
+          #         SubnetMask => ["0.0.0.0"]
+          # {6d2f3579-bc95-4a18-bed5-fb8b87b8673b}:
+          #         EnableDHCP => 0
+          #
+          # If a given interface does not have an address, win32/registry
+          # will trow an Win32::Registry::Error (which inherits directly from StandardError).
+          def interface_address(interface)
+            dhcp_enabled = interface.read('EnableDHCP')[1]
+
+            if dhcp_enabled
+              if_ip = interface.read('DhcpIPAddress')[1]
+              if_mask = interface.read('DhcpSubnetMask')[1]
+            else
+              if_ip = interface.read('IPAddress')[1]
+              if_mask = interface.read('SubnetMask')[1]
+            end
+
+            if if_ip.is_a? Array
+              if_ip = if_ip[0]
+            end
+
+            if if_mask.is_a? Array
+              if_mask = if_mask[0]
+            end
+
+            if if_ip == '0.0.0.0'
+              if_ip, if_mask = nil
+            end
+
+            [if_ip, if_mask]
+          rescue StandardError
+            [nil, nil]
+          end
 
           # Checks that all required tools are on the PATH and that the Wired AutoConfig service is started
           def ensure_prerequisites
@@ -92,19 +148,15 @@ module Landrush
             # Need to defer loading to ensure cross OS compatibility
             require 'win32/registry'
             if admin_mode?
-              network_name = get_network_name(ip)
-              if network_name.nil?
-                info("unable to determine network interface for #{ip}. DNS on host cannot be configured. Try manual configuration.")
-                return
-              else
-                info("adding Landrush'es DNS server to network '#{network_name}' using DNS IP '#{ip}'' and search domain '#{tld}'")
-              end
-              network_guid = get_guid(network_name)
+              address = IPAddr.new(ip)
+
+              network_guid = get_network_guid(address)
+
               if network_guid.nil?
                 info("unable to determine network GUID for #{ip}. DNS on host cannot be configured. Try manual configuration.")
                 return
               end
-              interface_path = INTERFACES + "\\{#{network_guid}}"
+              interface_path = INTERFACES + "\\#{network_guid}"
               Win32::Registry::HKEY_LOCAL_MACHINE.open(interface_path, Win32::Registry::KEY_ALL_ACCESS) do |reg|
                 reg['NameServer'] = '127.0.0.1'
                 reg['Domain'] = tld

data/lib/landrush/version.rb

@@ -1,3 +1,3 @@
 module Landrush
-  VERSION = '1.3.1'.freeze
+  VERSION = '1.3.2'.freeze
 end

data/test/landrush/cap/host/windows/configure_visibility_on_host_test.rb

@@ -21,49 +21,7 @@ DOT_3_SVC_STOPPED = 'SERVICE_NAME: dot3svc
         WAIT_HINT          : 0x0
 '.freeze
 
-NETSH_EXAMPLE = '
-Configuration for interface "VirtualBox Host-Only Network #1"
-    DHCP enabled:                         No
-    IP Address:                           192.168.99.1
-    Subnet Prefix:                        192.168.99.0/24 (mask 255.255.255.0)
-    InterfaceMetric:                      25
-    Statically Configured DNS Servers:    None
-    Register with which suffix:           Primary only
-    Statically Configured WINS Servers:   None
-
-Configuration for interface "Ethernet"
-    DHCP enabled:                         Yes
-    IP Address:                           192.168.1.193
-    Subnet Prefix:                        192.168.1.0/24 (mask 255.255.255.0)
-    Default Gateway:                      192.168.1.1
-    Gateway Metric:                       0
-    InterfaceMetric:                      35
-    DNS servers configured through DHCP:  192.168.1.1
-    Register with which suffix:           Primary only
-    WINS servers configured through DHCP: None
-
-Configuration for interface "Loopback Pseudo-Interface 1"
-    DHCP enabled:                         No
-    IP Address:                           127.0.0.1
-    Subnet Prefix:                        127.0.0.0/8 (mask 255.0.0.0)
-    InterfaceMetric:                      75
-    Statically Configured DNS Servers:    None
-    Register with which suffix:           Primary only
-    Statically Configured WINS Servers:   None
-'.freeze
-
-NETSH_EXAMPLE_SINGLE_INTERFACE = '
-Configuration for interface "Ethernet"
-    DHCP enabled:                         Yes
-    IP Address:                           192.168.1.193
-    Subnet Prefix:                        192.168.1.0/24 (mask 255.255.255.0)
-    Default Gateway:                      192.168.1.1
-    Gateway Metric:                       0
-    InterfaceMetric:                      35
-    DNS servers configured through DHCP:  192.168.1.1
-    Register with which suffix:           Primary only
-    WINS servers configured through DHCP: None
-'.freeze
+NETWORK_GUIDS = %w[{1abb8efe-c0d5-4ddf-8e29-eae8499e92ba} {34d34575-bc0d-4ca7-8571-97bccc35b437} {46666082-84ff-4888-8d75-31079e325934}].freeze
 
 module Landrush
   module Cap
@@ -107,31 +65,119 @@ module Landrush
           end
         end
 
-        describe '#get_network_name' do
-          it 'returns network name for matching IP' do
-            ConfigureVisibilityOnHost.expects(:`).with('netsh interface ip show config').returns(NETSH_EXAMPLE)
-            expect(ConfigureVisibilityOnHost.get_network_name('192.168.1.193')).must_equal('Ethernet')
+        describe '#get_network_guid' do
+          it 'should not be nil for IPAddr' do
+            ConfigureVisibilityOnHost.expects(:interfaces).multiple_yields(*NETWORK_GUIDS)
+
+            interface = MiniTest::Mock.new
+            interface.expect(:read, [0, false], ['EnableDHCP'])
+            interface.expect(:read, [0, '172.16.1.193'], ['IPAddress'])
+            interface.expect(:read, [0, '255.0.0.0'], ['SubnetMask'])
+            ConfigureVisibilityOnHost.expects(:open_interface).returns(interface)
+
+            address = IPAddr.new('172.28.128.3/32')
+            expect(ConfigureVisibilityOnHost.get_network_guid(address)).wont_be_nil
+          end
+
+          it 'should take into account that registry sometimes stores multiple IPs' do
+            ConfigureVisibilityOnHost.expects(:interfaces).yields(NETWORK_GUIDS[0])
+
+            interface = MiniTest::Mock.new
+            interface.expect(:read, [0, false], ['EnableDHCP'])
+            interface.expect(:read, [0, ['192.168.1.193']], ['IPAddress'])
+            interface.expect(:read, [0, ['255.255.255.0']], ['SubnetMask'])
+            ConfigureVisibilityOnHost.expects(:open_interface).returns(interface)
+            expect(ConfigureVisibilityOnHost.get_network_guid('192.168.1.193')).must_equal('{1abb8efe-c0d5-4ddf-8e29-eae8499e92ba}')
+          end
+
+          it 'should ignore 0.0.0.0 interfaces' do
+            ConfigureVisibilityOnHost.expects(:interfaces).multiple_yields(*NETWORK_GUIDS)
+
+            interface1 = MiniTest::Mock.new
+            interface1.expect(:read, [0, false], ['EnableDHCP'])
+            interface1.expect(:read, [0, '0.0.0.0'], ['IPAddress'])
+            interface1.expect(:read, [0, '0.0.0.0'], ['SubnetMask'])
+            interface2 = MiniTest::Mock.new
+            interface2.expect(:read, [0, false], ['EnableDHCP'])
+            interface2.expect(:read, [0, '192.168.1.193'], ['IPAddress'])
+            interface2.expect(:read, [0, '255.255.255.0'], ['SubnetMask'])
+            ConfigureVisibilityOnHost.expects(:open_interface).returns(interface1, interface2, interface1).at_most(3)
+
+            expect(ConfigureVisibilityOnHost.get_network_guid('192.168.1.193')).must_equal('{34d34575-bc0d-4ca7-8571-97bccc35b437}')
+          end
+
+          it 'returns the interface guid for matching static IP' do
+            ConfigureVisibilityOnHost.expects(:interfaces).multiple_yields(*NETWORK_GUIDS)
+
+            interface1 = MiniTest::Mock.new
+            interface1.expect(:read, [0, false], ['EnableDHCP'])
+            interface1.expect(:read, [0, '10.42.42.42'], ['IPAddress'])
+            interface1.expect(:read, [0, '255.0.0.0'], ['SubnetMask'])
+            interface2 = MiniTest::Mock.new
+            interface2.expect(:read, [0, false], ['EnableDHCP'])
+            interface2.expect(:read, [0, '192.168.1.193'], ['IPAddress'])
+            interface2.expect(:read, [0, '255.255.255.0'], ['SubnetMask'])
+            ConfigureVisibilityOnHost.expects(:open_interface).returns(interface1, interface2).at_most(2)
+
+            expect(ConfigureVisibilityOnHost.get_network_guid('192.168.1.193')).must_equal('{34d34575-bc0d-4ca7-8571-97bccc35b437}')
           end
 
           it 'returns nil for non matching IP' do
-            ConfigureVisibilityOnHost.expects(:`).with('netsh interface ip show config').returns(NETSH_EXAMPLE)
-            expect(ConfigureVisibilityOnHost.get_network_name('42.42.42.42')).must_be_nil
+            ConfigureVisibilityOnHost.expects(:interfaces).multiple_yields(*NETWORK_GUIDS)
+
+            interface1 = MiniTest::Mock.new
+            interface1.expect(:read, [0, false], ['EnableDHCP'])
+            interface1.expect(:read, [0, '10.42.42.42'], ['IPAddress'])
+            interface1.expect(:read, [0, '255.0.0.0'], ['SubnetMask'])
+            interface2 = MiniTest::Mock.new
+            interface2.expect(:read, [0, false], ['EnableDHCP'])
+            interface2.expect(:read, [0, '192.168.1.193'], ['IPAddress'])
+            interface2.expect(:read, [0, '255.255.255.0'], ['SubnetMask'])
+            interface3 = MiniTest::Mock.new
+            interface3.expect(:read, [0, false], ['EnableDHCP'])
+            interface3.expect(:read, [0, '172.16.1.193'], ['IPAddress'])
+            interface3.expect(:read, [0, '255.255.0.0'], ['SubnetMask'])
+            ConfigureVisibilityOnHost.expects(:open_interface).returns(interface1, interface2, interface3).at_most(3)
+            expect(ConfigureVisibilityOnHost.get_network_guid('42.42.42.42')).must_be_nil
+          end
+
+          it 'should work for DHCP set interfaces' do
+            ConfigureVisibilityOnHost.expects(:interfaces).multiple_yields(*NETWORK_GUIDS)
+
+            interface1 = MiniTest::Mock.new
+            interface1.expect(:read, [0, false], ['EnableDHCP'])
+            interface1.expect(:read, [0, '10.42.42.42'], ['IPAddress'])
+            interface1.expect(:read, [0, '255.0.0.0'], ['SubnetMask'])
+            interface2 = MiniTest::Mock.new
+            interface2.expect(:read, [0, true], ['EnableDHCP'])
+            interface2.expect(:read, [0, '192.168.1.193'], ['DhcpIPAddress'])
+            interface2.expect(:read, [0, '255.255.255.0'], ['DhcpSubnetMask'])
+            interface3 = MiniTest::Mock.new
+            interface3.expect(:read, [0, false], ['EnableDHCP'])
+            interface3.expect(:read, [0, '172.16.1.193'], ['IPAddress'])
+            interface3.expect(:read, [0, '255.255.0.0'], ['SubnetMask'])
+            ConfigureVisibilityOnHost.expects(:open_interface).returns(interface1, interface2, interface3).at_most(3)
+            expect(ConfigureVisibilityOnHost.get_network_guid('42.42.42.42')).must_be_nil
           end
 
           it 'returns nil for nil input' do
-            ConfigureVisibilityOnHost.expects(:`).with('netsh interface ip show config').returns(NETSH_EXAMPLE)
-            expect(ConfigureVisibilityOnHost.get_network_name(nil)).must_be_nil
+            expect(ConfigureVisibilityOnHost.get_network_guid(nil)).must_be_nil
           end
 
           it 'returns nil for empty input' do
-            ConfigureVisibilityOnHost.expects(:`).with('netsh interface ip show config').returns(NETSH_EXAMPLE)
-            expect(ConfigureVisibilityOnHost.get_network_name('')).must_be_nil
+            expect(ConfigureVisibilityOnHost.get_network_guid('')).must_be_nil
           end
 
           describe '#get_network_name' do
-            it 'returns network name for single interface' do
-              ConfigureVisibilityOnHost.expects(:`).with('netsh interface ip show config').returns(NETSH_EXAMPLE_SINGLE_INTERFACE)
-              expect(ConfigureVisibilityOnHost.get_network_name('192.168.1.193')).must_equal('Ethernet')
+            it 'returns network guid for single interface' do
+              ConfigureVisibilityOnHost.expects(:interfaces).yields(NETWORK_GUIDS[0])
+
+              interface = MiniTest::Mock.new
+              interface.expect(:read, [0, false], ['EnableDHCP'])
+              interface.expect(:read, [0, '192.168.1.193'], ['IPAddress'])
+              interface.expect(:read, [0, '255.255.255.0'], ['SubnetMask'])
+              ConfigureVisibilityOnHost.expects(:open_interface).returns(interface)
+              expect(ConfigureVisibilityOnHost.get_network_guid('192.168.1.193')).must_equal('{1abb8efe-c0d5-4ddf-8e29-eae8499e92ba}')
             end
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: landrush
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Paul Hinze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-04 00:00:00.000000000 Z
+date: 2019-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: filelock