vagrant-ghost 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f7324291014420cc8974f67bb919306781d56f0
+  data.tar.gz: b0731e3ac2351f218d35db97edf5bb813c361cd3
+SHA512:
+  metadata.gz: 8089840cbdc356d96e42bce47c1afe082f7112f128581199757ab5f900349edca85820bc3eee5ff696e9e728472d6d76593878170638b67681b9c11dd0fdf8b7
+  data.tar.gz: dc16f9a522dfb027f1a81cbc46641f76d1bd22c1df6146689ac6bc351a1395b3d248f2b81e3c8307468934979bb7689e04f87e56ea918177fe4ad3e9c7304015

data/.gitignore

@@ -0,0 +1,23 @@
+.idea
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Eric Mann
+
+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,29 @@
+# Vagrant::Ghost
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vagrant-ghost'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vagrant-ghost
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/vagrant-ghost/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+Bundler::GemHelper.install_tasks

data/lib/vagrant-ghost/command/base.rb

@@ -0,0 +1,32 @@
+module VagrantPlugins
+  module Ghost
+    module Command
+      class Base < Vagrant.plugin( 2, :command )
+        def execute
+          sub_command = self.class.name.split('::').last.downcase
+
+          parser = OptionParser.new do |opts|
+            opts.banner = "Usage: vagrant ghost #{sub_command} [vm-name]"
+          end
+
+          # Parse the options
+          argv = parse_options(parser)
+          return if !argv
+
+          with_target_vms(argv) do |vm|
+            if vm.state == :running
+              Ghost::VM.new(vm).send sub_command.to_sym
+            elsif vm.created?
+              vm.ui.info I18n.t("vagrant.commands.common.vm_not_running")
+            else
+              vm.ui.info I18n.t("vagrant.commands.common.vm_not_created")
+            end
+          end
+
+          # Success, exit status 0
+          0
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ghost/command/list.rb

@@ -0,0 +1,8 @@
+module VagrantPlugins
+  module Ghost
+    module Command
+      class List < Ghost::Command::Base
+      end
+    end
+  end
+end

data/lib/vagrant-ghost/command/remove.rb

@@ -0,0 +1,8 @@
+module VagrantPlugins
+  module Ghost
+    module Command
+      class Remove < Ghost::Command::Base
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+module VagrantPlugins
+  module Ghost
+    module Command
+      class Root < Vagrant.plugin( 2, :command )
+        def self.synopsis
+          "manages hosts file: addition, removal, etc."
+        end
+
+        def initialize(argv, env)
+          super
+
+          @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)
+
+          @subcommands = Vagrant::Registry.new
+          @subcommands.register(:list) do
+            require File.expand_path("../list", __FILE__)
+            List
+          end
+
+          @subcommands.register(:remove) do
+            require File.expand_path("../remove", __FILE__)
+            Remove
+          end
+
+          @subcommands.register(:update) do
+            require File.expand_path("../update", __FILE__)
+            Update
+          end
+        end
+
+        def execute
+          if @main_args.include?("-h") || @main_args.include?("--help")
+            # Print the help for all the hosts commands.
+            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
+
+        # Prints the help out for this command
+        def help
+          opts = OptionParser.new do |opts|
+            opts.banner = "Usage: vagrant ghost <command> [<args>]"
+            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 command run `vagrant ghost COMMAND -h`"
+          end
+
+          @env.ui.info(opts.help, :prefix => false)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ghost/command/update.rb

@@ -0,0 +1,8 @@
+module VagrantPlugins
+  module Ghost
+    module Command
+      class Update < Ghost::Command::Base
+      end
+    end
+  end
+end

data/lib/vagrant-ghost/config.rb

@@ -0,0 +1,10 @@
+module VagrantPlugins
+  module Ghost
+    class Config < Vagrant.plugin( 2, :config )
+      attr_accessor :name
+      attr_accessor :aliases
+      attr_accessor :id
+      attr_accessor :remove_on_suspend
+    end
+  end
+end

data/lib/vagrant-ghost/middleware/remove.rb

@@ -0,0 +1,21 @@
+module VagrantPlugins
+  module Ghost
+    module Middleware
+      class Remove
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          remove env[:vm] if env["vm"].created?
+          @app.call(env)
+        end
+
+        protected
+        def remove(vm)
+          Ghost::VM.new(vm).remove(:guests => false)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ghost/middleware/update.rb

@@ -0,0 +1,21 @@
+module VagrantPlugins
+  module Ghost
+    module Middleware
+      class Update
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          @app.call(env)
+          update env[:vm] if env["vm"].state == :running
+        end
+
+        protected
+        def update(vm)
+          Ghost::VM.new(vm).update
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-ghost/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module Ghost
+    VERSION = "0.0.1"
+  end
+end

data/lib/vagrant-ghost/vm.rb

@@ -0,0 +1,154 @@
+require 'forwardable'
+
+module VagrantPlugins
+  module Ghost
+    class VM
+      extend Forwardable
+
+      def_delegators :@vm, :channel, :config, :env, :name, :uuid
+
+      class << self
+        def expand_path(relative_path, relative_to)
+          File.expand_path(relative_path, relative_to)
+        end
+
+        def hosts_path
+          Util::Platform.windows? ? expand_path('system32/drivers/etc/hosts', ENV['SYSTEMROOT']) : '/etc/hosts'
+        end
+      end
+
+      def initialize( vm )
+        @vm = vm
+      end
+
+      def add(options = {})
+        if process_local?(options)
+          env.ui.info("Adding host entry for #{name} VM. Administrator privileges will be required...") unless options[:quiet]
+          sudo add_command
+        end
+
+        with_other_vms { |vm| channel.sudo vm.add_command(:uuid => uuid, :hosts_path => hosts_path) } if process_guests?(options)
+      end
+
+      def hosts_path
+        # TODO: if windows guests are supported, this will need to be smarter
+        "/etc/hosts"
+      end
+
+      def list(options = {})
+        if process_local?(options)
+          output = `#{list_command}`.chomp
+          env.ui.info("[local] #{output}\n\n", :prefix => false) unless output.empty?
+        end
+
+        if process_guests?(options)
+          entries = ""
+          with_other_vms do |vm|
+            channel.execute(vm.list_command(:uuid => uuid, :hosts_path => hosts_path), :error_check => false) do |type, data|
+              entries << data if type == :stdout
+            end
+          end
+          entries = entries.split($/).collect { |entry| "[#{name}] #{entry}" }.join("\n")
+          env.ui.info("#{entries}\n\n", :prefix => false) unless entries.empty?
+        end
+      end
+
+      def remove(options = {})
+        if process_local?(options)
+          env.ui.info("Removing host entry for #{name} VM. Administrator privileges will be required...") unless options[:quiet]
+          sudo remove_command
+        end
+        with_other_vms { |vm| channel.sudo vm.remove_command(:uuid => uuid, :hosts_path => hosts_path) } if process_guests?(options)
+      end
+
+      def update(options = {})
+        if process_local?(options)
+          env.ui.info("Updating host entry for #{name} VM. Administrator privileges will be required...") unless options[:quiet]
+          sudo(remove_command) && sudo(add_command)
+        end
+        with_other_vms { |vm| channel.sudo(vm.remove_command(:uuid => uuid, :hosts_path => hosts_path)) && channel.sudo(vm.add_command(:uuid => uuid, :hosts_path => hosts_path)) } if process_guests?(options)
+      end
+
+      protected
+      def add_command(options = {})
+        uuid = options[:uuid] || self.uuid
+        hosts_path = options[:hosts_path] || self.class.hosts_path
+        %Q(sh -c 'echo "#{host_entry(uuid)}" >>#{hosts_path}')
+      end
+
+      def address
+        # network parameters consist of an address and a hash of options
+        @address ||= (network_parameters && network_parameters.first)
+      end
+
+      def host_aliases
+        @host_aliases ||= Array(config.hosts.aliases)
+      end
+
+      def host_entry(uuid = self.uuid)
+        %Q(#{address}  #{host_names.join(' ')}  #{signature(uuid)})
+      end
+
+      def host_name
+        @host_name ||= (config.hosts.name || config.vm.host_name)
+      end
+
+      def host_names
+        @host_names ||= (Array(host_name) + host_aliases)
+      end
+
+      def process_guests?(options = {})
+        {:guests => true}.merge(options)[:guests]
+      end
+
+      def process_local?(options = {})
+        {:local => true}.merge(options)[:local]
+      end
+
+      def list_command(options = {})
+        uuid = options[:uuid] || self.uuid
+        hosts_path = options[:hosts_path] || self.class.hosts_path
+        %Q(grep '#{signature(uuid)}$' #{hosts_path})
+      end
+
+      def network
+        # hostonly networks are the only ones we're interested in
+        @network ||= networks.find { |type,network_parameters| type == :hostonly }
+      end
+
+      def network_parameters
+        # network is a pair of a network type and the network parameters
+        @network_parameters ||= (network && network.last)
+      end
+
+      def networks
+        @networks ||= config.vm.networks
+      end
+
+      def remove_command(options = {})
+        uuid = options[:uuid] || self.uuid
+        hosts_path = options[:hosts_path] || self.class.hosts_path
+        %Q(sed -e '/#{signature(uuid)}$/ d' -ibak #{hosts_path})
+      end
+
+      def signature(uuid = self.uuid)
+        %Q(# VAGRANT: #{uuid} (#{name}))
+      end
+
+      def sudo(command)
+        if Util::Platform.windows?
+          `#{command}`
+        else
+          `sudo #{command}`
+        end
+      end
+
+      def with_other_vms
+        env.vms.each do |name,vm|
+          yield Ghost::VM.new(vm) if vm.config.vm.networks.any? { |type,network_parameters| type == :hostonly } && vm.name != self.name
+        end
+      end
+
+    end
+  end
+end

data/lib/vagrant-ghost.rb

@@ -0,0 +1,49 @@
+begin
+  require 'vagrant'
+rescue LoadError
+  raise 'The Vagrant Ghost plugin must be run within Vagrant.'
+end
+
+require 'vagrant-ghost/version'
+require 'vagrant-ghost/vm'
+require 'vagrant-ghost/middleware/remove'
+require 'vagrant-ghost/middleware/update'
+
+module VagrantPlugins
+  module Ghost
+    class Plugin < Vagrant.plugin( 2 )
+      name 'Ghost'
+      description <<-DESC
+        Something something something
+      DESC
+
+      config( :ghost ) do
+        require 'vagrant-ghost/config'
+        Ghost::Config
+      end
+
+      action_hook( :ghost, :machine_action_destroy ) do |hook|
+        hook.append( Ghost::Middleware::Remove )
+      end
+
+      action_hook( :ghost, :machine_action_up ) do |hook|
+        hook.append( Vagrant::Action::VM::Provision, Ghost::Middleware::Update )
+      end
+
+      action_hook( :ghost, :machine_action_reload ) do |hook|
+        hook.append( Ghost::Middleware::Update )
+      end
+
+      action_hook( :ghost, :machine_action_resume ) do |hook|
+        hook.append( Ghost::Middleware::Update )
+      end
+
+      command( 'ghost' ) do
+        require 'vagrant-ghost/command/root'
+        require 'vagrant-ghost/command/base'
+
+        Command::Root
+      end
+    end
+  end
+end

data/vagrant-ghost.gemspec

@@ -0,0 +1,59 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-ghost/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-ghost"
+  spec.version       = VagrantPlugins::Ghost::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Eric Mann"]
+  spec.email         = ["eric@eamann.com"]
+  spec.summary       = %q{Vagrant plugin to manage /etc/hosts}
+  spec.description   = %q{Vagrant plugin to manage /etc/hosts}
+  spec.homepage      = "https://github.com/ericmann/vagrant-ghost"
+  spec.license       = "MIT"
+
+  #spec.files         = `git ls-files -z`.split("\x0")
+  #spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  #spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  #spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  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,89 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-ghost
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric Mann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Vagrant plugin to manage /etc/hosts
+email:
+- eric@eamann.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- lib/vagrant-ghost/command/base.rb
+- lib/vagrant-ghost/command/list.rb
+- lib/vagrant-ghost/command/remove.rb
+- lib/vagrant-ghost/command/root.rb
+- lib/vagrant-ghost/command/update.rb
+- lib/vagrant-ghost/config.rb
+- lib/vagrant-ghost/middleware/remove.rb
+- lib/vagrant-ghost/middleware/update.rb
+- lib/vagrant-ghost/version.rb
+- lib/vagrant-ghost/vm.rb
+- lib/vagrant-ghost.rb
+- LICENSE.txt
+- Rakefile
+- README.md
+- vagrant-ghost.gemspec
+- .gitignore
+homepage: https://github.com/ericmann/vagrant-ghost
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Vagrant plugin to manage /etc/hosts
+test_files: []