vagrant-dns 2.0.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b99205f3d200b610ee3b9c0fd3e3f3c84e99377a
-  data.tar.gz: e1677768a2c0117a10f8f5caf58ab9359124643b
+SHA256:
+  metadata.gz: db8e26c490508c47ab65d7a9065e491cac6d97a00a5c6134198acd258445b72c
+  data.tar.gz: 61651738cc69c6d9992e13e61ee8d21c6f2c2a5018ab32adbc338e6bc2d3e10d
 SHA512:
-  metadata.gz: 43bcb3a01c66b768ab75003f4add646658e7fb6e4c15e552a22ce6ddf85ce034c8738f96a8c3093e603f0dd963151a8fc578ff16ef73e81c5e471125d645df3a
-  data.tar.gz: 4492147711e59b16309206707b3eabcad0d92ca3b94392344e5bed70ce7703e37b705c4e7df5e896f7e494d86446db57545adacc962eb0a9d90b324cf8594082
+  metadata.gz: 7e2d081d253222942c755e9c8a65798d9225e2a6220a6317a092b37526cc354617e956c3255d0af078173fd458e1eb5826ac3769b1dfc20f2c77179b05359e53
+  data.tar.gz: 7b804c925ad00243d5643a6b9fe531dac654ded33456fb873bf6644f9e119faf99560838fb54a0285e7fe7e95e189688c2f67a0a3d5dff23f1101885464b0739

data/.gitignore

@@ -17,3 +17,4 @@ test/version_tmp
 test/acceptance/artifacts
 tmp
 testdrive/.vagrant
+Gemfile.local

data/CHANGELOG.md

@@ -1,14 +1,73 @@
-# 2.0.0
+## 2.2.2
+
+### Fixes:
+
+* Installation issue due to updated sub-dependency. [GH-69]
+
+## 2.2.1
+
+### Fixes:
+
+* Prevent action hooks (restarting dns server) from running multiple times [GH-67]
+
+## 2.2.0
+
+### New Feautres:
+
+* Add global config for time-to-live via `VagrantDNS::Config.ttl`
+
+### Fixes:
+
+* Fixes acceptance tests for macOS High Sierra (10.13) to cope with `scutil`s new output format
+* Adds the log-time missing `license` gem config
+
+### Breaking Changes:
+
+* Removes the global and vm config  `ipv4only`. It was nver been used.
+
+### Changes:
+
+* Resources will now respond with a low TTL (time-to-live) of 5 minutes (300 seconds) instead of the old 24 hours by default. Use `VagrantDNS::Config.ttl = 86400` to reset to the old behaviour.
+* Internal changes on how the dns pattern config is read and written. (Now using `YAML::Store`)
+* Acceptance tests run against vagrant v2.1.4
+* Acceptance tests run against Ubuntu 18.04
+
+### New Feautres:
+
+* Adds a check for the VMs configured TLDs to not be included in the [Public Suffix List](https://publicsuffix.org/)
+
+## 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 gets re/started or one of vagrant dns `--install`, `--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 +75,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 +91,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 +109,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 +145,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/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
-ruby(ENV['TEST_RUBY_VERSION'] || '~> 2.3.4')
+ruby(ENV['TEST_RUBY_VERSION'] || '~> 2.4.4')
 
-ENV['TEST_VAGRANT_VERSION'] ||= 'v1.9.6'
+ENV['TEST_VAGRANT_VERSION'] ||= 'v2.1.4'
 
 # Using the :plugins group causes Vagrant to automagially load auto_network
 # during acceptance tests.
@@ -11,7 +11,7 @@ end
 
 group :test, :development do
   if ENV['TEST_VAGRANT_VERSION'] == 'HEAD'
-    gem 'vagrant', :git => 'https://github.com/hashicorp/vagrant', :branch => 'master'
+    gem 'vagrant', :git => 'https://github.com/hashicorp/vagrant', :branch => 'main'
   else
     gem 'vagrant', :git => 'https://github.com/hashicorp/vagrant', :tag => ENV['TEST_VAGRANT_VERSION']
   end
@@ -19,7 +19,7 @@ group :test, :development do
 end
 
 group :test do
-  gem 'vagrant-spec', :git => 'https://github.com/hashicorp/vagrant-spec'
+  gem 'vagrant-spec', :git => 'https://github.com/hashicorp/vagrant-spec', :branch => 'main'
   gem 'rake'
 end
 

data/PLATFORM_SUPPORT.md

@@ -14,7 +14,7 @@ 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.
+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 (.test). As a fallback, it also supports pass-through, if you really want to play with ICANN domains.
 
 The DNS server runs on all platforms.
 
@@ -58,4 +58,4 @@ Quite frankly, I have not enough understanding on how to implement this properly
 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.
+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

@@ -18,11 +18,11 @@ In addition to your networking config, configure a toplevel domain and a `hostna
 Vagrant.configure("2") do |config|
   #...
 
-  config.dns.tld = "dev"
+  config.dns.tld = "test"
 
   config.vm.hostname = "machine"
 
-  config.dns.patterns = [/^.*mysite.dev$/, /^.*myothersite.dev$/]
+  config.dns.patterns = [/^(\w+\.)*mysite\.test$/, /^(\w+\.)*myothersite\.test$/]
 
   config.vm.network :private_network, ip: "33.33.33.60"
 end
@@ -37,7 +37,7 @@ Then, register the DNS server as a resolver:
 $ 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.
+On OS X, this will create a file `/etc/resolver/test`, which tells OS X to resolve the TLD `.test` 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:
 
@@ -45,7 +45,7 @@ You can delete this file by running:
 $ vagrant dns --uninstall
 ```
 
-To also delete the created config file for this TLD (`~/.vagrant.d/tmp/dns/resolver/dev` in our example) run:
+To also delete the created config file for this TLD (`~/.vagrant.d/tmp/dns/resolver/test` in our example) run:
 
 
 ```bash
@@ -64,12 +64,12 @@ And test it:
 $ scutil --dns
 ...
 resolver #8
-  domain   : dev
+  domain   : test
   nameserver[0] : 127.0.0.1
   port     : 5300
 ...
-$ dscacheutil -q host -a name test.machine.dev
-name: test.machine.dev
+$ dscacheutil -q host -a name test.machine.test
+name: test.machine.test
 ip_address: 33.33.33.10
 ```
 
@@ -87,6 +87,47 @@ $ 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.test$/ => 33.33.33.60
+/^.*myothersite.test$/ => 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)
+
+## Multi VM config
+
+We can use [multivm](https://www.vagrantup.com/docs/multi-machine/) configuration and have dns names for host.
+
+* Use below given vagrant config
+    ```ruby
+    BOX_IMAGE = "ubuntu/xenial64"
+    WORKER_COUNT = 2
+    Vagrant.configure("2") do |config|
+      (1..WORKER_COUNT).each do |i|
+        config.vm.define "worker#{i}" do |subconfig|
+          subconfig.dns.tld = "test"
+          subconfig.vm.hostname = "vagrant"
+          subconfig.dns.patterns = "worker#{i}.mysite.test"
+          subconfig.vm.box = BOX_IMAGE
+          subconfig.vm.network "private_network", ip: "10.240.0.#{i+15}"
+        end
+      end
+    end
+    ```
+*  `vagrant up`
+*  Execute : `vagrant dns --install`
+*  Test via: `ping worker2.mysite.box` or `worker1.mysite.box`
+
+
 ## VM options
 
 * `vm.dns.tld`: Set the tld for the given virtual machine. No default.
@@ -96,7 +137,36 @@ The DNS server will start automatically once the first VM is started.
 ## Global Options
 
 * `VagrantDNS::Config.listen`: an Array of Arrays describing interfaces to bind to. Defaults to `[[:udp, "127.0.0.1", 5300]]`.
+* `VagrantDNS::Config.ttl`: The time-to-live in seconds for all resources. Defaults to `300` (5 minutes).
 * `VagrantDNS::Config.auto_run`: (re)start and reconfigure the server every time a machine is started. On by default.
+* `VagrantDNS::Config.check_public_suffix`: Check if you are going to configure a [Public Suffix](https://publicsuffix.org/) (like a Top Level Domain) in a VMs `tld(s)` config, which could mess up your local dev machines DNS config. Possible configuration values are:
+  - `false`: Disables the feature.
+  - `"warn"`: Check and print a warning. (Still creates a resolver config and potentionally messes up your DNS) **At the moment, this is the default** because lots of projetcs used to use `"dev"` as a TLD, but this got registered by google and is now a public suffix.
+  - `"error"`: Check and prevent the box from starting. (Does not create the resolver config, it will also prevent the box from starting.)
+ 
+## 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
 
@@ -104,4 +174,4 @@ The DNS server will start automatically once the first VM is started.
 * 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/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/config.rb

@@ -3,27 +3,60 @@ require 'logger'
 module VagrantDNS
   class Config < Vagrant.plugin(2, :config)
     class << self
-      attr_accessor :listen, :logger, :ipv4only, :auto_run
+      attr_accessor :listen, :ttl, :logger, :auto_run, :check_public_suffix
 
       def listen
         @listen ||= [[:udp, "127.0.0.1", 5300]]
       end
 
-      def ipv4only
-        @ipv4only || @ipv4only.nil?
+      def ttl
+        @ttl ||= 300
       end
-      
+
       def auto_run
         return true if @auto_run.nil?
         @auto_run
       end
+
+      def check_public_suffix
+        return "warn" if @check_public_suffix.nil?
+        @check_public_suffix
+      end
+
+      def validate_tlds(vm)
+        return [true, nil] unless check_public_suffix
+
+        require "public_suffix"
+
+        # Don't include private domains in the list, we are only interested in TLDs and such
+        list = PublicSuffix::List.parse(
+          File.read(PublicSuffix::List::DEFAULT_LIST_PATH),
+          private_domains: false
+        )
+
+        failed_tlds = vm.config.dns.tlds.select { |tld| list.find(tld, default: false) }
+
+        err = if failed_tlds.any?
+          "tlds include a public suffix: #{failed_tlds.join(', ')}"
+        end
+
+        if err && check_public_suffix.to_s == "error"
+          [false, err]
+        elsif err
+          [true, err]
+        else
+          [true, nil]
+        end
+      end
     end
 
-    attr_accessor :records, :tlds, :ipv4only, :patterns
+    attr_accessor :records
+    attr_reader :tlds, :patterns
 
     def pattern=(pattern)
-      self.patterns = pattern
+      @patterns = (pattern ? Array(pattern) : pattern)
     end
+    alias_method :patterns=, :pattern=
 
     def tld=(tld)
       @tlds = Array(tld)
@@ -36,12 +69,31 @@ module VagrantDNS
     # explicit hash, to get symbols in hash keys
     def to_hash
       {
-        :patterns => (patterns ? Array(patterns) : patterns),
+        :patterns => patterns,
         :records => records,
-        :tlds => tlds,
-        :ipv4only => ipv4only
+        :tlds => tlds
       }
     end
+
+    def validate(machine)
+      errors = _detected_errors
+
+      errors = validate_check_public_suffix(errors, machine)
+
+      { "vagrant_dns" => errors }
+    end
+
+    def validate_check_public_suffix(errors, machine)
+      valid, err = self.class.validate_tlds(machine)
+
+      if !valid
+        errors << err
+      elsif err
+        machine.ui.warn(err)
+      end
+
+      errors
+    end
   end
 end
 

data/lib/vagrant-dns/configurator.rb

@@ -1,5 +1,4 @@
 require 'fileutils'
-require 'yaml'
 
 module VagrantDNS
   class Configurator
@@ -10,13 +9,28 @@ module VagrantDNS
       @tmp_path = tmp_path
     end
 
-    def run!
+    def up!
+      return unless validate_tlds
       regenerate_resolvers!
       ensure_deamon_env!
       register_patterns!
     end
 
+    def down!
+      unregister_patterns!
+    end
+
     private
+      def validate_tlds
+        valid, err = VagrantDNS::Config.validate_tlds(vm)
+        if !valid
+          vm.ui.error(err)
+        elsif err
+          vm.ui.warn(err)
+        end
+        valid
+      end
+
       def regenerate_resolvers!
         FileUtils.mkdir_p(resolver_folder)
 
@@ -56,15 +70,38 @@ module VagrantDNS
 
         ip = network.last[:ip]
 
-        registry = YAML.load(File.read(config_file)) if File.exists?(config_file)
-        registry ||= {}
+        registry = Registry.new(tmp_path)
+        registry.transaction do
+          patterns.each do |pattern|
+            registry[pattern] = ip
+          end
+        end
+      end
+
+      def unregister_patterns!
+        opts     = dns_options(vm)
 
-        patterns.each do |p|
-          p = p.source if p.respond_to? :source # Regexp#to_s is unusable
-          registry[p] = ip
+        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
 
-        File.open(config_file, "w") { |f| f << YAML.dump(registry) }
+        registry = Registry.new(tmp_path)
+        registry.transaction do
+          unless registry.any?
+            vm.ui.warn '[vagrant-dns] Configuration missing or empty. No patterns will be removed.'
+            registry.abort
+          end
+
+          patterns.each do |pattern|
+            if (ip = registry.delete(pattern))
+              vm.ui.info "[vagrant-dns] Removing pattern: #{pattern} for ip: #{ip}"
+            else
+              vm.ui.info "[vagrant-dns] Pattern: #{pattern} was not in config."
+            end
+          end
+        end
       end
 
       def dns_options(vm)
@@ -97,9 +134,5 @@ FILE
       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/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/registry.rb

@@ -0,0 +1,60 @@
+require 'yaml/store'
+require 'forwardable'
+
+module VagrantDNS
+  # This is the dns pattern registry (aka "config")
+  # It basically delegates everything to a YAML::Store but handles the conversion
+  # of Regexp dns-patterns into YAML string keys and reverse.
+  class Registry
+    extend Forwardable
+
+    def initialize(tmp_path)
+      @store = YAML::Store.new(File.join(tmp_path, "config"), true)
+    end
+
+    def_delegators :@store, :transaction, :abort, :commit
+
+    # This method is only valid in a #transaction and it cannot be read-only. It will raise PStore::Error if called at any other time.
+    def [](name)
+      name = name.source if name.respond_to? :source
+      @store[name]
+    end
+
+    # This method is only valid in a #transaction and it cannot be read-only. It will raise PStore::Error if called at any other time.
+    def []=(name, value)
+      name = name.source if name.respond_to? :source
+      @store[name] = value
+    end
+
+    def delete(name)
+      name = name.source if name.respond_to? :source
+      @store.delete(name)
+    end
+
+    # This method is only valid in a #transaction and it cannot be read-only. It will raise PStore::Error if called at any other time.
+    def root?(name)
+      name = name.source if name.respond_to? :source
+      @store.root?(name)
+    end
+    alias_method :key?, :root?
+
+    # This method is only valid in a #transaction and it cannot be read-only. It will raise PStore::Error if called at any other time.
+    def roots
+      @store.roots.map { |name| Regexp.new(name) }
+    end
+    alias_method :keys, :roots
+
+    # This method is only valid in a #transaction and it cannot be read-only. It will raise PStore::Error if called at any other time.
+    def any?
+      @store.roots.any?
+    end
+
+    def to_hash
+      @store.transaction(true) do
+        @store.roots.each_with_object({}) do |name, a|
+          a[Regexp.new(name)] = @store[name]
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-dns/service.rb

@@ -1,6 +1,5 @@
 require 'daemons'
 
-
 module VagrantDNS
   class Service
     attr_accessor :tmp_path
@@ -22,18 +21,24 @@ 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'
         require 'async/dns/system'
 
-        registry = YAML.load(File.read(config_file))
+        registry = Registry.new(tmp_path).to_hash
         std_resolver = RubyDNS::Resolver.new(Async::DNS::System.nameservers)
+        ttl = VagrantDNS::Config.ttl
 
         RubyDNS::run_server(VagrantDNS::Config.listen) do
           registry.each do |pattern, ip|
-            match(Regexp.new(pattern), Resolv::DNS::Resource::IN::A) do |transaction, match_data|
-              transaction.respond!(ip)
+            match(pattern, Resolv::DNS::Resource::IN::A) do |transaction, match_data|
+              transaction.respond!(ip, ttl: ttl)
             end
           end
 
@@ -52,6 +57,18 @@ module VagrantDNS
       start!(start_opts)
     end
 
+    def show_config
+      registry = Registry.new(tmp_path).to_hash
+
+      if registry.any?
+        registry.each do |pattern, ip|
+          puts format("%s => %s", pattern.inspect, ip)
+        end
+      else
+        puts "Configuration missing or empty."
+      end
+    end
+
     def runopts
       daemon_dir = File.join(tmp_path, "daemon")
       {
@@ -61,9 +78,5 @@ module VagrantDNS
         :log_dir    => daemon_dir
      }
     end
-
-    def config_file
-      File.join(tmp_path, "config")
-    end
   end
 end

data/lib/vagrant-dns/version.rb

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

data/lib/vagrant-dns.rb

@@ -1,15 +1,32 @@
 require "vagrant-dns/version"
 require "vagrant-dns/config"
 
+require "vagrant-dns/registry"
 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
 
-  class Plugin < Vagrant.plugin("2")
+  # @private
+  def self.hooks
+    @hooks ||= []
+  end
 
+  # @private
+  def self.hooked(name)
+    hooks << name
+  end
+
+  # @private
+  def self.hooked?(name)
+    hooks.include?(name)
+  end
+
+  class Plugin < Vagrant.plugin("2")
     name "vagrant-dns"
 
     config "dns" do
@@ -21,12 +38,23 @@ module VagrantDNS
       Command
     end
 
-    %w{up reload}.each do |action|
-      action_hook(:restart_host_dns, "machine_action_#{action}".to_sym) do |hook|
-        hook.append VagrantDNS::RestartMiddleware
+    %w{machine_action_up machine_action_reload}.each do |action|
+      action_hook("restart_vagarant_dns_on_#{action}", action) do |hook|
+        unless VagrantDNS.hooked?(action)
+          hook.append VagrantDNS::Middlewares::ConfigUp
+          hook.append VagrantDNS::Middlewares::Restart
+          VagrantDNS.hooked(action)
+        end
       end
     end
 
+    action_hook("remove_vagrant_dns_config", "machine_action_destroy") do |hook|
+      unless VagrantDNS.hooked?("remove_vagrant_dns_config")
+        hook.append VagrantDNS::Middlewares::ConfigDown
+        hook.append VagrantDNS::Middlewares::Restart
+        VagrantDNS.hooked("remove_vagrant_dns_config")
+      end
+    end
   end
 
 end

data/tasks/acceptance.rake

@@ -1,3 +1,5 @@
+require "tmpdir"
+
 namespace :acceptance do
   def tmp_dir_path
     @tmp_dir_path ||= ENV["VS_TEMP"] || Dir.mktmpdir('vagrant-dns-spec')
@@ -6,22 +8,25 @@ namespace :acceptance do
   ARTIFACT_DIR = File.join('test', 'acceptance', 'artifacts')
 
   TEST_BOXES = {
-    :virtualbox => 'http://files.vagrantup.com/precise32.box'
+    # Ubuntu 16.04 https://app.vagrantup.com/ubuntu/boxes/xenial64.json
+    # :virtualbox => "https://vagrantcloud.com/ubuntu/boxes/xenial64/versions/20180511.0.0/providers/virtualbox.box"
+    # Ubuntu 18.04 https://app.vagrantup.com/ubuntu/boxes/bionic64.json
+    :virtualbox => "https://vagrantcloud.com/ubuntu/boxes/bionic64/versions/20180709.0.0/providers/virtualbox.box"
   }
 
   TEST_BOXES.each do |provider, box_url|
     # Declare file download tasks
-    directory ARTIFACT_DIR do
-      file File.join(ARTIFACT_DIR, "#{provider}.box") => ARTIFACT_DIR do |path|
-        puts 'Downloading: ' + box_url
-        Kernel.system 'curl', '-L', '-o', path.to_s, box_url
-      end
+    directory ARTIFACT_DIR
+
+    file File.join(ARTIFACT_DIR, "#{provider}.box") => ARTIFACT_DIR do |path|
+      puts 'Downloading: ' + box_url
+      Kernel.system 'curl', '-L', '-o', path.to_s, box_url
     end
 
     desc "Run acceptance tests for #{provider}"
     task provider => :"setup:#{provider}" do |task|
       box_path = File.expand_path(File.join('..', '..', ARTIFACT_DIR, "#{provider}.box"), __FILE__)
-      puts "TMPDIR: " + tmp_dir_path
+      puts "TMPDIR: #{tmp_dir_path}"
       Kernel.system(
         {
           "VS_PROVIDER" => provider.to_s,

data/vagrant-dns.gemspec

@@ -7,18 +7,25 @@ Gem::Specification.new do |gem|
   gem.description   = %q{vagrant-dns is a vagrant plugin that manages DNS records associated with local machines.}
   gem.summary       = %q{vagrant-dns manages DNS records of vagrant machines}
   gem.homepage      = ""
+  gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($\).reject { |f| f.match(%r{^(test|testdrive)/}) }
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   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'
 
   gem.add_dependency "daemons"
   gem.add_dependency "rubydns", '~> 2.0.0'
+  gem.add_dependency "public_suffix"
+
+  # Pinning async gem to work around an issue in vagrant, where it does not
+  # honor "required_ruby_version" while resolving sub-dependencies.
+  # see: https://github.com/hashicorp/vagrant/issues/12640
+  gem.add_dependency 'async', '< 2'
 
   gem.add_development_dependency 'rspec'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-dns
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Florian Gilcher
 - Robert Schulze
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-10-19 00:00:00.000000000 Z
+date: 2022-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: daemons
@@ -39,6 +39,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -75,16 +103,20 @@ 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/registry.rb
 - lib/vagrant-dns/service.rb
 - lib/vagrant-dns/version.rb
 - tasks/acceptance.rake
 - vagrant-dns.gemspec
 - vagrant-spec.config.rb
 homepage: ''
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,9 +131,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: vagrant-dns manages DNS records of vagrant machines
 test_files: []

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