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

data/lib/landrush/win_network_config.rb

@@ -1,185 +0,0 @@
-# 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'
-
-# This class configures the network interface on Windows for use with the Landrush DNS server.
-# It makes use of the netsh executable which is assumed to be available on the Windows host.
-module Landrush
-  class WinNetworkConfig
-    include Landrush::Util::Retry
-
-    # Windows registry path under which network interface configuration is stored
-    INTERFACES = 'SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters\\Interfaces'.freeze
-
-    def initialize(env={})
-      @env = env
-    end
-
-    # 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, name_server, domain)
-      # Need to defer loading to ensure cross OS compatibility
-      require 'win32/registry'
-      ensure_admin_privileges(__FILE__.to_s, ip, name_server, domain)
-
-      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 '#{domain}'")
-      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'] = name_server
-        reg['Domain'] = domain
-      end
-    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 self.admin_mode?
-      (`reg query HKU\\S-1-5-19 2>&1` =~ /ERROR/).nil?
-    end
-
-    private
-
-    # 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 self.class.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
-
-# 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
-  config = Landrush::WinNetworkConfig.new nil
-  config.update_network_adapter(ARGV[0], ARGV[1], ARGV[2])
-end

data/test/landrush/resolver_config_test.rb

@@ -1,19 +0,0 @@
-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)
-        resolver_config.config_file.exist?.must_equal false
-        resolver_config.ensure_config_exists!
-        resolver_config.config_file.exist?.must_equal true
-        resolver_config.config_file.read.must_equal <<-EOF.gsub(/^ +/, '')
-          # Generated by landrush, a vagrant plugin
-          nameserver 127.0.0.1
-          port #{Server.port}
-        EOF
-      end
-    end
-  end
-end

data/test/landrush/win_network_config_test.rb

@@ -1,70 +0,0 @@
-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_resolver_config.rb

@@ -1,25 +0,0 @@
-require 'tmpdir'
-
-module FakeResolverConfigHooks
-  def setup
-    super
-    tempdir = Dir.mktmpdir('vagrant_landrush_fake_resolver-')
-    @test_resolver_config_dir = Pathname(tempdir)
-    Landrush::ResolverConfig.config_dir = @test_resolver_config_dir
-    Landrush::ResolverConfig.sudo       = ''
-  end
-
-  def teardown
-    super
-    Landrush::ResolverConfig.sudo = 'sudo'
-    if @test_resolver_config_dir.exist?
-      @test_resolver_config_dir.rmtree
-    end
-  end
-end
-
-module MiniTest
-  class Spec
-    include FakeResolverConfigHooks
-  end
-end

data/test/support/fake_ui.rb

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