vagrant-list 0.0.5 → 0.0.6

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in vagrant-list.gemspec
 gemspec
+
+# Required for running rake spec
+group :development, :test do
+  gem 'vagrant', :git => 'https://github.com/mitchellh/vagrant.git'
+end

data/README.md

@@ -8,11 +8,33 @@ vagrant-list
 
 ### How do I install it?
 
-#### Using bundler?
-Just add `gem 'vagrant-list'` to your `Gemfile`
+If you are using the packaged version of `vagrant` from [the Vagrant homepage]()http://downloads.vagrantup.com/) then you simply install this gem as a plugin by entering the following command in your terminal:
 
-#### Not using bundler?
-Untested, but just running `gem install vagrant-list` should have the same effect.
+``` bash
+vagrant plugin install vagrant-list
+```
+
+If you have vagrant installed from Rubygems, then you need to do a little more work - first, you can install the gem from [Rubygems](https://rubygems.org):
+
+``` bash
+gem install vagrant-list
+```
+
+Next, you need to tell Vagrant about this plugin, by adding to your project's `Vagrantfile`:
+
+``` ruby
+Vagrant.require_plugin "vagrant-list"
+```
+
+If you are still using a gem version though, it's worth considering the package upgrade, as that seems to be the preferred way for end-users to install Vagrant nowadays and will probably be better supported than a gem install.
+
+##### Vagrant < 1.1.x
+
+If you are using a version of Vagrant older than 1.1.x, then you need to install an older version of this gem from Rubygems - only 0.0.5 and below will work with Vagrant 1.0.x:
+
+`gem install vagrant-list --version "0.0.5"`
+
+Please note that versions older than 0.0.5 **will not** work with Vagrant 1.1.x and above.
 
 ### How do I use it?
 
@@ -20,7 +42,7 @@ Untested, but just running `gem install vagrant-list` should have the same effec
 `vagrant-list` adds just one command to vagrant - `list`. 
 For example, this following command will list the VMs:
 
-`bundle exec vagrant list` will output:
+`vagrant list` will output:
 
 ``` sh
 [vagrant] ALL:
@@ -35,26 +57,48 @@ For example, this following command will list the VMs:
 
 #### 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:
+If you need to acquire the same sort of list that the `vagrant list` command does, but programmatically, feel free to leverage a gem module that wraps around a couple of `VBoxManage` shell commands, like this:
+
+``` ruby
+require 'vagrant-list'
+
+Vagrant::List::VirtualBox::List.all # Returns all VMs
+Vagrant::List::VirtualBox::List.running # Returns only running VMs
+```
 
+The two methods above return an array of UUIDs. If you want to gather further information about a VM, you may also use another class - `Vagrant::List::VMInfo`, like so:
 
-`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.
+``` ruby
+require 'vagrant-list`
+	
+Vagrant::List::VirtualBox::List.all.map do |uuid|
+  puts Vagrant::List::VMInfo.new(uuid).inspect
+end
+```
 
 ### Running Tests
 
-The code has exactly three specs that check:
+Tests for this type of gem are slightly problematic, since much of the core functionality involves shelling out, which is inherently difficult to test, however there are tests to ensure that methods are called as designed, and that helper classes function the way they should.
 
-* 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
+To run the tests, follow the steps below:
 
-Unfortunately, because we are almost directly interacting with the VirtualBox command line tools, there is little opportunity for mocking or stubbing virtual machines. 
+1. Clone the project: `git clone https://github.com/joshmcarthur/vagrant-list.git`
+2. Install dependencies: `bundle install`
+3. Create a virtual machine named `Test` and boot it up
+4. Run the tests: `rake spec`
 
-**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
+** Remember, 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**
+
+### Contributing
 
-This open source software is licensed under the MIT License.
+1. Fork and clone the project
+2. Run specs and make sure everything is passing
+3. Install the plugin into your vagrant install from the local source and run `vagrant list` to test: `rake build && vagrant plugin install pkg/vagrant-list-#{version}.gem && vagrant list`.
+4. Make your changes, rinse and repeat steps 2 & 3 often
+5. Push your changes in a `feature` or `bugfix` branch to Github.
+6. Send me a pull request!
+
+### 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.**
+This open source software is licensed under the MIT License. For more details, see `./LICENSE.txt`.

data/Rakefile

@@ -1,2 +1,7 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/vagrant-list.rb

@@ -1,29 +1,7 @@
+require 'i18n'
 require "vagrant-list/version"
-require "vagrant/ext/driver/driver_overrides"
-require "vagrant/vm_info"
-require "vagrant"
-require "pp"
+require "vagrant-list/plugin"
+require "vagrant-list/vm_info"
+require "vagrant-list/command_error"
+require "vagrant-list/virtual_box/list"
 
-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::Driver::VirtualBox_4_1.send(:include, Vagrant::Ext::Driver::DriverOverrides)
-Vagrant::Driver::VirtualBox_4_2.send(:include, Vagrant::Ext::Driver::DriverOverrides)
-Vagrant.commands.register(:list) { Vagrant::List::All }

data/lib/vagrant-list/command.rb

@@ -0,0 +1,19 @@
+
+
+module Vagrant
+  module List
+    class Command < Vagrant.plugin("2", :command)
+      def execute
+        @env.ui.info "ALL:"
+        Vagrant::List::VirtualBox::List.all.each do |uuid|
+          @env.ui.info Vagrant::List::VMInfo.new(uuid).inspect
+        end
+
+        @env.ui.info "RUNNING:"
+        Vagrant::List::VirtualBox::List.running.each do |uuid|
+          @env.ui.info Vagrant::List::VMInfo.new(uuid).inspect
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-list/command_error.rb

@@ -0,0 +1,10 @@
+require 'vagrant/errors'
+
+
+module Vagrant
+  module List
+    class CommandError < ::Vagrant::Errors::VagrantError
+      error_key "command_failed"
+    end
+  end
+end

data/lib/vagrant-list/plugin.rb

@@ -0,0 +1,32 @@
+begin
+  require 'vagrant'
+rescue LoadError
+  raise 'vagrant-list should be used from within vagrant.'
+end
+
+# Ensure that the gem is not trying to be used from within a vagrant release
+# that will not have the ability to load the plugin
+if Vagrant::VERSION < "1.1.0"
+  raise <<-WARN
+  The vagrant-list plugin is only compatible with Vagrant 1.1+.
+  See https://github.com/joshmcarthur/vagrant-list/tree/1.0.x for a 1.0.x-comaptible version
+  WARN
+end
+
+module Vagrant
+  module List
+    class Plugin < Vagrant.plugin("2")
+      name "List"
+      description <<-DESC
+      This plugin makes a `list` command available to you to list all or running vms.
+      The information is returned in a clear but easy to parse format which is handy for automated
+      control of vagrant boxes.
+      DESC
+
+      command "list" do
+        require_relative 'command'
+        Command
+      end
+    end
+  end
+end

data/lib/vagrant-list/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module List
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/lib/vagrant-list/virtual_box/list.rb

@@ -0,0 +1,37 @@
+module Vagrant
+  module List
+    module VirtualBox
+      module List
+
+        def self.all
+          raw = `VBoxManage list vms`.split("\n")
+          raise Vagrant::List::CommandError, "VBoxManage list returned non-zero status" if errored?
+
+          process(raw)
+        end
+
+        def self.running
+         raw = `VBoxManage list runningvms`.split("\n")
+         raise Vagrant::List::CommandError, "VBoxManage list returned non-zero status" if errored?
+
+         process(raw)
+        end
+
+        def self.errored?
+          $? != 0
+        end
+
+        private
+
+        def self.process(raw)
+          raw.map! do |line|
+            next nil if line =~ /\A"<inaccessible>"/
+            if vm = line[/^".+?" \{(.+?)\}$/, 1]
+              next vm
+            end
+          end.compact
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-list/vm_info.rb

@@ -0,0 +1,48 @@
+require 'vagrant/util'
+
+module Vagrant
+  module List
+    class VMInfo
+      include Vagrant::Util
+
+      attr_accessor :raw
+      attr_accessor :uuid
+      attr_accessor :name
+      attr_accessor :guest_os
+
+      def initialize(uuid)
+        self.raw = `VBoxManage 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}=") && !self.send(key)
+          end
+        end
+
+        self
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,14 @@
 require 'rubygems'
 require 'bundler/setup'
-
-require 'vagrant'
 require 'vagrant-list'
-require 'vagrant_init'
+
+
+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
+
 
 

data/spec/vagrant-list/virtual_box/list_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Vagrant::List::VirtualBox::List do
+  describe ".all" do
+    it "should list VMs" do
+      subject.all.should have_at_least(1).string
+    end
+
+    it "should gracefully handle command failure" do
+      subject.stub(:errored?).and_return(true)
+      expect {
+        subject.all
+      }.to raise_error Vagrant::List::CommandError
+    end
+  end
+
+  describe ".running" do
+    it "should list the 'Test' VM" do
+      subject.running.should have(1).string
+    end
+
+    it "should gracefully handle command failure" do
+      subject.stub(:errored?).and_return(true)
+      expect {
+        subject.running
+      }.to raise_error Vagrant::List::CommandError
+    end
+  end
+end

data/spec/vagrant-list/vm_info_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Vagrant::List::VMInfo do
+  let(:uuid) { Vagrant::List::VirtualBox::List.all.first }
+  let(:attributes) { %w( raw uuid name guest_os ) }
+
+  subject do
+    Vagrant::List::VMInfo.new(uuid)
+  end
+
+  describe "attributes" do
+    %w( raw uuid name guest_os ).each do |attribute|
+      it { subject.methods.should include attribute.to_sym }
+      it { subject.methods.should include "#{attribute}=".to_sym }
+    end
+  end
+
+  describe "initialization" do
+    it "should delegate to process! for deriving VM information" do
+      subject.class.any_instance.should_receive(:process!).and_call_original
+      subject.class.new(uuid)
+    end
+
+    %w( raw uuid name guest_os ).each do |attribute|
+      it "should set #{attribute}" do
+        subject.send(attribute).should be_a(String)
+        subject.send(attribute).should_not eq ""
+      end
+    end
+  end
+
+  describe ".inspect" do
+    let(:vm_info) { Vagrant::List::VMInfo.new(uuid) }
+    subject do
+      vm_info.inspect
+    end
+
+    it "should include the UUID" do
+      subject.should include vm_info.uuid
+    end
+
+    it "should include the name" do
+      subject.should include vm_info.name
+    end
+
+    it "should include the guest OS" do
+      subject.should include vm_info.guest_os
+    end
+  end
+end

data/vagrant-list.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Vagrant::List::VERSION
 
-  gem.add_runtime_dependency "vagrant"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
+  gem.add_dependency "i18n"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-list
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,17 +9,17 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-16 00:00:00.000000000 Z
+date: 2013-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: vagrant
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -28,7 +28,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -44,14 +44,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -74,12 +74,15 @@ files:
 - README.md
 - Rakefile
 - lib/vagrant-list.rb
+- lib/vagrant-list/command.rb
+- lib/vagrant-list/command_error.rb
+- lib/vagrant-list/plugin.rb
 - lib/vagrant-list/version.rb
-- lib/vagrant/ext/driver/driver_overrides.rb
-- lib/vagrant/vm_info.rb
-- lib/vagrant_init.rb
+- lib/vagrant-list/virtual_box/list.rb
+- lib/vagrant-list/vm_info.rb
 - spec/spec_helper.rb
-- spec/vagrant_list_spec.rb
+- spec/vagrant-list/virtual_box/list_spec.rb
+- spec/vagrant-list/vm_info_spec.rb
 - vagrant-list.gemspec
 homepage: https://github.com/joshmcarthur/vagrant-list
 licenses: []
@@ -95,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1256749499276378399
+      hash: 3465248863129003724
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -104,13 +107,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1256749499276378399
+      hash: 3465248863129003724
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 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
+- spec/vagrant-list/virtual_box/list_spec.rb
+- spec/vagrant-list/vm_info_spec.rb

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

@@ -1,38 +0,0 @@
-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 = []
-            begin
-              execute("list", type.to_s, :retryable => true).split("\n").each do |line|
-                next if line =~ /\A"<inaccessible>"/
-                if vm = line[/^".+?" \{(.+?)\}$/, 1]
-                  results << vm
-                end
-              end
-            rescue 
-              puts "Could not list #{type.to_s}"
-            end
-
-            results
-          end
-        end
-      end
-    end
-  end
-  end
-end

data/lib/vagrant/vm_info.rb

@@ -1,45 +0,0 @@
-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}=") && !self.send(key)
-        end
-      end
-
-      self
-    end
-  end
-end

data/lib/vagrant_init.rb

@@ -1,2 +0,0 @@
-require 'vagrant-list'
-

data/spec/vagrant_list_spec.rb

@@ -1,37 +0,0 @@
-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
-