landrush 0.3.0

data/lib/landrush/dependent_vms.rb

@@ -0,0 +1,40 @@
+require 'fileutils'
+
+#
+# Keep track of dependent VMs.
+#
+# Poor man's race condition defense - touch and rm files in a directory and count them.
+#
+module Landrush
+  class DependentVMs
+    extend Enumerable
+
+    def self.each(&block)
+      (dir.directory? ? dir.children : []).each(&block)
+    end
+
+    def self.add(machine)
+      FileUtils.touch(file_for(machine))
+    end
+
+    def self.remove(machine)
+      file_for(machine).tap { |f| f.delete if f.exist? }
+    end
+
+    def self.list
+      self.map { |path| path.basename.to_s }
+    end
+
+    def self.clear!
+      dir.rmtree
+    end
+
+    def self.file_for(machine)
+      dir.join(Util.hostname(machine))
+    end
+
+    def self.dir
+      Landrush.working_dir.join('dependent_vms').tap(&:mkpath)
+    end
+  end
+end

data/lib/landrush/plugin.rb

@@ -0,0 +1,32 @@
+module Landrush
+  class Plugin < Vagrant.plugin('2')
+    name 'landrush'
+
+    command 'landrush' do
+      require_relative 'command'
+      Command
+    end
+
+    config 'landrush' do
+      require_relative 'config'
+      Config
+    end
+
+    action_hook 'landrush_setup', :machine_action_up do |hook|
+      require_relative 'action/setup'
+      require_relative 'action/redirect_dns'
+      hook.before(VagrantPlugins::ProviderVirtualBox::Action::Boot, Action::Setup)
+      hook.after(VagrantPlugins::ProviderVirtualBox::Action::Boot, Action::RedirectDns)
+    end
+
+    action_hook 'landrush_teardown', :machine_action_halt do |hook|
+      require_relative 'action/teardown'
+      hook.after(Vagrant::Action::Builtin::GracefulHalt, Action::Teardown)
+    end
+
+    action_hook 'landrush_teardown', :machine_action_destroy do |hook|
+      require_relative 'action/teardown'
+      hook.after(Vagrant::Action::Builtin::GracefulHalt, Action::Teardown)
+    end
+  end
+end

data/lib/landrush/resolver_config.rb

@@ -0,0 +1,53 @@
+require 'tempfile'
+
+module Landrush
+  class ResolverConfig
+    def self.desired_contents; <<-EOS.gsub(/^      /, '')
+      # Generated by landrush, a vagrant plugin
+      nameserver 127.0.0.1
+      port 10053
+      EOS
+    end
+
+    def self.osx?
+      `uname`.chomp == 'Darwin'
+    end
+
+    def self.config_file
+      @config_file ||= Pathname('/etc/resolver/vagrant.dev')
+    end
+
+    def self.contents_match?
+      config_file.exist? && File.read(config_file) == desired_contents
+    end
+
+    def self.write_config
+      puts "Mometarily using sudo to put the host config in place..."
+      Tempfile.open('vagrant_landrush_host_config') do |f|
+        f.write(desired_contents)
+        f.close
+        sudo = config_file.parent.writable? ? '' : 'sudo'
+        system "#{sudo} cp #{f.path} #{config_file}"
+        system "#{sudo} chmod 644 #{config_file}"
+      end
+    end
+
+    def self.ensure_config_exists
+      unless osx?
+        puts "Not an OSX machine, so skipping host DNS resolver config."
+        return
+      end
+
+      if contents_match?
+        puts "Host DNS resolver config looks good."
+      else
+        puts "Need to configure the host."
+        write_config
+      end
+    end
+
+    def self.puts(str)
+      Kernel.puts("[landrush] #{str}")
+    end
+  end
+end

data/lib/landrush/server.rb

@@ -0,0 +1,69 @@
+require 'rubydns'
+
+module Landrush
+  class Server < RExec::Daemon::Base
+    Name = Resolv::DNS::Name
+    IN   = Resolv::DNS::Resource::IN
+
+    def self.port
+      @port ||= 10053
+    end
+
+    def self.port=(port)
+      @port = port
+    end
+
+    def self.upstream_servers
+      [[:udp, "8.8.8.8", 53], [:tcp, "8.8.8.8", 53]]
+    end
+
+    def self.interfaces
+      [
+        [:udp, "0.0.0.0", port],
+        [:tcp, "0.0.0.0", port]
+      ]
+    end
+
+    def self.upstream
+      @upstream ||= landrush::Resolver.new(upstream_servers)
+    end
+
+    def self.pid
+      RExec::Daemon::ProcessFile.recall(self)
+    end
+
+    # For RExec
+    def self.working_directory
+      Landrush.working_dir
+    end
+
+    def self.running?
+      RExec::Daemon::ProcessFile.status(self) == :running
+    end
+
+    def self.prefork
+      super
+    end
+
+    def self.run
+      server = self
+      RubyDNS::run_server(:listen => interfaces) do
+        self.logger.level = Logger::INFO
+        
+        match(/.*/, IN::A) do |transaction|
+          ip = Store.hosts.get(transaction.name)
+          if ip
+            transaction.respond!(ip)
+          else
+            transaction.passthrough!(server.upstream)
+          end
+        end
+
+        # Default DNS handler
+        otherwise do |transaction|
+          transaction.passthrough!(server.upstream)
+        end
+      end
+    end
+  end
+end

data/lib/landrush/store.rb

@@ -0,0 +1,49 @@
+module Landrush
+  class Store
+    def self.hosts
+      @hosts ||= new(Landrush.working_dir.join('hosts.json'))
+    end
+
+    attr_accessor :backing_file
+
+    def initialize(backing_file)
+      @backing_file = Pathname(backing_file)
+    end
+
+    def set(key, value)
+      write(current_config.merge(key => value))
+    end
+
+    def delete(key)
+      write(current_config.reject { |k, _| k == key })
+    end
+
+    def get(key)
+      current_config[key]
+    end
+
+    def clear!
+      write({})
+    end
+
+    protected
+
+    def current_config
+      if backing_file.exist?
+        begin
+          JSON.parse(File.read(backing_file))
+        rescue JSON::ParserError
+          {}
+        end
+      else
+        {}
+      end
+    end
+
+    def write(config)
+      File.open(backing_file, "w") do |f|
+        f.write(JSON.pretty_generate(config))
+      end
+    end
+  end
+end

data/lib/landrush/util.rb

@@ -0,0 +1,25 @@
+module Landrush
+  module Util
+    def self.host_and_ip(machine)
+      [hostname(machine), ip_address(machine)]
+    end
+
+    def self.hostname(machine)
+      return nil unless machine
+
+      machine.config.vm.hostname
+    end
+
+    def self.ip_address(machine)
+      return nil unless machine
+
+      machine.config.vm.networks.each do |type, options|
+        if type == :private_network && options[:ip].is_a?(String)
+          return options[:ip]
+        end
+      end
+
+      nil
+    end
+  end
+end

data/lib/landrush/version.rb

@@ -0,0 +1,3 @@
+module Landrush
+  VERSION = "0.3.0"
+end

data/test/landrush/action/setup_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+require 'landrush/action/setup'
+
+module Landrush
+  module Action
+    describe Setup do
+      it "calls the next app in the chain" do
+        env = fake_environment(called: false)
+        app = lambda { |e| e[:called] = true }
+        setup = Setup.new(app, nil)
+
+        setup.call(env)
+
+        env[:called].must_equal true
+      end
+
+      it "stores the machine's hostname => ip address" do
+        app = Proc.new {}
+        setup = Setup.new(app, nil)
+        env = fake_environment_with_machine('somehost.vagrant.dev', '1.2.3.4')
+
+        setup.call(env)
+
+        Store.hosts.get('somehost.vagrant.dev').must_equal '1.2.3.4'
+      end
+
+      it "records the booting host as a dependent VM" do
+        app = Proc.new {}
+        setup = Setup.new(app, nil)
+        env = fake_environment_with_machine('somehost.vagrant.dev', '1.2.3.4')
+
+        setup.call(env)
+
+        DependentVMs.list.must_equal %w[somehost.vagrant.dev]
+      end
+
+      it "starts the landrush server if it's not already started" do
+        app = Proc.new {}
+        setup = Setup.new(app, nil)
+        env = fake_environment_with_machine('somehost.vagrant.dev', '1.2.3.4')
+
+        setup.call(env)
+
+        Server.running?.must_equal true
+      end
+
+      it "does not attempt to start the server if it's already up" do
+        app = Proc.new {}
+        setup = Setup.new(app, nil)
+        env = fake_environment_with_machine('somehost.vagrant.dev', '1.2.3.4')
+
+        Server.start
+        original_pid = Server.pid
+
+        setup.call(env)
+
+        Server.running?.must_equal true
+        Server.pid.must_equal original_pid
+      end
+
+      it "does nothing if it is not enabled via config" do
+        app = Proc.new {}
+        setup = Setup.new(app, nil)
+        env = fake_environment_with_machine('somehost.vagrant.dev', '1.2.3.4')
+
+        env[:global_config].landrush.disable
+        setup.call(env)
+
+        Store.hosts.get('somehost.vagrant.dev').must_equal nil
+      end
+    end
+  end
+end

data/test/landrush/action/teardown_test.rb

@@ -0,0 +1,92 @@
+require 'test_helper'
+require 'landrush/action/teardown'
+
+module Landrush
+  module Action
+    describe Teardown do
+      it "calls the next app in the chain" do
+        env = fake_environment(called: false)
+        app = lambda { |e| e[:called] = true }
+        teardown = Teardown.new(app, nil)
+
+        teardown.call(env)
+
+        env[:called].must_equal true
+      end
+
+      it "clears the machine's hostname => ip address" do
+        app = Proc.new {}
+        teardown = Teardown.new(app, nil)
+        env = fake_environment_with_machine('somehost.vagrant.dev', '1.2.3.4')
+
+        Store.hosts.set('somehost.vagrant.dev', '1.2.3.4')
+        teardown.call(env)
+
+        Store.hosts.get('somehost.vagrant.dev').must_equal nil
+      end
+
+      it "removes the machine as a dependent VM" do
+        app = Proc.new {}
+        teardown = Teardown.new(app, nil)
+        env = fake_environment_with_machine('somehost.vagrant.dev', '1.2.3.4')
+
+        DependentVMs.add(env[:machine])
+        teardown.call(env)
+
+        DependentVMs.list.must_equal []
+      end
+
+      it "stops the landrush server when there are no dependent machines left" do
+        app = Proc.new {}
+        teardown = Teardown.new(app, nil)
+        env = fake_environment_with_machine('somehost.vagrant.dev', '1.2.3.4')
+
+        Server.start
+        teardown.call(env)
+
+        Server.running?.must_equal false
+      end
+
+      it "leaves the landrush server when other dependent vms exist" do
+        app = Proc.new {}
+        teardown = Teardown.new(app, nil)
+        env = fake_environment_with_machine('somehost.vagrant.dev', '1.2.3.4')
+
+        other_env = fake_environment_with_machine('otherhost.vagrant.dev', '1.2.3.4')
+        DependentVMs.add(other_env[:machine])
+
+        Server.start
+        teardown.call(env)
+
+        Server.running?.must_equal true
+      end
+
+      it "leaves the server alone if it's not running" do
+        app = Proc.new {}
+        teardown = Teardown.new(app, nil)
+        env = fake_environment_with_machine('somehost.vagrant.dev', '1.2.3.4')
+
+        teardown.call(env)
+
+        Server.running?.must_equal false
+      end
+
+      it "does nothing when landrush is disabled" do
+        # somewhat unrealistic since this entry shouldn't be there if it was
+        # disabled in the first place, but oh well
+        Store.hosts.set('somehost.vagrant.dev', '1.2.3.4')
+
+        app = Proc.new {}
+        teardown = Teardown.new(app, nil)
+
+        env = fake_environment_with_machine('somehost.vagrant.dev', '1.2.3.4')
+        env[:global_config].landrush.disable
+
+        teardown.call(env)
+
+        Store.hosts.get('somehost.vagrant.dev').must_equal '1.2.3.4'
+      end
+    end
+  end
+end
+