vagrant-rubydns 0.0.2 → 0.0.3

data/README.md

@@ -21,16 +21,26 @@ Bring up a machine that has a private network IP address and a hostname (see the
 
     $ vagrant up
 
-And you should be able to get your hostname from the local server:
+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 entry will be gone! 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.
+
+You can also make this visible to the guest by using the provisioner, which will set `resolv.conf` and `iptables` rules such that DNS points at our server:
+
+    config.vm.provision :rubydns 
+
+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.rubydns.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.
 
 ## Work in Progress - Lots to do!
 
-* There's a stub provisioner in here - we'll use that to automatically point guests to our DNS server as they come up.
-* Lots of static values that need configurin' - config location, ports, TLD, etc.
+* The provisioner assumes resolv.conf-based DNS and iptables-based firewall.
+* Lots of static values that need configurin' - config location, ports, etc.
 * Tests tests tests.
 
 ## Contributing

data/examples/Vagrantfile

@@ -20,4 +20,7 @@ Vagrant.configure("2") do |config|
   config.vm.network :private_network, ip: '172.16.32.111'
 
   config.vm.hostname = "myhost.vagrant.dev"
+
+  config.rubydns.host 'static1.example.com', '1.2.3.4'
+  config.rubydns.host 'static2.example.com', '2.3.4.5'
 end

data/lib/vagrant-rubydns.rb

@@ -4,8 +4,8 @@ rescue LoadError
   raise 'The Vagrant RubyDNS plugin must be run within Vagrant.'
 end
 
-require 'vagrant-rubydns/config'
 require 'vagrant-rubydns/plugin'
+require 'vagrant-rubydns/store'
 require 'vagrant-rubydns/util'
 require 'vagrant-rubydns/version'
 

data/lib/vagrant-rubydns/action/setup.rb

@@ -6,13 +6,22 @@ module VagrantRubydns
       end
 
       def call(env)
-        hostname, ip_address = Util.host_and_ip(env[:machine])
-
-        env[:ui].info "setting #{hostname} to #{ip_address} in in DNS"
+        setup_machine_dns(env)
+        setup_static_dns(env)
+        @app.call(env)
+      end
 
-        Config.set(hostname, ip_address)
+      def setup_machine_dns(env)
+        hostname, ip_address = Util.host_and_ip(env[:machine])
+        env[:ui].info "[rubydns] adding machine entry: #{hostname} => #{ip_address}"
+        Store.set(hostname, ip_address)
+      end
 
-        @app.call(env)
+      def setup_static_dns(env)
+        env[:global_config].rubydns.hosts.each do |hostname, ip_address|
+          env[:ui].info "[rubydns] adding static entry: #{hostname} => #{ip_address}"
+          Store.set hostname, ip_address
+        end
       end
     end
   end

data/lib/vagrant-rubydns/action/teardown.rb

@@ -6,13 +6,22 @@ module VagrantRubydns
       end
 
       def call(env)
-        hostname = Util.hostname(env[:machine])
-
-        env[:ui].info "removing #{hostname} from DNS"
+        teardown_static_dns(env)
+        teardown_machine_dns(env)
+        @app.call(env)
+      end
 
-        Config.delete(hostname)
+      def teardown_machine_dns(env)
+        hostname = Util.hostname(env[:machine])
+        env[:ui].info "[rubydns] removing machine entry: #{hostname}"
+        Store.delete(hostname)
+      end
 
-        @app.call(env)
+      def teardown_static_dns(env)
+        env[:global_config].rubydns.hosts.each do |hostname, _|
+          env[:ui].info "[rubydns] removing static entry: #{hostname}"
+          Store.delete hostname
+        end
       end
     end
   end

data/lib/vagrant-rubydns/config.rb

@@ -1,36 +1,18 @@
 module VagrantRubydns
-  class Config
-    CONFIG_FILE = Pathname('.vagrant_dns.json')
+  class Config < Vagrant.plugin('2', :config)
+    attr_accessor :hosts
 
-    def self.set(key, value)
-      write(current_config.merge(key => value))
+    def initialize
+      @hosts = {}
     end
 
-    def self.delete(key)
-      write(current_config.reject { |k, _| k == key })
+    def host(hostname, ip_address)
+      @hosts[hostname] = ip_address
     end
 
-    def self.get(key)
-      current_config[key]
-    end
-
-    def self.clear!
-      write({})
-    end
-
-    protected
-
-    def self.current_config
-      if CONFIG_FILE.exist?
-        JSON.parse(File.read(CONFIG_FILE))
-      else
-        {}
-      end
-    end
-
-    def self.write(config)
-      File.open(CONFIG_FILE, "w") do |f|
-        f.write(JSON.pretty_generate(config))
+    def merge(other)
+      super.tap do |result|
+        result.hosts = @hosts.merge(other.hosts)
       end
     end
   end

data/lib/vagrant-rubydns/plugin.rb

@@ -7,6 +7,11 @@ module VagrantRubydns
       Command
     end
 
+    config 'rubydns' do
+      require_relative 'config'
+      Config
+    end
+
     provisioner 'rubydns' do
       require_relative 'provisioner'
       Provisioner

data/lib/vagrant-rubydns/provisioner.rb

@@ -8,9 +8,6 @@ module VagrantRubydns
     end
 
     def provision
-      # hostname, ip_address = Util.host_and_ip(@machine)
-      # Config.set(hostname, ip_address)
-
       @machine.env.ui.info "setting up machine's DNS to point to our server"
 
       redirect_dns_to_unpriviledged_port_tcp = 'OUTPUT -t nat -d 10.0.2.2 -p tcp --dport 53 -j DNAT --to-destination 10.0.2.2:10053'

data/lib/vagrant-rubydns/server.rb

@@ -14,15 +14,11 @@ module VagrantRubydns
       @upstream ||= RubyDNS::Resolver.new([[:udp, "8.8.8.8", 53], [:tcp, "8.8.8.8", 53]])
     end
 
-    def self.configfile
-      Pathname('.vagrant_dns.json')
-    end
-
     def self.run
       server = self
       RubyDNS::run_server(:listen => INTERFACES) do
-        match(/vagrant.dev/, IN::A) do |transaction|
-          ip = Config.get(transaction.name)
+        match(/.*/, IN::A) do |transaction|
+          ip = Store.get(transaction.name)
           if ip
             transaction.respond!(ip)
           else

data/lib/vagrant-rubydns/store.rb

@@ -0,0 +1,37 @@
+module VagrantRubydns
+  class Store
+    STORE_FILE = Pathname('.vagrant_dns.json')
+
+    def self.set(key, value)
+      write(current_config.merge(key => value))
+    end
+
+    def self.delete(key)
+      write(current_config.reject { |k, _| k == key })
+    end
+
+    def self.get(key)
+      current_config[key]
+    end
+
+    def self.clear!
+      write({})
+    end
+
+    protected
+
+    def self.current_config
+      if STORE_FILE.exist?
+        JSON.parse(File.read(STORE_FILE))
+      else
+        {}
+      end
+    end
+
+    def self.write(config)
+      File.open(STORE_FILE, "w") do |f|
+        f.write(JSON.pretty_generate(config))
+      end
+    end
+  end
+end

data/lib/vagrant-rubydns/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module Rubydns
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/test/test_helper.rb

@@ -8,7 +8,7 @@ require 'support/fake_ui'
 require 'vagrant-rubydns'
 
 # must be called before minitest/autorun to ensure proper at_exit ordering
-MiniTest::Unit.after_tests { VagrantRubydns::Config.clear! }
+MiniTest::Unit.after_tests { VagrantRubydns::Store.clear! }
 
 require 'minitest/autorun'
 

data/test/vagrant-rubydns/action/setup_test.rb

@@ -14,8 +14,8 @@ module VagrantRubydns
         env[:called].must_equal true
       end
 
-      it "stores the machine's hostname => ip address in the config" do
-        Config.clear!
+      it "stores the machine's hostname => ip address" do
+        Store.clear!
 
         app = Proc.new {}
         setup = Setup.new(app, nil)
@@ -23,7 +23,7 @@ module VagrantRubydns
         env = fake_environment_with_machine('somehost.vagrant.dev', '1.2.3.4')
         setup.call(env)
 
-        Config.get('somehost.vagrant.dev').must_equal '1.2.3.4'
+        Store.get('somehost.vagrant.dev').must_equal '1.2.3.4'
       end
     end
   end

data/test/vagrant-rubydns/action/teardown_test.rb

@@ -14,8 +14,8 @@ module VagrantRubydns
         env[:called].must_equal true
       end
 
-      it "stores the machine's hostname => ip address in the config" do
-        Config.set('somehost.vagrant.dev', '1.2.3.4')
+      it "stores the machine's hostname => ip address" do
+        Store.set('somehost.vagrant.dev', '1.2.3.4')
 
         app = Proc.new {}
         teardown = Teardown.new(app, nil)
@@ -23,7 +23,7 @@ module VagrantRubydns
         env = fake_environment_with_machine('somehost.vagrant.dev', '1.2.3.4')
         teardown.call(env)
 
-        Config.get('somehost.vagrant.dev').must_equal nil
+        Store.get('somehost.vagrant.dev').must_equal nil
       end
     end
   end

data/test/vagrant-rubydns/store_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+module VagrantRubydns
+  describe Store do
+    before { Store.clear! }
+    
+    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
+        Store.set('foo', 'bar')
+        Store.set('foo', 'qux')
+
+        Store.get('foo').must_equal 'qux'
+      end
+    end
+
+    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
+        Store.set('foo', 'first')
+        Store.get('foo').must_equal 'first'
+        Store.set('foo', 'second')
+        Store.get('foo').must_equal 'second'
+        Store.delete('foo')
+        Store.get('foo').must_equal nil
+      end
+    end
+
+    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'
+
+        Store.delete('now')
+
+        Store.get('now').must_equal nil # you don't!
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-rubydns
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -80,13 +80,14 @@ files:
 - lib/vagrant-rubydns/plugin.rb
 - lib/vagrant-rubydns/provisioner.rb
 - lib/vagrant-rubydns/server.rb
+- lib/vagrant-rubydns/store.rb
 - lib/vagrant-rubydns/util.rb
 - lib/vagrant-rubydns/version.rb
 - test/support/fake_ui.rb
 - test/test_helper.rb
 - test/vagrant-rubydns/action/setup_test.rb
 - test/vagrant-rubydns/action/teardown_test.rb
-- test/vagrant-rubydns/config_test.rb
+- test/vagrant-rubydns/store_test.rb
 - vagrant-rubydns.gemspec
 homepage: ''
 licenses:
@@ -118,5 +119,5 @@ test_files:
 - test/test_helper.rb
 - test/vagrant-rubydns/action/setup_test.rb
 - test/vagrant-rubydns/action/teardown_test.rb
-- test/vagrant-rubydns/config_test.rb
+- test/vagrant-rubydns/store_test.rb
 has_rdoc: 

data/test/vagrant-rubydns/config_test.rb

@@ -1,49 +0,0 @@
-require 'test_helper'
-
-module VagrantRubydns
-  describe Config do
-    before { Config.clear! }
-    
-    describe "set" do
-      it "sets the key to the value and makes it available for getting" do
-        Config.set('foo', 'bar')
-
-        Config.get('foo').must_equal 'bar'
-      end
-
-      it "allows updating keys that already exist" do
-        Config.set('foo', 'bar')
-        Config.set('foo', 'qux')
-
-        Config.get('foo').must_equal 'qux'
-      end
-    end
-
-    describe "get" do
-      it "returns nil for unset values" do
-        Config.get('notakey').must_equal nil
-      end
-
-      it "returns the latest set value (no caching)" do
-        Config.set('foo', 'first')
-        Config.get('foo').must_equal 'first'
-        Config.set('foo', 'second')
-        Config.get('foo').must_equal 'second'
-        Config.delete('foo')
-        Config.get('foo').must_equal nil
-      end
-    end
-
-    describe "delete" do
-      it "removes the key from the store" do
-        Config.set('now', 'you see me')
-
-        Config.get('now').must_equal 'you see me'
-
-        Config.delete('now')
-
-        Config.get('now').must_equal nil # you don't!
-      end
-    end
-  end
-end