vagrant-dns 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b99205f3d200b610ee3b9c0fd3e3f3c84e99377a
-  data.tar.gz: e1677768a2c0117a10f8f5caf58ab9359124643b
+  metadata.gz: 63885c6803289a7e6e199a44dbf761fb10683e90
+  data.tar.gz: d96529364b2f27a2f0237610dc02cdc69ca5745a
 SHA512:
-  metadata.gz: 43bcb3a01c66b768ab75003f4add646658e7fb6e4c15e552a22ce6ddf85ce034c8738f96a8c3093e603f0dd963151a8fc578ff16ef73e81c5e471125d645df3a
-  data.tar.gz: 4492147711e59b16309206707b3eabcad0d92ca3b94392344e5bed70ce7703e37b705c4e7df5e896f7e494d86446db57545adacc962eb0a9d90b324cf8594082
+  metadata.gz: b85c14d3d21603561ce7e9179182e3702c31e89d98cb8deae725fa6c513730089da2fb964dc2f69842e7667797941826fd7a97b6bf03deb0f9da24edf7f035b4
+  data.tar.gz: 82c123e1d400655805226e8ad62604ce0f5c3a6886517d81ea00f18a209f63b12a6e388a0e265be9a4eab51cc82af38f3af462d3117d5c3fc3041f28b7512c6b

data/CHANGELOG.md

@@ -1,14 +1,35 @@
-# 2.0.0
+## 2.1.0
+
+### Breaking, internal changes:
+
+* The version moved from `Vagrant::DNS::VERSION` to `VagrantDNS::VERSION`, removing an accidental highjack of the `Vagrant` namespace.
+* The `VagrantDNS::RestartMiddleware` got split up into `VagrantDNS::Middlewares::ConfigUp`, `VagrantDNS::Middlewares::ConfigDown` and `VagrantDNS::Middlewares::Restart`
+
+### Fixes:
+
+* Fixes cli short argument `-S` for `--stop` (collided with `--start`'s `-s`)
+
+### New Feautres:
+
+* Adds new cli command `--status` to display process running status and PID
+* Adds new cli command `--list` to display current (persisted) config
+* Adds auto-cleanup: Removes registered dns pattern from config when destroying the box. It will, however, be re-created when some box in the project get's re/started or one of vagrant dns `--instal`, `--start` or `--restart` is executed.
+
+### Changes:
+
+* The cli command `--stop` no longer re-builds configuration.
+
+## 2.0.0
 
 * Upgrades RubyDNS to `2.0` release
 
-# 2.0.0.rc1
+## 2.0.0.rc1
 
 * Upgrades RubyDNS to `2.0.0.pre.rc2`, which removes it's dependency on `celluloid`/`celluloid-dns` 🎉
 * Requires Vagrant >= 1.9.6 which ships with ruby 2.3.4 (RubyDNS requires ruby >= 2.2.6)
 * Development note: Upgraded to vagrant-share HEAD (d558861f)
 
-# 1.1.0
+## 1.1.0
 
 * Fixes handling of networks without static IP, such as DHCP. [GH-37], [GH-39], [GH-50]
 * Add support for boxes with `public_network` and static IP.
@@ -16,12 +37,12 @@
 * Log messages will now be tagged with the related box (vm) and `[vagrant-dns]`
 * Develepment targets Vagrant 1.9.3
 
-# 1.0.0
+## 1.0.0
 
 * 🎉Release as 1.0 [GH-34]
 * Fixes compatibility to Vagrant 1.7.4 by using RubyDNS ~> 1.0.2 [GH-38]
 
-# 0.6.0
+## 0.6.0
 
 This is a intermediate release towards v1.0.0
 
@@ -32,16 +53,16 @@ This is a intermediate release towards v1.0.0
 * Add acceptance test using vagrant-spec
 * Moved sample `Vagrantfile` into `/testdrive` which also contains a small wrapper script `bin/vagrant` to move "vagrant home" into a sandbox.
 
-# 0.5.0
+## 0.5.0
 
 * Use `osascript` to install system files, which require root privileges. [GH-18], [GH-22]
 * internal cleanups (@ringods)
 
-# v0.4.1
+## v0.4.1
 
 * Fixes an issue with not configured private networks [GH-21], [GH-19]
 
-# v0.4.0
+## v0.4.0
 
 **This version is not compatible to vagrant < 1.2**
 
@@ -50,33 +71,33 @@ This is a intermediate release towards v1.0.0
 * Fixes an issue where user-space files got created as root [GH-12]
 * Adds command line option `--purge` which deletes the created config file (not only the system symlink to it) [GH-3]
 
-# v0.3.0
+## v0.3.0
 
 * Using RubyDNS ~> 0.5.3
 
-# v0.2.5
+## v0.2.5
 
 * Using RubyDNS 0.4.x
 
-# v0.2.4
+## v0.2.4
 
 * Enable passthrough in DNS service. Helpful if you insist to hook a standard tld like .io.
 
-# v0.2.3
+## v0.2.3
 
 * Remove unneeded iteraton in installers/mac.rb. (thanks to JonathanTron for reporting)
 * Fix crash when no tld option was given.
 
-# v0.2.2
+## v0.2.2
 
 * Default to 127.0.0.1 when no network option is given
 * Warn if no default pattern is configured because TLD is given, but no host_name
 
-# v0.2.1
+## v0.2.1
 
 * Fix a crash when /etc/resolver is not present
 
-# v0.2.0
+## v0.2.0
 
 * Deactivate ipv6 support (was broken anyways)
 * Add multiple patterns support
@@ -86,7 +107,7 @@ This is a intermediate release towards v1.0.0
 * Uses one central server now
 * The DNS server is now reconfigured on every run
 
-# v0.1.0
+## v0.1.0
 
 * Initial Release
 * Support for A and AAAA configuration

data/DEVELOPMENT.md

@@ -0,0 +1,23 @@
+# Development Guidelines
+
+TODO: Expand this section :)
+
+The `Gemfile` uses two environment variables, `TEST_RUBY_VERSION` and `TEST_VAGRANT_VERSION` to control which version of ruby and vagrant are used during local development.
+
+## Running Acceptance Tests
+
+This project uses `vagrant-spec` to run acceptance tests.
+See `test/acceptance/dns` for spec files and `test/acceptance/skeletons/*` for Vagrantfiles. 
+See `tasks/acceptance.rake` for the basic setup of vagrant-spec. This file also defines which base box is used.
+Specs will take quite some time and run in GUI mode (due to some weirdness either in vagrant-spec and/or VirtualBox) which will render your machine basically unusable.
+
+```bash
+# List available tasks:
+bundle exec rake -D acceptance
+
+# Setup specs (download box artifacts)
+bundle exec rake acceptance:setup:virtualbox
+
+# Run tests
+rake acceptance:virtualbox
+```

data/README.md

@@ -87,6 +87,22 @@ $ vagrant dns --stop
 
 The DNS server will start automatically once the first VM is started.
 
+You can list the currently configured dns patterns using:
+
+```bash
+$ vagrant dns --list
+```
+
+(Keep in mind, that it's not guaranteed that the running server uses exactly this configuration - for example, when manually editing it.)  
+The output looks somewhat like this:
+
+```
+/^.*mysite.dev$/ => 33.33.33.60
+/^.*myothersite.dev$/ => 33.33.33.60
+```
+
+Where the first part of each line is a [regular expression](https://ruby-doc.org/core-2.3.0/Regexp.html) and the second part is the mapped IPv4. (` => ` is just a separator)
+
 ## VM options
 
 * `vm.dns.tld`: Set the tld for the given virtual machine. No default.
@@ -98,10 +114,34 @@ The DNS server will start automatically once the first VM is started.
 * `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.
 
+## Using custom domains from inside the VM (VirtualBox only)
+
+If you need to be able to resolve custom domains managed by this plugin from inside your virtual machine, add the following 
+setting to your `Vagrantfile`:
+
+```ruby
+Vagrant.configure(2) do |config|
+  # ...
+  config.vm.provider "virtualbox" do |vm_config, override|
+    vm_config.customize [
+      "modifyvm", :id,
+      "--natdnshostresolver1", "on",
+      # some systems also need this:
+      # "--natdnshostresolver2", "on"
+    ]
+  end
+end
+```
+
+By default, the Virtualbox NAT engine offers the same DNS servers to the guest that are configured on the host. With the above
+setting, however, the NAT engine will act as a DNS proxy 
+(see [Virtualbox docs](https://www.virtualbox.org/manual/ch09.html#nat-adv-dns)). That way, queries for your custom domains
+from inside the guest will also be handled by the DNS server run by the plugin.
+
 ## Issues
 
 * `A` records only
 * No IPv6 support
 * 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
+* Not automatically visible inside the box (special configuration of your guest system or provider needed)

data/lib/vagrant-dns.rb

@@ -3,8 +3,10 @@ require "vagrant-dns/config"
 
 require "vagrant-dns/service"
 require "vagrant-dns/installers/mac"
-require "vagrant-dns/restart_middleware"
 require "vagrant-dns/configurator"
+require "vagrant-dns/middlewares/config_up"
+require "vagrant-dns/middlewares/config_down"
+require "vagrant-dns/middlewares/restart"
 
 module VagrantDNS
 
@@ -23,10 +25,15 @@ module VagrantDNS
 
     %w{up reload}.each do |action|
       action_hook(:restart_host_dns, "machine_action_#{action}".to_sym) do |hook|
-        hook.append VagrantDNS::RestartMiddleware
+        hook.append VagrantDNS::Middlewares::ConfigUp
+        hook.append VagrantDNS::Middlewares::Restart
       end
     end
 
+    action_hook(:remove_dns_config, :machine_action_destroy) do |hook|
+      hook.append VagrantDNS::Middlewares::ConfigDown
+      hook.append VagrantDNS::Middlewares::Restart
+    end
   end
 
 end

data/lib/vagrant-dns/command.rb

@@ -11,35 +11,56 @@ module VagrantDNS
     def execute
       options = {}
       opts = OptionParser.new do |opts|
-        opts.banner = "Usage: vagrant dns [vm-name] [-i|--install] [-u|--uninstall] [--with-sudo] [--pruge] [-s|--start] [-S|--stop] [-r|--restart] [-o|--ontop]"
+        opts.banner = "Usage: vagrant dns [vm-name] [-i|--install] [-u|--uninstall] [--with-sudo] [--pruge] [-s|--start] [-S|--stop] [-r|--restart] [--status] [-l|--list] [-o|--ontop]"
         opts.separator ""
 
         opts.on("--install", "-i", "Install DNS config for machine domain") do
           options[:install] = true
+          options[:build_config] = true
+          options[:manage_installation] = true
         end
 
         opts.on("--uninstall", "-u", "Uninstall DNS config for machine domain") do
           options[:uninstall] = true
-        end
-
-        opts.on("--with-sudo", "In conjunction with `--install`, `--uninstall`, `--purge`: Run using `sudo` instead of `osascript`. Useful for automated scripts running as sudoer.") do
-          options[:installer_opts] = { exec_style: :sudo }
+          options[:build_config] = false
+          options[:manage_installation] = true
+          options[:stop] = true
         end
 
         opts.on("--purge", "Uninstall DNS config and remove DNS configurations of all machines.") do
           options[:purge] = true
+          options[:build_config] = false
+          options[:manage_installation] = true
+          options[:stop] = true
         end
 
         opts.on("--start", "-s", "Start the DNS service") do
           options[:start] = true
+          options[:build_config] = true
         end
 
-        opts.on("--stop", "-s", "Stop the DNS service") do
+        opts.on("--stop", "-S", "Stop the DNS service") do
           options[:stop] = true
+          options[:build_config] = false
         end
 
         opts.on("--restart", "-r", "Restart the DNS service") do
           options[:restart] = true
+          options[:build_config] = true
+        end
+
+        opts.on("--status", "Show DNS service running status and PID.") do
+          options[:status] = true
+          options[:build_config] = false
+        end
+
+        opts.on("--list", "-l", "Show the current DNS service config. This works in conjunction with --start --stop --restart --status.") do
+          options[:show_config] = true
+          options[:build_config] = false
+        end
+
+        opts.on("--with-sudo", "In conjunction with `--install`, `--uninstall`, `--purge`: Run using `sudo` instead of `osascript`. Useful for automated scripts running as sudoer.") do
+          options[:installer_opts] = { exec_style: :sudo }
         end
 
         opts.on("--ontop", "-o", "Start the DNS service on top. Debugging only, this blocks Vagrant!") do
@@ -52,15 +73,10 @@ module VagrantDNS
 
       vms = argv unless argv.empty?
 
-      if options[:uninstall] || options[:purge]
-        manage_service(vms, options.merge(stop: true))
-        manage_installation(vms, options)
-      else
-        build_config(vms, options)
-        manage_service(vms, options)
-        manage_installation(vms, options) if options[:install]
-      end
-
+      build_config(vms, options)        if options[:build_config]
+      manage_service(vms, options)
+      manage_installation(vms, options) if options[:manage_installation]
+      show_config(vms, options)         if options[:show_config]
     end
 
     protected
@@ -91,11 +107,18 @@ module VagrantDNS
         service.stop!
       elsif options[:restart]
         service.restart! :ontop => options[:ontop]
+      elsif options[:status]
+        service.status!
       end
     end
 
+    def show_config(vms, options)
+      service = VagrantDNS::Service.new(tmp_path)
+      service.show_config
+    end
+
     def build_config(vms, options)
-      with_target_vms(vms) { |vm| VagrantDNS::Configurator.new(vm, tmp_path).run! }
+      with_target_vms(vms) { |vm| VagrantDNS::Configurator.new(vm, tmp_path).up! }
     end
 
     def tmp_path

data/lib/vagrant-dns/configurator.rb

@@ -10,12 +10,16 @@ module VagrantDNS
       @tmp_path = tmp_path
     end
 
-    def run!
+    def up!
       regenerate_resolvers!
       ensure_deamon_env!
       register_patterns!
     end
 
+    def down!
+      unregister_patterns!
+    end
+
     private
       def regenerate_resolvers!
         FileUtils.mkdir_p(resolver_folder)
@@ -67,6 +71,33 @@ module VagrantDNS
         File.open(config_file, "w") { |f| f << YAML.dump(registry) }
       end
 
+      def unregister_patterns!
+        opts     = dns_options(vm)
+
+        patterns = opts[:patterns] || default_patterns(opts)
+        if patterns.empty?
+          vm.ui.warn '[vagrant-dns] TLD but no host_name given. No patterns will be removed.'
+          return
+        end
+
+        registry = YAML.load(File.read(config_file)) if File.exists?(config_file)
+        unless registry
+          vm.ui.warn '[vagrant-dns] Configuration file does not exists. No patterns will be removed.'
+          return
+        end
+
+        patterns.each do |p|
+          p = p.source if p.respond_to? :source # Regexp#to_s is unusable
+          if (ip = registry.delete(p))
+            vm.ui.info "[vagrant-dns] Removing pattern: #{p} for ip: #{ip}"
+          else
+            vm.ui.info "[vagrant-dns] Pattern: #{p} was not in config."
+          end
+        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.hostname

data/lib/vagrant-dns/middlewares/config_down.rb

@@ -0,0 +1,20 @@
+module VagrantDNS
+  module Middlewares
+    class ConfigDown
+      def initialize(app, env)
+        @app = app
+        @env = env
+      end
+
+      def call(env)
+        @env = env
+        vm = env[:machine]
+        if VagrantDNS::Config.auto_run
+          tmp_path = File.join(vm.env.tmp_path, "dns")
+          VagrantDNS::Configurator.new(vm, tmp_path).down!
+        end
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/vagrant-dns/middlewares/config_up.rb

@@ -0,0 +1,20 @@
+module VagrantDNS
+  module Middlewares
+    class ConfigUp
+      def initialize(app, env)
+        @app = app
+        @env = env
+      end
+
+      def call(env)
+        @env = env
+        vm = env[:machine]
+        if VagrantDNS::Config.auto_run
+          tmp_path = File.join(vm.env.tmp_path, "dns")
+          VagrantDNS::Configurator.new(vm, tmp_path).up!
+        end
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/vagrant-dns/middlewares/restart.rb

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

data/lib/vagrant-dns/service.rb

@@ -22,6 +22,11 @@ module VagrantDNS
       run!(run_options)
     end
 
+    def status!
+      run_options = {:ARGV => ["status"]}.merge(runopts)
+      run!(run_options)
+    end
+
     def run!(run_options)
       Daemons.run_proc("vagrant-dns", run_options) do
         require 'rubydns'
@@ -52,6 +57,17 @@ module VagrantDNS
       start!(start_opts)
     end
 
+    def show_config
+      registry = YAML.load(File.read(config_file)) if File.exists?(config_file)
+      if registry && registry.any?
+        registry.each do |pattern, ip|
+          puts format("%s => %s", Regexp.new(pattern).inspect, ip)
+        end
+      else
+        puts "Configuration missing or empty."
+      end
+    end
+
     def runopts
       daemon_dir = File.join(tmp_path, "daemon")
       {

data/lib/vagrant-dns/version.rb

@@ -1,5 +1,3 @@
-module Vagrant
-  module Dns
-    VERSION = "2.0.0"
-  end
+module VagrantDNS
+  VERSION = "2.1.0"
 end

data/vagrant-dns.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "vagrant-dns"
   gem.require_paths = ["lib"]
-  gem.version       = Vagrant::Dns::VERSION
+  gem.version       = VagrantDNS::VERSION
 
   gem.required_ruby_version = '>= 2.2.6'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-dns
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Florian Gilcher
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-19 00:00:00.000000000 Z
+date: 2018-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: daemons
@@ -75,7 +75,9 @@ files:
 - 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/middlewares/config_down.rb
+- lib/vagrant-dns/middlewares/config_up.rb
+- lib/vagrant-dns/middlewares/restart.rb
 - lib/vagrant-dns/service.rb
 - lib/vagrant-dns/version.rb
 - tasks/acceptance.rake

data/lib/vagrant-dns/restart_middleware.rb

@@ -1,21 +0,0 @@
-module VagrantDNS
-  class RestartMiddleware
-    def initialize(app, env)
-      @app = app
-      @env = env
-    end
-
-    def call(env)
-      @env = env
-      vm = env[:machine]
-      if VagrantDNS::Config.auto_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
-
-      @app.call(env)
-    end
-  end
-end