rbvmomi 1.0.2 → 1.1.0

data/lib/rbvmomi/vim/ResourcePool.rb

@@ -0,0 +1,18 @@
+class RbVmomi::VIM::ResourcePool
+  # Retrieve a child ResourcePool.
+  # @param name [String] Name of the child.
+  # @return [VIM::ResourcePool]
+  def find name
+    @soap.searchIndex.FindChild(entity: self, name: name)
+  end
+
+  # Retrieve a descendant of this ResourcePool.
+  # @param path [String] Path delimited by '/'.
+  # @return [VIM::ResourcePool]
+  def traverse path
+    es = path.split('/').reject(&:empty?)
+    es.inject(self) do |f,e|
+      f.find(e) || return
+    end
+  end
+end

data/lib/rbvmomi/vim/ServiceInstance.rb

@@ -0,0 +1,53 @@
+class RbVmomi::VIM::ServiceInstance
+  # Retrieve a Datacenter.
+  # If no path is given the first datacenter will be returned.
+  # @param path (see Folder#traverse)
+  # @return [Datacenter]
+  def find_datacenter path=nil
+    if path
+      content.rootFolder.traverse path, RbVmomi::VIM::Datacenter
+    else
+      content.rootFolder.childEntity.grep(RbVmomi::VIM::Datacenter).first
+    end
+  end
+
+  # Wait for several tasks to complete.
+  # @param interested [Array] Property paths to watch for updates.
+  # @param tasks [Array] Tasks to wait on.
+  # @yield [Hash] Called when a property is updated on a task.
+  #               The parameter is a hash from tasks to hashes from
+  #               property path to value.
+  # @return [void]
+  def wait_for_multiple_tasks interested, tasks
+    version = ''
+    interested = (interested + ['info.state']).uniq
+    task_props = Hash.new { |h,k| h[k] = {} }
+
+    filter = @soap.propertyCollector.CreateFilter :spec => {
+      :propSet => [{ :type => 'Task', :all => false, :pathSet => interested }],
+      :objectSet => tasks.map { |x| { :obj => x } },
+    }, :partialUpdates => false
+
+    begin
+      until task_props.size == tasks.size and task_props.all? { |k,h| %w(success error).member? h['info.state'] }
+        result = @soap.propertyCollector.WaitForUpdates(version: version)
+        version = result.version
+        os = result.filterSet[0].objectSet
+
+        os.each do |o|
+          changes = Hash[o.changeSet.map { |x| [x.name, x.val] }]
+
+          interested.each do |k|
+            task = tasks.find { |x| x._ref == o.obj._ref }
+            task_props[task][k] = changes[k] if changes.member? k
+          end
+        end
+
+        yield task_props
+      end
+    ensure
+      @soap.propertyCollector.CancelWaitForUpdates
+      filter.DestroyPropertyFilter
+    end
+  end
+end

data/lib/rbvmomi/vim/Task.rb

@@ -0,0 +1,31 @@
+class RbVmomi::VIM::Task
+  # Wait for a task to finish.
+  # @return +info.result+ on success.
+  # @raise +info.error+ on error.
+  def wait_for_completion
+    wait_until('info.state') { %w(success error).member? info.state }
+    case info.state
+    when 'success'
+      info.result
+    when 'error'
+      raise info.error
+    end
+  end
+
+  # Wait for a task to finish, with progress notifications.
+  # @return (see #wait_for_completion)
+  # @raise (see #wait_for_completion)
+  # @yield [info.progress]
+  def wait_for_progress
+    wait_until('info.state', 'info.progress') do
+      yield info.progress if block_given?
+      %w(success error).member? info.state
+    end
+    case info.state
+    when 'success'
+      info.result
+    when 'error'
+      raise info.error
+    end
+  end
+end

data/lib/rbvmomi/vim/VirtualMachine.rb

@@ -0,0 +1,7 @@
+class RbVmomi::VIM::VirtualMachine
+  # Retrieve the MAC addresses for all virtual NICs.
+  # @return [Hash] Keyed by device label.
+  def macs
+    Hash[self.config.hardware.device.grep(RbVmomi::VIM::VirtualEthernetCard).map { |x| [x.deviceInfo.label, x.macAddress] }]
+  end
+end

data/test/test_deserialization.rb

@@ -1,22 +1,14 @@
 require 'test/unit'
 require 'rbvmomi'
-include RbVmomi
+VIM ||= RbVmomi::VIM
 
 class DeserializationTest < Test::Unit::TestCase
   def setup
-    @soap = RbVmomi::Soap.new(ns: 'urn:vim25', rev: '4.0')
+    @soap = VIM.new(ns: 'urn:vim25', rev: '4.0')
   end
 
   def check str, expected, type
     got = @soap.xml2obj Nokogiri(str).root, type
-
-    puts "expected:"
-    pp expected
-    puts
-    puts "got:"
-    pp got
-    puts
-
     assert_equal expected, got
   end
 
@@ -79,7 +71,7 @@ class DeserializationTest < Test::Unit::TestCase
     )
 
     check <<-EOS, obj, 'ObjectContent'
-<root xmlns:xsi="#{RbVmomi::Soap::NS_XSI}">
+<root xmlns:xsi="#{VIM::NS_XSI}">
    <obj type="Folder">ha-folder-root</obj>
    <propSet>
       <name>childEntity</name>
@@ -96,8 +88,6 @@ def test_array2
     dynamicProperty: [],
     linkUp: true,
     blocked: false,
-    vmDirectPathGen2InactiveReasonNetwork: [],
-    vmDirectPathGen2InactiveReasonOther: [],
     vlanIds: [
       VIM::NumericRange(dynamicProperty: [], start: 5, end: 7),
       VIM::NumericRange(dynamicProperty: [], start: 10, end: 20),
@@ -123,8 +113,6 @@ end
 def test_empty_array
   obj = VIM.DVPortStatus(
     dynamicProperty: [],
-    vmDirectPathGen2InactiveReasonNetwork: [],
-    vmDirectPathGen2InactiveReasonOther: [],
     linkUp: true,
     blocked: false,
     vlanIds: []
@@ -149,7 +137,7 @@ end
     )
 
     check <<-EOS, obj, "LocalizedMethodFault"
-<error xmlns:xsi="#{RbVmomi::Soap::NS_XSI}">
+<error xmlns:xsi="#{VIM::NS_XSI}">
   <fault xsi:type="InvalidPowerState">
     <requestedState>poweredOn</requestedState>
     <existingState>poweredOff</existingState>
@@ -189,7 +177,7 @@ end
     )
 
     check <<-EOS, obj, "UpdateSet"
-<returnval xmlns:xsi="#{RbVmomi::Soap::NS_XSI}">
+<returnval xmlns:xsi="#{VIM::NS_XSI}">
   <version>7</version>
   <filterSet>
     <filter type="PropertyFilter">session[528BA5EB-335B-4AF6-B49C-6160CF5E8D5B]71E3AC7E-7927-4D9E-8BC3-522769F22DAF</filter>
@@ -238,6 +226,7 @@ end
     EOS
   end
 
+=begin
   def test_runtime_state
     obj = VIM::VirtualMachineDeviceRuntimeInfoVirtualEthernetCardRuntimeState(
       dynamicProperty: [],
@@ -246,40 +235,21 @@ end
       vmDirectPathGen2InactiveReasonVm: []
     )
     check <<-EOS, obj, 'VirtualMachineDeviceRuntimeInfoDeviceRuntimeState'
-<runtimeState xsi:type="VirtualMachineDeviceRuntimeInfoVirtualEthernetCardRuntimeState" xmlns:xsi="#{RbVmomi::Soap::NS_XSI}">
+<runtimeState xsi:type="VirtualMachineDeviceRuntimeInfoVirtualEthernetCardRuntimeState" xmlns:xsi="#{VIM::NS_XSI}">
   <vmDirectPathGen2Active>false</vmDirectPathGen2Active>
   <vmDirectPathGen2InactiveReasonOther>vmNptIncompatibleHost</vmDirectPathGen2InactiveReasonOther>
 </runtimeState>
     EOS
   end
+=end
 
   def test_runtime_info
-    obj = RbVmomi::VIM::VirtualMachineRuntimeInfo(
+    obj = VIM::VirtualMachineRuntimeInfo(
       bootTime: Time.parse('2010-08-20 05:44:35 UTC'),
       connectionState: "connected",
-      device: [RbVmomi::VIM::VirtualMachineDeviceRuntimeInfo(
-        dynamicProperty: [],
-        key: 4000,
-        runtimeState: RbVmomi::VIM::VirtualMachineDeviceRuntimeInfoVirtualEthernetCardRuntimeState(
-          dynamicProperty: [],
-          vmDirectPathGen2Active: false,
-          vmDirectPathGen2InactiveReasonOther: [],
-          vmDirectPathGen2InactiveReasonVm: ["vmNptIncompatibleAdapterType"]
-        )
-      ),
-      RbVmomi::VIM::VirtualMachineDeviceRuntimeInfo(
-        dynamicProperty: [],
-        key: 4001,
-        runtimeState: RbVmomi::VIM::VirtualMachineDeviceRuntimeInfoVirtualEthernetCardRuntimeState(
-          dynamicProperty: [],
-          vmDirectPathGen2Active: false,
-          vmDirectPathGen2InactiveReasonOther: ["vmNptIncompatibleHost"],
-          vmDirectPathGen2InactiveReasonVm: []
-        )
-      )],
       dynamicProperty: [],
       faultToleranceState: "notConfigured",
-      host: RbVmomi::VIM::HostSystem(nil, "host-32"),
+      host: VIM::HostSystem(nil, "host-32"),
       maxCpuUsage: 5612,
       maxMemoryUsage: 3072,
       memoryOverhead: 128671744,
@@ -291,21 +261,7 @@ end
     )
 
     check <<-EOS, obj, 'VirtualMachineRuntimeInfo'
-<val xsi:type="VirtualMachineRuntimeInfo" xmlns:xsi="#{RbVmomi::Soap::NS_XSI}">
-  <device>
-    <runtimeState xsi:type="VirtualMachineDeviceRuntimeInfoVirtualEthernetCardRuntimeState">
-      <vmDirectPathGen2Active>false</vmDirectPathGen2Active>
-      <vmDirectPathGen2InactiveReasonVm>vmNptIncompatibleAdapterType</vmDirectPathGen2InactiveReasonVm>
-    </runtimeState>
-    <key>4000</key>
-  </device>
-  <device>
-    <runtimeState xsi:type="VirtualMachineDeviceRuntimeInfoVirtualEthernetCardRuntimeState">
-      <vmDirectPathGen2Active>false</vmDirectPathGen2Active>
-      <vmDirectPathGen2InactiveReasonOther>vmNptIncompatibleHost</vmDirectPathGen2InactiveReasonOther>
-    </runtimeState>
-    <key>4001</key>
-  </device>
+<val xsi:type="VirtualMachineRuntimeInfo" xmlns:xsi="#{VIM::NS_XSI}">
   <host type="HostSystem">host-32</host>
   <connectionState>connected</connectionState>
   <powerState>poweredOn</powerState>

data/test/test_emit_request.rb

@@ -1,23 +1,26 @@
 require 'test/unit'
 require 'rbvmomi'
-include RbVmomi
+VIM ||= RbVmomi::VIM
 
 class EmitRequestTest < Test::Unit::TestCase
   MO = VIM::VirtualMachine(nil, "foo")
 
   def check desc, str, this, params
-    soap = RbVmomi::Soap.new(ns: 'urn:vim25', rev: '4.0')
+    soap = VIM.new(ns: 'urn:vim25', rev: '4.0')
     xml = Builder::XmlMarkup.new :indent => 2
     soap.emit_request xml, 'root', desc, this, params
 
-    puts "expected:"
-    puts str
-    puts
-    puts "got:"
-    puts xml.target!
-    puts
-
-    assert_equal str, xml.target!
+    begin
+      assert_equal str, xml.target!
+    rescue MiniTest::Assertion
+      puts "expected:"
+      puts str
+      puts
+      puts "got:"
+      puts xml.target!
+      puts
+      raise
+    end
   end
 
   def test_string_array

data/test/test_exceptions.rb

@@ -0,0 +1,16 @@
+require 'test/unit'
+require 'rbvmomi'
+VIM ||= RbVmomi::VIM
+
+class ExceptionTest < Test::Unit::TestCase
+  def test_fault
+    begin
+      fault = VIM::InvalidArgument.new invalidProperty: 'foo'
+      assert_raises RbVmomi::Fault do
+        raise RbVmomi::Fault.new('A specified parameter was not correct.', fault)
+      end
+    rescue VIM::InvalidArgument
+      assert_equal 'foo', $!.invalidProperty
+    end
+  end
+end

data/test/test_parse_response.rb

@@ -1,19 +1,11 @@
 require 'test/unit'
 require 'rbvmomi'
-include RbVmomi
+VIM ||= RbVmomi::VIM
 
 class ParseResponseTest < Test::Unit::TestCase
   def check desc, str, expected
-    soap = RbVmomi::Soap.new(ns: 'urn:vim25', rev: '4.0')
+    soap = VIM.new(ns: 'urn:vim25', rev: '4.0')
     got = soap.parse_response Nokogiri(str).root, desc
-
-    puts "expected:"
-    pp expected
-    puts
-    puts "got:"
-    pp got
-    puts
-
     assert_equal expected, got
   end
 

data/test/test_serialization.rb

@@ -1,21 +1,24 @@
 require 'test/unit'
 require 'rbvmomi'
-include RbVmomi
+VIM ||= RbVmomi::VIM
 
 class SerializationTest < Test::Unit::TestCase
   def check str, obj, type, array=false
-    @soap = RbVmomi::Soap.new(ns: 'urn:vim25', rev: '4.0')
+    @soap = VIM.new(ns: 'urn:vim25', rev: '4.0')
     xml = Builder::XmlMarkup.new :indent => 2
-    soap.obj2xml(xml, 'root', type, array, obj)
+    @soap.obj2xml(xml, 'root', type, array, obj)
 
-    puts "expected:"
-    puts str
-    puts
-    puts "got:"
-    puts xml.target!
-    puts
-
-    assert_equal str, xml.target!
+    begin
+      assert_equal str, xml.target!
+    rescue MiniTest::Assertion
+      puts "expected:"
+      puts str
+      puts
+      puts "got:"
+      puts xml.target!
+      puts
+      raise
+    end
   end
 
   def test_moref

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rbvmomi
 version: !ruby/object:Gem::Version 
-  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 2
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors: 
 - Rich Lane
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-11 00:00:00 -08:00
+date: 2011-02-20 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 5
         segments: 
         - 1
         - 4
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -56,7 +53,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -70,7 +66,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -84,25 +79,44 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.md
+- README.rdoc
 files: 
-- .gitignore
+- .yardopts
 - LICENSE
-- README.md
+- README.rdoc
 - Rakefile
 - VERSION
 - devel/analyze-vim-declarations.rb
 - devel/analyze-xml.rb
+- examples/create_vm.rb
+- examples/extraConfig.rb
+- examples/power.rb
+- examples/readme-1.rb
+- examples/readme-2.rb
 - lib/rbvmomi.rb
-- lib/rbvmomi/extensions.rb
-- lib/rbvmomi/profile.rb
+- lib/rbvmomi/basic_types.rb
+- lib/rbvmomi/connection.rb
+- lib/rbvmomi/fault.rb
+- lib/rbvmomi/trivial_soap.rb
 - lib/rbvmomi/trollop.rb
-- lib/rbvmomi/types.rb
-- lib/trivial_soap.rb
-- test/runner.rb
-- test/test.rb
+- lib/rbvmomi/type_loader.rb
+- lib/rbvmomi/vim.rb
+- lib/rbvmomi/vim/ComputeResource.rb
+- lib/rbvmomi/vim/Datacenter.rb
+- lib/rbvmomi/vim/Datastore.rb
+- lib/rbvmomi/vim/Folder.rb
+- lib/rbvmomi/vim/ManagedEntity.rb
+- lib/rbvmomi/vim/ManagedObject.rb
+- lib/rbvmomi/vim/ObjectContent.rb
+- lib/rbvmomi/vim/ObjectUpdate.rb
+- lib/rbvmomi/vim/OvfManager.rb
+- lib/rbvmomi/vim/ResourcePool.rb
+- lib/rbvmomi/vim/ServiceInstance.rb
+- lib/rbvmomi/vim/Task.rb
+- lib/rbvmomi/vim/VirtualMachine.rb
 - test/test_deserialization.rb
 - test/test_emit_request.rb
+- test/test_exceptions.rb
 - test/test_parse_response.rb
 - test/test_serialization.rb
 - vmodl.cdb
@@ -111,8 +125,8 @@ homepage: https://github.com/rlane/rbvmomi
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -120,7 +134,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 49
       segments: 
       - 1
       - 9
@@ -131,7 +144,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -143,9 +155,13 @@ signing_key:
 specification_version: 3
 summary: Ruby interface to the VI API
 test_files: 
-- test/runner.rb
-- test/test_serialization.rb
-- test/test.rb
+- examples/create_vm.rb
+- examples/extraConfig.rb
+- examples/power.rb
+- examples/readme-1.rb
+- examples/readme-2.rb
 - test/test_deserialization.rb
-- test/test_parse_response.rb
 - test/test_emit_request.rb
+- test/test_exceptions.rb
+- test/test_parse_response.rb
+- test/test_serialization.rb