rbvmomi 1.4.0 → 1.5.0

data/README.rdoc

@@ -22,7 +22,7 @@ A simple example of turning on a VM:
     vm = dc.find_vm("myvm") or fail "VM not found"
     vm.PowerOnVM_Task.wait_for_completion
 
-This code uses several RbVmomi extensions to the VI API for concision. The
+This code uses several RbVmomi extensions to the vSphere API for concision. The
 expanded snippet below uses only standard API calls and should be familiar to
 users of the Java SDK:
 
@@ -75,4 +75,4 @@ write something generally useful please send it to me and I'll add it in.
 == Development
 
 Fork the project on Github and send me a merge request, or send a patch to
-rlane@vmware.com.
+rlane@vmware.com. RbVmomi developers hang out in #rbvmomi on Freenode.

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.5.0

data/devel/benchmark.rb

@@ -0,0 +1,117 @@
+#!/usr/bin/env ruby
+require 'tempfile'
+
+if ENV['RBVMOMI_COVERAGE'] == '1'
+  require 'simplecov'
+  SimpleCov.start
+end
+
+require 'rbvmomi'
+require 'rbvmomi/deserialization'
+require 'benchmark'
+require 'libxml'
+
+NS_XSI = 'http://www.w3.org/2001/XMLSchema-instance'
+
+VIM = RbVmomi::VIM
+$conn = VIM.new(:ns => 'urn:vim25', :rev => '4.0')
+raw = File.read(ARGV[0])
+
+def diff a, b
+  a_io = Tempfile.new 'rbvmomi-diff-a'
+  b_io = Tempfile.new 'rbvmomi-diff-b'
+  PP.pp a, a_io
+  PP.pp b, b_io
+  a_io.close
+  b_io.close
+  system("diff -u #{a_io.path} #{b_io.path}")
+  a_io.unlink
+  b_io.unlink
+end
+
+begin
+  deserializer = RbVmomi::OldDeserializer.new($conn)
+  end_time = Time.now + 1
+  n = 0
+  while n == 0 or end_time > Time.now
+    deserializer.deserialize Nokogiri::XML(raw).root
+    n += 1
+  end
+  N = n*10
+end
+
+puts "iterations: #{N}"
+
+parsed_nokogiri = Nokogiri::XML(raw)
+parsed_libxml = LibXML::XML::Parser.string(raw).parse
+
+if true
+  nokogiri_xml = parsed_nokogiri.root
+  libxml_xml = parsed_libxml.root
+
+  old_nokogiri_result = RbVmomi::OldDeserializer.new($conn).deserialize nokogiri_xml
+  new_nokogiri_result = RbVmomi::NewDeserializer.new($conn).deserialize nokogiri_xml
+  new_libxml_result = RbVmomi::NewDeserializer.new($conn).deserialize libxml_xml
+
+  if new_nokogiri_result != old_nokogiri_result
+    puts "new_nokogiri_result doesnt match old_nokogiri_result"
+    puts "old_nokogiri_result:"
+    pp old_nokogiri_result
+    puts "new_nokogiri_result:"
+    pp new_nokogiri_result
+    puts "diff:"
+    diff old_nokogiri_result, new_nokogiri_result
+    exit 1
+  end
+
+  if new_libxml_result != old_nokogiri_result
+    puts "new_libxml_result doesnt match old_nokogiri_result"
+    puts "old_nokogiri_result:"
+    pp old_nokogiri_result
+    puts "new_libxml_result:"
+    pp new_libxml_result
+    puts "diff:"
+    diff old_nokogiri_result, new_libxml_result
+    exit 1
+  end
+
+  puts "all results match"
+end
+
+Benchmark.bmbm do|b|
+  GC.start
+  b.report("nokogiri parsing") do
+    N.times { Nokogiri::XML(raw) }
+  end
+  
+  GC.start
+  b.report("libxml parsing") do
+    N.times do
+      LibXML::XML::Parser.string(raw).parse
+    end
+  end
+  
+  GC.start
+  b.report("old deserialization (nokogiri)") do
+    deserializer = RbVmomi::OldDeserializer.new($conn)
+    N.times do
+      deserializer.deserialize Nokogiri::XML(raw).root
+    end
+  end
+
+  GC.start
+  b.report("new deserialization (nokogiri)") do
+    deserializer = RbVmomi::NewDeserializer.new($conn)
+    N.times do
+      deserializer.deserialize Nokogiri::XML(raw).root
+    end
+  end
+
+  GC.start
+  b.report("new deserialization (libxml)") do
+    deserializer = RbVmomi::NewDeserializer.new($conn)
+    N.times do
+      deserializer.deserialize LibXML::XML::Parser.string(raw).parse.root
+    end
+  end
+end

data/devel/collisions.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# Find collisions between VMODL property names and Ruby methods
+require 'rbvmomi'
+VIM = RbVmomi::VIM
+
+conn = VIM.new(:ns => 'urn:vim25', :rev => '4.0')
+
+VIM.loader.typenames.each do |name|
+  klass = VIM.loader.get name
+  next unless klass.respond_to? :kind and [:managed, :data].member? klass.kind
+  methods = klass.kind == :managed ?
+    RbVmomi::BasicTypes::ObjectWithMethods.instance_methods : 
+    RbVmomi::BasicTypes::ObjectWithProperties.instance_methods
+  klass.props_desc.each do |x|
+    name = x['name']
+    puts "collision: #{klass}##{name}" if methods.member? name.to_sym
+  end
+end

data/devel/merge-internal-vmodl.rb

@@ -7,6 +7,11 @@ internal_vmodl_filename = ARGV[1] or abort "internal vmodl filename required"
 output_vmodl_filename = ARGV[2] or abort "output vmodl filename required"
 
 TYPES = %w(
+DVSKeyedOpaqueData
+DVSOpaqueDataConfigSpec
+DVPortgroupSelection
+DVPortSelection
+DVSSelection
 DynamicTypeEnumTypeInfo
 DynamicTypeMgrAllTypeInfo
 DynamicTypeMgrAnnotation
@@ -27,9 +32,11 @@ ReflectManagedMethodExecuter
 ReflectManagedMethodExecuterSoapArgument
 ReflectManagedMethodExecuterSoapFault
 ReflectManagedMethodExecuterSoapResult
+SelectionSet
 )
 
 METHODS = %w(
+DistributedVirtualSwitchManager.UpdateDvsOpaqueData_Task
 HostSystem.RetrieveDynamicTypeManager
 HostSystem.RetrieveManagedMethodExecuter
 )

data/lib/rbvmomi/basic_types.rb

@@ -1,10 +1,11 @@
 # Copyright (c) 2010 VMware, Inc.  All Rights Reserved.
 require 'pp'
+require 'set'
 
 module RbVmomi
 module BasicTypes
 
-BUILTIN = %w(ManagedObject DataObject TypeName PropertyPath ManagedObjectReference MethodName MethodFault LocalizedMethodFault KeyValue)
+BUILTIN = Set.new %w(ManagedObject DataObject TypeName PropertyPath ManagedObjectReference MethodName MethodFault LocalizedMethodFault KeyValue)
 
 class Base
   class << self
@@ -36,6 +37,10 @@ class ObjectWithProperties < Base
       end
     end
 
+    def full_props_set
+      @full_props_set ||= Set.new(full_props_desc.map { |x| x['name'] })
+    end
+
     def full_props_desc
       @full_props_desc ||= (self == ObjectWithProperties ? [] : superclass.full_props_desc) + props_desc
     end
@@ -83,11 +88,19 @@ end
 class DataObject < ObjectWithProperties
   attr_reader :props
 
+  def self.kind; :data end
+
   def initialize props={}
+    # Deserialization fast path
+    if props == nil
+      @props = {}
+      return
+    end
+
     @props = Hash[props.map { |k,v| [k.to_sym, v] }]
-    self.class.full_props_desc.each do |desc|
+    #self.class.full_props_desc.each do |desc|
       #fail "missing required property #{desc['name'].inspect} of #{self.class.wsdl_name}" if @props[desc['name'].to_sym].nil? and not desc['is-optional']
-    end
+    #end
     @props.each do |k,v|
       fail "unexpected property name #{k}" unless self.class.find_prop_desc(k)
     end
@@ -148,6 +161,8 @@ class DataObject < ObjectWithProperties
 end
 
 class ManagedObject < ObjectWithMethods
+  def self.kind; :managed end
+
   def initialize connection, ref
     super()
     @connection = connection
@@ -222,6 +237,8 @@ class Enum < Base
     end
   end
 
+  def self.kind; :enum end
+
   attr_reader :value
 
   def initialize value

data/lib/rbvmomi/connection.rb

@@ -1,9 +1,11 @@
 # Copyright (c) 2010 VMware, Inc.  All Rights Reserved.
 require 'time'
+require 'date'
 require 'rbvmomi/trivial_soap'
 require 'rbvmomi/basic_types'
 require 'rbvmomi/fault'
 require 'rbvmomi/type_loader'
+require 'rbvmomi/deserialization'
 
 module RbVmomi
 
@@ -15,12 +17,24 @@ class Connection < TrivialSoap
   NS_XSI = 'http://www.w3.org/2001/XMLSchema-instance'
 
   attr_accessor :rev
-
+  attr_reader :profile
+  attr_reader :profile_summary
+  attr_accessor :profiling
+  attr_reader :deserializer
+  
   def initialize opts
     @ns = opts[:ns] or fail "no namespace specified"
     @rev = opts[:rev] or fail "no revision specified"
+    @deserializer = Deserializer.new self
+    reset_profiling
+    @profiling = false
     super opts
   end
+  
+  def reset_profiling
+    @profile = {}
+    @profile_summary = {:network_latency => 0, :request_emit => 0, :response_parse => 0, :num_calls => 0}
+  end
 
   def emit_request xml, method, descs, this, params
     xml.tag! method, :xmlns => @ns do
@@ -41,7 +55,7 @@ class Connection < TrivialSoap
   def parse_response resp, desc
     if resp.at('faultcode')
       detail = resp.at('detail')
-      fault = detail && xml2obj(detail.children.first, 'MethodFault')
+      fault = detail && @deserializer.deserialize(detail.children.first, 'MethodFault')
       msg = resp.at('faultstring').text
       if fault
         raise RbVmomi::Fault.new(msg, fault)
@@ -51,7 +65,7 @@ class Connection < TrivialSoap
     else
       if desc
         type = desc['is-task'] ? 'Task' : desc['wsdl_type']
-        returnvals = resp.children.select(&:element?).map { |c| xml2obj c, type }
+        returnvals = resp.children.select(&:element?).map { |c| @deserializer.deserialize c, type }
         (desc['is-array'] && !desc['is-task']) ? returnvals : returnvals.first
       else
         nil
@@ -64,89 +78,38 @@ class Connection < TrivialSoap
     fail "parameters must be passed as a hash" unless params.is_a? Hash
     fail unless desc.is_a? Hash
 
-    resp = request "#{@ns}/#{@rev}" do |xml|
+    t1 = Time.now
+    body = soap_envelope do |xml|
       emit_request xml, method, desc['params'], this, params
+    end.target!
+
+    t2 = Time.now
+    resp, resp_size = request "#{@ns}/#{@rev}", body
+
+    t3 = Time.now
+    out = parse_response resp, desc['result']
+    
+    if @profiling
+      t4 = Time.now
+      @profile[method] ||= []
+      profile_info = {
+        :network_latency => (t3 - t2),
+        :request_emit => t2 - t1,
+        :response_parse => t4 - t3,
+        :params => params, 
+        :obj => this, 
+        :backtrace => caller,
+        :request_size => body.length,
+        :response_size => resp_size,
+      }
+      @profile[method] << profile_info
+      @profile_summary[:network_latency] += profile_info[:network_latency]
+      @profile_summary[:response_parse] += profile_info[:response_parse]
+      @profile_summary[:request_emit] += profile_info[:request_emit]
+      @profile_summary[:num_calls] += 1
     end
-
-    parse_response resp, desc['result']
-  end
-
-  def demangle_array_type x
-    case x
-    when 'AnyType' then 'anyType'
-    when 'DateTime' then 'dateTime'
-    when 'Boolean', 'String', 'Byte', 'Short', 'Int', 'Long', 'Float', 'Double' then x.downcase
-    else x
-    end
-  end
-
-  def xml2obj xml, typename
-    if IS_JRUBY
-      type_attr = xml.attribute_nodes.find { |a| a.name == 'type' &&
-                                                 a.namespace &&
-                                                 a.namespace.prefix == 'xsi' }
-    else
-      type_attr = xml.attribute_with_ns('type', NS_XSI)
-    end
-    typename = (type_attr || typename).to_s
-
-    if typename =~ /^ArrayOf/
-      typename = demangle_array_type $'
-      return xml.children.select(&:element?).map { |c| xml2obj c, typename }
-    end
-
-    t = type typename
-    if t <= BasicTypes::DataObject
-      props_desc = t.full_props_desc
-      h = {}
-      props_desc.select { |d| d['is-array'] }.each { |d| h[d['name'].to_sym] = [] }
-      xml.children.each do |c|
-        next unless c.element?
-        field = c.name.to_sym
-        d = t.find_prop_desc(field.to_s) or next
-        o = xml2obj c, d['wsdl_type']
-        if h[field].is_a? Array
-          h[field] << o
-        else
-          h[field] = o
-        end
-      end
-      t.new h
-    elsif t == BasicTypes::ManagedObjectReference
-      type(xml['type']).new self, xml.text
-    elsif t <= BasicTypes::ManagedObject
-      type(xml['type'] || t.wsdl_name).new self, xml.text
-    elsif t <= BasicTypes::Enum
-      xml.text
-    elsif t <= BasicTypes::KeyValue
-      h = {}
-      xml.children.each do |c|
-        next unless c.element?
-        h[c.name] = c.text
-      end
-      [h['key'], h['value']]
-    elsif t <= String
-      xml.text
-    elsif t <= Symbol
-      xml.text.to_sym
-    elsif t <= Integer
-      xml.text.to_i
-    elsif t <= Float
-      xml.text.to_f
-    elsif t <= Time
-      Time.parse xml.text
-    elsif t == BasicTypes::Boolean
-      xml.text == 'true' || xml.text == '1'
-    elsif t == BasicTypes::Binary
-      xml.text.unpack('m')[0]
-    elsif t == BasicTypes::AnyType
-      fail "attempted to deserialize an AnyType"
-    else fail "unexpected type #{t.inspect}"
-    end
-  rescue
-    $stderr.puts "#{$!.class} while deserializing #{xml.name} (#{typename}):"
-    $stderr.puts xml.to_s
-    raise
+    
+    out
   end
 
   # hic sunt dracones
@@ -207,7 +170,10 @@ class Connection < TrivialSoap
       xml.tag! name, o.to_s, attrs
     when DateTime
       attrs['xsi:type'] = 'xsd:dateTime' if expected == BasicTypes::AnyType
-      xml.tag! name, o.to_s, attrs
+      xml.tag! name, o.strftime('%FT%T%:z'), attrs
+    when Time
+      attrs['xsi:type'] = 'xsd:dateTime' if expected == BasicTypes::AnyType
+      xml.tag! name, o.iso8601, attrs
     else fail "unexpected object class #{o.class}"
     end
     xml
@@ -230,7 +196,7 @@ class Connection < TrivialSoap
     when :base64Binary then BasicTypes::Binary
     when :KeyValue then BasicTypes::KeyValue
     else
-      if @loader.has_type? name
+      if @loader.has? name
         const_get(name)
       else
         fail "no such type #{name.inspect}"
@@ -252,25 +218,25 @@ protected
 
   def self.const_missing sym
     name = sym.to_s
-    if @loader and @loader.has_type? name
-      @loader.load_type name
-      const_get sym
+    if @loader and @loader.has? name
+      @loader.get(name)
     else
       super
     end
   end
 
   def self.method_missing sym, *a
-    if @loader and @loader.has_type? sym.to_s
-      const_get(sym).new(*a)
+    name = sym.to_s
+    if @loader and @loader.has? name
+      @loader.get(name).new(*a)
     else
       super
     end
   end
 
   def self.load_vmodl fn
-    @loader = RbVmomi::TypeLoader.new self, fn
-    @loader.init
+    @loader = RbVmomi::TypeLoader.new fn, extension_dirs, self
+    nil
   end
 end