rbvmomi2 3.1.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf4824d3bb1f25494502cc88370980ae16122a1b57d23b973ba90ad02257450c
-  data.tar.gz: 924e4c79fe11d3c940b3cc02a75b626209bfb8e899cf3d080afdead2383988c6
+  metadata.gz: ca23adf85e7f9aa7fc531ed9c16e45a07c4ed9aedc6725afed17b94aa978c45b
+  data.tar.gz: 3b2be36f622eb5ac2311315ce3a39e75245e91684fb22a3fb7574e58fc33375f
 SHA512:
-  metadata.gz: dd87f32ab50ec52e75f226048e518717e59d9558948d8d58d3e538e9fab15b4138de8dfed5d9c0501ab30474eb71a643e51033282da6b01151b23b1fca7d7691
-  data.tar.gz: 2faf225fb094a42118d22ed0be970e136223beb9bf9d62fd49703e0163d7d06f59c54fe9f04c72a1c78d8ec521f0c1e75991af7b757f164716c2702609b2404f
+  metadata.gz: 429eb97268d0b4be01876bb6b19371726e7177589418fe7fcae34729b77fc333e19e0d897fbcb6fd3aa5d988b4ed9b36c396e2f2ffb990bd20921dd93052eb52
+  data.tar.gz: 037b902b0da661ddc142c2a5eb27df979ac9b91db18c778ec40f102bc094ef16fd9b0f575d290d15299dbe7361ec1cbadbc43f921795615b5acddcc29c20f3ae

data/lib/rbvmomi/connection.rb

@@ -195,8 +195,7 @@ module RbVmomi
       end
       xml
     rescue
-      $stderr.puts "#{$!.class} while serializing #{name} (#{type}):"
-      PP.pp o, $stderr
+      RbVmomi.logger.error("#{$!.class} while serializing #{name} (#{type})\n#{o.pretty_inspect}")
       raise
     end
 

data/lib/rbvmomi/deserialization.rb

@@ -221,8 +221,7 @@ module RbVmomi
       else raise "unexpected type #{t.inspect} (#{t.ancestors * '/'})"
       end
     rescue
-      $stderr.puts "#{$!.class} while deserializing #{xml.name} (#{typename}):"
-      $stderr.puts xml.to_s
+      RbVmomi.logger.error("#{$!.class} while deserializing #{xml.name} (#{typename}):\n#{xml.to_s}")
       raise
     end
 

data/lib/rbvmomi/logging.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RbVmomi
+  class << self
+    attr_writer :logger
+  end
+
+  def self.logger
+    @logger ||= begin
+      require 'logger'
+      Logger.new($stderr)
+    end
+  end
+end

data/lib/rbvmomi/pbm.rb

@@ -18,7 +18,7 @@ module RbVmomi
     # @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.
+    # @option opts [Boolean] :debug (false) If true, print SOAP traffic to RbVmomi.logger.debug.
     def self.connect vim, opts = {}
       raise unless opts.is_a? Hash
 

data/lib/rbvmomi/sms.rb

@@ -17,7 +17,7 @@ module RbVmomi
     # @option opts [Boolean] :ssl (true) Whether to use SSL.
     # @option opts [Boolean] :insecure (false) If true, ignore SSL certificate errors.
     # @option opts [String]  :path (/sms/sdk) SDK endpoint path.
-    # @option opts [Boolean] :debug (false) If true, print SOAP traffic to stderr.
+    # @option opts [Boolean] :debug (false) If true, print SOAP traffic to RbVmomi.logger.debug.
     def self.connect vim, opts = {}
       raise unless opts.is_a? Hash
 

data/lib/rbvmomi/trivial_soap.rb

@@ -84,11 +84,7 @@ class RbVmomi::TrivialSoap
     headers = { 'content-type' => 'text/xml; charset=utf-8', 'SOAPAction' => action }
     headers['cookie'] = @cookie if @cookie
 
-    if @debug
-      $stderr.puts 'Request:'
-      $stderr.puts body
-      $stderr.puts
-    end
+    RbVmomi.logger.debug("Request:\n#{body}") if @debug
 
     if @cookie.nil? && @sso
       @sso.request_token unless @sso.assertion_id
@@ -112,11 +108,7 @@ class RbVmomi::TrivialSoap
 
     nk = Nokogiri(response.body)
 
-    if @debug
-      $stderr.puts "Response (in #{'%.3f' % (end_time - start_time)} s)"
-      $stderr.puts nk
-      $stderr.puts
-    end
+    RbVmomi.logger.debug("Response (in #{'%.3f' % (end_time - start_time)} s)\n#{nk}") if @debug
 
     [nk.xpath('//soapenv:Body/*').select(&:element?).first, response.body.size]
   end

data/lib/rbvmomi/version.rb

@@ -3,5 +3,5 @@
 # SPDX-License-Identifier: MIT
 
 module RbVmomi
-  VERSION = '3.1.0'.freeze
+  VERSION = '3.4.0'.freeze
 end

data/lib/rbvmomi/vim.rb

@@ -18,7 +18,7 @@ module RbVmomi
     # @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.
+    # @option opts [Boolean] :debug (false) If true, print SOAP traffic to RbVmomi.logger.debug.
     # @option opts [String]  :operation_id If set, use for operationID
     # @option opts [Boolean] :close_on_exit (true) If true, will close connection with at_exit
     # @option opts [RbVmomi::SSO] :sso (nil) Use SSO token to login if set
@@ -56,7 +56,7 @@ module RbVmomi
     def close
       serviceContent.sessionManager.Logout
     rescue RbVmomi::Fault => e
-      $stderr.puts(e.message) if debug
+      RbVmomi.logger.error(e.message) if debug
     ensure
       self.cookie = nil
       super

data/lib/rbvmomi.rb

@@ -12,6 +12,7 @@ module RbVmomi
 end
 
 require_relative 'rbvmomi/connection'
+require_relative 'rbvmomi/logging'
 require_relative 'rbvmomi/sso'
 require_relative 'rbvmomi/version'
 require_relative 'rbvmomi/vim'

data/lib/tasks/vmodl.rake

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative './vmodl_helper'
+
+namespace :vmodl do
+  desc 'Verify vmodl.db'
+  task :verify do
+    VmodlHelper.verify!
+  end
+
+  desc 'Generate vmodl.db'
+  task :generate do
+    VmodlHelper.generate!
+  end
+end

data/lib/tasks/vmodl_helper.rb

@@ -0,0 +1,278 @@
+# frozen_string_literal: true
+require 'active_support/core_ext/enumerable'
+require 'active_support/inflector'
+require 'optimist'
+require 'pathname'
+require 'wsdl/parser'
+require 'rbvmomi'
+require 'rbvmomi/pbm'
+require 'rbvmomi/sms'
+
+class VmodlHelper
+  class << self
+    def verify!
+      run!('verify')
+    end
+
+    def generate!
+      run!('generate')
+    end
+
+    private
+
+    def run!(mode)
+      vmodl, wsdl = options(mode).values_at(:vmodl, :wsdl)
+      new(vmodl_path: vmodl, wsdl_path: wsdl).send("#{mode}!")
+    end
+
+    def options(rake_task)
+      argv = ARGV.slice_after('--').to_a.last
+      Optimist.options(argv) do
+        educate_on_error
+        opt :wsdl, 'Path to the vsphere-ws wsdl file', type: :string, required: true
+        opt :vmodl, 'Path to the vmodl.db', type: :string, default: 'vmodl.db'
+        banner <<~EOS
+          Usage:
+          rake vmodl:#{rake_task} -- --wsdl=path/to/wsdl
+        EOS
+      end
+    end
+  end
+
+  def initialize(vmodl_path:, wsdl_path:)
+    @vmodl_path = Pathname.new(vmodl_path)
+    @wsdl_path  = Pathname.new(wsdl_path)
+
+    @vmodl = load_vmodl(@vmodl_path)
+    @wsdl  = load_wsdl(@wsdl_path)
+  end
+
+  def verify!
+    # Loop through the ComplexTypes in the WSDL and compare their types
+    # to the types which are defined in the vmodl.db
+    wsdl_classes_by_name.each_value do |type|
+      type_name  = type.name.name
+      vmodl_data = @vmodl[type_name]
+
+      # If a type exists in the WSDL but not in the vmodl.db this usually
+      # indicates that it was added in a newer version than the current
+      # vmodl.db supports.
+      #
+      # Print a warning that the type is missing and skip it.
+      if vmodl_data.nil?
+        puts " class #{type_name} is missing"
+        next
+      end
+
+      # Index the properties by name to make it simpler to find later
+      elements_by_name = type.elements.index_by { |e| e.name.name }
+
+      # Loop through the properties defined in the vmodl.db for this type and
+      # compare the type to that property as defined in the wsdl.
+      vmodl_data['props'].each do |vmodl_prop|
+        wsdl_prop = elements_by_name[vmodl_prop['name']]
+        next if wsdl_prop.nil?
+
+        vmodl_klass = wsdl_constantize(vmodl_prop['wsdl_type'])
+        wsdl_klass  = wsdl_constantize(wsdl_prop.type.source)
+
+        # The vmodl class should be equal to or a subclass of the one in the wsdl.
+        # Example of a subclass is e.g. VirtualMachine.host is defined as a HostSystem
+        # in the vmodl.db but it is a ManagedObjectReference in the wsdl.
+        puts "#{type_name}.#{vmodl_prop["name"]} #{wsdl_klass.wsdl_name} doesn't match #{vmodl_klass.wsdl_name}" unless vmodl_klass <= wsdl_klass
+      end
+    end
+
+    # Loop through the SimpleTypes (enums) in the WSDL
+    wsdl_enums_by_name.each_value do |enum|
+      enum_name = enum.name.name
+      vmodl_data = @vmodl[enum_name]
+
+      if vmodl_data.nil?
+        puts " enum #{enum_name} is missing"
+        next
+      end
+    end
+  end
+
+  def generate!
+    wsdl_classes_by_name.each_value do |type|
+      type_name = type.name.name
+
+      # Update the existing vmodl object if it exists otherwise instantiate a
+      # new one.
+      vmodl_data = @vmodl[type_name] || build_wsdl_class!(type)
+      props_by_name = vmodl_data['props'].index_by { |prop| prop['name'] }
+
+      vmodl_data['props'] = wsdl_properties(type).map do |element|
+        # NOTE we should prioritize the existing property hash over building a
+        # new one because the generic ManagedObjectReferences are manually
+        # replaced with their specific counterparts (e.g. Datastore) which
+        # cannot be computed programmatically.
+        props_by_name[element.name.name] || build_vmodl_property(element)
+      end
+
+      # Some types (e.g. ManagedObjectReference) have extra properties which are
+      # not present in the WSDL but are required for proper function of RbVmomi.
+      vmodl_data['props'] += extra_props_for_type(type_name)
+    end
+
+    wsdl_enums_by_name.each_value do |enum|
+      enum_name = enum.name.name
+
+      vmodl_data = @vmodl[enum_name] || build_wsdl_enum(enum)
+      vmodl_data['values'] = enum.restriction.enumeration
+    end
+
+    wsdl_classes_by_name.each_value do |type|
+      type_name = type.name.name
+      vmodl_data = @vmodl[type_name]
+
+      elements_by_name = type.elements.index_by { |e| e.name.name }
+
+      # Loop through the properties defined in the vmodl.db for this type and
+      # compare the type to that property as defined in the wsdl.
+      vmodl_data['props'].each do |vmodl_prop|
+        wsdl_prop = elements_by_name[vmodl_prop['name']]
+        next if wsdl_prop.nil?
+
+        vmodl_klass = wsdl_constantize(vmodl_prop['wsdl_type'])
+        wsdl_klass  = wsdl_constantize(wsdl_prop.type.source)
+
+        vmodl_prop['wsdl_type'] = wsdl_klass.wsdl_name unless vmodl_klass <= wsdl_klass
+      end
+    end
+
+    dump_vmodl!
+  end
+
+  protected
+
+  def load_wsdl(path)
+    # WSDL includes have to resolve in the local directory so we have to
+    # change working directories to where the wsdl is
+    Dir.chdir(path.dirname) do
+      WSDL::Parser.new.parse(path.read)
+    end
+  end
+
+  def load_vmodl(path)
+    Marshal.load(path.read)
+  end
+
+  def dump_vmodl!
+    File.write(@vmodl_path, Marshal.dump(@vmodl))
+  end
+
+  private
+
+  def build_wsdl_class!(type)
+    type_name = type.name.name
+
+    puts "Adding class #{type_name} to vmodl"
+
+    vmodl_obj = {'kind' => 'data', 'props' => [], 'wsdl_base' => type.complexcontent.extension.base.name}
+
+    @vmodl[type_name] = vmodl_obj
+    @vmodl['_typenames']['_typenames'] << type_name
+
+    wsdl_to_rbvmomi_namespace(type).loader.add_types(type_name => vmodl_obj)
+
+    vmodl_obj
+  end
+
+  def build_wsdl_enum(enum)
+    enum_name = enum.name.name
+
+    puts "Adding enum #{enum_name} to vmodl"
+
+    vmodl_obj = {'kind' => 'enum', 'values' => []}
+
+    @vmodl[enum_name] = vmodl_obj
+    @vmodl['_typenames']['_typenames'] << enum_name
+
+    wsdl_to_rbvmomi_namespace(enum).loader.add_types(enum_name => vmodl_obj)
+
+    vmodl_obj
+  end
+
+  def build_vmodl_property(element)
+    {
+      'name'           => element.name.name,
+      'is-optional'    => element.minoccurs == 0,
+      'is-array'       => element.maxoccurs != 1,
+      'version-id-ref' => nil,
+      'wsdl_type'      => wsdl_to_vmodl_type(element.type)
+    }
+  end
+
+  def wsdl_properties(type)
+    base_class = wsdl_classes_by_name[type.complexcontent&.extension&.base&.name]
+    if base_class
+      inherited_properties = base_class.elements.map { |element| element.name.name }
+      type.elements.reject { |e| inherited_properties.include?(e.name.name) }
+    else
+      type.elements
+    end
+  end
+
+  def extra_props_for_type(type)
+    @extra_props_for_type ||= {
+      'ManagedObjectReference' => [
+        {'name' => 'type',  'is-optional' => false, 'is-array' => false, 'version-id-ref' => nil, 'wsdl_type' => 'xsd:string'},
+        {'name' => 'value', 'is-optional' => false, 'is-array' => false, 'version-id-ref' => nil, 'wsdl_type' => 'xsd:string'}
+      ]
+    }
+
+    @extra_props_for_type[type] || []
+  end
+
+  def wsdl_classes_by_name
+    @wsdl_classes_by_name ||= @wsdl.collect_complextypes
+      .reject   { |type| type.name.name.match?(/^ArrayOf|RequestType$/) }
+      .index_by { |type| type.name.name }
+  end
+
+  def wsdl_enums_by_name
+    @wsdl_enums_by_name ||= @wsdl.collect_simpletypes.index_by { |type| type.name.name }
+  end
+
+  def wsdl_to_vmodl_type(type)
+    case type.source
+    when /vim25:/, /pbm:/, /sms:/
+      vmodl_type = type.name == 'ManagedObjectReference' ? 'ManagedObject' : type.name
+    when /xsd:/
+      vmodl_type = type.source
+    else
+      raise ArgumentError, "Unrecognized wsdl type: [#{type}]"
+    end
+
+    vmodl_type
+  end
+
+  def wsdl_to_rbvmomi_namespace(type)
+    case type.targetnamespace
+    when 'urn:vim25'
+      RbVmomi::VIM
+    when 'urn:pbm'
+      RbVmomi::PBM
+    when 'urn:sms'
+      RbVmomi::SMS
+    else
+      raise ArgumentError, "Unrecognized namespace [#{type}]"
+    end
+  end
+
+  # Normalize the type, some of these don't have RbVmomi equivalents such as xsd:long
+  # and RbVmomi uses ManagedObjects not ManagedObjectReferences as parameters
+  def wsdl_constantize(type)
+    type = type.split(':').last
+    type = 'int'           if %w[long short byte].include?(type)
+    type = 'float'         if type == 'double'
+    type = 'binary'        if type == 'base64Binary'
+    type = 'ManagedObject' if type == 'ManagedObjectReference'
+
+    type = type.camelcase
+    type.safe_constantize || "RbVmomi::BasicTypes::#{type}".safe_constantize || "#{wsdl_to_rbvmomi_namespace(@wsdl)}::#{type}".safe_constantize
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rbvmomi2
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Adam Grare
 - Jason Frey
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -43,16 +43,22 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.5
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.5
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: optimist
   requirement: !ruby/object:Gem::Requirement
@@ -87,14 +93,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +185,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.25
-description: 
+description:
 email:
 - adam@grare.com
 - fryguy9@gmail.com
@@ -196,6 +202,7 @@ files:
 - lib/rbvmomi/connection.rb
 - lib/rbvmomi/deserialization.rb
 - lib/rbvmomi/fault.rb
+- lib/rbvmomi/logging.rb
 - lib/rbvmomi/optimist.rb
 - lib/rbvmomi/pbm.rb
 - lib/rbvmomi/sms.rb
@@ -231,12 +238,14 @@ files:
 - lib/rbvmomi/vim/Task.rb
 - lib/rbvmomi/vim/VirtualMachine.rb
 - lib/rbvmomi2.rb
+- lib/tasks/vmodl.rake
+- lib/tasks/vmodl_helper.rb
 - vmodl.db
 homepage: https://github.com/ManageIQ/rbvmomi2
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -251,8 +260,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: Ruby interface to the VMware vSphere API
 test_files: []