rbvmomi2 3.0.0

data/lib/rbvmomi/connection.rb

@@ -0,0 +1,272 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+require 'time'
+require 'date'
+require_relative 'trivial_soap'
+require_relative 'basic_types'
+require_relative 'fault'
+require_relative 'type_loader'
+require_relative '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 for '#{name}', 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} for '#{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} for '#{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} for '#{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
+      if expected and not expected >= o.class and not expected == BasicTypes::AnyType
+        fail "expected #{expected.wsdl_name} for '#{name}', got #{o.class.wsdl_name} for field #{name.inspect}"
+      end
+      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} for '#{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} for '#{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} for '#{name}'"
+    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

data/lib/rbvmomi/deserialization.rb

@@ -0,0 +1,249 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+require 'time'
+
+module RbVmomi
+
+class NewDeserializer
+  NS_XSI = 'http://www.w3.org/2001/XMLSchema-instance'
+
+  DEMANGLED_ARRAY_TYPES = {
+    'AnyType' => 'xsd:anyType',
+    'DateTime' => 'xsd:dateTime',
+  }
+  %w(Boolean String Byte Short Int Long Float Double).each do |x|
+    DEMANGLED_ARRAY_TYPES[x] = "xsd:#{x.downcase}"
+  end
+
+  BUILTIN_TYPE_ACTIONS = {
+    'xsd:string' => :string,
+    'xsd:boolean' => :boolean,
+    'xsd:byte' => :int,
+    'xsd:short' => :int,
+    'xsd:int' => :int,
+    'xsd:long' => :int,
+    'xsd:float' => :float,
+    'xsd:dateTime' => :date,
+    'PropertyPath' => :string,
+    'MethodName' => :string,
+    'TypeName' => :string,
+    'xsd:base64Binary' => :binary,
+    'KeyValue' => :keyvalue,
+  }
+
+  BUILTIN_TYPE_ACTIONS.dup.each do |k,v|
+    if k =~ /^xsd:/
+      BUILTIN_TYPE_ACTIONS[$'] = v
+    end
+  end
+
+  def initialize conn
+    @conn = conn
+    @loader = conn.class.loader
+  end
+
+  def deserialize node, type=nil
+    type_attr = node['type']
+
+    # Work around for 1.5.x which doesn't populate node['type']
+    # XXX what changed
+    if node.attributes['type'] and not type_attr
+      type_attr = node.attributes['type'].value
+    end
+
+    type = type_attr if type_attr
+
+    if action = BUILTIN_TYPE_ACTIONS[type]
+      case action
+      when :string
+        node.content
+      when :boolean
+        node.content == '1' || node.content == 'true'
+      when :int
+        node.content.to_i
+      when :float
+        node.content.to_f
+      when :date
+        leaf_date node
+      when :binary
+        leaf_binary node
+      when :keyvalue
+        leaf_keyvalue node
+      else fail
+      end
+    else
+      if type =~ /:/
+        type = type.split(":", 2)[1]
+      end
+      if type =~ /^ArrayOf/
+        type = DEMANGLED_ARRAY_TYPES[$'] || $'
+        return node.children.select(&:element?).map { |c| deserialize c, type }
+      end
+      if type =~ /:/
+        type = type.split(":", 2)[1]
+      end
+
+      klass = @loader.get(type) or fail "no such type '#{type}'"
+      case klass.kind
+      when :data
+        traverse_data node, klass
+      when :enum
+        node.content
+      when :managed
+        leaf_managed node, klass
+      else fail
+      end
+    end
+  end
+
+  def traverse_data node, klass
+    obj = klass.new nil
+    props = obj.props
+    children = node.children.select(&:element?)
+    i = 0
+
+    klass.full_props_desc.each do |desc|
+      name = desc['name']
+      child_type = desc['wsdl_type']
+
+      # Ignore unknown fields
+      while child = children[i] and not klass.full_props_set.member? child.name
+        i += 1
+      end
+
+      if desc['is-array']
+        a = []
+        while ((child = children[i]) && (child.name == name))
+          child = children[i]
+          a << deserialize(child, child_type)
+          i += 1
+        end
+        props[name.to_sym] = a
+      elsif ((child = children[i]) && (child.name == name))
+        props[name.to_sym] = deserialize(child, child_type)
+        i += 1
+      end
+    end
+
+    obj
+  end
+
+  def leaf_managed node, klass
+    type_attr = node['type']
+    klass = @loader.get(type_attr) if type_attr
+    klass.new(@conn, node.content)
+  end
+
+  def leaf_date node
+    Time.parse node.content
+  end
+
+  def leaf_binary node
+    node.content.unpack('m')[0]
+  end
+
+  # XXX does the value need to be deserialized?
+  def leaf_keyvalue node
+    h = {}
+    node.children.each do |child|
+      next unless child.element?
+      h[child.name] = child.content
+    end
+    [h['key'], h['value']]
+  end
+end
+
+class OldDeserializer
+  NS_XSI = 'http://www.w3.org/2001/XMLSchema-instance'
+
+  def initialize conn
+    @conn = conn
+  end
+
+  def deserialize xml, typename=nil
+    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| deserialize c, typename }
+    end
+
+    t = @conn.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 = deserialize 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
+      @conn.type(xml['type']).new @conn, xml.text
+    elsif t <= BasicTypes::ManagedObject
+      @conn.type(xml['type'] || t.wsdl_name).new @conn, 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} (#{t.ancestors * '/'})"
+    end
+  rescue
+    $stderr.puts "#{$!.class} while deserializing #{xml.name} (#{typename}):"
+    $stderr.puts xml.to_s
+    raise
+  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
+end
+
+if ENV['RBVMOMI_NEW_DESERIALIZER'] == '1' || true # Always use new one now
+  Deserializer = NewDeserializer
+else
+  Deserializer = OldDeserializer
+end
+
+end

data/lib/rbvmomi/fault.rb

@@ -0,0 +1,19 @@
+# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+module RbVmomi
+
+class Fault < StandardError
+  attr_reader :fault
+
+  def initialize msg, fault
+    super "#{fault.class.wsdl_name}: #{msg}"
+    @fault = fault
+  end
+
+  def method_missing *a
+    @fault.send(*a)
+  end
+end
+
+end

data/lib/rbvmomi/optimist.rb

@@ -0,0 +1,72 @@
+# Copyright (c) 2010-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+require 'optimist'
+
+# Convenience methods for Optimist, Ruby's premier option parser.
+# @see http://optimist.rubyforge.org/
+# @see Optimist::Parser
+module Optimist
+
+# Convenience methods for Optimist, Ruby's premier option parser.
+#
+# See the examples directory for sample code.
+# Descriptions are of the form:
+#  <key>: <options> <environment variable> (<default>)
+# @see http://optimist.rubyforge.org/
+class Parser
+  # Options used by VIM.connect
+  #
+  #  !!!plain
+  #  host: -o --host RBVMOMI_HOST
+  #  port: --port RBVMOMI_PORT (443)
+  #  no-ssl: --no-ssl RBVMOMI_SSL (false)
+  #  insecure: -k --insecure RBVMOMI_INSECURE (false)
+  #  user: -u --user RBVMOMI_USER (root)
+  #  password: -p --password RBVMOMI_PASSWORD ()
+  #  path: --path RBVMOMI_PATH (/sdk)
+  #  debug: -d --debug RBVMOMI_DEBUG (false)
+  def rbvmomi_connection_opts
+    opt :host, "host", :type => :string, :short => 'o', :default => ENV['RBVMOMI_HOST']
+    opt :port, "port", :type => :int, :short => :none, :default => (ENV.member?('RBVMOMI_PORT') ? ENV['RBVMOMI_PORT'].to_i : 443)
+    opt :"no-ssl", "don't use ssl", :short => :none, :default => (ENV['RBVMOMI_SSL'] == '0')
+    opt :insecure, "don't verify ssl certificate", :short => 'k', :default => (ENV['RBVMOMI_INSECURE'] == '1')
+    opt :user, "username", :short => 'u', :default => (ENV['RBVMOMI_USER'] || 'root')
+    opt :password, "password", :short => 'p', :default => (ENV['RBVMOMI_PASSWORD'] || '')
+    opt :path, "SOAP endpoint path", :short => :none, :default => (ENV['RBVMOMI_PATH'] || '/sdk')
+    opt :debug, "Log SOAP messages", :short => 'd', :default => (ENV['RBVMOMI_DEBUG'] || false)
+  end
+
+  # Select a datacenter
+  #
+  #  !!!plain
+  #  datacenter: -D --datacenter RBVMOMI_DATACENTER (ha-datacenter)
+  def rbvmomi_datacenter_opt
+    opt :datacenter, "datacenter", :type => :string, :short => "D", :default => (ENV['RBVMOMI_DATACENTER'] || 'ha-datacenter')
+  end
+
+  # Select a folder
+  #
+  #  !!!plain
+  #  folder: -F --folder RBVMOMI_FOLDER ()
+  def rbvmomi_folder_opt
+    opt :folder, "VM folder", :type => :string, :short => "F", :default => (ENV['RBVMOMI_FOLDER'] || '')
+  end
+
+  # Select a compute resource
+  #
+  #  !!!plain
+  #  computer: -R --computer RBVMOMI_COMPUTER
+  def rbvmomi_computer_opt
+    opt :computer, "Compute resource", :type => :string, :short => "R", :default => (ENV['RBVMOMI_COMPUTER']||'ha-compute-res')
+  end
+
+  # Select a datastore
+  #
+  #  !!!plain
+  #  datastore: -s --datastore RBVMOMI_DATASTORE (datastore1)
+  def rbvmomi_datastore_opt
+    opt :datastore, "Datastore", :short => 's', :default => (ENV['RBVMOMI_DATASTORE'] || 'datastore1')
+  end
+end
+end

data/lib/rbvmomi/pbm.rb

@@ -0,0 +1,68 @@
+# Copyright (c) 2012-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+require_relative '../rbvmomi'
+
+module RbVmomi
+
+# A connection to one vSphere ProfileBasedManagement endpoint.
+# @see #serviceInstance
+class PBM < Connection
+  # Connect to a vSphere ProfileBasedManagement endpoint
+  #
+  # @param [VIM] Connection to main vSphere API endpoint
+  # @param [Hash] opts The options hash.
+  # @option opts [String]  :host Host to connect to.
+  # @option opts [Numeric] :port (443) Port to connect to.
+  # @option opts [Boolean] :ssl (true) Whether to use SSL.
+  # @option opts [Boolean] :insecure (false) If true, ignore SSL certificate errors.
+  # @option opts [String]  :path (/pbm/sdk) SDK endpoint path.
+  # @option opts [Boolean] :debug (false) If true, print SOAP traffic to stderr.
+  def self.connect vim, opts = {}
+    fail unless opts.is_a? Hash
+    opts[:host] = vim.host
+    opts[:ssl] = true unless opts.member? :ssl or opts[:"no-ssl"]
+    opts[:insecure] ||= false
+    opts[:port] ||= (opts[:ssl] ? 443 : 80)
+    opts[:path] ||= '/pbm/sdk'
+    opts[:ns] ||= 'urn:pbm'
+    rev_given = opts[:rev] != nil
+    opts[:rev] = '1.0' unless rev_given
+    opts[:debug] = (!ENV['RBVMOMI_DEBUG'].empty? rescue false) unless opts.member? :debug
+
+    new(opts).tap do |pbm|
+      pbm.vcSessionCookie = vim.cookie.split('"')[1]
+    end
+  end
+  
+  def vcSessionCookie= cookie
+    @vcSessionCookie = cookie
+  end
+
+  def rev= x
+    super
+    @serviceContent = nil
+  end
+
+  # Return the ServiceInstance
+  #
+  # The ServiceInstance is the root of the vSphere inventory.
+  def serviceInstance
+    @serviceInstance ||= VIM::PbmServiceInstance self, 'ServiceInstance'
+  end
+
+  # Alias to serviceInstance.PbmRetrieveServiceContent
+  def serviceContent
+    @serviceContent ||= serviceInstance.PbmRetrieveServiceContent
+  end
+
+  # @private
+  def pretty_print pp
+    pp.text "PBM(#{@opts[:host]})"
+  end
+
+  add_extension_dir File.join(File.dirname(__FILE__), "pbm")
+  load_vmodl(ENV['VMODL'] || File.join(File.dirname(__FILE__), "../../vmodl.db"))
+end
+
+end

data/lib/rbvmomi/sms/SmsStorageManager.rb

@@ -0,0 +1,10 @@
+# Copyright (c) 2013-2017 VMware, Inc.  All Rights Reserved.
+# SPDX-License-Identifier: MIT
+
+class RbVmomi::SMS::SmsStorageManager
+
+  def RegisterProvider_Task2 providerSpec
+     self.RegisterProvider_Task providerSpec
+  end
+
+end