costan-virtual_box 0.0.1 → 0.0.2

data/CHANGELOG

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

data/Manifest

@@ -1,17 +1,21 @@
 CHANGELOG
+LICENSE
+Manifest
+README.textile
+Rakefile
+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
-lib/virtual_box/vm.rb
-lib/virtual_box.rb
-LICENSE
-Manifest
-Rakefile
-README.textile
 test/command_line_test.rb
 test/general_settings_test.rb
 test/lifecycle_test.rb
+test/registry_test.rb
 test/version_test.rb
+testdata/createvm_output.txt
 testdata/golden_general_params.txt
+testdata/list_vms_output.txt

data/lib/virtual_box.rb

@@ -5,6 +5,7 @@
 # License:: MIT
 
 require 'virtual_box/command_line.rb'
+require 'virtual_box/registry.rb'
 require 'virtual_box/version.rb'
 require 'virtual_box/vm/general_settings.rb'
 require 'virtual_box/vm/identity.rb'

data/lib/virtual_box/registry.rb

@@ -0,0 +1,28 @@
+# VirtualBox version detection. 
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+# :nodoc: namespace
+module VirtualBox
+  # 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')
+    return nil unless result[:status] == 0
+    
+
+    vms = []
+    result[:output].each_line do |line|
+      line.strip!
+      guid_start = line.rindex ?{
+      vms << { :name => line[1, guid_start - 3],
+               :uuid => line[guid_start + 1, line.length - guid_start - 2] }
+    end
+    vms
+  end
+end  # namespace VirtualBox

data/lib/virtual_box/vm/identity.rb

@@ -1,4 +1,4 @@
-# VM identity (name and UUID) management. 
+# VM identity (name, UUID, configuration file) management. 
 #
 # Author:: Victor Costan
 # Copyright:: Copyright (C) 2009 Zergling.Net
@@ -18,19 +18,24 @@ module Identity
   
   # The VM's UUID  (unique id).
   attr_accessor :uuid
-
-  # Resets the VM's name and UUID.
+  
+  attr_accessor :config_file
+  
+  # Resets the VM's identity (name, UUID, configuration file).
   def reset_identity
     @name = nil
-    @uuid = nil    
+    @uuid = nil
+    @config_file = nil
   end
   
+  undef :uuid
   # :nodoc: documented as attribute
   def uuid
     # TODO(overmind): obtain UUID from name if it's not available
     @uuid
   end
 
+  undef :name
   # :nodoc: documented as attribute
   def name
     # TODO(overmind): obtain name from UUID if it's not available

data/lib/virtual_box/vm/lifecycle.rb

@@ -23,7 +23,7 @@ module Lifecycle
   #          call will raise an exception
   def start(options = {})
     if options[:gui]
-      command = "VBoxManage startvm #{uuid} --type gui"
+      command = "VBoxManage --nologo startvm #{uuid} --type gui"
     else
       command = "VBoxHeadless --startvm #{uuid}"
     end      
@@ -34,7 +34,64 @@ module Lifecycle
       command += " --vrdp #{options[:rdp] ? 'on' : 'off'}"
     end
     VirtualBox.shell_command(command)[:status] == 0
-  end  
+  end
+  
+  # Creates the virtual machine configuration in VirtualBox.
+  #
+  # Args:
+  #   config_path:: path to the VM configuration file that will be created
+  # 
+  def create_configuration(config_path = nil)   
+    command = %|VBoxManage --nologo createvm --name "#{name}"|
+    if config_path
+      command += %| --settingsfile "#{File.expand_path config_path}"|
+    end
+    
+    result = VirtualBox.shell_command command
+    raise 'VM creation failed' unless result[:status] == 0
+    
+    uuid_match = /^UUID: (.*)$/.match result[:output]
+    unless uuid_match
+      raise "VM creation didn't output a UUID:\n#{result[:output]}"
+    end
+    self.uuid = uuid_match[1]    
+    config_match = /^Settings file: '(.*)'$/.match result[:output]
+    unless uuid_match
+      raise "VM creation didn't output a config file path:\n#{result[:output]}"
+    end
+    self.config_file = config_match[1]
+    
+    true
+  end
+  
+  # Registers the VM configuration with the VirtualBox installation.
+  #
+  # Returns: +true+ for success, +false+ if registration failed 
+  def register_configuration
+    raise 'Call create_configuration before registering' unless config_file
+    
+    command = %|VBoxManage --nologo registervm "#{config_file}"|
+    result = VirtualBox.shell_command command
+    result[:status] == 0
+  end
+  
+  # Unregisters the VM configuration from the VirtualBox installation.
+  #
+  # Returns: +true+ for success, +false+ if de-registration failed 
+  def unregister_configuration
+    raise "Can't unregister a configuration without a UUID" unless uuid
+    
+    result = VirtualBox.shell_command "VBoxManage --nologo unregistervm #{uuid}"
+    result[:status] == 0
+  end
+  
+  # Deletes the VM configuration.
+  #
+  # Returns: +true+ for success, +false+ if de-registration failed 
+  def delete_configuration
+    File.delete config_file
+    true
+  end
 end  # module Lifecycle
 
 end  # class VM

data/test/general_settings_test.rb

@@ -8,6 +8,7 @@ require 'test/unit'
 
 class GeneralSettingsTest < Test::Unit::TestCase
   def setup
+    super
     @testdata_path = File.join(File.dirname(__FILE__), '..', 'testdata')    
     @vm = VirtualBox::VM.new
   end

data/test/lifecycle_test.rb

@@ -13,11 +13,119 @@ class LifecycleTest < Test::Unit::TestCase
   def setup
     super
     
-    @uuid = 'test-uuid'
+    @testdata_path = File.join(File.dirname(__FILE__), '..', 'testdata')
+    
+    @uuid = '0c21709e-7f29-41c0-a0ac-ff528f50edbf'
     @vm = VirtualBox::VM.new
     @vm.uuid = @uuid
   end
+  
+  
+  def _test_create
+    assert_equal @uuid, @vm.uuid, 'UUID parsing failed'
+    assert_equal '/Users/victor/Library/VirtualBox/Machines/virtual_box test ' + 
+                 'Create/virtual_box test Create.xml', @vm.config_file,
+                 'Config file parsing failed'    
+  end
+  
+  def test_create
+    mock_output = File.read File.join(@testdata_path, 'createvm_output.txt')    
+    flexmock(VirtualBox).should_receive(:shell_command).
+        with('VBoxManage --nologo createvm --name "virtual_box test Create"').
+        and_return({:status => 0, :output => mock_output})
+    
+    @vm.name = 'virtual_box test Create'
+    assert @vm.create_configuration, 'Configuration creation failed'
+  end
+  
+  def test_create_with_path
+    mock_output = File.read File.join(@testdata_path, 'createvm_output.txt')    
+    flexmock(VirtualBox).should_receive(:shell_command).
+        with('VBoxManage --nologo createvm --name "virtual_box test Create"' +
+             ' --settingsfile "' + File.expand_path('vms/testing.xml') + '"').
+        and_return({:status => 0, :output => mock_output})
+    
+    @vm.name = 'virtual_box test Create'
+    assert @vm.create_configuration('vms/testing.xml'),
+           'Configuration creation failed'
+  end
+  
+  def test_create_error
+    flexmock(VirtualBox).should_receive(:shell_command).
+        and_return({:status => 127, :output => 'Command not found'})
+    
+    assert_raise(RuntimeError) do
+      @vm.create_configuration
+    end
+  end
+  
+  def test_create_delete_live
+    @vm.name = 'virtual_box test Create'
+    assert @vm.create_configuration('./create_test.xml'),
+           'Configuration creation failed'
+    
+    assert File.exist?(@vm.config_file), 'Configuration file not created'
+    assert_equal '<?xml ', File.read(@vm.config_file)[0, 6],
+                 'Configuration path does not contain an XML config file'
+  
+    
+    assert @vm.delete_configuration, 'Configuration deletion failed'
+    assert !File.exist?(@vm.config_file), 'Configuration file not deleted'
+  end
+  
+  def test_register_configuration
+    @vm.config_file = config_path = '/prod/vms/testing.xml'
+    flexmock(VirtualBox).should_receive(:shell_command).
+        with(%|VBoxManage --nologo registervm "#{config_path}"|).
+        and_return({:status => 0, :output => ''})
+        
+    assert @vm.register_configuration    
+  end
+  
+  def test_register_error
+    @vm.config_file = config_path = '/prod/vms/testing.xml'
+    flexmock(VirtualBox).should_receive(:shell_command).
+        and_return({:status => 127, :output => 'Command not found'})
+    assert !@vm.register_configuration
+  end
+  
+  def test_register_without_creating_config
+    assert_raise(RuntimeError) do
+      @vm.register_configuration
+    end
+  end
     
+  def test_unregister_configuration
+    @vm.config_file = config_path = '/prod/vms/testing.xml'    
+    flexmock(VirtualBox).should_receive(:shell_command).
+        with("VBoxManage --nologo unregistervm #{@uuid}").
+        and_return({:status => 0, :output => ''})
+        
+    assert @vm.unregister_configuration
+  end
+  
+  def test_unregister_error
+    flexmock(VirtualBox).should_receive(:shell_command).
+        and_return({:status => 127, :output => 'Command not found'})
+    assert !@vm.unregister_configuration
+  end  
+  
+  def test_register_unregister_configuration_live
+    @vm.name = 'virtual_box test Register'
+    assert @vm.create_configuration('./create_test.xml'),
+           'Configuration creation failed'
+    assert @vm.register_configuration, 'Registration failed'
+    
+    vm_metadata = {:name => @vm.name, :uuid => @vm.uuid}    
+    assert VirtualBox.all_vms_metadata.include?(vm_metadata),
+           'Registred VM does not show up in listing'    
+    assert @vm.unregister_configuration, 'Unregistration failed'
+    assert !VirtualBox.all_vms_metadata.include?(vm_metadata),
+           'Unregistred VM still shows up in listing'
+  
+    assert @vm.delete_configuration, 'Configuration deletion failed'
+  end
+  
   def test_start
     flexmock(VirtualBox).should_receive(:ose?).and_return(false)
     flexmock(VirtualBox).should_receive(:shell_command).once.
@@ -56,7 +164,7 @@ 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 startvm #{@uuid} --type gui --vrdp off").
+        with("VBoxManage --nologo startvm #{@uuid} --type gui --vrdp off").
         and_return({:status => 127, :output => ""})
         
     assert_equal false, @vm.start(:gui => true)    

data/test/registry_test.rb

@@ -0,0 +1,46 @@
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+require 'virtual_box'
+require 'test/unit'
+
+require 'rubygems'
+require 'flexmock/test_unit'
+
+
+class RegistryTest < Test::Unit::TestCase
+  def setup
+    super  
+    @testdata_path = File.join(File.dirname(__FILE__), '..', 'testdata')    
+  end
+  
+  def test_all_vms_metadata
+    mock_output = File.read File.join(@testdata_path,
+                                      'list_vms_output.txt')
+    
+    flexmock(VirtualBox).should_receive(:shell_command).
+        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)
+  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'})
+    
+    assert_nil VirtualBox.all_vms_metadata
+  end
+  
+  # NOTE: The live test for all_vms_metadata is done in lifecycle_test.rb, under
+  #       test_register_unregister_configurations_live 
+end

data/testdata/createvm_output.txt

@@ -0,0 +1,3 @@
+Virtual machine 'virtual_box test Create' is created.
+UUID: 0c21709e-7f29-41c0-a0ac-ff528f50edbf
+Settings file: '/Users/victor/Library/VirtualBox/Machines/virtual_box test Create/virtual_box test Create.xml'

data/testdata/list_vms_output.txt

@@ -0,0 +1,2 @@
+"TEM" {0e6e5f5c-7438-4a4c-94cf-39b79b28f8e3}
+"TEM Firmware IDE" {0c21709e-7f29-41c0-a0ac-ff528f50edbf}

data/virtual_box.gemspec

@@ -2,22 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{virtual_box}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   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-21}
+  s.date = %q{2009-08-30}
   s.description = %q{Ruby API for VirtualBox (Sun's OSS virtualization software).}
   s.email = %q{victor@zergling.net}
-  s.extra_rdoc_files = ["CHANGELOG", "lib/virtual_box/command_line.rb", "lib/virtual_box/version.rb", "lib/virtual_box/vm/general_settings.rb", "lib/virtual_box/vm/identity.rb", "lib/virtual_box/vm/lifecycle.rb", "lib/virtual_box/vm.rb", "lib/virtual_box.rb", "LICENSE", "README.textile"]
-  s.files = ["CHANGELOG", "lib/virtual_box/command_line.rb", "lib/virtual_box/version.rb", "lib/virtual_box/vm/general_settings.rb", "lib/virtual_box/vm/identity.rb", "lib/virtual_box/vm/lifecycle.rb", "lib/virtual_box/vm.rb", "lib/virtual_box.rb", "LICENSE", "Manifest", "Rakefile", "README.textile", "test/command_line_test.rb", "test/general_settings_test.rb", "test/lifecycle_test.rb", "test/version_test.rb", "testdata/golden_general_params.txt", "virtual_box.gemspec"]
+  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"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.textile", "Rakefile", "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", "test/command_line_test.rb", "test/general_settings_test.rb", "test/lifecycle_test.rb", "test/registry_test.rb", "test/version_test.rb", "testdata/createvm_output.txt", "testdata/golden_general_params.txt", "testdata/list_vms_output.txt", "virtual_box.gemspec"]
   s.homepage = %q{http://github.com/costan/virtual_box}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Virtual_box", "--main", "README.textile"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{zerglings}
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Ruby API for VirtualBox (Sun's OSS virtualization software).}
-  s.test_files = ["test/command_line_test.rb", "test/general_settings_test.rb", "test/lifecycle_test.rb", "test/version_test.rb"]
+  s.test_files = ["test/command_line_test.rb", "test/general_settings_test.rb", "test/lifecycle_test.rb", "test/registry_test.rb", "test/version_test.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: costan-virtual_box
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Victor Costan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-21 00:00:00 -07:00
+date: 2009-08-30 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,37 +40,41 @@ extensions: []
 
 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
-- lib/virtual_box/vm.rb
-- lib/virtual_box.rb
-- LICENSE
-- README.textile
 files: 
 - CHANGELOG
+- LICENSE
+- Manifest
+- README.textile
+- Rakefile
+- 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
-- lib/virtual_box/vm.rb
-- lib/virtual_box.rb
-- LICENSE
-- Manifest
-- Rakefile
-- README.textile
 - test/command_line_test.rb
 - test/general_settings_test.rb
 - test/lifecycle_test.rb
+- test/registry_test.rb
 - test/version_test.rb
+- testdata/createvm_output.txt
 - testdata/golden_general_params.txt
+- testdata/list_vms_output.txt
 - virtual_box.gemspec
 has_rdoc: false
 homepage: http://github.com/costan/virtual_box
-licenses: 
 post_install_message: 
 rdoc_options: 
 - --line-numbers
@@ -96,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: zerglings
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: Ruby API for VirtualBox (Sun's OSS virtualization software).
@@ -104,4 +108,5 @@ test_files:
 - test/command_line_test.rb
 - test/general_settings_test.rb
 - test/lifecycle_test.rb
+- test/registry_test.rb
 - test/version_test.rb