vagrant-dns 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# v0.2.0
+
+* Deactivate ipv6 support (was broken anyways)
+* Add multiple patterns support
+* Introduces the `tlds` config key, for managing multiple tlds. `tld` is still supported
+* --ontop option to run the dns server on top
+* removed the logger config in favor of a default logger
+* Uses one central server now
+* The DNS server is now reconfigured on every run
+
+# v0.1.0
+
+* Initial Release
+* Support for A and AAAA configuration

data/README.md

@@ -14,7 +14,7 @@ otherwise, use:
 
 ## Usage
 
-In addition to your networking config, configure a toplevel domain and a `host_name` for your machine. Optionally configure a logger and the listen options for the DNS server, this setting is global:
+In addition to your networking config, configure a toplevel domain and a `host_name` for your machine. Optionally, configure a set of free matching patterns. Global configuration options can be given through the `VagrantDNS::Config` object:
 
 ```ruby
 Vagrant::Config.run do |config|
@@ -23,12 +23,14 @@ Vagrant::Config.run do |config|
   config.dns.tld = "dev"
   
   config.vm.host_name = "machine"
+  
+  config.dns.patterns = [/^.*mysite.dev$/, /^.*myothersite.dev$/]
+  
   config.vm.network :hostonly, "33.33.33.60"
 end
 
 # optional
 VagrantDNS::Config.logger = Logger.new("dns.log")
-VagrantDNS::Config.listen = [[:udp, "0.0.0.0", 5300]]
 ```
 
 Then, register the DNS server as a resolver:
@@ -37,7 +39,7 @@ Then, register the DNS server as a resolver:
 $ sudo vagrant dns --install
 ```
 
-On OS X, this will create a file `/etc/resolver/dev`, which tells OS X to resolve the TLD `.dev` by using the resolver given in this file.
+On OS X, this will create a file `/etc/resolver/dev`, which tells OS X to resolve the TLD `.dev` by using the nameserver given in this file. You will have to rerun --install every time a tld is added.
 
 You can delete this file by running:
 
@@ -65,11 +67,22 @@ Finally, stop the server using:
 $ vagrant dns --stop
 ```
 
-# Issues
+The DNS server will start automatically once the first VM is started.
+
+## VM options
+
+* `vm.dns.tld`: Set the tld for the given virtual machine. No default.
+* `vm.dns.tlds`: Set multiple tlds. Default: `[tld]`
+* `vm.dns.patterns`: A list of domain patterns to match. Defaults to `[/^.*{host_name}.{tld}$/]`
+
+## Global Options
+
+* `VagrantDNS::Config.listen`: an Array of Arrays describing interfaces to bind to. Defaults to `[[:udp, "127.0.0.1", 5300]]`.
+* `VagrantDNS::Config.auto_run`: (re)start and reconfigure the server every time a machine is started. On by default.
+
+## Issues
 
-* Currently, you need one TLD per environment
-* Only A and AAAA records at the moment
-* Only one record per machine ("hostname.tld")
-* Advanced customization of record rules is not supported at the moment
+* A records only
+* no ipv6 support
 * OS X only
 * Alpha code

data/Vagrantfile

@@ -9,12 +9,13 @@ Vagrant::Config.run do |config|
 
   # Every Vagrant virtual environment requires a box to build off of.
   config.vm.box = "base"
-  
+
   config.dns.tld = "dev"
-  
+  config.dns.patterns = /^.*machine.dev$/
+
   config.vm.host_name = "machine"
   config.vm.network :hostonly, "33.33.33.60"
 
-  VagrantDNS::Config.logger = Logger.new("dns.log")
+  
   VagrantDNS::Config.listen = [[:udp, "0.0.0.0", 5300]]
 end

data/lib/vagrant-dns.rb

@@ -1,7 +1,13 @@
 require "vagrant-dns/version"
 require "vagrant-dns/command"
 require "vagrant-dns/config"
+require "vagrant-dns/service"
+require "vagrant-dns/installers/mac"
+require "vagrant-dns/restart_middleware"
+require "vagrant-dns/configurator"
 
 Vagrant.config_keys.register(:dns) { VagrantDNS::Config }
 
-Vagrant.commands.register(:dns) { VagrantDNS::Command }
+Vagrant.commands.register(:dns) { VagrantDNS::Command }
+
+Vagrant.actions[:start].insert Vagrant::Action::VM::Customize, VagrantDNS::RestartMiddleware

data/lib/vagrant-dns/command.rb

@@ -1,5 +1,6 @@
 require 'optparse'
 require 'daemons'
+require 'rbconfig'
 
 module VagrantDNS
 
@@ -10,7 +11,7 @@ module VagrantDNS
     def execute
       options = {}
       opts = OptionParser.new do |opts|
-        opts.banner = "Usage: vagrant dns [vm-name] [-i|--install] [-u|--uninstall] [-s|--start] [-S|--stop]"
+        opts.banner = "Usage: vagrant dns [vm-name] [-i|--install] [-u|--uninstall] [-s|--start] [-S|--stop] [-r|--restart] [-o|--ontop]"
         opts.separator ""
 
         opts.on("--install", "-i", "Install DNS config for machine domain") do
@@ -28,7 +29,14 @@ module VagrantDNS
         opts.on("--stop", "-s", "Stop the DNS service") do
           options[:stop] = true
         end
-
+        
+        opts.on("--restart", "-r", "Restart the DNS service") do
+          options[:restart] = true
+        end
+        
+        opts.on("--ontop", "-o", "Start the DNS service on top. Debugging only, this blocks Vagrant!") do
+          options[:ontop] = true
+        end
       end
 
       argv = parse_options(opts)
@@ -36,75 +44,34 @@ module VagrantDNS
 
       dns_options = []
       
-      if argv.empty?
-        with_target_vms(nil) { |vm| dns_options << get_dns_options(vm) }
-      else
-        argv.each do |vm_name|
-          with_target_vms(vm_name) { |vm| dns_options << get_dns_options(vm) }
-        end
-      end
+      vms = argv unless argv.empty?
+      tmp_path = File.join(@env.tmp_path, "dns")
+      
+      with_target_vms(vms) { |vm| VagrantDNS::Configurator.new(vm, tmp_path).run! }
+
+      service = VagrantDNS::Service.new(tmp_path, options)
       
       if options[:start]
-        run_options = {:ARGV => ["start"]}
+        service.start!
       elsif options[:stop]
-        run_options = {:ARGV => ["stop"]}
+        service.stop!
+      elsif options[:restart]
+        service.restart!
       end
-      
-      if options[:start] || options[:stop]        
-        Daemons.run_proc("dnsserver.rb", run_options) do
-          require 'rubydns'
-
-          RubyDNS::run_server(:listen => VagrantDNS::Config.listen) do
-            self.logger = VagrantDNS::Config.logger if VagrantDNS::Config.logger
-            
-            dns_options.each do |opts|
-              pattern = /^.*#{opts[:host_name]}.#{opts[:tld]}$/
-
-              network = opts[:networks].first
-              ip = network.last.first
 
-              action = lambda { |match_data, transaction| transaction.respond!(ip) }
-
-              match(pattern, :A, &action)
-              match(pattern, :AAAA, &action)
-            end
-          end
-        end
-      end
-      
-      if options[:install]
-        require 'fileutils'
-        dns_options.each do |opts|
-          port = VagrantDNS::Config.listen.first.last
-          tld = opts[:tld]
-          contents = <<-FILE
-nameserver 127.0.0.1
-port #{port}
-FILE
-          FileUtils.mkdir_p("/etc/resolver")
-          File.open(File.join("/etc/resolver", tld), "w") do |f|
-            f << contents
+      if options[:install] || options[:uninstall]
+        if RbConfig::CONFIG["host_os"].match /darwin/
+          installer = VagrantDNS::Installers::Mac.new(tmp_path)
+          
+          if options[:install]
+            installer.install!
+          elsif options[:uninstall]
+            installer.uninstall!
           end
+        else
+          raise 'installing and uninstalling is only supported on Mac OS X at the moment.'
         end
       end
-      
-      if options[:uninstall]
-        require 'fileutils'
-        
-        dns_options.each do |opts|
-          tld = opts[:tld]
-          FileUtils.rm(File.join("/etc/resolver", tld))
-        end
-      end
-    end
-
-    protected
-    
-    def get_dns_options(vm)
-      dns_options = vm.config.dns.to_hash
-      dns_options[:host_name] = vm.config.vm.host_name
-      dns_options[:networks] = vm.config.vm.networks
-      dns_options
     end
   end
 end

data/lib/vagrant-dns/config.rb

@@ -1,26 +1,43 @@
 require 'logger'
 
 module VagrantDNS
-  
   class Config < Vagrant::Config::Base
     class << self
-      attr_accessor :listen, :logger
-      
+      attr_accessor :listen, :logger, :ipv4only, :auto_run
+
       def listen
         @listen ||= [[:udp, "127.0.0.1", 5300]]
       end
+
+      def ipv4only
+        @ipv4only || @ipv4only.nil?
+      end
+      
+      def auto_run
+        return true if @auto_run.nil?
+        @auto_run
+      end
+    end
+
+    attr_accessor :records, :tlds, :ipv4only, :patterns
+
+    def pattern=(pattern)
+      self.patterns = pattern
     end
     
-    attr_accessor :records, :tld
-    
+    def tld=(tld)
+      @tlds = Array(tld)
+    end
+
     # explicit hash, to get symbols in hash keys
     def to_hash
       {
+        :patterns => (patterns ? Array(patterns) : patterns),
         :records => records,
-        :tld => tld
+        :tlds => tlds,
+        :ipv4only => ipv4only
       }
     end
-    
   end
 end
 

data/lib/vagrant-dns/configurator.rb

@@ -0,0 +1,75 @@
+require 'fileutils'
+require 'yaml'
+
+module VagrantDNS
+  class Configurator
+    attr_accessor :vm, :tmp_path
+
+    def initialize(vm, tmp_path)
+      @vm = vm
+      @tmp_path = tmp_path
+    end
+
+    def run!
+      regenerate_resolvers!
+      ensure_deamon_env!
+      register_patterns!
+    end
+
+    private
+      def regenerate_resolvers!
+        FileUtils.mkdir_p(resolver_folder)
+        port = VagrantDNS::Config.listen.first.last
+        tlds = dns_options(vm)[:tlds]
+
+        tlds.each do |tld|
+          File.open(File.join(resolver_folder, tld), "w") do |f|
+            f << resolver_file(port)
+          end
+        end
+      end
+
+      def register_patterns!
+        registry = YAML.load(File.read(config_file)) if File.exists?(config_file)
+        registry ||= {}
+        opts     = dns_options(vm)
+        patterns = opts[:patterns] || opts[:tlds].map { |tld| /^.*#{opts[:host_name]}.#{tld}$/ } 
+        network  = opts[:networks].first
+        ip       = network.last.first
+        
+        patterns.each do |p|
+          p = p.source if p.respond_to? :source # Regexp#to_s is unusable
+          registry[p] = ip 
+        end
+        
+        File.open(config_file, "w") { |f| f << YAML.dump(registry) }
+      end
+
+      def dns_options(vm)
+        dns_options = vm.config.dns.to_hash
+        dns_options[:host_name] = vm.config.vm.host_name
+        dns_options[:networks] = vm.config.vm.networks
+        dns_options
+      end
+
+      def resolver_file(port)
+        contents = <<-FILE
+# this file is generated by vagrant-dns
+nameserver 127.0.0.1
+port #{port}
+FILE
+      end
+      
+      def resolver_folder
+        File.join(tmp_path, "resolver")
+      end
+      
+      def ensure_deamon_env!
+        FileUtils.mkdir_p(File.join(tmp_path, "daemon"))
+      end
+      
+      def config_file
+        File.join(tmp_path, "config")
+      end
+  end
+end

data/lib/vagrant-dns/installers/mac.rb

@@ -0,0 +1,38 @@
+module VagrantDNS
+  module Installers
+    class Mac
+      attr_accessor :tmp_path, :install_path
+
+      def initialize(tmp_path, install_path = "/etc/resolver")
+        self.tmp_path, self.install_path = tmp_path, install_path
+      end
+
+      def install!
+        require 'fileutils'
+
+        registered_resolvers.each do |r|
+          FileUtils.ln_s(registered_resolvers, "/etc/resolver", :force => true)
+        end
+      rescue Errno::EACCES => e
+        warn "vagrant-dns needs superuser access to manipulate DNS settings"
+        raise e
+      end
+
+      def uninstall!
+        require 'fileutils'
+
+        registered_resolvers.each do |r|
+          resolver = File.join("/etc/resolver", File.basename(r))
+          FileUtils.rm_f(resolver)
+        end
+      rescue Errno::EACCES => e
+        warn "vagrant-dns needs superuser access to manipulate DNS settings"
+        raise e
+      end
+      
+      def registered_resolvers
+        Dir[File.join(tmp_path, "resolver", "*")]
+      end
+    end
+  end
+end

data/lib/vagrant-dns/restart_middleware.rb

@@ -0,0 +1,19 @@
+module VagrantDNS
+  class RestartMiddleware
+    def initialize(app, env)
+      @app = app
+      @env = env
+    end
+
+    def call(env)
+      if VagrantDNS::Config.auto_run
+        tmp_path = File.join(env[:vm].env.tmp_path, "dns")
+        VagrantDNS::Configurator.new(env[:vm], tmp_path).run!
+        VagrantDNS::Service.new(tmp_path).restart!
+        env[:ui].info "Restarted DNS Service"
+      end
+
+      @app.call(env)
+    end
+  end
+end

data/lib/vagrant-dns/service.rb

@@ -0,0 +1,52 @@
+module VagrantDNS
+  class Service
+    attr_accessor :tmp_path, :options
+    
+    def initialize(tmp_path, options = {})
+      self.tmp_path = tmp_path
+      self.options = options
+    end
+
+    def start!
+      run_options = {:ARGV => ["start"]}.merge(options).merge(runopts)
+      run!(run_options)
+    end
+
+    def stop!
+      run_options = {:ARGV => ["stop"]}.merge(options).merge(runopts)
+      run!(run_options)
+    end
+
+    def run!(run_options)
+      Daemons.run_proc("vagrant-dns", run_options) do
+        require 'rubydns'
+
+        registry = YAML.load(File.read(config_file))
+
+        RubyDNS::run_server(:listen => VagrantDNS::Config.listen) do
+          registry.each do |pattern, ip|
+            match(Regexp.new(pattern), :A) do |match_data, transaction|
+              transaction.respond!(ip)
+            end
+          end
+        end
+      end
+    end
+
+    def restart!
+      stop!
+      start!
+    end
+    
+    def runopts
+      {:dir_mode => :normal, 
+       :dir => File.join(tmp_path, "daemon"),
+       :log_output => true,
+       :log_dir => File.join(tmp_path, "daemon")}
+    end
+    
+    def config_file
+      File.join(tmp_path, "config")
+    end
+  end
+end

data/lib/vagrant-dns/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module Dns
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-dns
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-28 00:00:00.000000000 Z
+date: 2012-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vagrant
@@ -68,6 +68,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -76,6 +77,10 @@ files:
 - lib/vagrant-dns.rb
 - lib/vagrant-dns/command.rb
 - lib/vagrant-dns/config.rb
+- lib/vagrant-dns/configurator.rb
+- lib/vagrant-dns/installers/mac.rb
+- lib/vagrant-dns/restart_middleware.rb
+- lib/vagrant-dns/service.rb
 - lib/vagrant-dns/version.rb
 - lib/vagrant_init.rb
 - vagrant-dns.gemspec