vagrant-command-dns 0.1.0

data/lib/vagrant-command-dns/command/host/destroy.rb

@@ -0,0 +1,46 @@
+require 'optparse'
+
+module VagrantPlugins
+  module CommandDns
+    module Command
+      module Host
+        class Destroy < Vagrant.plugin('2', :command)
+
+          def execute
+            options = {}
+            options[:skip] = false
+
+            opts = OptionParser.new do |o|
+              o.banner = 'Usage: vagrant dns host destroy'
+              o.separator ''
+              o.separator 'Options:'
+              o.separator ''
+
+              o.on('-s', '--skip', 'Skip ip check before record destruction. Use with extreme caution.') do |skip|
+                options[:skip] = skip
+              end
+
+              o.separator ''
+              o.separator 'Additional documentation can be found on the plugin homepage'
+              o.separator ''
+            end
+
+            argv = parse_options(opts)
+            return if !argv
+
+            with_target_vms(argv) do |machine|
+              machine.config.dns.__skip = options[:skip] if options[:skip]
+              @env.action_runner.run(Action::Host.host_destroy, {
+                  machine: machine,
+                  ui: Vagrant::UI::Prefixed.new(@env.ui, 'dns host'),
+              })
+            end
+
+            0
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-command-dns/command/host/root.rb

@@ -0,0 +1,74 @@
+require 'optparse'
+
+module VagrantPlugins
+  module CommandDns
+    module Command
+      module Host
+        class Root < Vagrant.plugin('2', :command)
+
+          def self.synopsis
+            'manage host /etc/hosts dns records'
+          end
+
+          def initialize(argv, env)
+            super
+
+            @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)
+
+            @subcommands = Vagrant::Registry.new
+
+            @subcommands.register(:create) do
+              require_relative 'create'
+              Command::Host::Create
+            end
+
+            @subcommands.register(:destroy) do
+              require_relative 'destroy'
+              Command::Host::Destroy
+            end
+          end
+
+          def execute
+            if @main_args.include?('-h') || @main_args.include?('--help')
+              return help
+            end
+
+            # If we reached this far then we must have a subcommand. If not,
+            # then we also just print the help and exit.
+            command_class = @subcommands.get(@sub_command.to_sym) if @sub_command
+            return help if !command_class || !@sub_command
+            @logger.debug("Invoking command class: #{command_class} #{@sub_args.inspect}")
+
+            # Initialize and execute the command class
+            command_class.new(@sub_args, @env).execute
+          end
+
+          def help
+            opts = OptionParser.new do |opts|
+              opts.version = VagrantPlugins::CommandDns::VERSION
+              opts.banner = 'Usage: vagrant dns host <subcommand>'
+              opts.separator ''
+              opts.separator 'Available subcommands:'
+
+              # Add the available subcommands as separators in order to print them
+              # out as well.
+              keys = []
+              @subcommands.each { |key, value| keys << key.to_s }
+
+              keys.sort.each do |key|
+                opts.separator "     #{key}"
+              end
+
+              opts.separator ''
+              opts.separator 'For help on any individual subcommand run `vagrant dns host <subcommand> -h`'
+              opts.separator ''
+            end
+
+            @env.ui.info(opts.help, prefix: false)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-command-dns/command/ip.rb

@@ -0,0 +1,34 @@
+require 'optparse'
+
+module VagrantPlugins
+  module CommandDns
+    module Command
+      class IP < Vagrant.plugin('2', :command)
+
+        def execute
+          options = {}
+
+          opts = OptionParser.new do |o|
+            o.banner = 'Usage: vagrant dns ip'
+            o.separator ''
+            o.separator 'Additional documentation can be found on the plugin homepage'
+            o.separator ''
+          end
+
+          argv = parse_options(opts)
+          return if !argv
+
+          with_target_vms(argv) do |machine|
+            @env.action_runner.run(Action.show_ip, {
+              machine: machine,
+              ui: Vagrant::UI::Prefixed.new(@env.ui, 'dns'),
+            })
+          end
+
+          0
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-command-dns/command/root.rb

@@ -0,0 +1,77 @@
+require 'optparse'
+
+module VagrantPlugins
+  module CommandDns
+    module Command
+      class Root < Vagrant.plugin('2', :command)
+
+        def self.synopsis
+          'manage dns records'
+        end
+
+        def initialize(argv, env)
+          super
+
+          @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)
+
+          @subcommands = Vagrant::Registry.new
+
+          @subcommands.register(:ip) do
+            require_relative 'ip'
+            IP
+          end
+
+          @subcommands.register(:host) do
+            require_relative 'host/root'
+            Host::Root
+          end
+
+          @subcommands.register(:route53) do
+            require_relative 'route53/root'
+            Route53::Root
+          end
+        end
+
+        def execute
+          if @main_args.include?('-h') || @main_args.include?('--help')
+            return help
+          end
+
+          # If we reached this far then we must have a subcommand. If not,
+          # then we also just print the help and exit.
+          command_class = @subcommands.get(@sub_command.to_sym) if @sub_command
+          return help if !command_class || !@sub_command
+          @logger.debug("Invoking command class: #{command_class} #{@sub_args.inspect}")
+
+          # Initialize and execute the command class
+          command_class.new(@sub_args, @env).execute
+        end
+
+        def help
+          opts = OptionParser.new do |opts|
+            opts.version = VagrantPlugins::CommandDns::VERSION
+            opts.banner = 'Usage: vagrant dns <subcommand>'
+            opts.separator ''
+            opts.separator 'Available subcommands:'
+
+            # Add the available subcommands as separators in order to print them
+            # out as well.
+            keys = []
+            @subcommands.each { |key, value| keys << key.to_s }
+
+            keys.sort.each do |key|
+              opts.separator "     #{key}"
+            end
+
+            opts.separator ''
+            opts.separator 'For help on any individual subcommand run `vagrant dns <subcommand> -h`'
+            opts.separator ''
+          end
+
+          @env.ui.info(opts.help, prefix: false)
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-command-dns/command/route53/create.rb

@@ -0,0 +1,34 @@
+require 'optparse'
+
+module VagrantPlugins
+  module CommandDns
+    module Command
+      module Route53
+        class Create < Vagrant.plugin('2', :command)
+
+          def execute
+            opts = OptionParser.new do |o|
+              o.banner = 'Usage: vagrant dns route53 create'
+              o.separator ''
+              o.separator 'Additional documentation can be found on the plugin homepage'
+              o.separator ''
+            end
+
+            argv = parse_options(opts)
+            return if !argv
+
+            with_target_vms(argv) do |machine|
+              @env.action_runner.run(Action::Route53.route53_create, {
+                  machine: machine,
+                  ui: Vagrant::UI::Prefixed.new(@env.ui, 'dns route53'),
+              })
+            end
+
+            0
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-command-dns/command/route53/destroy.rb

@@ -0,0 +1,46 @@
+require 'optparse'
+
+module VagrantPlugins
+  module CommandDns
+    module Command
+      module Route53
+        class Destroy < Vagrant.plugin('2', :command)
+
+          def execute
+            options = {}
+            options[:skip] = false
+
+            opts = OptionParser.new do |o|
+              o.banner = 'Usage: vagrant dns route53 destroy [options]'
+              o.separator ''
+              o.separator 'Options:'
+              o.separator ''
+
+              o.on('-s', '--skip', 'Skip ip check before record destruction. Use with extreme caution.') do |skip|
+                options[:skip] = skip
+              end
+
+              o.separator ''
+              o.separator 'Additional documentation can be found on the plugin homepage'
+              o.separator ''
+            end
+
+            argv = parse_options(opts)
+            return if !argv
+
+            with_target_vms(argv) do |machine|
+              machine.config.dns.__skip = options[:skip] if options[:skip]
+              @env.action_runner.run(Action::Route53.route53_destroy, {
+                  machine: machine,
+                  ui: Vagrant::UI::Prefixed.new(@env.ui, 'dns route53'),
+              })
+            end
+
+            0
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-command-dns/command/route53/root.rb

@@ -0,0 +1,74 @@
+require 'optparse'
+
+module VagrantPlugins
+  module CommandDns
+    module Command
+      module Route53
+        class Root < Vagrant.plugin('2', :command)
+
+          def self.synopsis
+            'manage route53 dns records'
+          end
+
+          def initialize(argv, env)
+            super
+
+            @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)
+
+            @subcommands = Vagrant::Registry.new
+
+            @subcommands.register(:create) do
+              require_relative 'create'
+              Command::Route53::Create
+            end
+
+            @subcommands.register(:destroy) do
+              require_relative 'destroy'
+              Command::Route53::Destroy
+            end
+          end
+
+          def execute
+            if @main_args.include?('-h') || @main_args.include?('--help')
+              return help
+            end
+
+            # If we reached this far then we must have a subcommand. If not,
+            # then we also just print the help and exit.
+            command_class = @subcommands.get(@sub_command.to_sym) if @sub_command
+            return help if !command_class || !@sub_command
+            @logger.debug("Invoking command class: #{command_class} #{@sub_args.inspect}")
+
+            # Initialize and execute the command class
+            command_class.new(@sub_args, @env).execute
+          end
+
+          def help
+            opts = OptionParser.new do |opts|
+              opts.version = VagrantPlugins::CommandDns::VERSION
+              opts.banner = 'Usage: vagrant dns route53 <subcommand>'
+              opts.separator ''
+              opts.separator 'Available subcommands:'
+
+              # Add the available subcommands as separators in order to print them
+              # out as well.
+              keys = []
+              @subcommands.each { |key, value| keys << key.to_s }
+
+              keys.sort.each do |key|
+                opts.separator "     #{key}"
+              end
+
+              opts.separator ''
+              opts.separator 'For help on any individual subcommand run `vagrant dns route53 <subcommand> -h`'
+              opts.separator ''
+            end
+
+            @env.ui.info(opts.help, prefix: false)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-command-dns/config.rb

@@ -0,0 +1,90 @@
+module VagrantPlugins
+  module CommandDns
+    class Config < Vagrant.plugin('2', :config)
+
+      # List of VM aliases in FQDN format
+      #
+      # @return [Array<String>]
+      attr_accessor :aliases
+
+      # AWS Route53 Settings
+
+      # The version of the AWS api to use
+      #
+      # @return [String]
+      attr_accessor :route53_version
+
+      # The access key ID for accessing AWS
+      #
+      # @return [String]
+      attr_accessor :route53_access_key_id
+
+      # The secret access key for accessing AWS
+      #
+      # @return [String]
+      attr_accessor :route53_secret_access_key
+
+      # The token associated with the key for accessing AWS
+      #
+      # @return [String]
+      attr_accessor :route53_session_token
+
+      # The Route53 Zone ID
+      #
+      # @return [String]
+      attr_accessor :route53_zone_id
+
+      attr_accessor :__skip
+      attr_reader   :__available_providers
+
+      def initialize
+        @aliases                   = UNSET_VALUE
+
+        @route53_version           = UNSET_VALUE
+        @route53_access_key_id     = UNSET_VALUE
+        @route53_secret_access_key = UNSET_VALUE
+        @route53_session_token     = UNSET_VALUE
+        @route53_zone_id           = UNSET_VALUE
+
+        # Internal
+        @__skip = false
+        @__available_providers = %w(local route53)
+      end
+
+      def finalize!
+        @aliases = [] if @aliases == UNSET_VALUE
+
+        @route53_version = nil if @route53_version == UNSET_VALUE
+        @route53_zone_id = nil if @route53_zone_id == UNSET_VALUE
+
+        # Try to get access keys from standard AWS environment variables; they
+        # will default to nil if the environment variables are not present.
+        @route53_access_key_id     = ENV['AWS_ACCESS_KEY']    if @route53_access_key_id     == UNSET_VALUE
+        @route53_secret_access_key = ENV['AWS_SECRET_KEY']    if @route53_secret_access_key == UNSET_VALUE
+        @route53_session_token     = ENV['AWS_SESSION_TOKEN'] if @route53_session_token     == UNSET_VALUE
+      end
+
+      def validate(machine)
+        errors = _detected_errors
+
+        if @route53
+          if machine.provider_name == :aws
+            aws_config = machine.provider_config
+            # If these values are still not set and the AWS provider is being used, borrow it's config values
+            @route53_version           = aws_config.version           if @route53_version           == nil
+            @route53_access_key_id     = aws_config.access_key_id     if @route53_access_key_id     == nil
+            @route53_secret_access_key = aws_config.secret_access_key if @route53_secret_access_key == nil
+            @route53_session_token     = aws_config.session_token     if @route53_session_token     == nil
+          end
+
+          errors << I18n.t('vagrant_command_dns.config.route53_zone_id_required') if @route53_zone_id.nil?
+          errors << I18n.t('vagrant_command_dns.config.route53_access_key_id_required') if @route53_access_key_id.nil?
+          errors << I18n.t('vagrant_command_dns.config.route53_secret_access_key_required') if @route53_secret_access_key.nil?
+        end
+
+        { 'DNS' => errors }
+      end
+
+    end
+  end
+end

data/lib/vagrant-command-dns/errors.rb

@@ -0,0 +1,31 @@
+module VagrantPlugins
+  module CommandDns
+    module Errors
+
+      class VagrantCommandDnsError < Vagrant::Errors::VagrantError
+        error_namespace('vagrant_command_dns.errors')
+      end
+
+      class MachineStateError < VagrantCommandDnsError
+        error_key(:machine_state_error)
+      end
+
+      class UnsupportedProviderError < VagrantCommandDnsError
+        error_key(:unsupported_provider_error)
+      end
+
+      class InvalidAddressError < VagrantCommandDnsError
+        error_key(:invalid_address_error)
+      end
+
+      class FogError < VagrantCommandDnsError
+        error_key(:fog_error)
+      end
+
+      class EditLocalHostsError < VagrantCommandDnsError
+        error_key(:edit_local_hosts_error)
+      end
+
+    end
+  end
+end

data/lib/vagrant-command-dns/plugin.rb

@@ -0,0 +1,69 @@
+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 a Vagrant version earlier than it was developed on.
+if Vagrant::VERSION < '1.7.4'
+  raise 'The Vagrant DNS Plugin is only compatible with Vagrant 1.7.4+'
+end
+
+module VagrantPlugins
+  module CommandDns
+    class Plugin < Vagrant.plugin('2')
+
+      name 'dns command'
+      description 'The `dns` command gives you a way to manage DNS records.'
+
+      # This initializes the internationalization strings.
+      def self.setup_i18n
+        I18n.load_path << File.expand_path('locales/en.yml', CommandDns.source_root)
+        I18n.reload!
+      end
+
+      # This sets up our log level to be whatever VAGRANT_LOG is.
+      def self.setup_logging
+        require 'log4r'
+
+        level = nil
+        begin
+          level = Log4r.const_get(ENV['VAGRANT_LOG'].upcase)
+        rescue NameError
+          # This means that the logging constant wasn't found,
+          # which is fine. We just keep `level` as `nil`. But
+          # we tell the user.
+          level = nil
+        end
+
+        # Some constants, such as "true" resolve to booleans, so the
+        # above error checking doesn't catch it. This will check to make
+        # sure that the log level is an integer, as Log4r requires.
+        level = nil if !level.is_a?(Integer)
+
+        # Set the logging level on all "vagrant" namespaced
+        # logs as long as we have a valid level.
+        if level
+          logger = Log4r::Logger.new('vagrant_command_dns')
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+
+      config 'dns' do
+        setup_i18n
+        require_relative 'config'
+        Config
+      end
+
+      command 'dns' do
+        setup_logging
+        require_relative 'command/root'
+        Command::Root
+      end
+
+    end
+  end
+end

data/lib/vagrant-command-dns/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module CommandDns
+    VERSION = '0.1.0'
+  end
+end

data/lib/vagrant-command-dns.rb

@@ -0,0 +1,20 @@
+require 'pathname'
+require 'vagrant-command-dns/version'
+require 'vagrant-command-dns/plugin'
+
+module VagrantPlugins
+  module CommandDns
+
+    lib_path = Pathname.new(File.expand_path('../vagrant-command-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
+
+  end
+end

data/locales/en.yml

@@ -0,0 +1,43 @@
+en:
+  vagrant_command_dns:
+
+    config:
+      route53_zone_id_required: |-
+        A zone ID must be specified via "route53_zone_id"
+      route53_access_key_id_required: |-
+        An access key ID must be specified via "route53_access_key_id"
+      route53_secret_access_key_required: |-
+        A secret access key is required via "route53_secret_access_key"
+
+    errors:
+      machine_state_error: |-
+        Machine must be %{state} to preform this action.
+      unsupported_provider_error: |-
+        Machine provider not supported. Pull requests and testers are welcome.
+      invalid_address_error: |-
+        invalid_address_error
+
+    command:
+      host:
+        edit_error: |-
+          Unable to edit /etc/hosts. Consult documentation or submit a pull request.
+        create_exists_match: |-
+          /etc/hosts record exists for %{ip} %{hostname}
+        create_exists_conflict: |-
+          this should be a friendly message telling them they have other conflicting entries to remove
+
+      route53:
+        fog_error: |-
+          AWS error: %{message}
+        create_success: |-
+          Route53 record created for %{ip} %{hostname}.
+        create_exists_match: |-
+          Route53 record exists for %{ip} %{hostname}.
+        create_exists_conflict: |-
+          Route53 record exists for %{ip} %{hostname}. Please update manually.
+        destroy_success: |-
+          Route53 record destroyed for %{hostname}
+        destroy_conflict: |-
+          Route53 record for %{hostname} does not match. Expected %{expected} got %{got}. Please update manually...
+        destroy_not_found: |-
+          Route53 record for %{hostname} not found. Skipping...

data/vagrant-command-dns.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-command-dns/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vagrant-command-dns'
+  spec.version       = VagrantPlugins::CommandDns::VERSION
+  spec.authors       = ['cornfeedhobo']
+  spec.email         = ['cornfeedhobo@fuzzlabs.org']
+
+  spec.summary       = %q{Vagrant Plugin to manage DNS records}
+  spec.homepage      = 'https://github.com/cornfeedhobo/vagrant-command-dns'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_runtime_dependency 'fog', '~> 1.22'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end