virtualbox-guestcontrol 1.0.2 → 1.1

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in virtualbox-guestcontrol.gemspec
 gemspec
+
+gem 'popen4'

data/README.md

@@ -20,6 +20,9 @@ Or install it yourself as:
 
 TODO: Write usage instructions here
 
+bundle exec rvbox execute --username XXX --password YYY "ZZZ" "c:\\windows\system32\\systeminfo.exe" |grep "System Up Time"
+bundle exec rvbox execute --username XXX --password YYY "ZZZ" "c:\\windows\system32\\shutdown.exe"  -s -t 0
+
 ## Contributing
 
 1. Fork it

data/bin/rvbox

@@ -1,116 +1,5 @@
 #!/usr/bin/env ruby
 require File.expand_path("../../lib/virtualbox-guestcontrol.rb", __FILE__)
 
-class VirtualBoxCommand < Clamp::Command
-  option ["-u", "--username"], "USERNAME", "username to log in as"
-  option ["-p", "--password"], "PASSWORD", "password to log in as"
-  option ["-t", "--timeout"], "TIMEOUT", "timeout in seconds"
-  option ["-b", "--vboxmanage"], "PATH", "path to VBoxManage"
-
-  def virtual_box
-    VirtualBox::GuestControl::Runner.configure do |c|
-      c.name = name
-      c.username = username
-      c.password = password
-      c.vbox_manage = vboxmanage unless vboxmanage.nil?
-      c.default_timeout = timeout unless vboxmanage.nil?
-    end
-    VirtualBox::GuestControl::Runner.new
-  end
-
-  subcommand "start", "start up the given VM" do
-    parameter "NAME", "name of virtual machine"
-
-    def execute
-      virtual_box.start!
-    end
-  end
-
-  subcommand "shutdown", "shutdown the given VM" do
-    parameter "NAME", "name of virtual machine"
-
-    def execute
-      virtual_box.shutdown!
-    end
-  end
-
-  subcommand "restart", "restart the given VM" do
-    parameter "NAME", "name of virtual machine"
-
-    def execute
-      virtual_box.restart!
-    end
-  end
-
-  subcommand "info", "list all known info about the VM" do
-    parameter "NAME", "name of virtual machine"
-
-    def execute
-      virtual_box.state.tap do |map|
-        map.keys.sort.each do |key|
-          puts [key, map[key]].join(": ")
-        end
-      end
-    end
-  end
-  
-  subcommand "usblist", "list usb devices on host" do
-    def execute
-      VirtualBox::GuestControl::Runner.usb_devices.each do |device|
-        puts device.to_s
-      end
-    end
-  end
-
-  subcommand "usbdetach", "detach usb devices on host" do
-    parameter "NAME", "name of virtual machine"
-    
-    def execute
-      VirtualBox::GuestControl::Runner.usb_devices.each do |device|
-        device.detach(name)
-      end
-    end
-  end
-
-  subcommand "status", "says if the vm is booted or not" do
-    parameter "NAME", "name of virtual machine"
-
-    def execute
-      if virtual_box.started?
-        puts "VM is started"
-      else
-        puts "VM is shutdown"
-      end
-    end
-  end
-  
-  subcommand "list", "lists the available VMs" do    
-    option ["--uuid"], :flag, "show only uuid", :default => false
-    option ["--name"], :flag, "show only name", :default => false    
-    
-    def execute
-      VirtualBox::GuestControl::Runner.virtual_machines.each do |name, uuid|
-        if uuid?
-          puts uuid
-        elsif name?
-          puts name
-        else
-          puts [name, uuid].join("\t")
-        end
-      end
-    end
-  end
-  
-  subcommand "execute", "execute a given command" do
-    parameter "NAME", "name of virtual machine"
-    parameter "[COMMAND_PARAMETERS] ...", "command and parameters to pass to the VM", :attribute_name => :command_parameters
-    
-    def execute
-      image_name, arguments = command_parameters
-      virtual_box.execute *command_parameters
-    end
-  end
-end
-
-VirtualBoxCommand.run(ARGV)
+VirtualBox::GuestControl::Command.run(ARGV)
 

data/lib/virtualbox-guestcontrol.rb

@@ -4,215 +4,12 @@ require 'active_support/configurable'
 require 'active_support/time'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'clamp'
+require 'state_machine'
 
 module VirtualBox
   module GuestControl
-    class Runner
-      include ActiveSupport::Configurable
-
-      self.config[:default_timeout] = 240.seconds
-      self.config[:vbox_manage] = Shellter.which("VBoxManage")
-
-      config_accessor :vbox_manage
-      config_accessor :name
-      config_accessor :default_timeout
-      config_accessor :username
-      config_accessor :password
-
-      def valid?
-        
-      end
-
-      def started?
-        state[:GuestAdditionsRunLevel] == "2" || state[:GuestAdditionsRunLevel] == "3"
-      end
-
-      def shutdown?
-        ["poweroff", "aborted", "saved"].include?(state[:VMState])
-      end
-
-      def shutdown!(force = false)
-        return if shutdown?
-
-        detach_usb_devices
-
-        if force
-          Shellter.run(vbox_manage, "controlvm", ":name", "poweroff", :name => name)
-          wait_until { shutdown? }
-        else
-          begin
-            Shellter.run(vbox_manage, "controlvm", ":name", "acpipowerbutton", :name => name)
-            wait_until { shutdown? }
-          rescue TimeoutError
-            shutdown_machine(true)
-          end
-        end
-      end
-
-      def start!
-        return if started?
-        Shellter.run!(vbox_manage, "startvm", ":name", :name => name)
-        wait_until { started? }
-      end
-
-      def restart!
-        shutdown!
-        start!
-      end
-
-      # VBoxManage guestcontrol     <vmname>|<uuid>
-      #                             exec[ute]
-      #                             --image <path to program>
-      #                             --username <name> --password <password>
-      #                             [--dos2unix]
-      #                             [--environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"]
-      #                             [--timeout <msec>] [--unix2dos] [--verbose]
-      #                             [--wait-exit] [--wait-stdout] [--wait-stderr]
-      #                             [-- [<argument1>] ... [<argumentN>]]
-      def execute(command, *arguments)
-        with_started_machine do
-          options = arguments.extract_options!
-          params = ["guestcontrol", ":name", "execute", "--image", ":command"]
-
-          options[:name] = name
-          options[:command] = command
-
-          if username
-            params += ["--username", ":username"]
-            options[:username] = username
-          end
-
-          if password
-            params += ["--password", ":password"]
-            options[:password] = password
-          end
-
-          # params += ["--timeout", ":timeout"]
-          params += ["--wait-exit", "--wait-stdout"]
-          # options[:timeout] = default_timeout.to_s
-
-          unless arguments.empty?
-            params += ["--"] + arguments
-          end
-
-          params << options
-          
-          result = Shellter.run(vbox_manage, *params)
-          puts result.stdout.read
-
-        end
-      end
-
-      def state
-        result = Shellter.run!(vbox_manage, "showvminfo", ":name", "--machinereadable", :name => name)
-        {}.with_indifferent_access.tap do |map|
-          result.stdout.read.lines.each do |line|
-            name, value = line.strip.split("=").map { |y| y.gsub(/(^"|"$)/, "") }
-            map[name] = value
-          end
-        end
-      end
-      
-      class UsbDevice
-        class << self
-          def parse(output, vbox_manage)
-            [].tap do |devices|
-              device = nil
-              output.lines.each do |line|
-                if device
-                  if line.strip.blank?
-                    devices << device
-                    device = nil
-                  else
-                    key, value = line.split(":")
-                    key = key.strip.gsub(" ", "_").underscore
-                    value = value.strip
-                    device.send(:"#{key}=", value)
-                  end
-                else
-                  next unless line =~ /UUID:/                  
-                  value = line.split(":").last.strip
-                  device = new(value, vbox_manage)
-                end
-              end
-            end
-          end
-        end
-        
-        attr_accessor :uuid, :vendor_id, :product_id, :revision
-        attr_accessor :manufacturer, :product, :address, :current_state
-        attr_accessor :serial_number
-        attr_accessor :vbox_manage
-        
-        def initialize(uuid, vbox_manage)
-          self.vbox_manage = vbox_manage
-          self.uuid = uuid
-        end
-        
-        def detach(name)
-          result = Shellter.run(vbox_manage, "controlvm", ":name", "usbdetach", ":uuid", :name => name, :uuid => uuid)          
-        end
-        
-        def attach(name)
-          Shellter.run!(vbox_manage, "controlvm", ":name", "usbattach", ":uuid", :name => name, :uuid => uuid)
-        end
-        
-        def to_s
-          "#{product} (#{uuid}): #{current_state}"
-        end
-      end
-      
-      def detach_usb_devices
-        self.class.usb_devices.each do |device|
-          device.detach(name)          
-        end
-      end
-      
-      def attach_usb_devices
-        self.class.usb_devices.each do |device|
-          device.attach(name)          
-        end        
-      end
-      
-      VM_MATCHER = /^"([^"]*)" \{(.*)\}$/
-      
-      class << self
-        def virtual_machines
-          result = Shellter.run!(vbox_manage, "list", "vms")
-          result.stdout.read.lines.map do |line|
-            line.scan(VM_MATCHER).first
-          end
-        end
-        
-        def usb_devices
-          result = Shellter.run!(vbox_manage, "list", "usbhost")
-          UsbDevice.parse(result.stdout, vbox_manage)
-        end
-      end
-
-      private
-
-      def wait_until
-        Timeout::timeout(default_timeout) do
-          loop do
-            result = yield
-            if result
-              break
-            else
-              sleep 5
-            end
-          end
-        end
-      end
-
-      def with_started_machine(shutdown_after = false)
-        begin
-          start!
-          yield
-        ensure
-          shutdown! if shutdown_after
-        end
-      end
-    end
+    autoload :Machine, 'virtualbox/guest_control/machine'
+    autoload :UsbDevice, 'virtualbox/guest_control/usb_device'
+    autoload :Command, 'virtualbox/guest_control/command'
   end
 end

data/lib/virtualbox/guest_control/command.rb

@@ -0,0 +1,125 @@
+module VirtualBox
+  module GuestControl
+
+    class Command < Clamp::Command
+      option ["-u", "--username"], "USERNAME", "username to log in as"
+      option ["-p", "--password"], "PASSWORD", "password to log in as"
+      option ["-t", "--timeout"], "TIMEOUT", "timeout in seconds"
+      option ["-b", "--vboxmanage"], "PATH", "path to VBoxManage"
+
+      def machine
+        VirtualBox::GuestControl::Machine.find_by_name(name).tap do |machine|
+          raise "No such machine #{name}" unless machine.present?
+          machine.username = username
+          machine.password = password
+          machine.vbox_manage = vboxmanage unless vboxmanage.nil?
+          machine.default_timeout = timeout unless vboxmanage.nil?
+        end
+      end
+
+      subcommand "start", "start up the given VM" do
+        parameter "NAME", "name of virtual machine"
+
+        def execute
+          if machine.can_start?
+            machine.start!
+          else
+            puts "Machine can't start because it is currently: #{machine.status}"
+          end
+        end
+      end
+
+      subcommand "shutdown", "shutdown the given VM" do
+        parameter "NAME", "name of virtual machine"
+
+        def execute
+          if machine.can_shutdown?
+            machine.shutdown!
+          else
+            puts "Machine can't shutdown because it is currently: #{machine.status}"
+          end
+        end
+      end
+
+      subcommand "restart", "restart the given VM" do
+        parameter "NAME", "name of virtual machine"
+
+        def execute
+          virtual_box.restart!
+        end
+      end
+
+      subcommand "info", "list all known info about the VM" do
+        parameter "NAME", "name of virtual machine"
+
+        def execute
+          machine.environment.each do |key, value|
+            puts [key, value].join("\t")
+          end
+        end
+      end
+
+      subcommand "usblist", "list usb devices on host" do
+        def execute
+          UsbDevice.all.each do |device|
+            puts device.to_s
+          end
+        end
+      end
+
+      subcommand "usbdetach", "detach usb devices on host" do
+        parameter "NAME", "name of virtual machine"
+
+        def execute
+          machine.usb_devices.each do |device|
+            device.detach(name)
+          end
+        end
+      end
+
+      subcommand "status", "says if the vm is booted or not" do
+        parameter "NAME", "name of virtual machine"
+
+        def execute
+          puts machine.status
+        end
+      end
+
+      subcommand "list", "lists the available VMs" do
+        option ["--uuid"], :flag, "show only uuid", :default => false
+        option ["--name"], :flag, "show only name", :default => false
+
+        def execute
+          VirtualBox::GuestControl::Machine.all.each do |machine|
+            if uuid?
+              puts machine.uuid
+            elsif name?
+              puts machine.name
+            else
+              puts [machine.name, machine.uuid].join("\t")
+            end
+          end
+        end
+      end
+
+      subcommand "execute", "execute a given command" do
+        parameter "NAME", "name of virtual machine"
+        parameter "[COMMAND_PARAMETERS] ...", "command and parameters to pass to the VM", :attribute_name => :command_parameters
+
+        def execute
+          image_name = command_parameters.shift
+          result = machine.execute image_name, *command_parameters
+          if result.success?
+            puts result.stdout.read
+          else
+            puts "Command failed with exit status #{result.exit_code}"
+            puts "Standard output:"
+            puts result.stdout.read
+            puts "Standard error:"
+            puts result.stderr.read
+          end
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/guest_control/machine.rb

@@ -0,0 +1,229 @@
+module VirtualBox
+  module GuestControl
+    class Machine
+      VM_MATCHER = /^"([^"]*)" \{(.*)\}$/
+
+      include ActiveSupport::Configurable
+
+      self.config[:default_timeout] = 240.seconds
+      self.config[:vbox_manage] = Shellter.which("VBoxManage")
+
+      config_accessor :vbox_manage
+
+      config_accessor :default_timeout
+      config_accessor :username
+      config_accessor :password
+
+      class << self
+        def all
+          result = Shellter.run!(vbox_manage, "list", "vms")
+          result.stdout.read.lines.map do |line|
+            new(*line.scan(VM_MATCHER).first)
+          end
+        end
+
+        def find_by_uuid(uuid)
+          all.detect { |machine| machine.uuid == uuid }
+        end
+
+        def find_by_name(name)
+          all.detect { |machine| machine.name == name }
+        end
+      end
+
+      def initialize(name, uuid)
+        @name = name
+        @uuid = uuid
+      end
+
+      attr_accessor :name
+      attr_accessor :uuid
+
+      state_machine :initial => :poweroff do
+
+        event :start do
+          transition [:saved, :aborted, :poweroff] => :running
+        end
+
+        event :shutdown do
+          transition :running => :poweroff
+        end
+
+        before_transition any => :running do |machine, transition|
+          Shellter.run!(machine.vbox_manage, "startvm", ":name", :name => machine.name)
+          machine.wait_until { machine.running? }
+          machine.wait_until { machine.guest_additions_started? }
+        end
+
+        before_transition :running => :poweroff do |machine, transition|
+          machine.detach_usb_devices!
+
+          begin
+            Shellter.run(machine.vbox_manage, "controlvm", ":name", "acpipowerbutton", :name => machine.name)
+            machine.wait_until { machine.poweroff? }
+          rescue TimeoutError
+            Shellter.run(machine.vbox_manage, "controlvm", ":name", "poweroff", :name => machine.name)
+            wait_until { machine.shutdown? }
+          end
+        end
+
+        state :poweroff do
+          def status
+            "Powered Off"
+          end
+
+          def execute(*arguments)
+            with_started_machine do
+              execute(*arguments)
+            end
+          end
+        end
+
+        state :aborted do
+          def status
+            "Aborted"
+          end
+
+          def execute(*arguments)
+            with_started_machine do
+              execute(*arguments)
+            end
+          end
+        end
+
+        state :running do
+          def status
+            "Running"
+          end
+
+          def execute(command, *arguments)
+
+            options = arguments.extract_options!
+            params = ["guestcontrol", ":name", "execute", "--image", ":command"]
+
+            options[:name] = name
+            options[:command] = command
+
+            if username
+              params += ["--username", ":username"]
+              options[:username] = username
+            end
+
+            if password
+              params += ["--password", ":password"]
+              options[:password] = password
+            end
+
+            # params += ["--timeout", ":timeout"]
+            params += ["--wait-exit", "--wait-stdout"]
+            # options[:timeout] = default_timeout.to_s
+
+            unless arguments.empty?
+              params += ["--"] + arguments
+            end
+
+            params << options
+
+            Shellter.run(vbox_manage, *params)
+          end
+        end
+
+        state :saved do
+          def status
+            "Saved State"
+          end
+
+          def execute(*arguments)
+            with_started_machine do
+              execute(*arguments)
+            end
+          end
+        end
+      end
+
+      def wait_until
+        Timeout::timeout(default_timeout) do
+          loop do
+            result = yield
+            if result
+              break
+            else
+              sleep 5
+            end
+          end
+        end
+      end
+
+      def state
+        environment[:VMState]
+      end
+
+      def guest_additions_started?
+        guest_additions_run_level >= 2
+      end
+
+      def guest_additions_run_level
+        environment[:GuestAdditionsRunLevel].to_i
+      end
+
+      def restart!
+        shutdown!
+        start!
+      end
+
+      # VBoxManage guestcontrol     <vmname>|<uuid>
+      #                             exec[ute]
+      #                             --image <path to program>
+      #                             --username <name> --password <password>
+      #                             [--dos2unix]
+      #                             [--environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"]
+      #                             [--timeout <msec>] [--unix2dos] [--verbose]
+      #                             [--wait-exit] [--wait-stdout] [--wait-stderr]
+      #                             [-- [<argument1>] ... [<argumentN>]]
+
+
+      def environment
+        result = Shellter.run!(vbox_manage, "showvminfo", ":name", "--machinereadable", :name => name)
+        {}.with_indifferent_access.tap do |map|
+          result.stdout.read.lines.each do |line|
+            name, value = line.strip.split("=").map { |y| y.gsub(/(^"|"$)/, "") }
+            map[name] = value
+          end
+        end
+      end
+
+      def with_started_machine(shutdown_after = false)
+        begin
+          start!
+          yield
+        ensure
+          shutdown! if shutdown_after
+        end
+      end
+
+      def usb_devices
+        UsbDevice.all(vbox_manage)
+      end
+
+      def detach_usb_devices!
+        usb_devices.each do |usb_device|
+          detach!(usb_device)
+        end
+      end
+
+      def attach_usb_devices!
+        usb_devices.each do |usb_device|
+          attach!(usb_device)
+        end
+      end
+
+      def detach!(usb_device)
+        Shellter.run(vbox_manage, "controlvm", ":name", "usbdetach", ":uuid", :name => name, :uuid => usb_device.uuid)
+      end
+
+      def attach!(usb_device)
+        Shellter.run!(vbox_manage, "controlvm", ":name", "usbattach", ":uuid", :name => name, :uuid => usb_device.uuid)
+      end
+    end
+  end
+end

data/lib/virtualbox/guest_control/usb_device.rb

@@ -0,0 +1,59 @@
+module VirtualBox
+  module GuestControl
+    class UsbDevice
+      include ActiveSupport::Configurable
+
+      class << self
+        def all(vbox_manage)
+          result = Shellter.run!(vbox_manage, "list", "usbhost")
+          parse(result.stdout)
+        end
+
+        def parse(output)
+          [].tap do |devices|
+            device = nil
+            output.lines.each do |line|
+              if device
+                if line.strip.blank?
+                  devices << device
+                  device = nil
+                else
+                  key, value = line.split(":")
+                  key = key.strip.gsub(" ", "_").underscore
+                  value = value.strip
+                  begin
+                    device.send(:"#{key}=", value)
+                  rescue
+                    # this is the version/speed attribute... maybe we should parse it
+                    #puts [key, value].join(" => ")
+                  end
+                end
+              else
+                next unless line =~ /UUID:/
+                value = line.split(":").last.strip
+                device = new(value)
+              end
+            end
+          end
+        end
+      end
+
+      attr_accessor :uuid, :vendor_id, :product_id, :revision
+      attr_accessor :manufacturer, :product, :address, :current_state, :port
+      attr_accessor :serial_number
+      attr_accessor :vbox_manage
+
+      def initialize(uuid)
+        self.uuid = uuid
+      end
+
+      def to_s
+        "#{product} (#{uuid}): #{current_state}"
+      end
+
+      def state
+        current_state
+      end
+    end
+  end
+end

data/lib/{virtualbox-guestcontrol → virtualbox/guest_control}/version.rb

@@ -1,5 +1,5 @@
 module VirtualBox
   module GuestControl
-    VERSION = "1.0.2"
+    VERSION = "1.1"
   end
 end

data/virtualbox-guestcontrol.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/virtualbox-guestcontrol/version', __FILE__)
+require File.expand_path('../lib/virtualbox/guest_control/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Andrew Eberbach"]
@@ -18,4 +18,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'shellter'
   gem.add_dependency 'activesupport', "~> 3.0"
   gem.add_dependency 'clamp'
+  gem.add_dependency 'state_machine'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: virtualbox-guestcontrol
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: '1.1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-06 00:00:00.000000000 Z
+date: 2012-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shellter
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: state_machine
+  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'
 description: Runs stuff inside of a VirtualBox VM
 email:
 - andrew@ebertech.ca
@@ -74,7 +90,10 @@ files:
 - Rakefile
 - bin/rvbox
 - lib/virtualbox-guestcontrol.rb
-- lib/virtualbox-guestcontrol/version.rb
+- lib/virtualbox/guest_control/command.rb
+- lib/virtualbox/guest_control/machine.rb
+- lib/virtualbox/guest_control/usb_device.rb
+- lib/virtualbox/guest_control/version.rb
 - virtualbox-guestcontrol.gemspec
 homepage: ''
 licenses: []
@@ -96,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Runs stuff inside of a VirtualBox VM