costan-virtual_box 0.0.2 → 0.0.3

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.0.3. VM life-cycle management: start and stop.
+
 v0.0.2. Configuration life-cycle management: VM creation and registration.
 
 v0.0.1. Initial release.

data/lib/virtual_box/registry.rb

@@ -6,16 +6,11 @@
 
 # :nodoc: namespace
 module VirtualBox
-  # The names and UUIDs of all the VMs registered with VirtualBox.
+  # Parses a VBoxManage command result into VM metadata information.
   #
-  # Returns an array with one hash per registered VM. Each hash has the keys
-  # +:name+ and +:uuid+. In case of failure (e.g. VirtualBox is not installed),
-  # returns nil.
-  def self.all_vms_metadata
-    result = VirtualBox.shell_command('VBoxManage --nologo list vms')
+  # This method works for 'VBoxManage show vms | runningvms'
+  def self._vm_metadata_from_command_result(result)
     return nil unless result[:status] == 0
-    
-
     vms = []
     result[:output].each_line do |line|
       line.strip!
@@ -25,4 +20,24 @@ module VirtualBox
     end
     vms
   end
+  
+  # The names and UUIDs of all the VMs registered with VirtualBox.
+  #
+  # Returns an array with one hash per registered VM. Each hash has the keys
+  # +:name+ and +:uuid+. In case of failure (e.g. VirtualBox is not installed),
+  # returns nil.
+  def self.all_vms_metadata
+    result = VirtualBox.shell_command('VBoxManage --nologo list vms')    
+    _vm_metadata_from_command_result result
+  end
+  
+  # The names and UUIDs of the VMs running inside VirtualBox right now.
+  #
+  # Returns an array with one hash per running VM. Each hash has the keys
+  # +:name+ and +:uuid+. In case of failure (e.g. VirtualBox is not installed),
+  # returns nil.
+  def self.running_vms_metadata
+    result = VirtualBox.shell_command('VBoxManage --nologo list runningvms')    
+    _vm_metadata_from_command_result result    
+  end
 end  # namespace VirtualBox

data/lib/virtual_box/vm/lifecycle.rb

@@ -22,17 +22,43 @@ module Lifecycle
   #          support is disabled; VirtualBox OSE does not support RDP, so the
   #          call will raise an exception
   def start(options = {})
-    if options[:gui]
-      command = "VBoxManage --nologo startvm #{uuid} --type gui"
-    else
-      command = "VBoxHeadless --startvm #{uuid}"
-    end      
-      
     if VirtualBox.ose?
       raise 'Cannot enable RDP support on VirtualBox OSE' if options[:rdp]
+    end
+
+    if options[:gui]
+      command = "VBoxManage --nologo startvm #{uuid} --type gui"
     else
-      command += " --vrdp #{options[:rdp] ? 'on' : 'off'}"
+      command = "VBoxManage --nologo startvm #{uuid} --type headless"
     end
+    return false unless VirtualBox.shell_command(command)[:status] == 0
+    
+    options[:rdp] ? control(:vrdp, :on) : true    
+  end
+  
+  # Stops the virtual machine simulation.
+  #
+  # This is equivalent to pulling the power cord from a physical machine.
+  #
+  # Returns +true+ for success, and +false+ for failure.
+  def stop
+    control :power_off
+  end
+
+  # Controls a started virtual machine.
+  #
+  # The following actions are supported:
+  #   :power_off:: hard power-off (pulling the power cord from the machine)
+  #   :acpi_power_button:: Power button press
+  #   :inject_nmi:: NMI (non-maskable interrupt)
+  #   :vrdp:: enables or disables the VM's RDP server (set +action_data+ to :on
+  #           or :off)
+  #
+  # Returns +true+ for success, and +false+ for failure.
+  def control(action, action_data = nil)
+    action = action.to_s.gsub '_', ''
+    command = "VBoxManage --nologo controlvm #{uuid} #{action}"
+    command += " #{action_data}" if action_data
     VirtualBox.shell_command(command)[:status] == 0
   end
   
@@ -41,7 +67,9 @@ module Lifecycle
   # Args:
   #   config_path:: path to the VM configuration file that will be created
   # 
-  def create_configuration(config_path = nil)   
+  def create_configuration(config_path = nil)
+    raise 'Cannot create a configuration without a VM name' unless name
+    
     command = %|VBoxManage --nologo createvm --name "#{name}"|
     if config_path
       command += %| --settingsfile "#{File.expand_path config_path}"|

data/test/lifecycle_test.rb

@@ -112,7 +112,7 @@ class LifecycleTest < Test::Unit::TestCase
   
   def test_register_unregister_configuration_live
     @vm.name = 'virtual_box test Register'
-    assert @vm.create_configuration('./create_test.xml'),
+    assert @vm.create_configuration('./register_test.xml'),
            'Configuration creation failed'
     assert @vm.register_configuration, 'Registration failed'
     
@@ -129,7 +129,7 @@ class LifecycleTest < Test::Unit::TestCase
   def test_start
     flexmock(VirtualBox).should_receive(:ose?).and_return(false)
     flexmock(VirtualBox).should_receive(:shell_command).once.
-        with("VBoxHeadless --startvm #{@uuid} --vrdp off").
+        with("VBoxManage --nologo startvm #{@uuid} --type headless").
         and_return({:status => 0, :output => ""})
         
     assert @vm.start    
@@ -138,7 +138,10 @@ class LifecycleTest < Test::Unit::TestCase
   def test_start_rdp
     flexmock(VirtualBox).should_receive(:ose?).and_return(false)
     flexmock(VirtualBox).should_receive(:shell_command).once.
-        with("VBoxHeadless --startvm #{@uuid} --vrdp on").
+        with("VBoxManage --nologo startvm #{@uuid} --type headless").
+        and_return({:status => 0, :output => ""})
+    flexmock(VirtualBox).should_receive(:shell_command).once.
+        with("VBoxManage --nologo controlvm #{@uuid} vrdp on").
         and_return({:status => 0, :output => ""})
         
     assert @vm.start(:rdp => true)
@@ -146,11 +149,7 @@ class LifecycleTest < Test::Unit::TestCase
   
   def test_start_with_ose
     flexmock(VirtualBox).should_receive(:ose?).and_return(true)
-    flexmock(VirtualBox).should_receive(:shell_command).once.
-        with("VBoxHeadless --startvm #{@uuid}").
-        and_return({:status => 0, :output => ""})
-        
-    assert @vm.start
+    test_start
   end  
 
   def test_start_rdp_with_ose
@@ -164,9 +163,55 @@ class LifecycleTest < Test::Unit::TestCase
   def test_start_gui_with_error
     flexmock(VirtualBox).should_receive(:ose?).and_return(false)
     flexmock(VirtualBox).should_receive(:shell_command).once.
-        with("VBoxManage --nologo startvm #{@uuid} --type gui --vrdp off").
+        with("VBoxManage --nologo startvm #{@uuid} --type gui").
         and_return({:status => 127, :output => ""})
         
     assert_equal false, @vm.start(:gui => true)    
   end
+  
+  def test_start_rdp_with_error
+    flexmock(VirtualBox).should_receive(:ose?).and_return(false)
+    flexmock(VirtualBox).should_receive(:shell_command).once.
+        with("VBoxManage --nologo startvm #{@uuid} --type headless").
+        and_return({:status => 0, :output => ""})
+    flexmock(VirtualBox).should_receive(:shell_command).once.
+        with("VBoxManage --nologo controlvm #{@uuid} vrdp on").
+        and_return({:status => 127, :output => ""})
+
+    assert_equal false, @vm.start(:rdp => true)
+  end
+  
+  def test_stop
+    flexmock(VirtualBox).should_receive(:shell_command).once.
+        with("VBoxManage --nologo controlvm #{@uuid} poweroff").
+        and_return({:status => 0, :output => ""})
+    
+    assert_equal true, @vm.stop
+  end
+  
+  def test_stop_error
+    flexmock(VirtualBox).should_receive(:shell_command).once.
+        and_return({:status => 127, :output => ""})
+    assert_equal false, @vm.stop    
+  end
+  
+  def test_start_stop_live
+    @vm.name = 'virtual_box test Start'
+    assert @vm.create_configuration('./start_test.xml'),
+           'Configuration creation failed'
+    assert @vm.register_configuration, 'Registration failed'
+    
+    assert @vm.start, 'Starting failed'
+    Kernel.sleep 0.5  # Wait for the VM to start.
+    vm_metadata = {:name => @vm.name, :uuid => @vm.uuid}    
+    assert VirtualBox.running_vms_metadata.include?(vm_metadata),
+           'Running VM does not show up in listing'
+    assert @vm.stop, 'Stopping failed'
+    Kernel.sleep 0.5  # Wait for the VM to die.
+    assert !VirtualBox.running_vms_metadata.include?(vm_metadata),
+           'Unregistred VM still shows up in listing'
+
+    assert @vm.unregister_configuration, 'Unregistration failed'
+    assert @vm.delete_configuration, 'Configuration deletion failed'
+  end
 end

data/test/registry_test.rb

@@ -23,24 +23,42 @@ class RegistryTest < Test::Unit::TestCase
         with('VBoxManage --nologo list vms').
         and_return({:status => 0, :output => mock_output})
     
-    vms = VirtualBox.all_vms_metadata
-    assert_equal 2, vms.length, 'Wrong VM count'
-    assert_equal({:name => 'TEM',
-                  :uuid => '0e6e5f5c-7438-4a4c-94cf-39b79b28f8e3'},
-                 vms.first)
-    assert_equal({:name => 'TEM Firmware IDE',
-                  :uuid => '0c21709e-7f29-41c0-a0ac-ff528f50edbf'},
-                 vms.last)
+    _check_vm_metadata VirtualBox.all_vms_metadata    
   end
   
   def test_all_vms_metadata_error
     flexmock(VirtualBox).should_receive(:shell_command).
-        with('VBoxManage --nologo list vms').
-        and_return({:status => 127, :output => 'Command not found'})
-    
+        and_return({:status => 127, :output => 'Command not found'})    
     assert_nil VirtualBox.all_vms_metadata
   end
   
+  def test_running_vms_metadata
+    mock_output = File.read File.join(@testdata_path,
+                                      'list_vms_output.txt')
+    
+    flexmock(VirtualBox).should_receive(:shell_command).
+        with('VBoxManage --nologo list runningvms').
+        and_return({:status => 0, :output => mock_output})
+    
+    _check_vm_metadata VirtualBox.running_vms_metadata    
+  end
+
+  def test_running_vms_metadata_error
+    flexmock(VirtualBox).should_receive(:shell_command).
+        and_return({:status => 127, :output => 'Command not found'})    
+    assert_nil VirtualBox.running_vms_metadata
+  end
+  
+  def _check_vm_metadata(metadata)
+    assert_equal 2, metadata.length, 'Wrong VM count'
+    assert_equal({:name => 'TEM',
+                  :uuid => '0e6e5f5c-7438-4a4c-94cf-39b79b28f8e3'},
+                 metadata.first)
+    assert_equal({:name => 'TEM Firmware IDE',
+                  :uuid => '0c21709e-7f29-41c0-a0ac-ff528f50edbf'},
+                 metadata.last)    
+  end
+  
   # NOTE: The live test for all_vms_metadata is done in lifecycle_test.rb, under
   #       test_register_unregister_configurations_live 
 end

data/virtual_box.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{virtual_box}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Victor Costan"]
-  s.date = %q{2009-08-30}
+  s.date = %q{2009-08-31}
   s.description = %q{Ruby API for VirtualBox (Sun's OSS virtualization software).}
   s.email = %q{victor@zergling.net}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.textile", "lib/virtual_box.rb", "lib/virtual_box/command_line.rb", "lib/virtual_box/registry.rb", "lib/virtual_box/version.rb", "lib/virtual_box/vm.rb", "lib/virtual_box/vm/general_settings.rb", "lib/virtual_box/vm/identity.rb", "lib/virtual_box/vm/lifecycle.rb"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: costan-virtual_box
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Victor Costan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-30 00:00:00 -07:00
+date: 2009-08-31 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency