landrush 0.3.0

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tags
+
+.vagrant
+.vagrant_dns.json

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+
+  gem "debugger"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Paul Hinze
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# Landrush: DNS for Vagrant
+
+Simple DNS that's visible on both the guest and the host.
+
+> Because even a Vagrant needs a place to settle down once in a while.
+
+Spins up a small DNS server and redirects DNS traffic from your VMs to use it,
+automatically registers/deregisters IP addresseses of guests as they come up
+and down.
+
+## Installation
+
+Install under Vagrant (1.1 or later):
+
+    $ vagrant plugin install landrush
+
+## Usage
+
+Enable the plugin in your `Vagrantfile`:
+
+    config.landrush.enable
+
+Bring up a machine that has a private network IP address and a hostname (see the `Vagrantfile` for an example) 
+
+    $ vagrant up
+
+And you should be able to get your hostname from your host:
+
+    $ dig -p 10053 @localhost myhost.vagrant.dev
+    
+If you shut down your guest, the entries associated with it will be removed.
+
+You can add static host entries to the DNS server in your `Vagrantfile` like so:
+
+    config.landrush.host 'myhost.example.com', '1.2.3.4'
+
+Any DNS queries that do not match will be passed through to an upstream DNS server, so this will be able to serve as the one-stop shop for your guests' DNS needs.
+
+### Visibility on the Guest
+
+Linux guests using iptables should automatically have their DNS traffic redirected properly to our DNS server. File an issue if this does not work for you.
+
+### Visibility on the Host
+
+I'm currently developing this on OS X 10.8, and there's a nice trick you can pull to unobtrusibly add a secondary DNS server only for specific domains.
+
+All you do is drop a file in `/etc/resolvers/$DOMAIN` with information on how to connect to the DNS server you'd like to use for that domain.
+
+So what I do is name all of my vagrant servers with the pattern `$host.vagrant.dev` and then drop a file called `/etc/resolvers/vagrant.dev` with these contents:
+
+```
+# Use landrush server for this domain
+nameserver 127.0.0.1
+port 10053
+```
+
+This gives us automatic access to the landrush hosts without having to worry about it getting in the way of our normal DNS config.
+
+## Work in Progress - Lots to do!
+
+* The guest visibility strategy assumes iptables-based firewall.
+* Lots of static values that need configurin' - config location, ports, etc.
+* VirtualBox only right now, need to support VMWare
+* Tests tests tests.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+  t.libs << 'test'
+end
+
+task :default => :test

data/examples/Vagrantfile

@@ -0,0 +1,26 @@
+# 
+# This serves as a simple example, and it's what I'm using for testing locally.
+#
+# If you're doing development and want to run this locally you can simply
+# `bundle install`, then prefix all your vagrant commands with `bundle exec`, like so:
+#
+#   VAGRANT_CWD=examples bundle exec vagrant up
+#   VAGRANT_CWD=examples bundle exce vagrant halt
+#
+
+# This line is unnecessary when the plugin is installed normally; it's just
+# here for the development / testing use case.
+Vagrant.require_plugin "landrush"
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "precise64"
+
+  config.landrush.enable
+
+  config.vm.network :private_network, ip: '172.16.32.111'
+
+  config.vm.hostname = "myhost.vagrant.dev"
+
+  config.landrush.host 'static1.example.com', '1.2.3.4'
+  config.landrush.host 'static2.example.com', '2.3.4.5'
+end

data/landrush.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'landrush/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "landrush"
+  spec.version       = Landrush::VERSION
+  spec.authors       = ["Paul Hinze"]
+  spec.email         = ["paul.t.hinze@gmail.com"]
+  spec.description   = <<-DESCRIP.gsub(/^    /, '')
+    Even a Vagrant needs a place to settle down once in a while.
+
+    This Vagrant plugin spins up a lightweight DNS server and makes it visible
+    to your guests and your host, so that you can easily access all your
+    machines without having to fiddle with IP addresses.
+
+    DNS records are automatically added and removed as machines are brought up
+    and down, and you can configure static entries to be returned from the
+    server as well. See the README for more documentation.
+  DESCRIP
+  spec.summary       = %q{a vagrant plugin providing consistent DNS visible on host and guests}
+  spec.homepage      = "https://github.com/phinze/landrush"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubydns"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/ext/rexec.rb

@@ -0,0 +1,10 @@
+# Monkey patch in a prefix for the RExec daemon log lines.
+module RExec
+  module Daemon
+    module Controller
+      def self.puts(str)
+        Kernel.puts "[landrush] #{str}"
+      end
+    end
+  end
+end

data/lib/landrush.rb

@@ -0,0 +1,27 @@
+begin
+  require 'vagrant'
+rescue LoadError
+  raise 'The Vagrant landrush plugin must be run within Vagrant.'
+end
+
+module Landrush
+  def self.working_dir
+    @working_dir ||= Pathname(File.expand_path('~/.vagrant.d/data/landrush')).tap(&:mkpath)
+  end
+
+  def self.working_dir=(working_dir)
+    @working_dir = Pathname(working_dir).tap(&:mkpath)
+  end
+end
+
+require 'rubydns'
+
+require 'landrush/dependent_vms'
+require 'landrush/plugin'
+require 'landrush/resolver_config'
+require 'landrush/server'
+require 'landrush/store'
+require 'landrush/util'
+require 'landrush/version'
+
+require 'ext/rexec'

data/lib/landrush/action/redirect_dns.rb

@@ -0,0 +1,35 @@
+module Landrush
+  module Action
+    class RedirectDns
+      def initialize(app, env)
+        @app = app
+      end
+
+      def call(env)
+        @machine = env[:machine]
+
+        @machine.ui.info "setting up machine's DNS to point to our server"
+
+        redirect_dns('10.0.2.3', 53, '10.0.2.2', 10053)
+      end
+
+      def redirect_dns(original_server, original_port, target_server, target_port)
+        %w[tcp udp].each do |protocol|
+          rule = "OUTPUT -t nat -d #{original_server} -p #{protocol} --dport #{original_port} -j DNAT --to-destination #{target_server}:#{target_port}"
+          command = %Q(iptables -C #{rule} 2> /dev/null || iptables -A #{rule})
+          _run_command(command)
+        end
+      end
+
+      def _run_command(command)
+        @machine.communicate.sudo(command) do |data, type|
+          if [:stderr, :stdout].include?(type)
+            color = (type == :stdout) ? :green : :red
+            @machine.env.ui.info(data.chomp, :color => color, :prefix => false)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/landrush/action/setup.rb

@@ -0,0 +1,42 @@
+module Landrush
+  module Action
+    class Setup
+      def initialize(app, env)
+        @app = app
+      end
+
+      def call(env)
+        if env[:global_config].landrush.enabled?
+          DependentVMs.add(env[:machine])
+          start_server_if_necessary(env)
+          setup_machine_dns(env)
+          setup_static_dns(env)
+          env[:machine].config.vm.provision :landrush
+        end
+        @app.call(env)
+      end
+
+      def start_server_if_necessary(env)
+        if Server.running?
+          env[:ui].info "[landrush] dns server already running"
+        else
+          env[:ui].info "[landrush] starting dns server"
+          Server.start
+        end
+      end
+
+      def setup_machine_dns(env)
+        hostname, ip_address = Util.host_and_ip(env[:machine])
+        env[:ui].info "[landrush] adding machine entry: #{hostname} => #{ip_address}"
+        Store.hosts.set(hostname, ip_address)
+      end
+
+      def setup_static_dns(env)
+        env[:global_config].landrush.hosts.each do |hostname, ip_address|
+          env[:ui].info "[landrush] adding static entry: #{hostname} => #{ip_address}"
+          Store.hosts.set hostname, ip_address
+        end
+      end
+    end
+  end
+end

data/lib/landrush/action/teardown.rb

@@ -0,0 +1,46 @@
+module Landrush
+  module Action
+    class Teardown
+      def initialize(app, env)
+        @app = app
+      end
+
+      def call(env)
+        if env[:global_config].landrush.enabled?
+          teardown_static_dns(env)
+          teardown_machine_dns(env)
+
+          DependentVMs.remove(env[:machine])
+          stop_server_if_necessary(env)
+        end
+        @app.call(env)
+      end
+
+      def stop_server_if_necessary(env)
+        if Server.running?
+          if DependentVMs.none?
+            env[:ui].info "[landrush] no dependent vms left, stopping dns server"
+            Server.stop
+          else
+            env[:ui].info "[landrush] there are dependent vms left, leaving dns server"
+          end
+        else
+          env[:ui].info "[landrush] dns server already stopped"
+        end
+      end
+
+      def teardown_machine_dns(env)
+        hostname = Util.hostname(env[:machine])
+        env[:ui].info "[landrush] removing machine entry: #{hostname}"
+        Store.hosts.delete(hostname)
+      end
+
+      def teardown_static_dns(env)
+        env[:global_config].landrush.hosts.each do |hostname, _|
+          env[:ui].info "[landrush] removing static entry: #{hostname}"
+          Store.hosts.delete hostname
+        end
+      end
+    end
+  end
+end

data/lib/landrush/command.rb

@@ -0,0 +1,45 @@
+module Landrush
+  class Command < Vagrant.plugin('2', :command)
+    DAEMON_COMMANDS = %w(start stop restart status)
+
+    def execute
+      ARGV.shift # flush landrush from ARGV, RExec wants to use it for daemon commands
+
+      command = ARGV.first
+      if DAEMON_COMMANDS.include?(command)
+        Server.daemonize
+      elsif command == 'dependentvms'
+        if DependentVMs.any?
+          @env.ui.info(DependentVMs.list.map { |dvm| " - #{dvm}" }.join("\n"))
+        else
+          @env.ui.info("No dependent VMs")
+        end
+      elsif command == 'install'
+        ResolverConfg.ensure_config_exists
+      else
+        boom("'#{command}' is not a command")
+      end
+
+      0 # happy exit code
+    end
+
+    def boom(msg)
+      raise Vagrant::Errors::CLIInvalidOptions, :help => usage(msg)
+    end
+
+    def usage(msg); <<-EOS.gsub(/^      /, '')
+      ERROR: #{msg}
+
+      vagrant landrush <command>
+
+      commands:
+        {start|stop|restart|status}
+          control the landrush server daemon
+        dependentvms
+          list vms currently dependent on the landrush server
+        install
+          install resolver config for host visbility (requires sudo)
+      EOS
+    end
+  end
+end

data/lib/landrush/config.rb

@@ -0,0 +1,32 @@
+module Landrush
+  class Config < Vagrant.plugin('2', :config)
+    attr_accessor :hosts
+
+    def initialize
+      @hosts = {}
+      @enabled = false
+    end
+
+    def enable(enabled=true)
+      @enabled = true
+    end
+
+    def disable
+      @enabled = false
+    end
+
+    def enabled?
+      @enabled
+    end
+
+    def host(hostname, ip_address)
+      @hosts[hostname] = ip_address
+    end
+
+    def merge(other)
+      super.tap do |result|
+        result.hosts = @hosts.merge(other.hosts)
+      end
+    end
+  end
+end