vagrant-dns 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63885c6803289a7e6e199a44dbf761fb10683e90
-  data.tar.gz: d96529364b2f27a2f0237610dc02cdc69ca5745a
+  metadata.gz: f20a43dd1e1d8a8fd560f86348319ad956f2a28e
+  data.tar.gz: d3411d5c4f66cadeb93aeec523a834341598a101
 SHA512:
-  metadata.gz: b85c14d3d21603561ce7e9179182e3702c31e89d98cb8deae725fa6c513730089da2fb964dc2f69842e7667797941826fd7a97b6bf03deb0f9da24edf7f035b4
-  data.tar.gz: 82c123e1d400655805226e8ad62604ce0f5c3a6886517d81ea00f18a209f63b12a6e388a0e265be9a4eab51cc82af38f3af462d3117d5c3fc3041f28b7512c6b
+  metadata.gz: d2e561a70c62e88e222b5df72e84256a27552d0200fc6b041cbf634f3d7fd9b765d0d7668f6294c3967a158f44b22cd348d71f4a7ffb4d9f83e36021a9d06fee
+  data.tar.gz: e7ae3cacb4cbc579b5ddc9f8de00589bba5505d2050b654cf35bffb0763eb0f7a0e57dc5ab1107d40e8a9e0de70fa5fc29d7d4a0e9ec4e8ede58776acb78432e

data/.gitignore

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

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+## 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:
@@ -13,7 +39,7 @@
 
 * 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.
+* 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:
 

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.

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
 ```
 
@@ -97,12 +97,37 @@ $ vagrant dns --list
 The output looks somewhat like this:
 
 ```
-/^.*mysite.dev$/ => 33.33.33.60
-/^.*myothersite.dev$/ => 33.33.33.60
+/^.*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.
@@ -112,8 +137,13 @@ Where the first part of each line is a [regular expression](https://ruby-doc.org
 ## 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 

data/lib/vagrant-dns.rb

@@ -1,6 +1,7 @@
 require "vagrant-dns/version"
 require "vagrant-dns/config"
 
+require "vagrant-dns/registry"
 require "vagrant-dns/service"
 require "vagrant-dns/installers/mac"
 require "vagrant-dns/configurator"

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
@@ -11,6 +10,7 @@ module VagrantDNS
     end
 
     def up!
+      return unless validate_tlds
       regenerate_resolvers!
       ensure_deamon_env!
       register_patterns!
@@ -21,6 +21,16 @@ module VagrantDNS
     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)
 
@@ -60,15 +70,12 @@ module VagrantDNS
 
         ip = network.last[:ip]
 
-        registry = YAML.load(File.read(config_file)) if File.exists?(config_file)
-        registry ||= {}
-
-        patterns.each do |p|
-          p = p.source if p.respond_to? :source # Regexp#to_s is unusable
-          registry[p] = ip
+        registry = Registry.new(tmp_path)
+        registry.transaction do
+          patterns.each do |pattern|
+            registry[pattern] = ip
+          end
         end
-
-        File.open(config_file, "w") { |f| f << YAML.dump(registry) }
       end
 
       def unregister_patterns!
@@ -80,22 +87,21 @@ module VagrantDNS
           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
+        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 |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."
+          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
-
-        File.open(config_file, "w") { |f| f << YAML.dump(registry) }
       end
 
       def dns_options(vm)
@@ -128,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/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
@@ -32,13 +31,14 @@ module VagrantDNS
         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
 
@@ -58,10 +58,11 @@ module VagrantDNS
     end
 
     def show_config
-      registry = YAML.load(File.read(config_file)) if File.exists?(config_file)
-      if registry && registry.any?
+      registry = Registry.new(tmp_path).to_hash
+
+      if registry.any?
         registry.each do |pattern, ip|
-          puts format("%s => %s", Regexp.new(pattern).inspect, ip)
+          puts format("%s => %s", pattern.inspect, ip)
         end
       else
         puts "Configuration missing or empty."
@@ -77,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,3 +1,3 @@
 module VagrantDNS
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 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,6 +7,7 @@ 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) }
@@ -19,6 +20,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "daemons"
   gem.add_dependency "rubydns", '~> 2.0.0'
+  gem.add_dependency "public_suffix"
 
   gem.add_development_dependency 'rspec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-dns
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Florian Gilcher
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-16 00:00:00.000000000 Z
+date: 2018-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: daemons
@@ -39,6 +39,20 @@ 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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -78,13 +92,15 @@ files:
 - 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: 
 rdoc_options: []
@@ -102,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: vagrant-dns manages DNS records of vagrant machines