vagrant-command-dns 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9091d62e746bfa1ac32f14792aed653bd4897110
-  data.tar.gz: 93912f062c9535573c51eab4e1da0024230b2f97
+  metadata.gz: cd77fab9b2c0d0d39c8b38f2db26615e58c27c84
+  data.tar.gz: 8cfd993bbc28ced4e07711752166157fa8bdf7b6
 SHA512:
-  metadata.gz: 41ac13370fd2a073ce190974ac479c34503477abd98a3898f0782700165d7da6a9c805afe96898a115a74af0d7672c5bb1bb4bc2f68f6b442b9644eba081dbbe
-  data.tar.gz: fe983024d0b333baebca6021ccf25e1f14bbdf87dfd36985d0531bd0bfc583c8e3ecd57f850206b6aaf515a2de30ef08415fc449edb1c757e37b11404f506cc5
+  metadata.gz: 42520e3d9c9fc2332455695663dfafdc7b246f2df7d74b9a43765943b2c38cf5f3e93864a50ad3d841e9de45d7b7d15b9e5588d7498dfca46e528dbbf54f196c
+  data.tar.gz: e5725a24eb19b3b81b90d90aa9598fbcedc131830d9822f7774cd0dc9d0ff452fd2b6c5768e2fe0794bafda492e87ef78565f2675d2a41e71933aef733d030c9

data/README.md

@@ -1,25 +1,118 @@
 VagrantPlugins::CommandDns
 ==========================
 
-_*Currently in development. DO NOT USE.*_
+[![Gem Version](https://badge.fury.io/rb/vagrant-command-dns.svg)](https://badge.fury.io/rb/vagrant-command-dns)
 
+Todo:
+- add confirm to destroy subcommands
+- add windows support
 
-# 
- - Untested in multi-machine environments
 
+# Installation
+```
+vagrant plugin install vagrant-command-dns
+```
 
-# Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# Configuration
+- [optional] `aliases` List of FQDNs to register this box's ip with
+- [optional] `route53_version` The version of the AWS api to use
+- [optional] `route53_access_key_id` The access key ID for accessing AWS
+- [optional] `route53_secret_access_key` The secret access key for accessing AWS
+- [optional] `route53_session_token` The token associated with the key for accessing AWS
+- [optional] `route53_zone_id` The Route53 Zone ID
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+# Usage
+```
+vagrant dns
+Usage: vagrant dns <subcommand>
+
+Available subcommands:
+     host
+     ip
+     route53
+
+For help on any individual subcommand run `vagrant dns <subcommand> -h`
+```
+
+
+## Hostname and Aliases
+The hostname and any aliases will be used to create records
+```
+config.vm.hostname = "www.example.com"
+config.route53.aliases = ["alias.example.com", "alias2.example.com"]
+```
+
+
+## Network
+This plugin works only for `:private_network` and `:public_network`.
+```
+config.vm.network :private_network, ip: "172.18.7.1"
+```
+
+or
+
+```
+config.vm.network :public_network
+```
+
+
+## Box Providers
+Currently only VirtualBox is supported, because that is what I have to test with.
+
+Pull requests are welcome.
+
+
+## DNS Providers
+Currently only editing the host's (linux/osx) `/etc/hosts` file and AWS Route53 are supported.
+
+Pull requests are welcome.
+
+
+# Route53
+## IAM Permissions
+```
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Effect": "Allow",
+            "Action": [
+                "route53:CreateHostedZone",
+                "route53:GetHostedZone",
+                "route53:ListHostedZones",
+                "route53:ChangeResourceRecordSets",
+                "route53:ListResourceRecordSets"
+            ],
+            "Resource": [
+                "arn:aws:route53:::hostedzone/1A2B3C4D5E6F"
+            ]
+        }
+    ]
+}
+```
+
+
+# FAQ
+Q) I reloaded my box and the `dns` command is only returning the VirtualBox NAT interface.
+A) Run reload once more. This is a known issue with no workaround at the moment.
+
+
+# Shortfalls
+- Untested in multi-machine environments
+- Does not support Windows hosts or guests
+
+
+# Sponsors
+This plugin was made possible by [Shiftgig](https://www.shiftgig.com)
 
 
 # Contributing
+Pull requests are welcome on GitHub at https://github.com/cornfeedhobo/vagrant-command-dns.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/vagrant-command-dns. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 # License
-
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/vagrant-command-dns/action/get_ip.rb

@@ -19,25 +19,29 @@ module VagrantPlugins
             ip = nil
 
             case env[:machine].provider_name
-            when :virtualbox
-              # We only operate on the first network defined in the Vagrantfile
-              unless env[:machine].config.vm.networks[1].nil?
-                network = env[:machine].config.vm.networks[1]
-                if network[1][:dns] == 'skip'
-                  @logger.info('')
-                  env[:ui].info('')
-                else
-                  cmd = "vagrant ssh -c \"ip -4 addr show \\$(ip -4 route | head -n2 | tail -n1 | awk '{print \\$5}') | grep -oP '(?<=inet\\s)\\d+(\\.\\d+){3}'\" 2>/dev/null"
-                  begin
-                    ip = IPAddr.new(`#{cmd}`.chomp)
-                  rescue IPAddr::InvalidAddressError
-                    raise Errors::InvalidAddressError
+              when :virtualbox
+                env[:machine].config.vm.networks.each do |network|
+                  key, options = network[0], network[1]
+                  if key == :private_network or key == :public_network
+                    if options[:dns] != 'skip'
+                      case key
+                        when :private_network
+                          cmd = "vagrant ssh -c \"ip -4 addr show \\$(ip -4 route | tail -n1 | awk '{print \\$3}') | grep -oP '(?<=inet\\s)\\d+(\\.\\d+){3}'\" 2>/dev/null"
+                        when :public_network
+                          cmd = "vagrant ssh -c \"ip -4 addr show \\$(ip -4 route | head -n2 | tail -n1 | awk '{print \\$5}') | grep -oP '(?<=inet\\s)\\d+(\\.\\d+){3}'\" 2>/dev/null"
+                      end
+                      begin
+                        ip = IPAddr.new(`#{cmd}`.chomp)
+                      rescue IPAddr::InvalidAddressError
+                        raise Errors::InvalidAddressError
+                      end
+                    else
+                      env[:ui].info(I18n.t('vagrant_command_dns.config.network_skip'))
+                    end
                   end
                 end
-              end
-
-            else
-              raise Errors::UnsupportedProviderError
+              else
+                raise Errors::UnsupportedProviderError
             end
 
             unless ip.nil?
@@ -48,7 +52,6 @@ module VagrantPlugins
 
               record_map = {}
               host_names.each do |h|
-                env[:ui].info "#{h} #{ip.to_string}"
                 record_map[h] = ip.to_string
               end
 

data/lib/vagrant-command-dns/action/host/create.rb

@@ -16,27 +16,37 @@ module VagrantPlugins
               raise Errors::MachineStateError, state: 'running'
             end
 
-            lines = []
-            env[:record_map].each do |hostname, ip|
-              loose_pattern = Regexp.new('^\s*[0-9]{1,3}[0-9]{1,3}[0-9]{1,3}[0-9]{1,3}\s+' + hostname)
-              precise_pattern = Regexp.new('^\s*' + ip + '\s+' + hostname)
-              File.open('/etc/hosts', 'r') do |f|
-                f.each_line do |line|
+            record_map = env[:record_map]
+
+            File.open('/etc/hosts', 'r') do |file|
+              file.each_line do |line|
+                env[:record_map].each do |hostname, ip|
+                  precise_pattern = Regexp.new('^\s*' + ip + '\s+' + hostname)
+                  loose_pattern = Regexp.new('^\s*[0-9]{1,3}[0-9]{1,3}[0-9]{1,3}[0-9]{1,3}\s+' + hostname)
                   if line.match(/#{precise_pattern}/)
-                    env[:ui].info(I18n.t('vagrant_command_dns.command.host.create_exists_match',
-                                         ip: ip, hostname: hostname))
-                    return
+                    record_map.delete(hostname)
+                    env[:ui].info(I18n.t('vagrant_command_dns.command.host.create_exists_match', ip: ip, hostname: hostname))
                   elsif line.match(/#{loose_pattern}/)
                     env[:ui].info(I18n.t('vagrant_command_dns.command.host.create_exists_conflict'))
                   end
                 end
               end
+            end
+
+            lines = []
+            record_map.each do |hostname, ip|
               lines.push("#{ip}    #{hostname}")
             end
 
-            content = lines.join("\n").strip
-            unless system("sudo sh -c 'echo \"#{content}\" >> /etc/hosts'")
-              env[:ui].error(I18n.t('vagrant_command_dns.command.host.edit_error'))
+            if lines.length > 0
+              content = lines.join("\n").strip
+              if system("sudo sh -c 'echo \"#{content}\" >> /etc/hosts'")
+                record_map.each do |hostname, ip|
+                  env[:ui].info(I18n.t('vagrant_command_dns.command.host.create_success', ip: ip, hostname: hostname))
+                end
+              else
+                env[:ui].error(I18n.t('vagrant_command_dns.command.host.edit_error'))
+              end
             end
 
             @app.call(env)

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

@@ -18,25 +18,39 @@ module VagrantPlugins
               end
             end
 
+            # read the file into memory to save reading it for each alias
             lines = []
+            File.open('/etc/hosts', 'r') do |file|
+              file.each_line do |line|
+                lines.push(line.chomp)
+              end
+            end
+
+            destroyed = {}
             env[:record_map].each do |hostname, ip|
               if env[:machine].config.dns.__skip
                 record_pattern = Regexp.new('^\s*[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\s+' + hostname)
               else
                 record_pattern = Regexp.new('^\s*' + ip + '\s+' + hostname)
               end
-              File.open('/etc/hosts', 'r') do |f|
-                f.each_line do |line|
-                  unless line.match(/#{record_pattern}/)
-                    lines.push(line.chomp)
-                  end
+
+              lines.each do |line|
+                if line.match(/#{record_pattern}/)
+                  lines.delete(line)
+                  destroyed[hostname] = ip
                 end
               end
             end
 
-            content = lines.join("\n").strip
-            unless system("sudo sh -c 'echo \"#{content}\" > /etc/hosts'")
-              env[:ui].error(I18n.t('vagrant_command_dns.command.host.edit_error'))
+            if destroyed.length > 0
+              content = lines.join("\n").strip
+              if system("sudo sh -c 'echo \"#{content}\" > /etc/hosts'")
+                destroyed.each do |hostname, ip|
+                  env[:ui].info(I18n.t('vagrant_command_dns.command.host.destroy_success', hostname: hostname))
+                end
+              else
+                env[:ui].error(I18n.t('vagrant_command_dns.command.host.edit_error'))
+              end
             end
 
             @app.call(env)

data/lib/vagrant-command-dns/action/show_ip.rb

@@ -10,8 +10,9 @@ module VagrantPlugins
 
         def call(env)
           if env[:record_map]
-            ip = env[:record_map].values[0]
-            env[:ui].info("#{ip}")
+            env[:record_map].each do |h, ip|
+              env[:ui].info "#{h} #{ip}"
+            end
           end
 
           @app.call(env)

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

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

data/locales/en.yml

@@ -2,6 +2,8 @@ en:
   vagrant_command_dns:
 
     config:
+      network_skip: |-
+        Skip requested for network in Vagrantfile
       route53_zone_id_required: |-
         A zone ID must be specified via "route53_zone_id"
       route53_access_key_id_required: |-
@@ -21,10 +23,14 @@ en:
       host:
         edit_error: |-
           Unable to edit /etc/hosts. Consult documentation or submit a pull request.
+        create_success: |-
+          /etc/hosts record created for %{ip} %{hostname}
         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
+          Potentially conflicting entries found in /etc/hosts. Please update manually...
+        destroy_success: |-
+          /etc/hosts record destroyed for %{hostname}
 
       route53:
         fog_error: |-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-command-dns
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - cornfeedhobo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2016-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog