landrush 1.1.0.beta.1 → 1.1.0.beta.2

data/lib/landrush/cap/host/redhat/restart_dnsmasq.rb

@@ -0,0 +1,23 @@
+module Landrush
+  module Cap
+    module Redhat
+      module RestartDnsmasq
+        class << self
+          SED_COMMAND = <<-EOF.gsub(/^ +/, '')
+          sudo sed -i.orig '/nameserver/i\\
+          nameserver 127.0.0.1 # Added by landrush, a vagrant plugin
+
+          ' /etc/resolv.conf
+          EOF
+
+          def restart_dnsmasq(_env)
+            # TODO: At some stage we might want to make create_dnsmasq_config host specific and add the resolv.conf
+            # changes there which seems more natural
+            system(SED_COMMAND) unless system("cat /etc/resolv.conf | grep 'nameserver 127.0.0.1' > /dev/null 2>&1")
+            system('sudo systemctl restart dnsmasq')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/landrush/cap/host/ubuntu/host.rb

@@ -0,0 +1,12 @@
+module Landrush
+  module Cap
+    module Ubuntu
+      class UbuntuHost < Vagrant.plugin('2', 'host')
+        def detect?(_env)
+          return false unless Pathname('/usr/bin/lsb_release').exist?
+          system("/usr/bin/lsb_release -i | grep 'Ubuntu' >/dev/null 2>&1")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,187 @@
+# 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_relative '../../../util/retry'
+
+module Landrush
+  module Cap
+    module Windows
+      class ConfigureVisibilityOnHost
+        # Windows registry path under which network interface configuration is stored
+        INTERFACES = 'SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters\\Interfaces'.freeze
+
+        class << self
+          def configure_visibility_on_host(env, ip, tld)
+            @env = env
+            update_network_adapter(ip, tld) if ensure_prerequisites
+          end
+
+          # If this registry query succeeds we assume we have Admin rights
+          # http://stackoverflow.com/questions/8268154/run-ruby-script-in-elevated-mode/27954953
+          def admin_mode?
+            (`reg query HKU\\S-1-5-19 2>&1` =~ /ERROR/).nil?
+          end
+
+          private
+
+          # Checks that all required tools are on the PATH and that the Wired AutoConfig service is started
+          def ensure_prerequisites
+            return false unless command_found('netsh')
+            return false unless command_found('net')
+            return false unless command_found('reg')
+
+            unless wired_autoconfig_service_running?
+              info('starting \'Wired AutoConfig\' service')
+              if self.class.admin_mode?
+                `net start dot3svc`
+              else
+                require 'win32ole'
+                shell = WIN32OLE.new('Shell.Application')
+                shell.ShellExecute('net', 'start dot3svc', nil, 'runas', 1)
+              end
+              service_has_started = self.retry(tries: 5, sleep: 1) do
+                wired_autoconfig_service_running?
+              end
+              unless service_has_started
+                info('Unable to start \'Wired AutoConfig\' service. Unable to configure DNS on host. Try manual configuration.')
+                return false
+              end
+              info('\'Wired AutoConfig\' service has started.')
+            end
+            true
+          end
+
+          # Does the actual update of the network configuration
+          def update_network_adapter(ip, tld)
+            # Need to defer loading to ensure cross OS compatibility
+            require 'win32/registry'
+            ensure_admin_privileges(__FILE__.to_s, ip, tld)
+
+            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)
+            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}}"
+            Win32::Registry::HKEY_LOCAL_MACHINE.open(interface_path, Win32::Registry::KEY_ALL_ACCESS) do |reg|
+              reg['NameServer'] = '127.0.0.1'
+              reg['Domain'] = tld
+            end
+          end
+
+          # Given a network name (as displayed on 'Control Panel\Network and Internet\Network Connections'),
+          # determines the GUID of this network interface using 'netsh'.
+          #
+          # To make this work the "Wired Autoconfig" service must be started (go figure).
+          #
+          # Output of netsh command which is being processed:
+          #
+          # There are 4 interfaces on the system:
+          #
+          # Name             : Ethernet
+          # Description      : Intel(R) Ethernet Connection (3) I218-LM
+          # GUID             : fd9270f6-aff6-4f24-bc4a-1f90c032d5c3
+          # Physical Address : 50-7B-9D-AB-25-1D
+          # \n\n
+          # ...
+          def get_guid(network_name)
+            cmd_out = `netsh lan show interfaces`
+            interface_details = cmd_out.split(/\n\n/).select { |settings| settings.match(/#{Regexp.quote(network_name)}/m) }
+            return nil if interface_details.empty?
+            interface_details[0].split(/\n/)[2].match(/.*:(.*)/).captures[0].strip
+          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(/\n\n/).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
+                false
+              end
+            end
+            return nil if network_details[0].nil?
+            network_details[0].split(/\n/)[0].match(/Configuration for interface "(.*)"/).captures[0].strip
+          end
+
+          # Makes sure that we have admin privileges and if nor starts a new shell with the required
+          # privileges
+          def ensure_admin_privileges(file, *args)
+            unless admin_mode?
+              require 'win32ole'
+              shell = WIN32OLE.new('Shell.Application')
+              shell.ShellExecute('ruby', "#{file} #{args.join(' ')}", nil, 'runas', 1)
+              # need to exit current execution, changes will occur in new environment
+              exit
+            end
+          end
+
+          def info(msg)
+            @env[:ui].info("[landrush] #{msg}") unless @env.nil?
+          end
+
+          def wired_autoconfig_service_running?
+            cmd_out = `net start`
+            cmd_out =~ /Wired AutoConfig/m
+          end
+
+          def command_found(cmd)
+            if which(cmd).nil?
+              info("Cannot find '#{cmd}' on the PATH. Unable to configure DNS. Try manual configuration.")
+              false
+            else
+              true
+            end
+          end
+
+          # Cross-platform way of finding an executable in the $PATH.
+          #
+          #   which('ruby') #=> /usr/bin/ruby
+          def which(cmd)
+            exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+            ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+              exts.each do |ext|
+                exe = File.join(path, "#{cmd}#{ext}")
+                return exe if File.executable?(exe) && !File.directory?(exe)
+              end
+            end
+            nil
+          end
+        end
+      end
+    end
+  end
+end
+
+# Only run the following code when this file is the main file being run
+# instead of having been required or loaded by another file
+if __FILE__ == $0
+  Landrush::Cap::Windows::ConfigureVisibilityOnHost.configure_visibility_on_host(nil, ARGV[0], ARGV[1])
+end

data/lib/landrush/config.rb

@@ -8,26 +8,29 @@ module Landrush
     attr_accessor :guest_redirect_dns
     attr_accessor :host_interface
     attr_accessor :host_interface_excludes
+    attr_accessor :host_redirect_dns
 
     DEFAULTS = {
-      :enabled                 => false,
-      :tld                     => 'vagrant.test',
-      :upstream_servers        => [[:udp, '8.8.8.8', 53], [:tcp, '8.8.8.8', 53]],
-      :host_ip_address         => nil,
-      :guest_redirect_dns      => true,
-      :host_interface          => nil,
-      :host_interface_excludes => [/lo[0-9]*/, /docker[0-9]+/, /tun[0-9]+/]
+      :enabled                   => false,
+      :tld                       => 'vagrant.test',
+      :upstream_servers          => [[:udp, '8.8.8.8', 53], [:tcp, '8.8.8.8', 53]],
+      :host_ip_address           => nil,
+      :guest_redirect_dns        => true,
+      :host_interface            => nil,
+      :host_interface_excludes   => [/lo[0-9]*/, /docker[0-9]+/, /tun[0-9]+/],
+      :host_redirect_dns         => true
     }.freeze
 
     def initialize
-      @hosts                   = {}
-      @enabled                 = UNSET_VALUE
-      @tld                     = UNSET_VALUE
-      @upstream_servers        = UNSET_VALUE
-      @host_ip_address         = UNSET_VALUE
-      @guest_redirect_dns      = UNSET_VALUE
-      @host_interface          = UNSET_VALUE
-      @host_interface_excludes = UNSET_VALUE
+      @hosts                     = {}
+      @enabled                   = UNSET_VALUE
+      @tld                       = UNSET_VALUE
+      @upstream_servers          = UNSET_VALUE
+      @host_ip_address           = UNSET_VALUE
+      @guest_redirect_dns        = UNSET_VALUE
+      @host_interface            = UNSET_VALUE
+      @host_interface_excludes   = UNSET_VALUE
+      @host_redirect_dns         = UNSET_VALUE
     end
 
     def enable
@@ -46,6 +49,10 @@ module Landrush
       @guest_redirect_dns
     end
 
+    def host_redirect_dns?
+      @host_redirect_dns
+    end
+
     def host(hostname, ip_address=nil)
       @hosts[hostname] = ip_address
     end

data/lib/landrush/plugin.rb

@@ -63,43 +63,103 @@ module Landrush
     action_hook 'landrush_teardown', :machine_action_reload, &landrush_teardown
 
     guest_capability('debian', 'iptables_installed') do
-      require_relative 'cap/debian/iptables_installed'
+      require_relative 'cap/guest/debian/iptables_installed'
       Cap::Debian::IptablesInstalled
     end
 
     guest_capability('debian', 'install_iptables') do
-      require_relative 'cap/debian/install_iptables'
+      require_relative 'cap/guest/debian/install_iptables'
       Cap::Debian::InstallIptables
     end
 
     guest_capability('redhat', 'iptables_installed') do
-      require_relative 'cap/redhat/iptables_installed'
+      require_relative 'cap/guest/redhat/iptables_installed'
       Cap::Redhat::IptablesInstalled
     end
 
     guest_capability('redhat', 'install_iptables') do
-      require_relative 'cap/redhat/install_iptables'
+      require_relative 'cap/guest/redhat/install_iptables'
       Cap::Redhat::InstallIptables
     end
 
     guest_capability('linux', 'configured_dns_servers') do
-      require_relative 'cap/linux/configured_dns_servers'
+      require_relative 'cap/guest/linux/configured_dns_servers'
       Cap::Linux::ConfiguredDnsServers
     end
 
     guest_capability('linux', 'redirect_dns') do
-      require_relative 'cap/linux/redirect_dns'
+      require_relative 'cap/guest/linux/redirect_dns'
       Cap::Linux::RedirectDns
     end
 
     guest_capability('linux', 'add_iptables_rule') do
-      require_relative 'cap/linux/add_iptables_rule'
+      require_relative 'cap/guest/linux/add_iptables_rule'
       Cap::Linux::AddIptablesRule
     end
 
     guest_capability('linux', 'read_host_visible_ip_address') do
-      require_relative 'cap/all/read_host_visible_ip_address'
+      require_relative 'cap/guest/all/read_host_visible_ip_address'
       Cap::All::ReadHostVisibleIpAddress
     end
+
+    host_capability('darwin', 'configure_visibility_on_host') do
+      require_relative 'cap/host/darwin/configure_visibility_on_host'
+      Cap::Darwin::ConfigureVisibilityOnHost
+    end
+
+    host_capability('windows', 'configure_visibility_on_host') do
+      require_relative 'cap/host/windows/configure_visibility_on_host'
+      Cap::Windows::ConfigureVisibilityOnHost
+    end
+
+    host_capability('linux', 'configure_visibility_on_host') do
+      require_relative 'cap/host/linux/configure_visibility_on_host'
+      Cap::Linux::ConfigureVisibilityOnHost
+    end
+
+    host_capability('linux', 'create_dnsmasq_config') do
+      require_relative 'cap/host/linux/create_dnsmasq_config'
+      Cap::Linux::CreateDnsmasqConfig
+    end
+
+    host 'debian', 'linux' do
+      require_relative 'cap/host/debian/host'
+      Cap::Debian::DebianHost
+    end
+
+    host 'ubuntu', 'debian' do
+      require_relative 'cap/host/ubuntu/host'
+      Cap::Ubuntu::UbuntuHost
+    end
+
+    host_capability('debian', 'dnsmasq_installed') do
+      require_relative 'cap/host/debian/dnsmasq_installed'
+      Landrush::Cap::Debian::DnsmasqInstalled
+    end
+
+    host_capability('debian', 'install_dnsmasq') do
+      require_relative 'cap/host/debian/install_dnsmasq'
+      Cap::Debian::InstallDnsmasq
+    end
+
+    host_capability('debian', 'restart_dnsmasq') do
+      require_relative 'cap/host/debian/restart_dnsmasq'
+      Cap::Debian::RestartDnsmasq
+    end
+
+    host_capability('redhat', 'dnsmasq_installed') do
+      require_relative 'cap/host/redhat/dnsmasq_installed'
+      Cap::Redhat::DnsmasqInstalled
+    end
+
+    host_capability('redhat', 'install_dnsmasq') do
+      require_relative 'cap/host/redhat/install_dnsmasq'
+      Cap::Redhat::InstallDnsmasq
+    end
+
+    host_capability('redhat', 'restart_dnsmasq') do
+      require_relative 'cap/host/redhat/restart_dnsmasq'
+      Cap::Redhat::RestartDnsmasq
+    end
   end
 end

data/lib/landrush/version.rb

@@ -1,3 +1,3 @@
 module Landrush
-  VERSION = '1.1.0.beta.1'.freeze
+  VERSION = '1.1.0.beta.2'.freeze
 end

data/test/landrush/action/setup_test.rb

@@ -5,17 +5,13 @@ require 'landrush/action/setup'
 module Landrush
   module Action
     describe Setup do
+      let(:env) { fake_environment }
+      let(:app) { proc {} }
       before do
-        ResolverConfig.sudo = ''
-      end
-
-      after do
-        ResolverConfig.sudo = 'sudo'
+        env[:machine].config.landrush.host_redirect_dns = false
       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)
 
@@ -25,10 +21,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
 
         setup.call(env)
 
@@ -36,10 +29,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
 
         setup.call(env)
 
@@ -47,10 +37,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
 
         Server.start
         original_pid = Server.pid
@@ -62,10 +49,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
 
         env[:machine].config.landrush.disable
         setup.call(env)
@@ -74,10 +58,7 @@ module Landrush
       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)
@@ -85,10 +66,7 @@ module Landrush
       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'
@@ -98,10 +76,7 @@ module Landrush
       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)
@@ -111,10 +86,7 @@ module Landrush
 
       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
 
           setup.call(env)
 
@@ -122,11 +94,9 @@ 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)
 
+          env = fake_environment(enabled: false)
           setup.call(env)
 
           Store.hosts.get('somehost.vagrant.test').must_equal nil