vagrant-list 0.0.1

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
+.DS_Store
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-list.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Josh McArthur
+
+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,60 @@
+vagrant-list
+=====
+
+### What does it do?
+
+`vagrant-list` adds a command to the Vagrant CLI to list both all VMs known to VirtualBox, as well as any that are running. It's handy for seeing what all your VMs are up to.
+
+
+### How do I install it?
+
+#### Using bundler?
+Just add `gem 'vagrant-list'` to your `Gemfile`
+
+#### Not using bundler?
+Untested, but just running `gem install vagrant-list` should have the same effect.
+
+### How do I use it?
+
+#### From the CLI
+`vagrant-list` adds just one command to vagrant - `list`. 
+For example, this following command will list the VMs:
+
+`bundle exec vagrant list` will output:
+
+``` sh
+[vagrant] ALL:
+[vagrant] 35279736-412a-47b0-aa09-b1aef373a9c7: IE7 (Windows Vista)
+[vagrant] ebb807dd-64d6-4a17-87f8-1d6d80a3f467: IE8 (Windows 7)
+[vagrant] 4db11a4d-0a97-48c4-8b23-9cb2ca4fcb93: IE9 (Windows 7)
+[vagrant] 508bf5cd-dcce-48f6-b19d-287fba4306d6: Windows XP (Windows XP)
+[vagrant] 729322cf-e11d-438c-b9dc-6b1d31e9a56d: Python Development (Windows XP)
+[vagrant] RUNNING:
+[vagrant] ebb807dd-64d6-4a17-87f8-1d6d80a3f467: IE8 (Windows 7)
+```
+
+#### From your own code
+
+`vagrant-list` handily extends the driver for VirtualBox 4.1 to query both running and all VMs (previous to this you could only query all). If you'd like to use this feature in your code, you should just be able to add the gem to your `Gemfile`, and then run:
+
+
+`Vagrant::Driver::VirtualBox.new(nil).read_vms(:vms)` to show **all** VMs (default), or `Vagrant::Driver::VirtualBox.new(nil).read_vms(:runningvms)` to show **running** VMs.
+
+### Running Tests
+
+The code has exactly three specs that check:
+
+* That the overridden driver method lists a known VM
+* That the overridden driver method does not list an unknown VM
+* That the overridden driver method lists a running VM
+
+Unfortunately, because we are almost directly interacting with the VirtualBox command line tools, there is little opportunity for mocking or stubbing virtual machines. 
+
+**Therefore, in order for the specs to pass, it is required that you have a VM called 'Test' running when the specs are run. It doesn't matter what this VM _is_ (XP, Ubuntu etc.), just as long as it's there**
+
+### License
+
+This open source software is licensed under the MIT License.
+
+---
+** If this project has been useful to you, I ask that you consider a donation to an open source project in need - check out my donations page at http://joshmcarthur.com/donations for projects that I've donated to for inspiration.**

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/vagrant-list.rb

@@ -0,0 +1,26 @@
+require "vagrant-list/version"
+require "vagrant/vm_info"
+require "vagrant"
+require "pp"
+
+module Vagrant
+  module List
+    class All < ::Vagrant::Command::Base
+      def execute
+        all = Driver::VirtualBox.new(nil).read_vms(:vms)
+        @env.ui.info "ALL:"
+        all.each do |uuid|
+          @env.ui.info Vagrant::VMInfo.new(uuid).inspect
+        end
+
+        running = Driver::VirtualBox.new(nil).read_vms(:runningvms)
+        @env.ui.info "RUNNING:"
+        running.each do |uuid|
+          @env.ui.info Vagrant::VMInfo.new(uuid).inspect
+        end
+      end
+    end
+  end
+end
+
+Vagrant.commands.register(:list) { Vagrant::List::All }

data/lib/vagrant-list/version.rb

@@ -0,0 +1,5 @@
+module Vagrant
+  module List
+    VERSION = "0.0.1"
+  end
+end

data/lib/vagrant/ext/driver/driver_overrides.rb

@@ -0,0 +1,33 @@
+module Vagrant
+  module Ext
+  module Driver
+    module DriverOverrides
+      def self.included(base)
+        base.class_eval do
+
+          # Public - Support passing in a category
+          # of vms to list.
+          #
+          # Currently supported options:
+          # vms - All vms, regardless of status
+          # runningvms - Only running vms
+          #
+          # This method can be used to query the state of all vms.
+          # In the case of https://github.com/joshmcarthur/urchin,
+          # it is used to query for a list of VMs to display
+          def read_vms(type = :vms)
+            results = []
+            execute("list", type.to_s, :retryable => true).split("\n").each do |line|
+              if vm = line[/^".+?" \{(.+?)\}$/, 1]
+                results << vm
+              end
+            end
+
+            results
+          end
+        end
+      end
+    end
+  end
+  end
+end

data/lib/vagrant/vm_info.rb

@@ -0,0 +1,45 @@
+module Vagrant
+  class VMInfo
+    include Vagrant::Util
+
+    attr_accessor :raw
+    attr_accessor :uuid
+    attr_accessor :name
+    attr_accessor :guest_os
+
+    def initialize(uuid)
+      driver = Driver::VirtualBox.new
+      self.raw = driver.execute("showvminfo", uuid)
+      process!
+    end
+
+
+    # Public - Override inspect to display
+    # vm attributes
+    def inspect
+      "#{uuid}: #{name} (#{guest_os})"
+    end
+
+    private
+
+    # Private - Accept raw output from VBoxManage showvminfo command
+    # and manipulate string into a useful form.
+    #
+    # Requires raw be defined on the instance
+    #
+    # Returns the processed object
+    def process!
+      lines = self.raw.split("\n")
+      lines.each do |line|
+        raw_key, value = line.split(/\:\s+/)
+
+        if raw_key
+          key = raw_key.downcase.gsub(/\s+/, '_')
+          self.send("#{key}=", value) if self.respond_to?("#{key}=")
+        end
+      end
+
+      self
+    end
+  end
+end

data/lib/vagrant_init.rb

@@ -0,0 +1,4 @@
+require 'vagrant-list'
+require 'vagrant/ext/driver/driver_overrides.rb'
+
+Vagrant::Driver::VirtualBox_4_1.send(:include, Vagrant::Ext::Driver::DriverOverrides)

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'vagrant'
+require 'vagrant-list'
+require 'vagrant_init'
+
+

data/spec/vagrant_list_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe 'Vagrant List' do
+
+  before :all do
+    puts <<-WARNING
+
+
+      WARNING: Because there is currently no support for mocking or stubbing
+      out calls to VirtualBox, it is required that there be at least
+      one running VM called 'Test' loaded into VirtualBox in order
+      for these tests to pass.
+
+    WARNING
+  end
+
+  let(:driver) { Vagrant::Driver::VirtualBox_4_1.new(nil) }
+
+  it "should list a VM" do
+    driver.read_vms.map { |vm| Vagrant::VMInfo.new(vm) }.select { |info|
+      info.name == "Test"
+    }.should_not be_empty
+  end
+
+  it "should not list a non-existent VM" do
+    driver.read_vms.map { |vm| Vagrant::VMInfo.new(vm) }.select { |info|
+      info.name == "Non-existent"
+    }.should be_empty
+  end
+
+  it "should list a VM when one is running" do
+    driver.read_vms(:runningvms).map { |vm| Vagrant::VMInfo.new(vm) }.select { |info|
+      info.name == "Test"
+    }.should_not be_empty
+  end
+end
+

data/vagrant-list.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/vagrant-list/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Josh McArthur"]
+  gem.email         = ["joshua.mcarthur@gmail.com"]
+  gem.description   = %q{Extends Vagrant with a 'list' command to list known VirtualBox virtual machines}
+  gem.summary   = %q{Extends Vagrant with a 'list' command to list known VirtualBox virtual machines}
+  gem.homepage      = "https://github.com/joshmcarthur/vagrant-list"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "vagrant-list"
+  gem.require_paths = ["lib"]
+  gem.version       = Vagrant::List::VERSION
+
+  gem.add_runtime_dependency "vagrant"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-list
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Josh McArthur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vagrant
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Extends Vagrant with a 'list' command to list known VirtualBox virtual
+  machines
+email:
+- joshua.mcarthur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/vagrant-list.rb
+- lib/vagrant-list/version.rb
+- lib/vagrant/ext/driver/driver_overrides.rb
+- lib/vagrant/vm_info.rb
+- lib/vagrant_init.rb
+- spec/spec_helper.rb
+- spec/vagrant_list_spec.rb
+- vagrant-list.gemspec
+homepage: https://github.com/joshmcarthur/vagrant-list
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 738696425748107712
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 738696425748107712
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Extends Vagrant with a 'list' command to list known VirtualBox virtual machines
+test_files:
+- spec/spec_helper.rb
+- spec/vagrant_list_spec.rb