rbvmomi 1.0.2 → 1.1.0

data/lib/rbvmomi/connection.rb

@@ -0,0 +1,239 @@
+# Copyright (c) 2010 VMware, Inc.  All Rights Reserved.
+require 'time'
+require 'rbvmomi/trivial_soap'
+require 'rbvmomi/basic_types'
+require 'rbvmomi/fault'
+require 'rbvmomi/type_loader'
+
+module RbVmomi
+
+class DeserializationFailed < Exception; end
+
+class Connection < TrivialSoap
+  NS_XSI = 'http://www.w3.org/2001/XMLSchema-instance'
+
+  attr_accessor :rev
+
+  def initialize opts
+    @ns = opts[:ns] or fail "no namespace specified"
+    @rev = opts[:rev] or fail "no revision specified"
+    super opts
+  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'].to_sym
+        if params.member? k or params.member? k.to_s
+          v = params.member?(k) ? params[k] : params[k.to_s]
+          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 && xml2obj(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| xml2obj c, type }
+        desc['is-array'] ? 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
+
+    resp = request "#{@ns}/#{@rev}" do |xml|
+      emit_request xml, method, desc['params'], this, params
+    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
+    typename = (xml.attribute_with_ns('type', NS_XSI) || 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 <= 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
+  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
+    case o
+    when Array
+      fail "expected #{expected.wsdl_name}, got array" unless is_array
+      o.each do |e|
+        obj2xml xml, name, expected.wsdl_name, false, e, attrs
+      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
+      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
+      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
+      fail "expected #{expected.wsdl_name}, got a hash" unless expected <= BasicTypes::DataObject
+      obj2xml xml, name, type, false, expected.new(o), attrs
+    when true, false
+      fail "expected #{expected.wsdl_name}, got a boolean" unless expected == BasicTypes::Boolean
+      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, 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.to_s, attrs
+    else fail "unexpected object class #{o.class}"
+    end
+    xml
+  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
+    else
+      if @loader.has_type? name
+        const_get(name)
+      else
+        fail "no such type #{name.inspect}"
+      end
+    end
+  end
+
+  def type name
+    self.class.type name
+  end
+
+  def self.extension_path
+    fail "must be implemented in subclass"
+  end
+
+protected
+
+  def self.const_missing sym
+    name = sym.to_s
+    if @loader and @loader.has_type? name
+      @loader.load_type name
+      const_get sym
+    else
+      super
+    end
+  end
+
+  def self.method_missing sym, *a
+    if @loader and @loader.has_type? sym.to_s
+      const_get(sym).new(*a)
+    else
+      super
+    end
+  end
+
+  def self.load_vmodl fn
+    @loader = RbVmomi::TypeLoader.new self, fn
+  end
+end
+
+end

data/lib/rbvmomi/fault.rb

@@ -0,0 +1,17 @@
+# Copyright (c) 2010 VMware, Inc.  All Rights Reserved.
+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/{trivial_soap.rb → rbvmomi/trivial_soap.rb}

@@ -4,18 +4,19 @@ require 'builder'
 require 'nokogiri'
 require 'net/http'
 require 'pp'
-require 'rbvmomi/profile'
 
-class Net::HTTPGenericRequest
-  alias old_exec exec
+module Net
+  class HTTPGenericRequest
+    alias old_exec exec
 
-  def exec sock, ver, path
-    old_exec sock, ver, path
-    sock.io.flush
+    def exec sock, ver, path
+      old_exec sock, ver, path
+      sock.io.flush
+    end
   end
 end
 
-class TrivialSoap
+class RbVmomi::TrivialSoap
   attr_accessor :debug, :cookie
   attr_reader :http
 
@@ -23,21 +24,31 @@ class TrivialSoap
     fail unless opts.is_a? Hash
     @opts = opts
     return unless @opts[:host] # for testcases
+    @debug = @opts[:debug]
+    @cookie = nil
+    @lock = Mutex.new
+    @http = nil
+    restart_http
+  end
+
+  def restart_http
+    @http.finish if @http
     @http = Net::HTTP.new(@opts[:host], @opts[:port], @opts[:proxyHost], @opts[:proxyPort])
     if @opts[:ssl]
       require 'net/https'
       @http.use_ssl = true
-      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE # XXX
+      if @opts[:insecure]
+        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      else
+        @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
       @http.cert = OpenSSL::X509::Certificate.new(@opts[:cert]) if @opts[:cert]
       @http.key = OpenSSL::PKey::RSA.new(@opts[:key]) if @opts[:key]
     end
     @http.set_debug_output(STDERR) if $DEBUG
-    @http.read_timeout = 60
+    @http.read_timeout = 1000000000
     @http.open_timeout = 5
     @http.start
-    @debug = @opts[:debug]
-    @cookie = nil
-    @lock = Mutex.new
   end
 
   def soap_envelope
@@ -65,7 +76,14 @@ class TrivialSoap
     end
 
     start_time = Time.now
-    response = @lock.synchronize { profile(:post) { @http.request_post(@opts[:path], body, headers) } }
+    response = @lock.synchronize do
+      begin
+        @http.request_post(@opts[:path], body, headers)
+      rescue Exception
+        restart_http
+        raise
+      end
+    end
     end_time = Time.now
 
     @cookie = response['set-cookie'] if response.key? 'set-cookie'

data/lib/rbvmomi/trollop.rb

@@ -1,10 +1,13 @@
+# Copyright (c) 2011 VMware, Inc.  All Rights Reserved.
 require 'trollop'
 
-class Trollop::Parser
+module Trollop
+class Parser
   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')
@@ -12,7 +15,7 @@ class Trollop::Parser
   end
 
   def rbvmomi_datacenter_opt
-    opt :datacenter, "datacenter", type: :string, short: "D", default: (ENV['RBVMOMI_DATACENTER'])
+    opt :datacenter, "datacenter", type: :string, short: "D", default: (ENV['RBVMOMI_DATACENTER'] || 'ha-datacenter')
   end
 
   def rbvmomi_folder_opt
@@ -27,3 +30,4 @@ class Trollop::Parser
     opt :datastore, "Datastore", short: 's', default: (ENV['RBVMOMI_DATASTORE'] || 'datastore1')
   end
 end
+end

data/lib/rbvmomi/type_loader.rb

@@ -0,0 +1,72 @@
+# Copyright (c) 2010 VMware, Inc.  All Rights Reserved.
+require 'cdb'
+require 'set'
+
+module RbVmomi
+
+class TypeLoader
+  def initialize target, fn
+    @target = target
+    @db = CDB.new fn
+    @vmodl = Hash.new { |h,k| if e = @db[k] then h[k] = Marshal.load(e) end }
+    @typenames = Set.new(Marshal.load(@db['_typenames']) + BasicTypes::BUILTIN)
+    @target.constants.select { |x| has_type? x.to_s }.each { |x| load_type x.to_s }
+    BasicTypes::BUILTIN.each do |x|
+      target.const_set x, BasicTypes.const_get(x)
+      load_extension x
+    end
+  end
+
+  def has_type? name
+    fail unless name.is_a? String
+    @typenames.member? name
+  end
+
+  def load_type name
+    fail unless name.is_a? String
+    @target.const_set name, make_type(name)
+    load_extension name
+    nil
+  end
+
+  private
+
+  def load_extension name
+    path = @target.extension_path name
+    load path if File.exists? path
+  end
+
+  def make_type name
+    name = name.to_s
+    fail if BasicTypes::BUILTIN.member? name
+    desc = @vmodl[name] or fail "unknown VMODL type #{name}"
+    case desc['kind']
+    when 'data' then make_data_type name, desc
+    when 'managed' then make_managed_type name, desc
+    when 'enum' then make_enum_type name, desc
+    else fail desc.inspect
+    end
+  end
+
+  def make_data_type name, desc
+    superclass = @target.const_get desc['wsdl_base']
+    Class.new(superclass).tap do |klass|
+      klass.init name, desc['props']
+    end
+  end
+
+  def make_managed_type name, desc
+    superclass = @target.const_get desc['wsdl_base']
+    Class.new(superclass).tap do |klass|
+      klass.init name, desc['props'], desc['methods']
+    end
+  end
+
+  def make_enum_type name, desc
+    Class.new(BasicTypes::Enum).tap do |klass|
+      klass.init name, desc['values']
+    end
+  end
+end
+
+end

data/lib/rbvmomi/vim.rb

@@ -0,0 +1,76 @@
+# Copyright (c) 2011 VMware, Inc.  All Rights Reserved.
+require 'rbvmomi'
+
+module RbVmomi
+
+# A connection to one vSphere SDK endpoint.
+# @see #serviceInstance
+class VIM < Connection
+  # Connect to a vSphere SDK 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]  :user (root) Username.
+  # @option opts [String]  :password Password.
+  # @option opts [String]  :path (/sdk) SDK endpoint path.
+  # @option opts [Boolean] :debug (false) If true, print SOAP traffic to stderr.
+  def self.connect opts
+    fail unless opts.is_a? Hash
+    fail "host option required" unless opts[:host]
+    opts[:user] ||= 'root'
+    opts[:password] ||= ''
+    opts[:ssl] = true unless opts.member? :ssl
+    opts[:insecure] ||= false
+    opts[:port] ||= (opts[:ssl] ? 443 : 80)
+    opts[:path] ||= '/sdk'
+    opts[:ns] ||= 'urn:vim25'
+    opts[:rev] = '4.1'
+    opts[:debug] = (!ENV['RBVMOMI_DEBUG'].empty? rescue false) unless opts.member? :debug
+
+    new(opts).tap do |vim|
+      vim.serviceContent.sessionManager.Login :userName => opts[:user], :password => opts[:password]
+    end
+  end
+
+  # Return the ServiceInstance
+  #
+  # The ServiceInstance is the root of the vSphere inventory.
+  # @see http://www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/vim.ServiceInstance.html
+  def serviceInstance
+    VIM::ServiceInstance self, 'ServiceInstance'
+  end
+
+  # Alias to serviceInstance.RetrieveServiceContent
+  def serviceContent
+    @serviceContent ||= serviceInstance.RetrieveServiceContent
+  end
+
+  # Alias to serviceContent.rootFolder
+  def rootFolder
+    serviceContent.rootFolder
+  end
+
+  alias root rootFolder
+
+  # Alias to serviceContent.propertyCollector
+  def propertyCollector
+    serviceContent.propertyCollector
+  end
+
+  # Alias to serviceContent.searchIndex
+  def searchIndex
+    serviceContent.searchIndex
+  end
+
+  # @private
+  def self.extension_path name
+    File.join(File.dirname(__FILE__), "vim", "#{name}.rb")
+  end
+
+  load_vmodl(ENV['VMODL'] || File.join(File.dirname(__FILE__), "../../vmodl.cdb"))
+end
+
+end