rbvmomi2 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee70c9cbf14069109282bc0dc3b3fbfc192a75c2dfc7169e20ece8c17de30fd9
-  data.tar.gz: 34749740fe0bbfaf0d098eea7081dc09d527e1ff08b868126c61cde22bc1740e
+  metadata.gz: 3cd7c8f7c07cfc8e042bc125747b279ff88430ab531068b3bb56aeb937ec5009
+  data.tar.gz: 1c76cde83a228ac728cdd747b3367a32d19a2a98c7c07eb796a2a73fd414fd2b
 SHA512:
-  metadata.gz: ac0c4954c87993b43020edadfe1d142cff52041a655dc48039cb5f462d6e8ad5eaf14cef7f719f512179d00e8ec9f29b1ebfe99341ec3e1ec4659c715f19da24
-  data.tar.gz: 3388115b0783d73c42ad20eeb99422e90601568c7140fae69e28366c0209065df07cf2c8dc535769802792d661f86f655bf542d690f34bbec46720ea3e9220b9
+  metadata.gz: d9779867969725d9d0eeb72fda7193e5a6e8725cc53a5d4c41518089203657ca7eb30ed8bbcf1f5e17f7a48aec52accbb975fb32e6d19a9a63c1c01d2796d560
+  data.tar.gz: 88421663c3b937da0fe46cb021c3f17830670738cb5297851db5ee3a0a605b994c5c12d3402b835d6418481f5348d4a6e3cb8a354d6cc67192597527bc8bcfad

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.2.0'.freeze
+  VERSION = '3.3.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,206 @@
+# 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_types_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 " #{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
+  end
+
+  def generate!
+    wsdl_types_by_name.each_value do |type|
+      type_name  = type.name.name
+      vmodl_data = @vmodl[type_name]
+
+      if vmodl_data.nil?
+        base_class           = wsdl_types_by_name[type.complexcontent.extension.base.name]
+        inherited_properties = base_class.elements.map { |element| element.name.name }
+        properties           = type.elements.reject { |e| inherited_properties.include?(e.name.name) }
+
+        vmodl_data = {
+          'kind'      => 'data',
+          'props'     => properties.map do |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,
+          'wsdl_base' => type.complexcontent.extension.base.name
+        }
+
+        @vmodl[type_name] = vmodl_data
+        @vmodl['_typenames']['_typenames'] << type_name
+
+        puts "Adding #{type_name} to vmodl"
+
+        wsdl_to_rbvmomi_namespace(type).loader.add_types type_name => vmodl_data
+      end
+    end
+
+    wsdl_types_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 wsdl_types_by_name
+    @wsdl_types_by_name ||= @wsdl.collect_complextypes
+      .reject   { |type| type.name.name.match?(/^ArrayOf|RequestType$/) }
+      .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 'urb: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 || "RbVmomi::VIM::#{type}".safe_constantize
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rbvmomi2
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Adam Grare
 - Jason Frey
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-08 00:00:00.000000000 Z
+date: 2022-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -185,7 +185,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.25
-description:
+description: 
 email:
 - adam@grare.com
 - fryguy9@gmail.com
@@ -202,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
@@ -237,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
@@ -257,8 +260,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.27
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: Ruby interface to the VMware vSphere API
 test_files: []