landrush 1.1.2 → 1.2.0

data/test/landrush/config_test.rb

@@ -1,7 +1,7 @@
 require_relative '../test_helper'
 
 describe 'Landrush::Config' do
-  it "supports enabling via accessor style" do
+  it 'supports enabling via accessor style' do
     machine = fake_machine
     config = machine.config.landrush
 
@@ -11,7 +11,7 @@ describe 'Landrush::Config' do
     config.enabled?.must_equal false
   end
 
-  it "is backwards-compatible with the old method call style" do
+  it 'is backwards-compatible with the old method call style' do
     machine = fake_machine
     config = machine.config.landrush
 
@@ -20,4 +20,25 @@ describe 'Landrush::Config' do
     machine.config.landrush.disable
     config.enabled?.must_equal false
   end
+
+  it 'should validate host_interface_class' do
+    machine = fake_machine
+    config = machine.config.landrush
+
+    validation_success = []
+    validation_error = [Landrush::Config::INTERFACE_CLASS_INVALID, { fields: 'host_interface_class' }]
+
+    Landrush::Config::INTERFACE_CLASSES.each do |sym|
+      machine.config.landrush.host_interface_class = sym
+      config.validate(machine).must_equal('landrush' => validation_success)
+
+      machine.config.landrush.host_interface_class = sym.to_s
+      config.validate(machine).must_equal('landrush' => validation_success)
+    end
+
+    [:invalid_symbol, 'invalid_string', 4].each do |v|
+      machine.config.landrush.host_interface_class = v
+      config.validate(machine).must_equal('landrush' => validation_error)
+    end
+  end
 end

data/test/landrush/dependent_vms_test.rb

@@ -2,23 +2,23 @@ require_relative '../test_helper'
 
 module Landrush
   describe DependentVMs do
-    describe "any?" do
-      it "reports false when nothing has happened" do
+    describe 'any?' do
+      it 'reports false when nothing has happened' do
         DependentVMs.any?.must_equal false
       end
 
-      it "reports true once a machine has been added" do
+      it 'reports true once a machine has been added' do
         DependentVMs.add('recordme.example.test')
         DependentVMs.any?.must_equal true
       end
 
-      it "reports false if a machine has been added then removed" do
+      it 'reports false if a machine has been added then removed' do
         DependentVMs.add('recordme.example.test')
         DependentVMs.remove('recordme.example.test')
         DependentVMs.any?.must_equal false
       end
 
-      it "reports true if not all machines have been removed" do
+      it 'reports true if not all machines have been removed' do
         DependentVMs.add('recordme.example.test')
         DependentVMs.add('alsome.example.test')
         DependentVMs.remove('recordme.example.test')

data/test/landrush/issues/255.rb

@@ -0,0 +1,115 @@
+require_relative '../../test_helper'
+
+module Landrush
+  module Cap
+    module All
+      describe ReadHostVisibleIpAddress do
+        let(:landrush_ip_output) do
+          <<YAML
+- name: br-44ba74744d5d
+  ipv4: 172.17.0.1
+  ipv6: fe80::42:e1ff:fe01:ae98
+- name: br-7884014b4104
+  ipv4: 172.19.0.1
+  ipv6: fe80::42:c0ff:fe4b:900c
+- name: br-efce9da0c1fd
+  ipv4: 172.18.0.1
+  ipv6: fe80::42:2ff:fe46:f1d1
+- name: docker0
+  ipv4: 172.16.0.1
+  ipv6: fe80::42:dbff:fe1b:6e92
+- name: docker_gwbridge
+  ipv4: 172.20.0.1
+  ipv6: fe80::42:72ff:fe96:c6df
+- name: enp4s0
+  ipv4: 192.168.88.97
+  ipv6: fe80::323d:9fa0:ef2a:ddf5
+- name: wlp3s0
+  ipv4: 192.168.88.118
+  ipv6: fe80::6b80:15d4:e83c:a59d
+- name: lo
+  ipv4: 127.0.0.1
+  ipv6: ::1/128
+- name: veth050aa01
+  ipv4: ""
+  ipv6: fe80::c83a:8eff:fe7a:3244
+- name: veth1c191f7
+  ipv4: ""
+  ipv6: fe80::b498:f3ff:fea1:3243
+- name: veth38aa771
+  ipv4: ""
+  ipv6: fe80::8c97:e2ff:fe1a:b14f
+- name: veth5f49498
+  ipv4: ""
+  ipv6: fe80::6825:20ff:fef5:a00d
+- name: veth7803c65
+  ipv4: ""
+  ipv6: fe80::34d7:6cff:fe28:54ce
+- name: veth8a09803
+  ipv4: ""
+  ipv6: fe80::b436:30ff:fed1:598e
+- name: veth8bf1652
+  ipv4: ""
+  ipv6: fe80::60a8:67ff:fe85:cce4
+- name: veth95ef8de
+  ipv4: ""
+  ipv6: fe80::9c45:e8ff:fe69:e62f
+- name: vethc75f284
+  ipv4: ""
+  ipv6: fe80::78b2:7fff:fe55:59
+- name: vethe533ef0
+  ipv4: ""
+  ipv6: fe80::b83e:93ff:fe52:aac7
+YAML
+        end
+
+        let(:machine) { fake_machine }
+        let(:addresses) { YAML.load(landrush_ip_output) }
+
+        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_installed).returns(true)
+          machine.guest.stubs(:capability).with(:landrush_ip_get).returns(addresses)
+
+          machine.config.landrush.host_interface          = nil
+          machine.config.landrush.host_interface_excludes = [/lo[0-9]*/, /docker[0-9]+/, /tun[0-9]+/, /br-(.+)/]
+        end
+
+        describe 'Issue 255: read_host_visible_ip_address failure in presence of interface without IPv4, with IPv6 address' do
+          # Test IPv4
+          it 'should return the last non-empty IPv4 address' do
+            expected = addresses.detect { |a| a['name'] == 'wlp3s0' }
+            expected = expected['ipv4']
+
+            call_cap(machine).must_equal expected
+          end
+
+          # Test IPv6 selection
+          it 'should return the last non-empty IPv6 address' do
+            machine.config.landrush.host_interface_class = :ipv6
+
+            expected = addresses.detect { |a| a['name'] == 'vethe533ef0' }
+            expected = expected['ipv6']
+
+            call_cap(machine).must_equal expected
+          end
+
+          # Test ANY selection
+          it 'should return the last non-empty address of either class' do
+            machine.config.landrush.host_interface_class = :any
+
+            expected = addresses.detect { |a| a['name'] == 'vethe533ef0' }
+            expected = expected['ipv6']
+
+            call_cap(machine).must_equal expected
+          end
+        end
+      end
+    end
+  end
+end

data/test/landrush/server_test.rb

@@ -1,16 +1,34 @@
-require_relative '../test_helper'
 require 'resolv'
+require 'tmpdir'
+require 'fileutils'
+
+require_relative '../test_helper'
 
 module Landrush
   describe Server do
     def query(host)
-      Resolv::DNS.open(:nameserver_port => [["127.0.0.1", Server.port]]) do |r|
+      Resolv::DNS.open(nameserver_port: [['127.0.0.1', Server.port]]) do |r|
         r.getaddress(host).to_s
       end
     end
 
     def wait_for_port
-      sleep 1 until (TCPSocket.open('127.0.0.1', Server.port) rescue nil)
+      sleep 1 until begin
+                       TCPSocket.open('127.0.0.1', Server.port)
+                     rescue
+                       nil
+                     end
+    end
+
+    before do
+      @tmp_dir = Dir.mktmpdir('landrush-server-test-')
+      Server.working_dir = @tmp_dir
+      Server.gems_dir = gem_dir
+    end
+
+    after do
+      Server.stop
+      FileUtils.rm_rf(@tmp_dir) if File.exist?(@tmp_dir)
     end
 
     describe 'start/stop' do
@@ -32,7 +50,7 @@ module Landrush
 
         wait_for_port
 
-        query("phinze.com").must_match(/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/)
+        query('phinze.com').must_match(/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/)
       end
 
       it 'responds properly to configured machine entries' do

data/test/landrush/store_test.rb

@@ -3,7 +3,7 @@ require_relative '../test_helper'
 module Landrush
   describe Store do
     before do
-      @temp_file = Tempfile.new(%w[landrush_test_store .json])
+      @temp_file = Tempfile.new(%w(landrush_test_store .json))
       @store = Store.new(@temp_file)
     end
 
@@ -11,14 +11,14 @@ module Landrush
       @temp_file.unlink
     end
 
-    describe "set" do
-      it "sets the key to the value and makes it available for getting" do
+    describe 'set' do
+      it 'sets the key to the value and makes it available for getting' do
         @store.set('foo', 'bar')
 
         @store.get('foo').must_equal 'bar'
       end
 
-      it "allows updating keys that already exist" do
+      it 'allows updating keys that already exist' do
         @store.set('foo', 'bar')
         @store.set('foo', 'qux')
 
@@ -26,12 +26,12 @@ module Landrush
       end
     end
 
-    describe "get" do
-      it "returns nil for unset values" do
+    describe 'get' do
+      it 'returns nil for unset values' do
         @store.get('notakey').must_equal nil
       end
 
-      it "returns the latest set value (no caching)" do
+      it 'returns the latest set value (no caching)' do
         @store.set('foo', 'first')
         @store.get('foo').must_equal 'first'
         @store.set('foo', 'second')
@@ -41,8 +41,8 @@ module Landrush
       end
     end
 
-    describe "delete" do
-      it "removes the key from the store" do
+    describe 'delete' do
+      it 'removes the key from the store' do
         @store.set('now', 'you see me')
 
         @store.get('now').must_equal 'you see me'
@@ -53,8 +53,8 @@ module Landrush
       end
     end
 
-    describe "find" do
-      it "returns the key that matches the end of the search term" do
+    describe 'find' do
+      it 'returns the key that matches the end of the search term' do
         @store.set('somehost.vagrant.test', 'here')
 
         @store.find('foo.somehost.vagrant.test').must_equal 'somehost.vagrant.test'
@@ -63,12 +63,12 @@ module Landrush
         @store.find('host.vagrant.test').must_equal nil
       end
 
-      it "returns exact matches too" do
+      it 'returns exact matches too' do
         @store.set('somehost.vagrant.test', 'here')
         @store.find('somehost.vagrant.test').must_equal 'somehost.vagrant.test'
       end
 
-      it "returns for prefix searches as well" do
+      it 'returns for prefix searches as well' do
         @store.set('somehost.vagrant.test', 'here')
 
         @store.find('somehost').must_equal 'somehost.vagrant.test'
@@ -77,5 +77,20 @@ module Landrush
         @store.find('someh').must_equal nil
       end
     end
+
+    describe 'clear' do
+      it 'clears all keys from the store' do
+        @store.set('foo', 'bar')
+        @store.set('foo', 'qux')
+
+        @store.clear!
+
+        count = 0
+        @store.each do
+          count += 1
+        end
+        count.must_equal 0
+      end
+    end
   end
 end

data/test/support/test_server_daemon.rb

@@ -16,7 +16,7 @@ module SilenceOutput
   def self.included(base)
     orig_stop_method = base.method(:stop)
     base.define_singleton_method :stop do
-      SilenceOutput.silence {orig_stop_method.call}
+      SilenceOutput.silence { orig_stop_method.call }
     end
   end
 end
@@ -31,9 +31,7 @@ module TestServerHooks
   def teardown
     super
     # Cleanup any stray server instances from tests
-    if Landrush::Server.running?
-      Landrush::Server.stop
-    end
+    Landrush::Server.stop if Landrush::Server.running?
     Landrush::Store.reset
   end
 end

data/test/test_helper.rb

@@ -1,4 +1,4 @@
-$:.push(File.expand_path('../../lib', __FILE__))
+$LOAD_PATH.push(File.expand_path('../../lib', __FILE__))
 
 require 'bundler/setup'
 require 'minitest/spec'
@@ -19,32 +19,53 @@ require 'mocha/mini_test'
 # 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'}
+    { 'name' => 'ipv6empty1', 'ipv4' => '172.28.128.10', 'ipv6' => '' },
+    { 'name' => 'ipv4empty1', 'ipv4' => '',              'ipv6' => '::10' },
+    { 'name' => 'ipv6empty2', 'ipv4' => '172.28.128.11', 'ipv6' => '' },
+    { 'name' => 'ipv4empty2', 'ipv4' => '',              'ipv6' => '::11' },
+    { '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})
+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
-  {machine: fake_machine(options), ui: FakeUI.new, home_path: vagrant_test_home}
+  machine = fake_machine(options)
+  { machine: machine, ui: FakeUI.new, home_path: vagrant_test_home, gems_path: machine.env.gems_path }
+end
+
+# Returns the gem directory for running unit tests
+def gem_dir
+  `gem environment gemdir`.strip!
 end
 
 class FakeUI
+  attr_reader :received_detail_messages
   attr_reader :received_info_messages
+  attr_reader :received_error_messages
 
   def initialize
+    @received_detail_messages = []
     @received_info_messages = []
+    @received_error_messages = []
+  end
+
+  def detail(*args)
+    @received_detail_messages << args[0]
   end
 
   def info(*args)
-    # puts "#{args}"
     @received_info_messages << args[0]
   end
+
+  def error(*args)
+    @received_error_messages << args[0]
+  end
 end
 
 class RecordingCommunicator
@@ -111,8 +132,10 @@ module Landrush
   end
 end
 
-def fake_machine(options={})
+def fake_machine(options = {})
+  gem_path = Pathname.new(gem_dir)
   env = options.fetch(:env, Vagrant::Environment.new)
+  env.stubs(:gems_path).returns(gem_path)
   machine = Vagrant::Machine.new(
     'fake_machine',
     'fake_provider',
@@ -122,11 +145,11 @@ def fake_machine(options={})
     env.vagrantfile.config, # config
     Pathname('data_dir'),
     'box',
-    options.fetch(:env, Vagrant::Environment.new),
+    env,
     env.vagrantfile
   )
 
-  machine.instance_variable_set("@communicator", RecordingCommunicator.new)
+  machine.instance_variable_set('@communicator', RecordingCommunicator.new)
 
   machine.config.landrush.enabled = options.fetch(:enabled, false)
   machine.config.landrush.host_interface = nil
@@ -145,7 +168,7 @@ end
 
 module MiniTest
   class Spec
-    alias_method :hush, :capture_io
+    alias hush capture_io
   end
 end