virtual_box 0.1.1 → 0.1.2

data/.project

@@ -5,8 +5,14 @@
 	<projects>
 	</projects>
 	<buildSpec>
+		<buildCommand>
+			<name>com.aptana.ide.core.unifiedBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
 	</buildSpec>
 	<natures>
 		<nature>org.radrails.rails.core.railsnature</nature>
+		<nature>com.aptana.ruby.core.rubynature</nature>
 	</natures>
 </projectDescription>

data/Gemfile

@@ -1,6 +1,6 @@
 source :rubygems
 
-gem 'hashie', '>= 0.4.0'
+gem 'posix-spawn', '>= 0.3.6'
 gem 'uuid', '>= 2.3.5'
 
 group :development do
@@ -9,6 +9,7 @@ group :development do
   gem 'minitest', '>= 2.12.1'
   gem 'mocha', '>= 0.11.0', :require => false
   gem 'net-ssh', '>= 2.3.0', :require => 'net/ssh'
+  gem 'redcarpet', '>= 2.1.1'  # Yard needs this to parse Markdown.
   gem 'simplecov', '>= 0.6.1'
-  gem 'yard', '>= 0.7.5'
+  gem 'yard', '>= 0.8.1'
 end

data/Gemfile.lock

@@ -2,7 +2,6 @@ GEM
   remote: http://rubygems.org/
   specs:
     git (1.2.5)
-    hashie (1.2.0)
     jeweler (1.8.3)
       bundler (~> 1.0)
       git (>= 1.2.5)
@@ -17,9 +16,11 @@ GEM
       metaclass (~> 0.0.1)
     multi_json (1.3.4)
     net-ssh (2.3.0)
+    posix-spawn (0.3.6)
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
+    redcarpet (2.1.1)
     simplecov (0.6.2)
       multi_json (~> 1.3)
       simplecov-html (~> 0.5.3)
@@ -27,18 +28,19 @@ GEM
     systemu (2.5.0)
     uuid (2.3.5)
       macaddr (~> 1.0)
-    yard (0.8.0)
+    yard (0.8.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (>= 1.1.3)
-  hashie (>= 0.4.0)
   jeweler (>= 1.8.3)
   minitest (>= 2.12.1)
   mocha (>= 0.11.0)
   net-ssh (>= 2.3.0)
+  posix-spawn (>= 0.3.6)
+  redcarpet (>= 2.1.1)
   simplecov (>= 0.6.1)
   uuid (>= 2.3.5)
-  yard (>= 0.7.5)
+  yard (>= 0.8.1)

data/README.markdown

@@ -28,7 +28,7 @@ Running tests relies on a few command-line tools.
 On Fedora, use the following command to install the packages.
 
 ```bash
-sudo yum install advancecomp curl mkisofs p7zip squashfs-tools
+sudo yum install -y advancecomp curl mkisofs p7zip p7zip-plugins squashfs-tools
 ```
 
 On OSX, run the following command.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/virtual_box/cli.rb

@@ -8,13 +8,31 @@ module VirtualBox
 # Runs a command in a sub-shell, waiting until the command completes.
 #
 # @param [Array<String>] args the name and arguments for the command to be run
-#
-# @return [Hashie::Mash<Symbol, String>] hash with the following keys / methods:
+# @return [Hash<Symbol, String>] hash with the following keys:
 #     :status:: the command's exit status
 #     :output:: a string with the command's output
 def self.run_command(args)
-  output = Kernel.`(Shellwords.shelljoin(args))
-  Hashie::Mash.new :status => $CHILD_STATUS.exitstatus, :output => output
+  begin
+    output = Kernel.`(Shellwords.shelljoin(args) + ' 2>&1')
+    { :status => $CHILD_STATUS.exitstatus, :output => output }
+
+    # TODO(pwnall): this should work, but it makes VirtualBox slow as hell
+    # child = POSIX::Spawn::Child.new(*args)
+    # Hashie::Mash.new :status => child.status.exitstatus, :output => child.out
+  rescue SystemCallError
+    { :status => -1, :output => '' }
+  end
+end
+
+# Runs a command in a sub-shell, waiting until the command completes.
+#
+# @param [Array<String>] args the name and arguments for the command to be run
+# @return [String] the command's output
+# @raise [VirtualBox::Error] if the command exits with a non-zero code
+def self.run_command!(args)
+  result = run_command args
+  raise VirtualBox::Error, result unless result[:status] == 0
+  result[:output]
 end
 
 end  # namespace VirtualBox

data/lib/virtual_box/error.rb

@@ -0,0 +1,25 @@
+module VirtualBox
+
+# Raised when the VirtualBox CLI returns a non-zero error code. 
+class Error < StandardError
+  # The exit code of the failed VirtualBox command.
+  # @return [Integer]
+  attr_reader :exit_code
+  
+  # The combined stdout and stderr of the failed VirtualBox command.
+  # @return [String] 
+  attr_reader :output
+
+  # Called by raise.
+  #
+  # @param [Hash<Symbol, Object>] cli_result the return value of a
+  #     VirtualBox.run call.
+  def initialize(cli_result)
+    @exit_code = cli_result[:status]
+    @output = output
+    
+    super "VirtualBox CLI exited with code #{@exit_code}:\n#{@output}\n"
+  end
+end  # class VirtualBox::Error
+
+end  # namespace VirtualBox

data/lib/virtual_box/{dhcp.rb → net/dhcp.rb}

@@ -1,14 +1,9 @@
 module VirtualBox
 
+class Net
+
 # Specification for a virtual DHCP server.
 class Dhcp
-  # The name of the VirtualBox network served by this DHCP server.
-  #
-  # This name must match the name of a host-only or internal network that is
-  # registered with VirtualBox.
-  # @return [String]
-  attr_accessor :net_name
-  
   # This DHCP server's IP address on the virtual network that it serves.
   # @return [String]
   attr_accessor :ip
@@ -66,48 +61,54 @@ class Dhcp
       :start_ip => start_ip, :end_ip => end_ip }
   end
   
-  # True if this DHCP rule has been registered with VirtualBox.
-  def live?
-    servers = self.class.all
-    dhcp = servers.find { |server| server.net_name == net_name }
-    dhcp ? true : false
-  end
-  
   # Adds this DHCP server to VirtualBox.
   #
-  # @return [VirtualBox::Dhcp] self, for easy call chaining
-  def add
-    remove if live?
-    
-    result = VirtualBox.run_command ['VBoxManage', 'dhcpserver', 'add',
-        '--netname', net_name, '--ip', ip, '--netmask', netmask,
-        '--lowerip', start_ip, '--upperip', end_ip, '--enable']
-    if result.status != 0
-      raise 'Unexpected error code returned by VirtualBox'
+  # @param [String, VirtualBox::Net] net_or_name the name of the VirtualBox
+  #     virtual network that this server will be connected to
+  # @return [VirtualBox::Net::Dhcp] self, for easy call chaining
+  def add(net_or_name)
+    command = ['VBoxManage', 'dhcpserver', 'add', '--ip', ip,
+        '--netmask', netmask, '--lowerip', start_ip, '--upperip', end_ip,
+        '--enable']
+    if net_or_name.kind_of? VirtualBox::Net
+      command.push '--ifname', net_or_name.if_name
+    else
+      command.push '--netname', net_or_name
     end
+
+    VirtualBox.run_command! command
     self
   end
   
   # Removes this DHCP server from VirtualBox.
   #
-  # @return [VirtualBox::Dhcp] self, for easy call chaining
-  def remove
-    VirtualBox.run_command ['VBoxManage', 'dhcpserver', 'remove', '--netname',
-                            net_name]
+  # @param [String, VirtualBox::Net] net_or_name the name of the VirtualBox
+  #     virtual network that this server was connected to
+  # @return [VirtualBox::Net::Dhcp] self, for easy call chaining
+  def remove(net_or_name)
+    command = ['VBoxManage', 'dhcpserver', 'remove']
+    if net_or_name.kind_of? VirtualBox::Net
+      command.push '--ifname', net_or_name.if_name
+    else
+      command.push '--netname', net_or_name
+    end
+
+    VirtualBox.run_command command
     self
   end
   
   # The DHCP servers added to with VirtualBox.
   #
-  # @return [Array<VirtualBox::Dhcp>] all the DHCP servers added to VirtualBox
+  # @return [Hash<String, VirtualBox::Dhcp>] all the DHCP servers added to
+  #     VirtualBox, indexed by the name of the virtual network that they serve
   def self.all
-    result = VirtualBox.run_command ['VBoxManage', '--nologo', 'list', '--long',
-                                     'dhcpservers']
-    if result.status != 0
-      raise 'Unexpected error code returned by VirtualBox'
-    end
-    result.output.split("\n\n").
-                  map { |dhcp_info| new.from_dhcp_info(dhcp_info) }
+    output = VirtualBox.run_command! ['VBoxManage', '--nologo', 'list',
+                                      '--long', 'dhcpservers']
+    Hash[output.split("\n\n").map { |dhcp_info|
+      dhcp = new
+      if_name = dhcp.from_dhcp_info(dhcp_info)
+      [if_name, dhcp]
+    }]
   end
   
   # Parses information about a DHCP server returned by VirtualBox.
@@ -115,18 +116,18 @@ class Dhcp
   # The parsed information is used to replace this network's specification.
   # @param [String] dhcp_info output from "VBoxManage list --long dhcpservers"
   #                           for one server
-  # @return [VirtualBox::Dhcp] self, for easy call chaining
+  # @return [String] the name of the virtual network served by this DHCP server
   def from_dhcp_info(dhcp_info)
     info = Hash[dhcp_info.split("\n").map { |line|
       line.split(':', 2).map(&:strip)
     }]
 
-    self.net_name = info['NetworkName']
     self.ip = info['IP']
     self.netmask = info['NetworkMask']
     self.start_ip = info['lowerIPAddress']
     self.end_ip = info['upperIPAddress']
-    self
+
+    info['NetworkName']
   end
   
   # Converts an IP number into a string.
@@ -144,6 +145,8 @@ class Dhcp
   def self.ip_stob(ip_string)
     ip_string.split('.').map(&:to_i).pack('C*').unpack('N').first
   end
-end  # class VirtualBox::Dhcp
+end  # class VirtualBox::Net::Dhcp
+
+end  # class VirtualBox::Net
 
 end  # namespace VirtualBox

data/lib/virtual_box/net.rb

@@ -34,6 +34,21 @@ class Net
   # @return [String]
   attr_reader :mac
   
+  # The VirtualBox-powered DHCP server configured to serve this interface.
+  # @return [VirtualBox::Net::Dhcp, NilClass]
+  attr_accessor :dhcp
+  
+  undef :dhcp=
+  def dhcp=(new_dhcp)
+    if new_dhcp.nil?
+      @dhcp = nil
+    elsif new_dhcp.kind_of? VirtualBox::Net::Dhcp
+      @dhcp = new_dhcp
+    else
+      @dhcp = VirtualBox::Net::Dhcp.new new_dhcp
+    end
+  end
+  
   # Creates a virtual network specification rule based on the given attributes.
   #
   # The network is not automatically added to VirtualBox.
@@ -48,7 +63,7 @@ class Net
   # @return [Hash<Symbol, Object>] Ruby-friendly Hash that can be used to
   #                                re-create this virtual network specification
   def to_hash
-    { :ip => ip, :netmask => netmask }
+    { :ip => ip, :netmask => netmask, :dhcp => dhcp && dhcp.to_hash }
   end
   
   # True if this virtual network has been added to VirtualBox.
@@ -68,12 +83,9 @@ class Net
     end
     
     # Create the network and pull its name.
-    result = VirtualBox.run_command ['VBoxManage', '--nologo', 'hostonlyif',
-        'create']
-    if result.status != 0
-      raise 'Unexpected error code returned by VirtualBox'
-    end
-    unless match = /^interface\s+'(.*)'\s+.*created/i.match(result.output)
+    output = VirtualBox.run_command! ['VBoxManage', '--nologo', 'hostonlyif',
+                                      'create']
+    unless match = /^interface\s+'(.*)'\s+.*created/i.match(output)
       raise "VirtualBox output does not include interface name"
     end
     @if_name = match[1]
@@ -85,16 +97,16 @@ class Net
     @mac = network.mac
     
     if (ip && ip != network.ip) || (netmask && netmask != network.netmask)
-      result = VirtualBox.run_command ['VBoxManage', '--nologo', 'hostonlyif',
+      VirtualBox.run_command! ['VBoxManage', '--nologo', 'hostonlyif',
           'ipconfig', if_name, '--ip', ip, '--netmask', netmask]
-      if result.status != 0
-        raise 'Unexpected error code returned by VirtualBox'
-      end
     else
       self.ip = network.ip
       self.netmask = network.netmask
     end
     
+    # Register the DHCP server, if it's connected.
+    dhcp.add self if dhcp
+    
     self
   end
   
@@ -103,22 +115,25 @@ class Net
   # @return [VirtualBox::Net] self, for easy call chaining
   def remove
     unless if_name.nil?
+      dhcp.remove self if dhcp
       VirtualBox.run_command ['VBoxManage', 'hostonlyif', 'remove', if_name]
     end
     self
   end
   
-  # The DHCP servers added to with VirtualBox.
+  # The virtual networks added to VirtualBox.
   #
-  # @return [Array<VirtualBox::Dhcp>] all the DHCP servers added to VirtualBox
+  # @return [Array<VirtualBox::Net>] all the DHCP servers added to VirtualBox
   def self.all
-    result = VirtualBox.run_command ['VBoxManage', '--nologo', 'list', '--long',
-                                     'hostonlyifs']
-    if result.status != 0
-      raise 'Unexpected error code returned by VirtualBox'
+    dhcps = VirtualBox::Net::Dhcp.all
+    
+    output = VirtualBox.run_command! ['VBoxManage', '--nologo', 'list',
+                                      '--long', 'hostonlyifs']
+    output.split("\n\n").map do |net_info|
+      net = new.from_net_info(net_info)
+      net.dhcp = dhcps[net.name]
+      net
     end
-    result.output.split("\n\n").
-                  map { |net_info| new.from_net_info(net_info) }
   end
   
   # Parses information about a DHCP server returned by VirtualBox.
@@ -139,6 +154,37 @@ class Net
     self.netmask = info['NetworkMask']
     self
   end
-end  # class VirtualBox::Dhcp
+  
+  
+  # Information about the NICs attached to the computer.
+  #
+  # @return [Array<Hash<Symbol, Object>>] an array with one hash per NIC; hashes
+  #     have the following keys:
+  #     :name:: the NIC device's name (use when setting a Nic's net_name)
+  #     :ip:: the IP address (compare against 0.0.0.0 to see if it's live)
+  #     :mask:: the network mask used to figure out broadcasting
+  #     :mac:: the NICs MAC address (format: "AB0123456789")
+  def self.host_nics
+    @host_nics ||= host_nics!
+  end
+
+  # Queries VirtualBox for the network interfaces on the computer.
+  #
+  # @return (see .host_nics)
+  def self.host_nics!
+    output = VirtualBox.run_command! ['VBoxManage', '--nologo', 'list',
+                                      '--long', 'hostifs']
+    output.split("\n\n").map do |nic_info|
+      info = Hash[nic_info.split("\n").map { |line|
+        line.split(':', 2).map(&:strip)
+      }]
+      {
+        :name => info['Name'], :ip => info['IPAddress'],
+        :mask => info['NetworkMask'],
+        :mac => info['HardwareAddress'].upcase.gsub(/[^0-9A-F]/, '')
+      }
+    end
+  end
+end  # class VirtualBox::Net
 
 end  # namespace VirtualBox

data/lib/virtual_box/version.rb

@@ -8,10 +8,10 @@ module VirtualBox
   # The open-source edition of VirtualBox has some limitations, such as no
   # support for RDP and USB devices.
   def self.ose?
-    unless version.edition
+    unless version[:edition]
       raise 'VirtualBox is not installed on this machine.'
     end
-    version.edition == 'OSE'
+    version[:edition] == 'OSE'
   end
   
   # Version information about the VirtualBox package installed on this machine.
@@ -26,12 +26,12 @@ module VirtualBox
     return @version_info unless @version_info.nil?
     
     cmd_result = run_command ['VBoxManage', '--version']
-    if cmd_result.status != 0
-      @version_info = Hashie::Mash.new
+    if cmd_result[:status] != 0
+      @version_info = {}
       return @version_info
     end
     
-    output = cmd_result.output.strip
+    output = cmd_result[:output].strip
 
     if revision_offset = output.rindex('r')
       revision = output[revision_offset + 1, output.length].to_i
@@ -47,8 +47,8 @@ module VirtualBox
       edition = ''
     end
     
-    @version_info = Hashie::Mash.new :release => output, :svn => revision,
-                                     :edition => edition
+    @version_info = { :release => output, :svn => revision,
+                      :edition => edition }
   end
   
   # Removes the cached information on the VirtualBox package version.

data/lib/virtual_box/vm/board.rb

@@ -272,13 +272,9 @@ class Board
   # @return [Hash<String, String> mapping from each VirtualBox OS type ID to its
   #     description
   def self.list_os_types
-    result = VirtualBox.run_command ['VBoxManage', '--nologo', 'list',
-                                     '--long', 'ostypes']
-    if result.status != 0
-      raise 'Unexpected error code returned by VirtualBox'
-    end
-    
-    types = result.output.split("\n\n").map do |os_info|
+    output = VirtualBox.run_command! ['VBoxManage', '--nologo', 'list',
+                                      '--long', 'ostypes']
+    types = output.split("\n\n").map do |os_info|
       i = Hash[os_info.split("\n").map { |line| line.split(':').map(&:strip) }]
       [i['ID'], i['Description']]
     end

data/lib/virtual_box/vm/disk.rb

@@ -55,12 +55,9 @@ class Disk
     when :dvd
       'dvddrive'
     end
-    result = VirtualBox.run_command ['VBoxManage', '--nologo', 'storageattach',
+    VirtualBox.run_command! ['VBoxManage', '--nologo', 'storageattach',
         vm.uid, '--storagectl', io_bus.name, '--port', port.to_s,
         '--device', device.to_s, '--type', media_arg, '--medium', file]
-    if result.status != 0
-      raise 'Unexpected error code returned by VirtualBox'
-    end
     self
   end
   
@@ -90,13 +87,9 @@ class Disk
     memo = options[:memo] || 'Created with the virtual_box RubyGem'
     variant = options[:prealloc] ? 'Fixed' : 'Standard'
     
-    result = VirtualBox.run_command ['VBoxManage', '--nologo', 'createhd',
+    VirtualBox.run_command! ['VBoxManage', '--nologo', 'createhd',
         '--filename', path, '--size', size_mb.to_s, '--format', format.to_s,
         '--variant', variant]
-    if result.status != 0
-      raise 'Unexpected error code returned by VirtualBox'
-    end
-    
     new :file => path, :format => format, :media => :disk
   end
   

data/lib/virtual_box/vm/io_bus.rb

@@ -209,11 +209,8 @@ class IoBus
   #                            be removed from
   # @return [VirtualBox::Vm::IoBus] self, for easy call chaining
   def remove_from(vm)
-    result = VirtualBox.run_command ['VBoxManage', '--nologo', 'storagectl',
-                                     vm.uuid, '--name', name, '--remove']
-    if result.status != 0
-      raise 'Unexpected error code returned by VirtualBox'
-    end
+    VirtualBox.run_command! ['VBoxManage', '--nologo', 'storagectl', vm.uuid,
+                             '--name', name, '--remove']
     self
   end
 
@@ -223,11 +220,8 @@ class IoBus
   #                            added to
   # @return [VirtualBox::Vm::IoBus] self, for easy call chaining
   def add_bus_to(vm)
-    command = ['VBoxManage', '--nologo', 'storagectl', vm.uid].concat to_params
-    result = VirtualBox.run_command command
-    if result.status != 0
-      raise 'Unexpected error code returned by VirtualBox'
-    end
+    VirtualBox.run_command! ['VBoxManage', '--nologo', 'storagectl',
+                             vm.uid].concat(to_params)
     self
   end
   

data/lib/virtual_box/vm/nic.rb

@@ -177,39 +177,6 @@ class Nic
     { :mode => mode, :chip => chip, :net_name => net_name, :mac => mac,
       :trace_file => trace_file }
   end
-  
-  # Information about the NICs attached to the computer.
-  #
-  # @return [Array<Hash<Symbol, Object>>] an array with one hash per NIC; hashes
-  #     have the following keys:
-  #     :id:: the inteface id (use when setting a Nic's net_id)
-  #     :ip:: the IP address (check for 0.0.0.0 to see if it's live)
-  #     :mask:: the netmask
-  #     :mac:: the NICs MAC address
-  def self.host_nics
-    @host_nics ||= get_host_nics
-  end
-
-  # Queries VirtualBox for the network interfaces on the computer.
-  #
-  # @return (see .host_nics)
-  def self.get_host_nics    
-    result = VirtualBox.run_command ['VBoxManage', '--nologo', 'list',
-                                     '--long', 'hostifs']
-    if result.status != 0
-      raise 'Unexpected error code returned by VirtualBox'
-    end
-    
-    result.output.split("\n\n").map do |nic_info|
-      i = Hash[nic_info.split("\n").map { |line|
-        line.split(':', 2).map(&:strip)
-      }]
-      {
-        :id => i['Name'], :ip => i['IPAddress'], :mask => i['NetworkMask'],
-        :mac => i['HardwareAddress'].upcase.gsub(/[^0-9A-F]/, '')
-      }
-    end
-  end
 end  # class VirtualBox::Vm::Nic
 
 end  # class VirtualBox::Vm