gapinc-rbvmomi 1.6.0

data/lib/rbvmomi/basic_types.rb

@@ -0,0 +1,373 @@
+# Copyright (c) 2010 VMware, Inc.  All Rights Reserved.
+require 'pp'
+require 'set'
+
+module RbVmomi
+module BasicTypes
+
+BUILTIN = Set.new %w(ManagedObject DataObject TypeName PropertyPath ManagedObjectReference MethodName MethodFault LocalizedMethodFault KeyValue)
+
+class Base
+  class << self
+    attr_accessor :wsdl_name
+
+    def init wsdl_name=self.name
+      @wsdl_name = wsdl_name
+    end
+
+    def to_s
+      @wsdl_name
+    end
+  end
+
+  init
+end
+
+class ObjectWithProperties < Base
+  class << self
+    attr_accessor :props_desc
+
+    def init name=self.name, props=[]
+      super name
+      @props_desc = props
+      @props_desc.each do |d|
+        sym = d['name'].to_sym
+        define_method(sym) { _get_property sym }
+        define_method(:"#{sym}=") { |x| _set_property sym, x }
+      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
+
+    def find_prop_desc name
+      full_props_desc.find { |x| x['name'] == name.to_s }
+    end
+  end
+
+  def _get_property sym
+    fail 'unimplemented'
+  end
+
+  def _set_property sym, val
+    fail 'unimplemented'
+  end
+
+  init
+end
+
+class ObjectWithMethods < ObjectWithProperties
+  class << self
+    attr_accessor :methods_desc
+
+    def init name=self.name, props=[], methods={}
+      super name, props
+      @methods_desc = methods
+
+      @methods_desc.each do |k,d|
+        sym = k.to_sym
+        define_method(sym) { |*args| _call sym, *args }
+        define_method(:"#{sym}!") { |*args| _call sym, *args }
+      end
+    end
+
+    # XXX cache
+    def full_methods_desc
+      (self == ObjectWithMethods ? {} : superclass.full_methods_desc).merge methods_desc
+    end
+  end
+
+  init
+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|
+      #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
+    @props.each do |k,v|
+      fail "unexpected property name #{k}" unless self.class.find_prop_desc(k)
+    end
+  end
+
+  def initialize_copy(source)  
+    super  
+    @props = @props.dup  
+  end 
+
+  def _get_property sym
+    @props[sym]
+  end
+
+  def [] sym
+    _get_property sym
+  end
+
+  def _set_property sym, val
+    @props[sym] = val
+  end
+
+  def []= sym, val
+    _set_property sym, val
+  end
+
+  def == o
+    return false unless o.class == self.class
+    keys = (props.keys + o.props.keys).uniq
+    keys.all? { |k| props[k] == o.props[k] }
+  end
+
+  alias eql? ==
+
+  def hash
+    props.hash
+  end
+
+  def pretty_print q
+    q.text self.class.wsdl_name
+    q.group 2 do
+      q.text '('
+      q.breakable
+      props = @props.sort_by { |k,v| k.to_s }
+      q.seplist props, nil, :each do |e|
+        k, v = e
+        q.group do
+          q.text k.to_s
+          q.text ': '
+          q.pp v
+        end
+      end
+    end
+    q.breakable
+    q.text ')'
+  end
+
+  init
+end
+
+class ManagedObject < ObjectWithMethods
+  def self.kind; :managed end
+
+  def initialize connection, ref
+    super()
+    @connection = connection
+    @soap = @connection # XXX deprecated
+    @ref = ref
+  end
+
+  def _connection
+    @connection
+  end
+
+  def _ref
+    @ref
+  end
+
+  def _get_property sym
+    ret = @connection.propertyCollector.RetrieveProperties(:specSet => [{
+      :propSet => [{ :type => self.class.wsdl_name, :pathSet => [sym.to_s] }],
+      :objectSet => [{ :obj => self }],
+    }])[0]
+
+    if ret.propSet.empty?
+      return nil if ret.missingSet.empty?
+      raise ret.missingSet[0].fault
+    else
+      ret.propSet[0].val
+    end
+  end
+
+  def _set_property sym, val
+    fail 'unimplemented'
+  end
+
+  def _call method, o={}
+    fail "parameters must be passed as a hash" unless o.is_a? Hash
+    desc = self.class.full_methods_desc[method.to_s] or fail "unknown method"
+    @connection.call method, desc, self, o
+  end
+
+  def to_s
+    "#{self.class.wsdl_name}(#{@ref.inspect})"
+  end
+
+  def pretty_print pp
+    pp.text to_s
+  end
+
+  def [] k
+    _get_property k
+  end
+
+  def == x
+    out = (x.class == self.class && x._ref == @ref) 
+    out = (out && x._connection.instanceUuid == self._connection.instanceUuid)
+    out
+  end
+
+  alias eql? ==
+
+  def hash
+    [self.class, @ref].hash
+  end
+
+  init 'ManagedObject'
+end
+
+class Enum < Base
+  class << self
+    attr_accessor :values
+
+    def init name=self.name, values=[]
+      super name
+      @values = values
+    end
+  end
+
+  def self.kind; :enum end
+
+  attr_reader :value
+
+  def initialize value
+    @value = value
+  end
+
+  init
+end
+
+class MethodFault < DataObject
+  init 'MethodFault', [
+    {
+      'name' => 'faultCause',
+      'wsdl_type' => 'LocalizedMethodFault',
+      'is-array' => false,
+      'is-optional' => true,
+    }, {
+      'name' => 'faultMessage',
+      'wsdl_type' => 'LocalizableMessage',
+      'is-array' => true,
+      'is-optional' => true,
+    },
+  ]
+
+  def self.=== exn
+    exn.class == RbVmomi::Fault and self <= exn.fault.class
+  end
+end
+
+class LocalizedMethodFault < DataObject
+  init 'LocalizedMethodFault', [
+    {
+      'name' => 'fault',
+      'wsdl_type' => 'MethodFault',
+      'is-array' => false,
+      'is-optional' => false,
+    }, {
+      'name' => 'localizedMessage',
+      'wsdl_type' => 'xsd:string',
+      'is-array' => false,
+      'is-optional' => true,
+    },
+  ]
+
+  def exception
+    RbVmomi::Fault.new(self.localizedMessage, self.fault)
+  end
+end
+
+class RuntimeFault < MethodFault
+  init
+end
+
+class MethodName < String
+  def self.wsdl_name; 'MethodName' end
+end
+
+class PropertyPath < String
+  def self.wsdl_name; 'PropertyPath' end
+end
+
+class TypeName < String
+  def self.wsdl_name; 'TypeName' end
+end
+
+class ManagedObjectReference
+  def self.wsdl_name; 'ManagedObjectReference' end
+end
+
+class Boolean
+  def self.wsdl_name; 'xsd:boolean' end
+end
+
+class AnyType
+  def self.wsdl_name; 'xsd:anyType' end
+end
+
+class Binary
+  def self.wsdl_name; 'xsd:base64Binary' end
+end
+
+class ::Class
+  def wsdl_name; self.class.name end
+end
+
+class ::String
+  def self.wsdl_name; 'xsd:string' end
+end
+
+class ::Integer
+  def self.wsdl_name; 'xsd:int' end
+end
+
+class ::Float
+  def self.wsdl_name; 'xsd:float' end
+end
+
+class Int
+  def self.wsdl_name; 'xsd:int' end
+  
+  def initialize x
+    @val = x
+  end
+  
+  def to_s
+    @val.to_s
+  end
+end
+
+class KeyValue
+  def self.wsdl_name; 'KeyValue' end
+  attr_accessor :key, :value
+
+  def initialize k, v
+    @key = k
+    @value = v
+  end
+
+  def [] i
+    if i == 0 then @key
+    elsif i == 1 then @value
+    else fail "invalid index #{i.inspect}"
+    end
+  end
+end
+
+
+end
+end

data/lib/rbvmomi/connection.rb

@@ -0,0 +1,268 @@
+# 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
+
+IS_JRUBY = RUBY_PLATFORM == 'java'
+
+class DeserializationFailed < Exception; end
+
+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
+      obj2xml xml, '_this', 'ManagedObject', false, this
+      descs.each do |d|
+        k = d['name']
+        k = k.to_sym if !params.member?(k) && params.member?(k.to_sym)
+        v = params[k]
+        if not v == nil
+          obj2xml xml, d['name'], d['wsdl_type'], d['is-array'], v
+        else
+          fail "missing required parameter #{d['name']}" unless d['is-optional']
+        end
+      end
+    end
+  end
+
+  def parse_response resp, desc
+    if resp.at('faultcode')
+      detail = resp.at('detail')
+      fault = detail && @deserializer.deserialize(detail.children.first, 'MethodFault')
+      msg = resp.at('faultstring').text
+      if fault
+        raise RbVmomi::Fault.new(msg, fault)
+      else
+        fail "#{resp.at('faultcode').text}: #{msg}"
+      end
+    else
+      if desc
+        type = desc['is-task'] ? 'Task' : desc['wsdl_type']
+        returnvals = resp.children.select(&:element?).map { |c| @deserializer.deserialize c, type }
+        (desc['is-array'] && !desc['is-task']) ? returnvals : returnvals.first
+      else
+        nil
+      end
+    end
+  end
+
+  def call method, desc, this, params
+    fail "this is not a managed object" unless this.is_a? BasicTypes::ManagedObject
+    fail "parameters must be passed as a hash" unless params.is_a? Hash
+    fail unless desc.is_a? Hash
+
+    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
+    
+    out
+  end
+
+  # hic sunt dracones
+  def obj2xml xml, name, type, is_array, o, attrs={}
+    expected = type(type)
+    fail "expected array, got #{o.class.wsdl_name}" if is_array and not (o.is_a? Array or (o.is_a? Hash and expected == BasicTypes::KeyValue))
+    case o
+    when Array, BasicTypes::KeyValue
+      if o.is_a? BasicTypes::KeyValue and expected != BasicTypes::KeyValue
+        fail "expected #{expected.wsdl_name}, got KeyValue"
+      elsif expected == BasicTypes::KeyValue and not is_array
+        xml.tag! name, attrs do
+          xml.tag! 'key', o[0].to_s
+          xml.tag! 'value', o[1].to_s
+        end
+      else
+        fail "expected #{expected.wsdl_name}, got array" unless is_array
+        o.each do |e|
+          obj2xml xml, name, expected.wsdl_name, false, e, attrs
+        end
+      end
+    when BasicTypes::ManagedObject
+      fail "expected #{expected.wsdl_name}, got #{o.class.wsdl_name} for field #{name.inspect}" if expected and not expected >= o.class and not expected == BasicTypes::AnyType
+      xml.tag! name, o._ref, :type => o.class.wsdl_name
+    when BasicTypes::DataObject
+      fail "expected #{expected.wsdl_name}, got #{o.class.wsdl_name} for field #{name.inspect}" if expected and not expected >= o.class and not expected == BasicTypes::AnyType
+      xml.tag! name, attrs.merge("xsi:type" => o.class.wsdl_name) do
+        o.class.full_props_desc.each do |desc|
+          if o.props.member? desc['name'].to_sym
+            v = o.props[desc['name'].to_sym]
+            next if v.nil?
+            obj2xml xml, desc['name'], desc['wsdl_type'], desc['is-array'], v
+          end
+        end
+      end
+    when BasicTypes::Enum
+      xml.tag! name, o.value.to_s, attrs
+    when Hash
+      if expected == BasicTypes::KeyValue and is_array
+        obj2xml xml, name, type, is_array, o.to_a, attrs
+      else
+        fail "expected #{expected.wsdl_name}, got a hash" unless expected <= BasicTypes::DataObject
+        obj2xml xml, name, type, false, expected.new(o), attrs
+      end
+    when true, false
+      fail "expected #{expected.wsdl_name}, got a boolean" unless [BasicTypes::Boolean, BasicTypes::AnyType].member? expected
+      attrs['xsi:type'] = 'xsd:boolean' if expected == BasicTypes::AnyType
+      xml.tag! name, (o ? '1' : '0'), attrs
+    when Symbol, String
+      if expected == BasicTypes::Binary
+        attrs['xsi:type'] = 'xsd:base64Binary' if expected == BasicTypes::AnyType
+        xml.tag! name, [o].pack('m').chomp.gsub("\n", ""), attrs
+      else
+        attrs['xsi:type'] = 'xsd:string' if expected == BasicTypes::AnyType
+        xml.tag! name, o.to_s, attrs
+      end
+    when Integer
+      attrs['xsi:type'] = 'xsd:long' if expected == BasicTypes::AnyType
+      xml.tag! name, o.to_s, attrs
+    when Float
+      attrs['xsi:type'] = 'xsd:double' if expected == BasicTypes::AnyType
+      xml.tag! name, o.to_s, attrs
+    when DateTime
+      attrs['xsi:type'] = 'xsd:dateTime' if expected == BasicTypes::AnyType
+      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
+    when BasicTypes::Int
+      attrs['xsi:type'] = 'xsd:int'
+      xml.tag! name, o.to_s, attrs
+    else fail "unexpected object class #{o.class}"
+    end
+    xml
+  rescue
+    $stderr.puts "#{$!.class} while serializing #{name} (#{type}):"
+    PP.pp o, $stderr
+    raise
+  end
+
+  def self.type name
+    fail unless name and (name.is_a? String or name.is_a? Symbol)
+    name = $' if name.to_s =~ /^xsd:/
+    case name.to_sym
+    when :anyType then BasicTypes::AnyType
+    when :boolean then BasicTypes::Boolean
+    when :string then String
+    when :int, :long, :short, :byte then Integer
+    when :float, :double then Float
+    when :dateTime then Time
+    when :base64Binary then BasicTypes::Binary
+    when :KeyValue then BasicTypes::KeyValue
+    else
+      first_char = name[0].chr
+      if first_char.downcase == first_char
+        name = "%s%s" % [first_char.upcase, name[1..-1]]
+      end
+
+      if @loader.has? name
+        const_get(name)
+      else
+        fail "no such type #{name.inspect}"
+      end
+    end
+  end
+
+  def type name
+    self.class.type name
+  end
+  
+  def instanceUuid
+    nil
+  end
+
+  def self.extension_dirs
+    @extension_dirs ||= []
+  end
+
+  def self.add_extension_dir dir
+    extension_dirs << dir
+    @loader.reload_extensions_dir dir if @loader
+  end
+
+  def self.reload_extensions
+    @loader.reload_extensions
+  end
+
+  def self.loader; @loader; end
+
+protected
+
+  def self.const_missing sym
+    name = sym.to_s
+    if @loader and @loader.has? name
+      @loader.get(name)
+    else
+      super
+    end
+  end
+
+  def self.method_missing sym, *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 fn, extension_dirs, self
+    nil
+  end
+end
+
+end