rbvmomi2 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cd7c8f7c07cfc8e042bc125747b279ff88430ab531068b3bb56aeb937ec5009
-  data.tar.gz: 1c76cde83a228ac728cdd747b3367a32d19a2a98c7c07eb796a2a73fd414fd2b
+  metadata.gz: ca23adf85e7f9aa7fc531ed9c16e45a07c4ed9aedc6725afed17b94aa978c45b
+  data.tar.gz: 3b2be36f622eb5ac2311315ce3a39e75245e91684fb22a3fb7574e58fc33375f
 SHA512:
-  metadata.gz: d9779867969725d9d0eeb72fda7193e5a6e8725cc53a5d4c41518089203657ca7eb30ed8bbcf1f5e17f7a48aec52accbb975fb32e6d19a9a63c1c01d2796d560
-  data.tar.gz: 88421663c3b937da0fe46cb021c3f17830670738cb5297851db5ee3a0a605b994c5c12d3402b835d6418481f5348d4a6e3cb8a354d6cc67192597527bc8bcfad
+  metadata.gz: 429eb97268d0b4be01876bb6b19371726e7177589418fe7fcae34729b77fc333e19e0d897fbcb6fd3aa5d988b4ed9b36c396e2f2ffb990bd20921dd93052eb52
+  data.tar.gz: 037b902b0da661ddc142c2a5eb27df979ac9b91db18c778ec40f102bc094ef16fd9b0f575d290d15299dbe7361ec1cbadbc43f921795615b5acddcc29c20f3ae

data/lib/rbvmomi/version.rb

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

data/lib/tasks/vmodl_helper.rb

@@ -50,7 +50,7 @@ class VmodlHelper
   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|
+    wsdl_classes_by_name.each_value do |type|
       type_name  = type.name.name
       vmodl_data = @vmodl[type_name]
 
@@ -60,7 +60,7 @@ class VmodlHelper
       #
       # Print a warning that the type is missing and skip it.
       if vmodl_data.nil?
-        puts " #{type_name} is missing"
+        puts " class #{type_name} is missing"
         next
       end
 
@@ -82,42 +82,49 @@ class VmodlHelper
         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_types_by_name.each_value do |type|
-      type_name  = type.name.name
-      vmodl_data = @vmodl[type_name]
+    wsdl_classes_by_name.each_value do |type|
+      type_name = type.name.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
+      # 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_types_by_name.each_value do |type|
+    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]
 
@@ -159,12 +166,77 @@ class VmodlHelper
 
   private
 
-  def wsdl_types_by_name
-    @wsdl_types_by_name ||= @wsdl.collect_complextypes
+  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:/
@@ -180,7 +252,7 @@ class VmodlHelper
 
   def wsdl_to_rbvmomi_namespace(type)
     case type.targetnamespace
-    when 'urb:vim25'
+    when 'urn:vim25'
       RbVmomi::VIM
     when 'urn:pbm'
       RbVmomi::PBM
@@ -201,6 +273,6 @@ class VmodlHelper
     type = 'ManagedObject' if type == 'ManagedObjectReference'
 
     type = type.camelcase
-    type.safe_constantize || "RbVmomi::BasicTypes::#{type}".safe_constantize || "RbVmomi::VIM::#{type}".safe_constantize
+    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.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Adam Grare
 - Jason Frey
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -93,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
@@ -185,7 +185,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.25
-description: 
+description:
 email:
 - adam@grare.com
 - fryguy9@gmail.com
@@ -245,7 +245,7 @@ homepage: https://github.com/ManageIQ/rbvmomi2
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -260,8 +260,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: Ruby interface to the VMware vSphere API
 test_files: []