vagrant-dns 0.3.0 → 0.4.0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# v0.4.0
+
+**This version is not compatible to vagrant < 1.2**
+
+* Supports vagrant 1.2.x
+* Update RubyDNS ~> 0.6.0
+
 # v0.3.0
 
 * Using RubyDNS ~> 0.5.3
@@ -37,4 +44,4 @@
 # v0.1.0
 
 * Initial Release
-* Support for A and AAAA configuration
+* Support for A and AAAA configuration

data/Gemfile

@@ -2,3 +2,10 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in vagrant-dns.gemspec
 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"
+end

data/PLATFORM_SUPPORT.md

@@ -0,0 +1,61 @@
+Platform Support
+================
+
+Vagrant-DNS only supports OS X at the moment. This has 2 main reasons:
+
+1) All main developers are on OS X and have no good idea how to properly implement such a system for other OSes. Also, OS X makes it incredibly easy to do what vagrant-dns does.
+
+2) We spoke to multiple Linux and Windows-Developers and found that a half-baked implementation of people not invested at the respective platform as a _convenient development_ platform is only harmful and might at worst mess with users systems in unintended ways. None of them have supplied us with a proper way to implement this.
+
+That said, we will happily accept any patches and want to encourage platform support beyond OS X, including ensuring further development of those solutions. Some of the groundwork for this has been layed. It might not be 100% finished, but we happily apply any changes necessary.
+
+This document aims to be a guide to implementing support for other platforms.
+
+How Vagrant-DNS currently works
+===============================
+
+In a nutshell, Vagrant-DNS starts a DNS server on a non-privileged port (5300 by default) and makes sure that the host operating system knows this server. If possible, it only does so for a specific, free, TLD (.dev). As a fallback, it also supports pass-through, if you really want to play with ICANN domains.
+
+The DNS server runs on all platforms.
+
+Design Goals
+============
+
+Vagrant-DNS should not require superuser access for anything except reconfiguring the hosts DNS system. This is why there is a seperate "install" step that registers the Vagrant-DNS server to your system (for the configured TLDs). (Re)starts of the server (happening at startup of the machine) need to happen without superuser access.
+
+Mac OS X
+========
+
+As a reference, here is how this works on OS X:
+
+* `install` places a symlink in `/etc/resolver/{tld}` that links to a corresponding file in `.vagrant.d` with content similar to this one:
+
+```
+nameserver 127.0.0.1
+port 5300
+```
+
+From then on, OS X will resolve all requests to that top level domain using the given resolver.
+
+Linux
+=====
+
+To help anyone that attempts a Linux implementation, here is what has already been tried.
+
+* Editing resolv.conf: Linux resolv.conf (in contrast to, say OpenBSD) does not allow you to set a port number for the DNS server. Also, its size is limited to 3 servers and the file is often under OS control, so messing around with it might not be advisable.
+* Setting up dnsmasq: this is certainly an option, but we couldn't find out how invasive this was, which Linux flavors might already come with dnsmasq configurations and how not to shoot other people in the foot with it. User help is needed.
+
+(Open)BSD
+=========
+
+Here, the question is simple: Is editing resolv.conf an option? Any takers?
+
+Windows
+=======
+
+Quite frankly, I have not enough understanding on how to implement this properly on Windows.
+
+General Notes
+=============
+
+mDNS is not an option. It doesn't support subdomains and most implementations do not support multiple servers per machine. Thats sad, as all platforms come with good solutions for it.

data/README.md

@@ -6,15 +6,11 @@
 
 If you use the gem version of Vagrant, use:
 
-    $ gem install vagrant-dns
-
-otherwise, use:
-
-    $ vagrant gem install vagrant-dns
+    $ vagrant plugin install vagrant-dns
 
 ## Usage
 
-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:
+In addition to your networking config, configure a toplevel domain and a `hostname` 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|
@@ -22,11 +18,11 @@ Vagrant::Config.run do |config|
   
   config.dns.tld = "dev"
   
-  config.vm.host_name = "machine"
+  config.vm.hostname = "machine"
   
   config.dns.patterns = [/^.*mysite.dev$/, /^.*myothersite.dev$/]
   
-  config.vm.network :hostonly, "33.33.33.60"
+  config.vm.network :private_network, ip: "33.33.33.60"
 end
 
 # optional
@@ -36,7 +32,7 @@ VagrantDNS::Config.logger = Logger.new("dns.log")
 Then, register the DNS server as a resolver. RVM users must use `rvmsudo` instead of `sudo`:
 
 ```bash
-$ sudo vagrant dns --install
+$ 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 nameserver given in this file. You will have to rerun --install every time a tld is added.
@@ -44,7 +40,7 @@ On OS X, this will create a file `/etc/resolver/dev`, which tells OS X to resolv
 You can delete this file by running:
 
 ```bash
-$ sudo vagrant dns --uninstall
+$ vagrant dns --uninstall
 ```
 
 Then, run the DNS server:
@@ -84,5 +80,6 @@ The DNS server will start automatically once the first VM is started.
 
 * A records only
 * no ipv6 support
-* OS X only
-* Alpha code
+* OS X only (please read: [Platform
+  Support](https://github.com/BerlinVagrant/vagrant-dns/blob/master/PLATFORM_SUPPORT.md) before ranting about this).
+* Not visible inside the box

data/Vagrantfile

@@ -2,7 +2,7 @@
 # vi: set ft=ruby :
 
 
-Vagrant::Config.run do |config|
+Vagrant.configure("2") do |config|
   # All Vagrant configuration is done here. The most common configuration
   # options are documented and commented below. For a complete reference,
   # please see the online documentation at vagrantup.com.
@@ -13,8 +13,8 @@ Vagrant::Config.run do |config|
   config.dns.tld = "dev"
   config.dns.patterns = /^.*machine.dev$/
 
-  config.vm.host_name = "machine"
-  config.vm.network :hostonly, "33.33.33.60"
+  config.vm.hostname = "machine"
+  config.vm.network :private_network, ip: "33.33.33.60"
 
   
   VagrantDNS::Config.listen = [[:udp, "0.0.0.0", 5300]]

data/lib/vagrant-dns/command.rb

@@ -4,14 +4,14 @@ require 'rbconfig'
 
 module VagrantDNS
 
-  class Command < Vagrant::Command::Base
+  class Command < Vagrant.plugin(2, :command)
 
     # Runs the vbguest installer on the VMs that are represented
     # by this environment.
     def execute
       options = {}
       opts = OptionParser.new do |opts|
-        opts.banner = "Usage: vagrant dns [vm-name] [-i|--install] [-u|--uninstall] [-s|--start] [-S|--stop] [-r|--restart] [-o|--ontop]"
+        opts.banner = "Usage: vagrant dns [vm-name] [-i|--install] [-u|--uninstall] [--pruge] [-s|--start] [-S|--stop] [-r|--restart] [-o|--ontop]"
         opts.separator ""
 
         opts.on("--install", "-i", "Install DNS config for machine domain") do
@@ -22,6 +22,11 @@ module VagrantDNS
           options[:uninstall] = true
         end
 
+        opts.on("--purge", "Uninstall DNS config and remove DNS configurations of all machines.") do
+          options[:uninstall] = true
+          options[:purge] = true
+        end
+
         opts.on("--start", "-s", "Start the DNS service") do
           options[:start] = true
         end
@@ -29,11 +34,11 @@ 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
@@ -42,15 +47,43 @@ module VagrantDNS
       argv = parse_options(opts)
       return if !argv
 
-      dns_options = []
-      
       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! }
 
+      if options[:uninstall]
+        manage_service(vms, options.merge(stop: true))
+        manage_installation(vms, options)
+
+        if options[:purge]
+          require 'fileutils'
+          FileUtils.rm_r(tmp_path)
+        end
+      else
+        build_config(vms, options)
+        manage_service(vms, options)
+        manage_installation(vms, options) if options[:install]
+      end
+
+    end
+
+    protected
+
+    def manage_installation(vms, options)
+      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
+
+    def manage_service(vms, options)
       service = VagrantDNS::Service.new(tmp_path, options)
-      
+
       if options[:start]
         service.start!
       elsif options[:stop]
@@ -58,20 +91,14 @@ module VagrantDNS
       elsif options[:restart]
         service.restart!
       end
+    end
 
-      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
+    def build_config(vms, options)
+      with_target_vms(vms) { |vm| VagrantDNS::Configurator.new(vm, tmp_path).run! }
+    end
+
+    def tmp_path
+      File.join(@env.tmp_path, "dns")
     end
   end
-end
+end

data/lib/vagrant-dns/config.rb

@@ -1,7 +1,7 @@
 require 'logger'
 
 module VagrantDNS
-  class Config < Vagrant::Config::Base
+  class Config < Vagrant.plugin(2, :config)
     class << self
       attr_accessor :listen, :logger, :ipv4only, :auto_run
 

data/lib/vagrant-dns/configurator.rb

@@ -35,25 +35,29 @@ module VagrantDNS
         registry ||= {}
         opts     = dns_options(vm)
         patterns = opts[:patterns] || default_patterns(opts)
-        network  = opts[:networks].first
+        networks = opts[:networks]
+        network = {}
+        networks.each do |nw|
+          network = nw if nw.first == :private_network
+        end
 
         if network
-          ip     = network.last.first
+          ip     = network.last[:ip]
         else
           ip     = '127.0.0.1'
         end
 
         patterns.each do |p|
           p = p.source if p.respond_to? :source # Regexp#to_s is unusable
-          registry[p] = ip 
+          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[:host_name] = vm.config.vm.hostname
         dns_options[:networks] = vm.config.vm.networks
         dns_options
       end
@@ -74,17 +78,17 @@ 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
+end

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

@@ -9,29 +9,25 @@ module VagrantDNS
 
       def install!
         require 'fileutils'
-        FileUtils.mkdir_p('/etc/resolver')
 
-        FileUtils.ln_s(registered_resolvers, "/etc/resolver", :force => true)
-      rescue Errno::EACCES => e
-        warn "vagrant-dns needs superuser access to manipulate DNS settings"
-        raise e
+        `sudo mkdir -p #{install_path}`
+        registered_resolvers.each do |resolver|
+          `sudo ln -sf #{resolver} #{install_path}`
+        end
       end
 
       def uninstall!
         require 'fileutils'
 
         registered_resolvers.each do |r|
-          resolver = File.join("/etc/resolver", File.basename(r))
-          FileUtils.rm_f(resolver)
+          installed_resolver = File.join(install_path, File.basename(r))
+          `sudo rm -rf #{installed_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
+end

data/lib/vagrant-dns/restart_middleware.rb

@@ -6,9 +6,11 @@ module VagrantDNS
     end
 
     def call(env)
+      @env = env
+      vm = env[:machine]
       if VagrantDNS::Config.auto_run
-        tmp_path = File.join(env[:vm].env.tmp_path, "dns")
-        VagrantDNS::Configurator.new(env[:vm], tmp_path).run!
+        tmp_path = File.join(vm.env.tmp_path, "dns")
+        VagrantDNS::Configurator.new(vm, tmp_path).run!
         VagrantDNS::Service.new(tmp_path).restart!
         env[:ui].info "Restarted DNS Service"
       end
@@ -16,4 +18,4 @@ module VagrantDNS
       @app.call(env)
     end
   end
-end
+end

data/lib/vagrant-dns/service.rb

@@ -1,3 +1,6 @@
+require 'daemons'
+
+
 module VagrantDNS
   class Service
     attr_accessor :tmp_path, :options
@@ -27,7 +30,7 @@ module VagrantDNS
 
         RubyDNS::run_server(:listen => VagrantDNS::Config.listen) do
           registry.each do |pattern, ip|
-            match(Regexp.new(pattern), Resolv::DNS::Resource::IN::A) do |match_data, transaction|
+            match(Regexp.new(pattern), Resolv::DNS::Resource::IN::A) do |transaction, match_data|
               transaction.respond!(ip)
             end
           end
@@ -58,4 +61,4 @@ module VagrantDNS
       File.join(tmp_path, "config")
     end
   end
-end
+end

data/lib/vagrant-dns/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module Dns
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/vagrant-dns.rb

@@ -1,13 +1,32 @@
 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 }
+module VagrantDNS
+
+  class Plugin < Vagrant.plugin("2")
+
+    name "vagrant-dns"
+
+    config "dns" do
+      Config
+    end
+
+    command "dns" do
+      require File.expand_path("../vagrant-dns/command", __FILE__)
+      Command
+    end
+
+    %w{up reload}.each do |action|
+      action_hook(:restart_host_dns, "machine_action_#{action}".to_sym) do |hook|
+        hook.append VagrantDNS::RestartMiddleware
+      end
+    end
 
-Vagrant.commands.register(:dns) { VagrantDNS::Command }
+  end
 
-Vagrant.actions[:start].insert Vagrant::Action::VM::Customize, VagrantDNS::RestartMiddleware
+end

data/vagrant-dns.gemspec

@@ -15,7 +15,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Vagrant::Dns::VERSION
 
-  gem.add_dependency "vagrant"
   gem.add_dependency "daemons"
-  gem.add_dependency "rubydns", "~> 0.5.3"
+  gem.add_dependency "rubydns", "~> 0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-dns
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-03 00:00:00.000000000 Z
+date: 2013-06-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: vagrant
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: daemons
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: 0.6.0
 description: vagrant-dns is a vagrant plugin that manages DNS records associated with
   local machines.
 email:
@@ -71,6 +55,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE
+- PLATFORM_SUPPORT.md
 - README.md
 - Rakefile
 - Vagrantfile
@@ -82,7 +67,6 @@ files:
 - lib/vagrant-dns/restart_middleware.rb
 - lib/vagrant-dns/service.rb
 - lib/vagrant-dns/version.rb
-- lib/vagrant_init.rb
 - vagrant-dns.gemspec
 homepage: ''
 licenses: []
@@ -104,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: vagrant-dns manages DNS records of vagrant machines

data/lib/vagrant_init.rb

@@ -1 +0,0 @@
-require 'vagrant-dns'