lh-vagrant-dns 0.0.1.dev

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Vagrantfile
+.vagrant

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem "vagrant", git: "git://github.com/mitchellh/vagrant.git"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Lin He
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Vagrant dns plugin
+
+A Vagrant **1.1.x** plugin to manage DNS records on **Mac systems**. It is
+heavily based on https://github.com/BerlinVagrant/vagrant-dns (which doesn't
+seem to support Vagrant 1.1.x currently), so credit goes to the author of that
+lib.
+
+## TODOs
+
+* Add specs
+* Add config validation
+* Add DNS resolver uninstall command
+* Add Vagrant destroy action hook to clean dns tmp path
+
+## Installation
+
+It is only used as a plugin for Vagrant, so to install:
+
+    $ vagrant plugin install lh-vagrant-dns
+
+## Usage
+
+    Vagrant.configure("2") do |config|
+
+      # Configure DNS tlds
+      config.dns.tld = "dev"
+      # or config.dns.tlds = ["dev", "stag"]
+
+      # This will be used to construct dns patterns, unless if
+      # config.dns.patterns option is explicity defined. Otherwise, given tld
+      # to be 'dev', we would get DNS pattern /^.*machine.dev$/
+      config.vm.hostname = "machine"
+
+      # Optional configuration
+      config.dns.patterns = [/^.*mysite.dev$/, /^.*myothersite.dev$/]
+
+      config.vm.network :private_network, ip: "33.33.33.100"
+    end
+
+After `vagrant up`, install DNS resolver on mac:
+
+    $ sudo vagrant dns --install
+
+Now, `vagrant halt` stops a DNS server, while `vagrant up` or `vagrant provision`
+starts a DNS server.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/vagrant-dns/action/create_daemons_dir.rb

@@ -0,0 +1,24 @@
+module VagrantPlugins
+  module DNS
+    module Action
+      class CreateDaemonsDir
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          daemon_path = env[:dns].daemon_path
+
+          if File.directory?(daemon_path)
+            env[:dns].ui.info "Existed daemons dir #{daemon_path}"
+          else
+            env[:dns].ui.info "Creating daemons dir #{daemon_path}"
+            FileUtils.mkdir_p(daemon_path)
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-dns/action/create_resolvers.rb

@@ -0,0 +1,42 @@
+module VagrantPlugins
+  module DNS
+    module Action
+      # Create resolver files in ~/.vagrant.d/tmp/dns/resolver
+      class CreateResolvers
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          tmp_dns_path    = env[:dns].tmp_path
+          resolver_folder = File.join(tmp_dns_path, "resolver")
+
+          port = VagrantPlugins::DNS.listen.first.last # 5300
+          tlds = env[:machine].config.dns.tlds
+
+          FileUtils.mkdir_p(resolver_folder)
+
+          tlds.each do |tld|
+            File.open(File.join(resolver_folder, tld), "w") do |f|
+              f << resolver_file(port)
+            end
+          end
+
+          env[:dns].ui.info "Created resolvers for tlds #{tlds}"
+
+          @app.call(env)
+        end
+
+        private
+
+        def resolver_file(port)
+          contents = <<-FILE
+# this file is generated by vagrant-dns
+nameserver 127.0.0.1
+port #{port}
+FILE
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-dns/action/register_patterns.rb

@@ -0,0 +1,56 @@
+module VagrantPlugins
+  module DNS
+    module Action
+      # Write dns patterns to ~/.vagrant.d/dns/config file.
+      class RegisterPatterns
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          config_file = env[:dns].config_file
+          registry    = File.exists?(config_file) ? \
+                          YAML.load(File.read(config_file)) : {}
+          opts        = prepare_opts(env[:machine].config)
+          patterns    = opts[:patterns] || default_patterns(opts)
+          networks    = opts[:networks].select { |i| i[0] == :private_network }
+                                       .flatten
+
+          ip = networks.empty? ? '127.0.0.1' : networks[1][:ip]
+
+          patterns.each do |p|
+            p = p.source if p.respond_to? :source # Regexp#to_s is unusable
+            registry[p] = ip
+          end
+
+          env[:dns].ui.info "Registering patterns #{registry}"
+
+          File.open(config_file, "w") { |f| f << YAML.dump(registry) }
+
+          @app.call(env)
+        end
+
+        private
+
+        def prepare_opts(config)
+          {
+            tlds:      config.dns.tlds,
+            patterns:  config.dns.patterns,
+            host_name: config.vm.hostname,
+            networks:  config.vm.networks
+          }
+        end
+
+        def default_patterns(opts)
+          if opts[:host_name]
+            opts[:tlds].map { |tld| /^.*#{opts[:host_name]}.#{tld}$/ }
+          else
+            env[:dns].ui.warn 'TLD but no host_name given. No patterns will \
+                               be configured.'
+            []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-dns/action/setup_env.rb

@@ -0,0 +1,22 @@
+module VagrantPlugins
+  module DNS
+    module Action
+      class SetupEnv
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:dns].tmp_path    = File.join(env[:tmp_path], DNS.namespace)
+          env[:dns].daemon_path = File.join(env[:dns].tmp_path, "daemon")
+          env[:dns].config_file = File.join(env[:dns].tmp_path, "config")
+          env[:dns].dns_server  = DNSServer.new \
+                                    dir:    env[:dns].daemon_path,
+                                    config: env[:dns].config_file
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-dns/action/start_dns_server.rb

@@ -0,0 +1,20 @@
+require "vagrant-dns/dns_server"
+
+module VagrantPlugins
+  module DNS
+    module Action
+      class StartDNSServer
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:dns].ui.info "Restarting dns server..."
+          env[:dns].dns_server.restart!
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-dns/action/stop_dns_server.rb

@@ -0,0 +1,21 @@
+require "vagrant-dns/dns_server"
+
+module VagrantPlugins
+  module DNS
+    module Action
+      class StopDNSServer
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:dns].ui.info "Stopping dns server..."
+          env[:dns].dns_server.stop!
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end
+

data/lib/vagrant-dns/action.rb

@@ -0,0 +1,46 @@
+require "pathname"
+require "vagrant/action/builder"
+
+require_relative "env"
+
+module VagrantPlugins
+  module DNS
+    module Action
+      class << self
+        def setup
+          @setup ||= ::Vagrant::Action::Builder.new.tap do |b|
+            b.use ::Vagrant::Action::Builtin::EnvSet, dns: VagrantPlugins::DNS::Env.new
+            b.use SetupEnv
+            b.use CreateResolvers
+            b.use CreateDaemonsDir
+            b.use RegisterPatterns
+          end
+        end
+
+        def clean
+          @clean ||= ::Vagrant::Action::Builder.new.tap do |b|
+            b.use ::Vagrant::Action::Builtin::EnvSet, dns: VagrantPlugins::DNS::Env.new
+            b.use SetupEnv
+            b.use StopDNSServer
+          end
+        end
+
+        def start
+          @start ||= ::Vagrant::Action::Builder.new.tap do |b|
+            b.use ::Vagrant::Action::Builtin::EnvSet, dns: VagrantPlugins::DNS::Env.new
+            b.use SetupEnv
+            b.use StartDNSServer
+          end
+        end
+      end
+
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :SetupEnv,         action_root.join("setup_env")
+      autoload :CreateResolvers,  action_root.join("create_resolvers")
+      autoload :CreateDaemonsDir, action_root.join("create_daemons_dir")
+      autoload :RegisterPatterns, action_root.join("register_patterns")
+      autoload :StartDNSServer,   action_root.join("start_dns_server")
+      autoload :StopDNSServer,    action_root.join("stop_dns_server")
+    end
+  end
+end

data/lib/vagrant-dns/command.rb

@@ -0,0 +1,44 @@
+module VagrantPlugins
+  module DNS
+    class Command < ::Vagrant.plugin("2", :command)
+      INSTALL_PATH = "/etc/resolver".freeze
+
+      def execute
+        tmp_dns_path = File.join @env.tmp_path, DNS.namespace
+        options      = {}
+
+        opts = OptionParser.new do |o|
+          o.banner = "Usage: vagrant destroy [vm-name]"
+          o.separator ""
+
+          o.on("-f", "--install", "Install dns resolver on mac.") do |f|
+            begin
+              if File.directory?(INSTALL_PATH)
+                @env.ui.info "Existed install dir #{INSTALL_PATH}"
+              else
+                @env.ui.info "Creating install dir #{INSTALL_PATH}"
+                FileUtils.mkdir_p(INSTALL_PATH)
+              end
+
+              registered_resolvers = Dir[File.join(tmp_dns_path, "resolver", "*")]
+
+              @env.ui.info "Installing DNS resolvers #{registered_resolvers} to #{INSTALL_PATH}"
+
+              FileUtils.ln_s(registered_resolvers, INSTALL_PATH, force: true)
+
+            rescue Errno::EACCES => e
+              @env.ui.error "vagrant-dns needs superuser access to manipulate DNS settings"
+              @env.ui.error "DNS resolvers not installed"
+
+            rescue Errno::EEXIST => e
+              @env.ui.error "#{INSTALL_PATH} exists. Please remove it first to force override"
+            end
+          end
+        end
+
+        # Parse the options
+        argv = parse_options(opts)
+      end
+    end
+  end
+end

data/lib/vagrant-dns/config.rb

@@ -0,0 +1,19 @@
+module VagrantPlugins
+  module DNS
+    class Config < ::Vagrant.plugin("2", :config)
+      # config.dns.tld = "dev"
+      # config.dns.tlds = ["dev", "dom"]
+      #
+      def tld=(tlds)
+        @tlds = Array(tlds)
+      end
+      alias :tlds= :tld=
+
+      attr_reader :tlds
+
+      # config.dns.patterns = [/^.*promojam.dev$/, /^.*coca-cola.dev$/]
+      #
+      attr_accessor :patterns
+    end
+  end
+end

data/lib/vagrant-dns/dns_server.rb

@@ -0,0 +1,61 @@
+module VagrantPlugins
+  module DNS
+    class DNSServer
+      def initialize(options)
+        @config  = options.fetch(:config) { raise "" }
+        @dir     = options.fetch(:dir) { raise "" }
+        @log_dir = options.fetch(:dir, @dir)
+
+        @run_options = {
+          dir_mode: :normal,
+          dir: @dir,
+          log_output: true,
+          log_dir: @log_dir,
+        }
+      end
+
+      def start!
+        run! @run_options.merge ARGV: ["start"]
+      end
+
+      def stop!
+        run! @run_options.merge ARGV: ["stop"]
+      end
+
+      def run!(run_options)
+        require "daemons"
+
+        Daemons.run_proc("vagrant-dns", run_options) do
+          require 'rubydns'
+          require 'rubydns/system'
+
+          # Here the registry file has been created, so we can read it and
+          # respond!
+          registry = YAML.load(File.read(@config))
+          std_resolver = RubyDNS::Resolver.new(RubyDNS::System::nameservers)
+
+          RubyDNS::run_server(listen: VagrantPlugins::DNS.listen) do
+            registry.each do |pattern, ip|
+              match(Regexp.new(pattern), Resolv::DNS::Resource::IN::A) \
+                do |match_data, transaction|
+                  transaction.respond!(ip)
+                end
+            end
+
+            otherwise do |transaction|
+              transaction.passthrough!(std_resolver) do |reply, reply_name|
+                puts reply
+                puts reply_name
+              end
+            end
+          end
+        end
+      end
+
+      def restart!
+        stop!
+        start!
+      end
+    end
+  end
+end

data/lib/vagrant-dns/env.rb

@@ -0,0 +1,31 @@
+module VagrantPlugins
+  module DNS
+    # Environment data to build up and persist through the middleware chain
+    class Env
+
+      # Returns a scoped vagrant ui
+      #
+      # @return [Vagrant::UI::Interface]
+      attr_accessor :ui
+
+      # Returns the tmp path for this plugin.
+      #
+      # @return [Pathname]
+      attr_accessor :tmp_path
+
+      attr_accessor :daemon_path
+
+      attr_accessor :config_file
+
+      attr_accessor :dns_server
+
+      def initialize
+        @ui = ::Vagrant::UI::Colored.new.scope("dns")
+      end
+
+      def tmp_path
+        @tmp_path || raise("@tmp_path has not been set")
+      end
+    end
+  end
+end

data/lib/vagrant-dns/env_helper.rb

@@ -0,0 +1,6 @@
+module VagrantPlugins
+  module DNS
+    module EnvHelper
+    end
+  end
+end

data/lib/vagrant-dns/plugin.rb

@@ -0,0 +1,45 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The Vagrant DNS plugin must be run within Vagrant."
+end
+
+# This is a sanity check to make sure no one is attempting to install
+# this into an early Vagrant version.
+if Vagrant::VERSION < "1.1.0"
+  raise "The Vagrant DNS plugin is only compatible with Vagrant 1.1+"
+end
+
+module VagrantPlugins
+  module DNS
+    class Plugin < ::Vagrant.plugin("2")
+      name "DNS"
+
+      class << self
+        def provision(hook)
+          hook.before ::Vagrant::Action::Builtin::ConfigValidate, Action.setup
+          hook.after  ::Vagrant::Action::Builtin::Provision,      Action.start
+        end
+      end
+
+      name "vagrant-dns"
+
+      action_hook(:rubydns_provision, :machine_action_up,        &method(:provision))
+      action_hook(:rubydns_provision, :machine_action_provision, &method(:provision))
+      action_hook(:rubydns_cleanup,   :machine_action_halt) do |hook|
+        hook.after(::Vagrant::Action::Builtin::GracefulHalt,
+          VagrantPlugins::DNS::Action.clean)
+      end
+
+      config(:dns) do
+        require_relative "config"
+        Config
+      end
+
+      command(:dns) do
+        require_relative "command"
+        Command
+      end
+    end
+  end
+end

data/lib/vagrant-dns/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module DNS
+    VERSION = "0.0.1.dev"
+  end
+end

data/lib/vagrant-dns.rb

@@ -0,0 +1,29 @@
+require "pathname"
+require "vagrant-dns/plugin"
+
+module VagrantPlugins
+  module DNS
+    lib_path = Pathname.new(File.expand_path("../vagrant-dns", __FILE__))
+
+    autoload :Action, lib_path.join("action")
+    # autoload :Errors, lib_path.join("errors")
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+
+    # Returns the default interfaces that a ruby dns server listens to.
+    #
+    # @return [Array]
+    def self.listen
+      @listen ||= [[:udp, "127.0.0.1", 5300]]
+    end
+
+    def self.namespace
+      @namespace ||= "dns"
+    end
+  end
+end

data/vagrant-dns.gemspec

@@ -0,0 +1,58 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-dns/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lh-vagrant-dns"
+  spec.version       = VagrantPlugins::DNS::VERSION
+  spec.authors       = ["Lin He"]
+  spec.email         = ["he9lin@gmail.com"]
+  spec.description   = %q{A RubyDns plugin for Vagrant 1.1.x}
+  spec.summary       = %q{A RubyDns plugin for Vagrant 1.1.x}
+  spec.homepage      = "http://heyook.com"
+  spec.license       = "MIT"
+
+  spec.required_rubygems_version = ">= 1.3.6"
+
+  spec.add_runtime_dependency "rubydns", "~> 0.6.1"
+  spec.add_runtime_dependency "daemons", "~> 1.1.9"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  # The following block of code determines the files that should be included
+  # in the gem. It does this by reading all the files in the directory where
+  # this gemspec is, and parsing out the ignored files from the gitignore.
+  # Note that the entire gitignore(5) syntax is not supported, specifically
+  # the "!" syntax, but it should mostly work correctly.
+  root_path      = File.dirname(__FILE__)
+  all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
+  all_files.reject! { |file| [".", ".."].include?(File.basename(file)) }
+  gitignore_path = File.join(root_path, ".gitignore")
+  gitignore      = File.readlines(gitignore_path)
+  gitignore.map!    { |line| line.chomp.strip }
+  gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }
+
+  unignored_files = all_files.reject do |file|
+    # Ignore any directories, the gemspec only cares about files
+    next true if File.directory?(file)
+
+    # Ignore any paths that match anything in the gitignore. We do
+    # two tests here:
+    #
+    #   - First, test to see if the entire path matches the gitignore.
+    #   - Second, match if the basename does, this makes it so that things
+    #     like '.DS_Store' will match sub-directories too (same behavior
+    #     as git).
+    #
+    gitignore.any? do |ignore|
+      File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
+        File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
+    end
+  end
+
+  spec.files         = unignored_files
+  spec.executables   = unignored_files.map { |f| f[/^bin\/(.*)/, 1] }.compact
+  spec.require_path  = 'lib'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: lh-vagrant-dns
+version: !ruby/object:Gem::Version
+  version: 0.0.1.dev
+  prerelease: 6
+platform: ruby
+authors:
+- Lin He
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubydns
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: daemons
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A RubyDns plugin for Vagrant 1.1.x
+email:
+- he9lin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- lib/vagrant-dns/action/create_daemons_dir.rb
+- lib/vagrant-dns/action/create_resolvers.rb
+- lib/vagrant-dns/action/register_patterns.rb
+- lib/vagrant-dns/action/setup_env.rb
+- lib/vagrant-dns/action/start_dns_server.rb
+- lib/vagrant-dns/action/stop_dns_server.rb
+- lib/vagrant-dns/action.rb
+- lib/vagrant-dns/command.rb
+- lib/vagrant-dns/config.rb
+- lib/vagrant-dns/dns_server.rb
+- lib/vagrant-dns/env.rb
+- lib/vagrant-dns/env_helper.rb
+- lib/vagrant-dns/plugin.rb
+- lib/vagrant-dns/version.rb
+- lib/vagrant-dns.rb
+- LICENSE.txt
+- Rakefile
+- README.md
+- vagrant-dns.gemspec
+- .gitignore
+homepage: http://heyook.com
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A RubyDns plugin for Vagrant 1.1.x
+test_files: []