rbvmomi2 3.0.0 → 3.0.1

data/lib/rbvmomi/deserialization.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
 # SPDX-License-Identifier: MIT
 
@@ -5,245 +6,240 @@ require 'time'
 
 module RbVmomi
 
-class NewDeserializer
-  NS_XSI = 'http://www.w3.org/2001/XMLSchema-instance'
+  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
+    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
-  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
+    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|
+      BUILTIN_TYPE_ACTIONS[$'] = v if k =~ /^xsd:/
     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
+    def initialize conn
+      @conn = conn
+      @loader = conn.class.loader
+    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
+    def deserialize node, type=nil
+      type_attr = node['type']
+
+      # Work around for 1.5.x which doesn't populate node['type']
+      # XXX what changed
+      type_attr = node.attributes['type'].value if node.attributes['type'] and not type_attr
+
+      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 raise
+        end
+      else
+        type = type.split(':', 2)[1] if type =~ /:/
+        if type =~ /^ArrayOf/
+          type = DEMANGLED_ARRAY_TYPES[$'] || $'
+          return node.children.select(&:element?).map { |c| deserialize c, type }
+        end
+        type = type.split(':', 2)[1] if type =~ /:/
+
+        klass = @loader.get(type) or raise "no such type '#{type}'"
+        case klass.kind
+        when :data
+          traverse_data node, klass
+        when :enum
+          node.content
+        when :managed
+          leaf_managed node, klass
+        else raise
+        end
       end
     end
-  end
 
-  def traverse_data node, klass
-    obj = klass.new nil
-    props = obj.props
-    children = node.children.select(&:element?)
-    i = 0
+    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']
+      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
+        # 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)
+        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
-        props[name.to_sym] = a
-      elsif ((child = children[i]) && (child.name == name))
-        props[name.to_sym] = deserialize(child, child_type)
-        i += 1
       end
+
+      obj
     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_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_date node
-    Time.parse node.content
-  end
+    def leaf_binary node
+      node.content.unpack('m')[0]
+    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?
 
-  # 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
+        h[child.name] = child.content
+      end
+      [h['key'], h['value']]
     end
-    [h['key'], h['value']]
   end
-end
-
-class OldDeserializer
-  NS_XSI = 'http://www.w3.org/2001/XMLSchema-instance'
 
-  def initialize conn
-    @conn = conn
-  end
+  class OldDeserializer
+    NS_XSI = 'http://www.w3.org/2001/XMLSchema-instance'
 
-  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)
+    def initialize conn
+      @conn = conn
     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
+    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
 
-    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
+      if typename =~ /^ArrayOf/
+        typename = demangle_array_type $'
+        return xml.children.select(&:element?).map { |c| deserialize c, typename }
       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
+
+      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
+        raise 'attempted to deserialize an AnyType'
+      else raise "unexpected type #{t.inspect} (#{t.ancestors * '/'})"
       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 * '/'})"
+    rescue
+      $stderr.puts "#{$!.class} while deserializing #{xml.name} (#{typename}):"
+      $stderr.puts xml.to_s
+      raise
     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
+    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
-end
 
-if ENV['RBVMOMI_NEW_DESERIALIZER'] == '1' || true # Always use new one now
-  Deserializer = NewDeserializer
-else
-  Deserializer = OldDeserializer
-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

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

data/lib/rbvmomi/optimist.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (c) 2010-2017 VMware, Inc.  All Rights Reserved.
 # SPDX-License-Identifier: MIT
 
@@ -14,59 +15,59 @@ module Optimist
 # 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
+  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 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 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 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')
+    # 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
-end