vagrant-global-status 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 604a21bf1c9c118e332c445290442c369b877c47
+  data.tar.gz: a921da366043462f06f8b863888e5aa0e8b62969
+SHA512:
+  metadata.gz: 818a8857af249396e6a12a16051f1db3858fbe8358abee80b7012cd726419c433ecf562335748883b9a77669854846e00e00af7aa74935b65730240b17f45135
+  data.tar.gz: 3ca978c30988061a728b8378090647d820279676d2eb7f4faef4869a25143b39ea80ab0418c29d731109f28cd3496a809b5c27f20f810bf57ca6c38d822b81f9

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-global-status.gemspec
+gemspec
+
+group :development do
+  gem 'vagrant',          github: 'mitchellh/vagrant'
+  gem 'vagrant-lxc',      github: 'fgrehm/vagrant-lxc'
+  gem 'vagrant-cachier',  github: 'fgrehm/vagrant-cachier'
+  gem 'vagrant-pristine', github: 'fgrehm/vagrant-pristine'
+end

data/Gemfile.lock

@@ -0,0 +1,60 @@
+GIT
+  remote: git://github.com/fgrehm/vagrant-cachier.git
+  revision: 5f30e3c9da53b25fa239b28871f0007a6de64221
+  specs:
+    vagrant-cachier (0.3.0.dev)
+
+GIT
+  remote: git://github.com/fgrehm/vagrant-lxc.git
+  revision: 5ae82681cdedaf2a6f778e005dd65014fc7c2cec
+  specs:
+    vagrant-lxc (0.5.1.dev)
+
+GIT
+  remote: git://github.com/fgrehm/vagrant-pristine.git
+  revision: 5c400d7850fc5f98d9601b59f4c3bd74818650de
+  specs:
+    vagrant-pristine (0.2.0)
+
+GIT
+  remote: git://github.com/mitchellh/vagrant.git
+  revision: 16002d03c07f842a23497543129fa99f40f2bbc0
+  specs:
+    vagrant (1.2.8.dev)
+      childprocess (~> 0.3.7)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6.0)
+      log4r (~> 1.1.9)
+      net-scp (~> 1.1.0)
+      net-ssh (~> 2.6.6)
+
+PATH
+  remote: .
+  specs:
+    vagrant-global-status (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    erubis (2.7.0)
+    ffi (1.9.0)
+    i18n (0.6.4)
+    log4r (1.1.10)
+    net-scp (1.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.6.8)
+    rake (10.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  rake
+  vagrant!
+  vagrant-cachier!
+  vagrant-global-status!
+  vagrant-lxc!
+  vagrant-pristine!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fabio Rehm
+
+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,51 @@
+# vagrant-global-status
+
+A proof of concept [Vagrant](http://www.vagrantup.com/) plugin that keeps
+track of vagrant machines and provides a command for listing the status of all
+known machines.
+
+## Installation
+
+Make sure you have Vagrant 1.1+ and run:
+
+```
+vagrant plugin install vagrant-global-status
+```
+
+## Usage
+
+```
+vagrant global-status [--all]
+
+    -a, --all       Displays information about all machines (instead of just the active ones)
+    -h, --help      Print this help
+```
+
+## How does it work?
+
+Whenever you `vagrant up` a VM, the plugin will register the machine name and
+path to its `Vagrantfile` on a global state file under `~/.vagrant.d`. That
+is enough information for the `global-status` command to do its job and parse
+machine's statuses.
+
+After a `vagrant destroy`, the VM will get removed from the global state file
+and will no longer show up by default on `vagrant global-status` unless you pass
+in `-a` to it.
+
+Besides that, the plugin is smart enough to detect [multiple combinations](lib/vagrant-global-status/global_environment.rb)
+of Vagrant environments and is able to get the status for a machine that is
+used for development of a Vagrant plugin using Bundler.
+
+## Current limitations / ideas for contributions
+
+* Keeps track of active vagrant-lxc and VirtualBox VMs only
+* Blows up if the `Vagrantfile` gets removed from the registered path
+* Detect orphaned machines
+
+## 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-global-status.rb

@@ -0,0 +1 @@
+require_relative "vagrant-global-status/plugin"

data/lib/vagrant-global-status/action/deregister_machine.rb

@@ -0,0 +1,24 @@
+require_relative '../global_registry'
+
+module VagrantPlugins
+  module GlobalStatus
+    module Action
+      class DeregisterMachine
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          @app.call(env)
+          if env[:machine].provider.state.id == :not_created
+            GlobalRegistry.deregister(
+              home_path:    env[:home_path],
+              machine_name: env[:machine].name,
+              root_path:    env[:root_path]
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-global-status/action/register_machine.rb

@@ -0,0 +1,24 @@
+require_relative '../global_registry'
+
+module VagrantPlugins
+  module GlobalStatus
+    module Action
+      class RegisterMachine
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          @app.call(env)
+          if env[:machine].provider.state.id == :running
+            GlobalRegistry.register(
+              home_path:    env[:home_path],
+              machine_name: env[:machine].name,
+              root_path:    env[:root_path]
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-global-status/command.rb

@@ -0,0 +1,30 @@
+require_relative 'global_registry'
+
+module VagrantPlugins
+  module GlobalStatus
+    class Command < Vagrant.plugin("2", :command)
+      def execute
+        options = {}
+
+        opts = OptionParser.new do |o|
+          o.banner = "Usage: vagrant global-status [--all]"
+
+          o.on("-a", "--all", "Displays information about all machines (instead of just the active ones)") do |f|
+            options[:all] = true
+          end
+        end
+
+        @argv = parse_options(opts)
+        return if !@argv
+
+        registry = GlobalRegistry.new(@env.home_path.join('machine-environments.json'))
+        registry.environments.each do |env|
+          @env.ui.info "\n#{env.path}"
+          @env.ui.info "#{env.status(options[:all])}"
+        end
+
+        0
+      end
+    end
+  end
+end

data/lib/vagrant-global-status/global_environment.rb

@@ -0,0 +1,107 @@
+module VagrantPlugins
+  module GlobalStatus
+    class GlobalEnvironment
+      attr_reader :path
+
+      RUBY_VERSION_MANAGERS = [ /\/\.rbenv\//, /\/\.rvm\// ]
+
+      def initialize(path, data)
+        @path = Pathname(path)
+        @machine_names = Array(data['machines']).map{|machine| machine['name']}
+      end
+
+      # REFACTOR: Extract a machine class
+      def status(all = false)
+        matches = vagrant_status.scan(/(\w[\w-]+)\s+(\w[\w\s]+)\s+\((\w+)\)/)
+        matches.map do |vm, status, provider|
+          if all || @machine_names.include?(vm)
+            "  #{vm.ljust(15)} #{status} (#{provider})"
+          end
+        end.compact.join("\n")
+      end
+
+      def vagrant_status
+        return @vagrant_status if @vagrant_status
+
+        # Plugins development
+        if defined?(::Bundler)
+          if plugin_sources?
+            Bundler.with_clean_env do
+              @vagrant_status = run_vagrant_status
+            end
+          else
+            Bundler.with_clean_env do
+              with_clean_ruby_env(RUBY_VERSION_MANAGERS) do
+                @vagrant_status = run_vagrant_status
+              end
+            end
+          end
+
+        # Vagrant installer
+        else
+          if plugin_sources?
+            with_clean_vagrant_env do
+              @vagrant_status = run_vagrant_status
+            end
+          else
+            @vagrant_status = run_vagrant_status
+          end
+        end
+      end
+
+      ORIGINAL_ENV = ENV.to_hash
+      def with_original_env
+        yield
+      ensure
+        ENV.replace(ORIGINAL_ENV)
+      end
+
+      def with_clean_vagrant_env
+        with_clean_ruby_env(/\/vagrant\//) do
+          yield
+        end
+      end
+
+      def with_clean_ruby_env(regex)
+        with_original_env do
+          Array(regex).each do |reg|
+            ENV['PATH'] = remove_from_path(reg)
+          end
+          ENV.delete('GEM_HOME')
+          ENV.delete('GEM_PATH')
+          yield
+        end
+      end
+
+      def remove_from_path(regex)
+        ENV['PATH'].split(':').
+                    reject{ |p| p =~ regex  }.
+                    join(':')
+      end
+
+      def run_vagrant_status
+        cmd = "cd #{@path} && "
+        if plugin_sources?
+          cmd << "bundle exec "
+        end
+        cmd << "vagrant status"
+        `#{cmd}`
+      end
+
+      def plugin_sources?
+        return @plugin_sources if defined?(@plugin_sources)
+
+        gemfile_dir = @path
+        gemfile     = gemfile_dir.join('Gemfile')
+
+        # If the parent is the same dir, we reached the root dir
+        while !gemfile.file? && gemfile_dir.parent != gemfile_dir
+          gemfile_dir = gemfile_dir.parent
+          gemfile     = gemfile_dir.join('Gemfile')
+        end
+
+        @plugin_sources = gemfile.file? ? gemfile.read =~ /gem\s+['"]vagrant['"]/ : false
+      end
+    end
+  end
+end

data/lib/vagrant-global-status/global_registry.rb

@@ -0,0 +1,69 @@
+require_relative 'global_environment'
+
+module VagrantPlugins
+  module GlobalStatus
+    class GlobalRegistry
+      def self.register(params)
+        statefile = params.fetch(:home_path).join('machine-environments.json')
+        new(statefile).register(
+          params.fetch(:machine_name).to_s,
+          params.fetch(:root_path).to_s
+        )
+      end
+
+      def self.deregister(params)
+        statefile = params.fetch(:home_path).join('machine-environments.json')
+        new(statefile).deregister(
+          params.fetch(:machine_name).to_s,
+          params.fetch(:root_path).to_s
+        )
+      end
+
+      def initialize(statefile)
+        @statefile = statefile
+        @current_state = if @statefile.file?
+          JSON.parse(@statefile.read)
+        else
+          { 'environments' => {} }
+        end
+      end
+
+      def environments
+        @environments ||= @current_state['environments'].each_with_object({}) do |(env, data), hash|
+          hash[env] = GlobalEnvironment.new(env, data)
+        end
+
+        @environments.values
+      end
+
+      def register(machine_name, root_path)
+        @current_state['environments'][root_path] ||= { 'machines' => [] }
+
+        global_environment = @current_state['environments'][root_path]
+        machine = { 'name' => machine_name }
+        unless global_environment['machines'].include?(machine)
+          global_environment['machines'] << {'name' => machine_name}
+        end
+
+        write_statefile
+      end
+
+      def deregister(machine_name, root_path)
+        @current_state['environments'][root_path] ||= { 'machines' => [] }
+
+        global_environment = @current_state['environments'][root_path]
+        global_environment['machines'].delete({'name' => machine_name})
+
+        write_statefile
+      end
+
+      private
+
+      def write_statefile
+        @statefile.open("w+") do |f|
+          f.write(JSON.dump(@current_state))
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-global-status/plugin.rb

@@ -0,0 +1,44 @@
+require "vagrant"
+
+require_relative "version"
+
+module VagrantPlugins
+  module GlobalStatus
+    class Plugin < Vagrant.plugin("2")
+      name "Vagrant Global Status"
+      description 'Find out the status of all of the Vagrant VMs you manage'
+
+      # TODO: This should be generic, we don't want to hard code every single
+      #       possible provider action class that Vagrant might have
+      register_machine = lambda do |hook|
+        require_relative "action/register_machine"
+        hook.before VagrantPlugins::ProviderVirtualBox::Action::Boot, Action::RegisterMachine
+
+        if defined?(Vagrant::LXC)
+          # TODO: Require just the boot action file once its "require dependencies" are sorted out
+          require 'vagrant-lxc/action'
+          hook.before Vagrant::LXC::Action::Boot, Action::RegisterMachine
+        end
+      end
+      action_hook 'register-machine-on-up',     :machine_action_up,     &register_machine
+      action_hook 'register-machine-on-reload', :machine_action_reload, &register_machine
+
+      deregister_machine = lambda do |hook|
+        require_relative "action/deregister_machine"
+        hook.before VagrantPlugins::ProviderVirtualBox::Action::Destroy, Action::DeregisterMachine
+
+        if defined?(Vagrant::LXC)
+          # TODO: Require just the boot action file once its "require dependencies" are sorted out
+          require 'vagrant-lxc/action'
+          hook.before Vagrant::LXC::Action::Destroy, Action::DeregisterMachine
+        end
+      end
+      action_hook 'deregister-machine-on-destroy', :machine_action_destroy, &deregister_machine
+
+      command('global-status') do
+        require_relative 'command'
+        Command
+      end
+    end
+  end
+end

data/lib/vagrant-global-status/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module GlobalStatus
+    VERSION = "0.1.0"
+  end
+end

data/vagrant-global-status.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-global-status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-global-status"
+  spec.version       = VagrantPlugins::GlobalStatus::VERSION
+  spec.authors       = ["Fabio Rehm"]
+  spec.email         = ["fgrehm@gmail.com"]
+  spec.description   = %q{Find out the status of all of the Vagrant VMs you manage}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/fgrehm/vagrant-global-status"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-global-status
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fabio Rehm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: Find out the status of all of the Vagrant VMs you manage
+email:
+- fgrehm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-global-status.rb
+- lib/vagrant-global-status/action/deregister_machine.rb
+- lib/vagrant-global-status/action/register_machine.rb
+- lib/vagrant-global-status/command.rb
+- lib/vagrant-global-status/global_environment.rb
+- lib/vagrant-global-status/global_registry.rb
+- lib/vagrant-global-status/plugin.rb
+- lib/vagrant-global-status/version.rb
+- vagrant-global-status.gemspec
+homepage: https://github.com/fgrehm/vagrant-global-status
+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.0
+signing_key: 
+specification_version: 4
+summary: Find out the status of all of the Vagrant VMs you manage
+test_files: []