rbvmomi 1.11.3 → 3.0.0

data/devel/analyze-vim-declarations.rb

@@ -1,217 +0,0 @@
-#!/usr/bin/env ruby
-
-# Copyright (c) 2010-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-require 'nokogiri'
-require 'pp'
-# :usage => analyze-vim-declarations.rb vim-declarations.xml foo-declarations.xml vmodl.db
-
-XML_FNS = ARGV[0...-1]
-abort "must specify path to vim-declarations.xml" if XML_FNS.empty?
-OUT_FN = ARGV[-1] or abort "must specify path to output database"
-
-XML_FNS.each do |x|
-  abort "XML file #{x} does not exist" unless File.exists? x
-end
-
-TYPES = {}
-VERSIONS = []
-
-ID2NAME = Hash.new { |h,k| fail "unknown type-id #{k.inspect}" }
-
-ID2NAME.merge!({
-  'java.lang.String' => 'xsd:string',
-  'BOOLEAN' => 'xsd:boolean',
-  'BYTE' => 'xsd:byte',
-  'SHORT' => 'xsd:short',
-  'INT' => 'xsd:int',
-  'LONG' => 'xsd:long',
-  'FLOAT' => 'xsd:float',
-  'DOUBLE' => 'xsd:double',
-  'vmodl.DateTime' => 'xsd:dateTime',
-  'vmodl.Binary' => 'xsd:base64Binary',
-  'vmodl.Any' => 'xsd:anyType',
-  'vmodl.URI' => 'xsd:anyURI',
-  'void' => nil,
-})
-
-%w(DataObject ManagedObject MethodFault MethodName
-   PropertyPath RuntimeFault TypeName).each do |x|
-  ID2NAME['vmodl.' + x] = x
-end
-
-def handle_data_object node
-  if TYPES[node['name']]
-    puts "Type #{node['name']} already exists"
-    return
-  end
-
-  ID2NAME[node['type-id']] = node['name']
-  TYPES[node['name']] = {
-    'kind' => 'data',
-    'base-type-id' => node['base-type-id'],
-    'props' => node.children.select { |x| x.name == 'property' }.map do |property|
-      {
-        'name' => property['name'],
-        'type-id-ref' => property['type-id-ref'],
-        'is-optional' => property['is-optional'] ? true : false,
-        'is-array' => property['is-array'] ? true : false,
-        'version-id-ref' => property['version-id-ref'],
-      }
-    end
-  }
-end
-
-def handle_managed_object node
-  if TYPES[node['name']]
-    puts "Type #{node['name']} already exists"
-    return
-  end
-  ID2NAME[node['type-id']] = node['name']
-  TYPES[node['name']] = {
-    'kind' => 'managed',
-    'base-type-id' => node['base-type-id'],
-    'props' => node.children.select { |x| x.name == 'property' }.map do |property|
-      {
-        'name' => property['name'],
-        'type-id-ref' => property['type-id-ref'],
-        'is-optional' => property['is-optional'] ? true : false,
-        'is-array' => property['is-array'] ? true : false,
-        'version-id-ref' => property['version-id-ref'],
-      }
-    end,
-    'methods' => Hash[
-      node.children.select { |x| x.name == 'method' }.map do |method|
-        [method['is-task'] ? "#{method['name']}_Task" : method['name'],
-         {
-           'params' => method.children.select { |x| x.name == 'parameter' }.map do |param|
-             {
-               'name' => param['name'],
-               'type-id-ref' => param['type-id-ref'],
-               'is-array' => param['is-array'] ? true : false,
-               'is-optional' => param['is-optional'] ? true : false,
-               'version-id-ref' => param['version-id-ref'],
-             }
-           end,
-           'result' => {
-             'type-id-ref' => method['type-id-ref'],
-             'is-array' => method['is-array'] ? true : false,
-             'is-optional' => method['is-optional'] ? true : false,
-             'is-task' => method['is-task'] ? true : false,
-             'version-id-ref' => method['version-id-ref'],
-           }
-         }
-        ]
-      end
-    ]
-  }
-end
-
-def handle_enum node
-  if TYPES[node['name']]
-    puts "Type #{node['name']} already exists"
-    return
-  end
-
-  ID2NAME[node['type-id']] = node['name']
-  TYPES[node['name']] = {
-    'kind' => 'enum',
-    'values' => node.children.map { |child| child['name'] },
-  }
-end
-
-def handle_fault node
-  handle_data_object node
-end
-
-def handle_version x
-  attrs = %w(display-name name service-namespace type-id version-id vmodl-name)
-  h = Hash[attrs.map { |k| [k, x[k]] }]
-  h['compatible'] = x.children.select(&:element?).map { |y| y.text }
-  VERSIONS << h
-end
-
-XML_FNS.each do |fn|
-  puts "parsing #{fn} ..."
-  xml_str = File.read(fn)
-  xml_str = xml_str.gsub(/\<description-html\>(.*?)\<\/description-html\>/m, "")
-  xml = Nokogiri.parse(xml_str, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS)
-  xml.root.at('enums').children.each { |x| handle_enum x }
-  xml.root.at('managed-objects').children.each { |x| handle_managed_object x }
-  xml.root.at('data-objects').children.each { |x| handle_data_object x }
-  xml.root.at('faults').children.each { |x| handle_fault x }
-  #xml.root.at('definitions').at('version-types').children.each { |x| handle_version x }
-end
-
-#pp ID2NAME
-
-munge_fault = lambda { |x| true }
-
-TYPES.each do |k,t|
-  case t['kind']
-  when 'data'
-    t['wsdl_base'] = t['base-type-id'] ? ID2NAME[t['base-type-id']] : 'DataObject'
-    t.delete 'base-type-id'
-    t['props'].each do |x|
-      x['wsdl_type'] = ID2NAME[x['type-id-ref']]
-      x.delete 'type-id-ref'
-      munge_fault[x]
-    end
-  when 'managed'
-    t['wsdl_base'] = t['base-type-id'] ? ID2NAME[t['base-type-id']] : 'ManagedObject'
-    t.delete 'base-type-id'
-    t['props'].each do |x|
-      x['wsdl_type'] = ID2NAME[x['type-id-ref']]
-      x.delete 'type-id-ref'
-      munge_fault[x]
-    end
-    t['methods'].each do |mName,x|
-      if y = x['result']
-        begin
-          y['wsdl_type'] = ID2NAME[y['type-id-ref']]
-        rescue Exception => ex
-          pp ex
-        end
-        y.delete 'type-id-ref'
-        munge_fault[y]
-      end
-      x['params'].each do |r|
-        begin
-          r['wsdl_type'] = ID2NAME[r['type-id-ref']]
-        rescue Exception => ex
-          pp ex
-        end
-        r.delete 'type-id-ref'
-        munge_fault[r]
-      end
-    end
-  when 'enum'
-  else fail
-  end
-end
-
-db = {}
-
-TYPES.each do |k,t|
-  db[k] = t
-end
-
-db['_typenames'] = TYPES.keys
-db['_versions'] = VERSIONS
-
-File.open(OUT_FN, 'w') { |io| Marshal.dump db, io }
-
-if filename = ENV['VERSION_GRAPH']
-  File.open(filename, 'w') do |io|
-    io.puts "digraph versions\n{"
-    VERSIONS.each do |h|
-      io.puts "\"#{h['vmodl-name']}\" [label=\"#{h['vmodl-name']} (#{h['version-id']})\"]"
-      h['compatible'].each do |x|
-        x =~ /^interface / or fail x
-        io.puts "\"#{h['vmodl-name']}\" -> \"#{$'}\""
-      end
-    end
-    io.puts "}\n"
-  end
-end

data/devel/analyze-xml.rb

@@ -1,49 +0,0 @@
-# Copyright (c) 2010-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-require 'nokogiri'
-
-# removes line breaks and whitespace between xml nodes.
-def prepare_xml(xml)
-  xml = xml.gsub(/\n+/, "")
-  xml = xml.gsub(/(>)\s*(<)/, '\1\2')
-end
-
-def analyze_xml x, tree
-  subtree = (tree[x.name] ||= { :attributes => [], :min_occur => nil, :max_occur => nil })
-  attrs = x.attributes.keys.sort
-  subtree[:attributes] << attrs unless subtree[:attributes].member? attrs
-
-  child_occurs = Hash.new 0
-  x.children.select(&:element?).each do |c|
-    child_occurs[c.name] += 1
-    analyze_xml c, subtree
-  end
-
-  subtree.select { |k,v| k.is_a? String }.each do |k,v|
-    v[:min_occur] = [v[:min_occur], child_occurs[k]].compact.min
-    v[:max_occur] = [v[:max_occur], child_occurs[k]].compact.max
-  end
-end
-
-def print_tree tree, indent=0
-  tree.select { |k,v| k.is_a? String }.sort.each do |k,v|
-    attrs = v[:attributes] || []
-    min, max = v[:min_occur], v[:max_occur]
-    numsym = if min == 0 and max == 0 then fail
-             elsif min == 0 and max == 1 then '?'
-             elsif min == 0 then '*'
-             elsif min == 1 and max == 1 then ''
-             else '+'
-             end
-    puts "#{'  '*indent}#{k}#{numsym}: #{attrs.sort.map { |a| "[#{a * ' '}]"} * ', '} {#{min},#{max}}"
-    print_tree v, (indent+1)
-  end
-end
-
-tree = {}
-ARGV.each do |fn|
-  nk = Nokogiri(prepare_xml(File.read fn))
-  analyze_xml nk.root, tree
-end
-print_tree tree

data/devel/benchmark.rb

@@ -1,121 +0,0 @@
-#!/usr/bin/env ruby
-
-# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-require 'tempfile'
-
-if ENV['RBVMOMI_COVERAGE'] == '1'
-  require 'simplecov'
-  SimpleCov.start
-end
-
-require 'rbvmomi'
-require 'rbvmomi/deserialization'
-require 'benchmark'
-require 'libxml'
-
-NS_XSI = 'http://www.w3.org/2001/XMLSchema-instance'
-
-VIM = RbVmomi::VIM
-$conn = VIM.new(:ns => 'urn:vim25', :rev => '4.0')
-raw = File.read(ARGV[0])
-
-def diff a, b
-  a_io = Tempfile.new 'rbvmomi-diff-a'
-  b_io = Tempfile.new 'rbvmomi-diff-b'
-  PP.pp a, a_io
-  PP.pp b, b_io
-  a_io.close
-  b_io.close
-  system("diff -u #{a_io.path} #{b_io.path}")
-  a_io.unlink
-  b_io.unlink
-end
-
-begin
-  deserializer = RbVmomi::OldDeserializer.new($conn)
-  end_time = Time.now + 1
-  n = 0
-  while n == 0 or end_time > Time.now
-    deserializer.deserialize Nokogiri::XML(raw).root
-    n += 1
-  end
-  N = n*10
-end
-
-puts "iterations: #{N}"
-
-parsed_nokogiri = Nokogiri::XML(raw)
-parsed_libxml = LibXML::XML::Parser.string(raw).parse
-
-if true
-  nokogiri_xml = parsed_nokogiri.root
-  libxml_xml = parsed_libxml.root
-
-  old_nokogiri_result = RbVmomi::OldDeserializer.new($conn).deserialize nokogiri_xml
-  new_nokogiri_result = RbVmomi::NewDeserializer.new($conn).deserialize nokogiri_xml
-  new_libxml_result = RbVmomi::NewDeserializer.new($conn).deserialize libxml_xml
-
-  if new_nokogiri_result != old_nokogiri_result
-    puts "new_nokogiri_result doesnt match old_nokogiri_result"
-    puts "old_nokogiri_result:"
-    pp old_nokogiri_result
-    puts "new_nokogiri_result:"
-    pp new_nokogiri_result
-    puts "diff:"
-    diff old_nokogiri_result, new_nokogiri_result
-    exit 1
-  end
-
-  if new_libxml_result != old_nokogiri_result
-    puts "new_libxml_result doesnt match old_nokogiri_result"
-    puts "old_nokogiri_result:"
-    pp old_nokogiri_result
-    puts "new_libxml_result:"
-    pp new_libxml_result
-    puts "diff:"
-    diff old_nokogiri_result, new_libxml_result
-    exit 1
-  end
-
-  puts "all results match"
-end
-
-Benchmark.bmbm do|b|
-  GC.start
-  b.report("nokogiri parsing") do
-    N.times { Nokogiri::XML(raw) }
-  end
-  
-  GC.start
-  b.report("libxml parsing") do
-    N.times do
-      LibXML::XML::Parser.string(raw).parse
-    end
-  end
-  
-  GC.start
-  b.report("old deserialization (nokogiri)") do
-    deserializer = RbVmomi::OldDeserializer.new($conn)
-    N.times do
-      deserializer.deserialize Nokogiri::XML(raw).root
-    end
-  end
-
-  GC.start
-  b.report("new deserialization (nokogiri)") do
-    deserializer = RbVmomi::NewDeserializer.new($conn)
-    N.times do
-      deserializer.deserialize Nokogiri::XML(raw).root
-    end
-  end
-
-  GC.start
-  b.report("new deserialization (libxml)") do
-    deserializer = RbVmomi::NewDeserializer.new($conn)
-    N.times do
-      deserializer.deserialize LibXML::XML::Parser.string(raw).parse.root
-    end
-  end
-end

data/devel/collisions.rb

@@ -1,22 +0,0 @@
-#!/usr/bin/env ruby
-
-# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-# Find collisions between VMODL property names and Ruby methods
-require 'rbvmomi'
-VIM = RbVmomi::VIM
-
-conn = VIM.new(:ns => 'urn:vim25', :rev => '4.0')
-
-VIM.loader.typenames.each do |name|
-  klass = VIM.loader.get name
-  next unless klass.respond_to? :kind and [:managed, :data].member? klass.kind
-  methods = klass.kind == :managed ?
-    RbVmomi::BasicTypes::ObjectWithMethods.instance_methods : 
-    RbVmomi::BasicTypes::ObjectWithProperties.instance_methods
-  klass.props_desc.each do |x|
-    name = x['name']
-    puts "collision: #{klass}##{name}" if methods.member? name.to_sym
-  end
-end

data/devel/merge-internal-vmodl.rb

@@ -1,63 +0,0 @@
-#!/usr/bin/env ruby
-
-# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-# These types are not public and so may change between releases. Do not
-# use them directly.
-
-public_vmodl_filename = ARGV[0] or abort "public vmodl filename required"
-internal_vmodl_filename = ARGV[1] or abort "internal vmodl filename required"
-output_vmodl_filename = ARGV[2] or abort "output vmodl filename required"
-
-TYPES = %w(
-DVSKeyedOpaqueData
-DVSOpaqueDataConfigSpec
-DVPortgroupSelection
-DVPortSelection
-DVSSelection
-DynamicTypeEnumTypeInfo
-DynamicTypeMgrAllTypeInfo
-DynamicTypeMgrAnnotation
-DynamicTypeMgrDataTypeInfo
-DynamicTypeMgrFilterSpec
-DynamicTypeMgrManagedTypeInfo
-DynamicTypeMgrMethodTypeInfo
-DynamicTypeMgrMethodTypeInfoAnnotationType
-DynamicTypeMgrMoFilterSpec
-DynamicTypeMgrMoInstance
-DynamicTypeMgrParamTypeInfo
-DynamicTypeMgrParamTypeInfoAnnotationType
-DynamicTypeMgrPropertyTypeInfo
-DynamicTypeMgrPropertyTypeInfoAnnotationType
-DynamicTypeMgrTypeFilterSpec
-InternalDynamicTypeManager
-ReflectManagedMethodExecuter
-ReflectManagedMethodExecuterSoapArgument
-ReflectManagedMethodExecuterSoapFault
-ReflectManagedMethodExecuterSoapResult
-SelectionSet
-)
-
-METHODS = %w(
-DistributedVirtualSwitchManager.UpdateDvsOpaqueData_Task
-HostSystem.RetrieveDynamicTypeManager
-HostSystem.RetrieveManagedMethodExecuter
-)
-
-public_vmodl = File.open(public_vmodl_filename, 'r') { |io| Marshal.load io }
-internal_vmodl = File.open(internal_vmodl_filename, 'r') { |io| Marshal.load io }
-
-TYPES.each do |k|
-  puts "Merging in #{k}"
-  fail "Couldn't find type #{k} in internal VMODL" unless internal_vmodl.member? k
-  public_vmodl[k] = internal_vmodl[k]
-end
-
-METHODS.each do |x|
-  puts "Merging in #{x}"
-  type, method = x.split '.'
-  public_vmodl[type]['methods'][method] = internal_vmodl[type]['methods'][method] or fail
-end
-
-File.open(output_vmodl_filename, 'w') { |io| Marshal.dump public_vmodl, io }

data/devel/merge-manual-vmodl.rb

@@ -1,36 +0,0 @@
-#!/usr/bin/env ruby
-
-# Copyright (c) 2013-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-# Manually merge two versions of vmodl.db
-
-public_vmodl_filename = ARGV[0] or abort "public vmodl filename required"
-internal_vmodl_filename = ARGV[1] or abort "internal vmodl filename required"
-output_vmodl_filename = ARGV[2] or abort "output vmodl filename required"
-
-public_vmodl = File.open(public_vmodl_filename, 'r') { |io| Marshal.load io }
-internal_vmodl = File.open(internal_vmodl_filename, 'r') { |io| Marshal.load io }
-
-db = {}
-tn = {}
-public_vmodl.each do |k,v|
-  unless k == '_typenames'
-    db[k] = v
-  else
-    tn['_typenames'] = v
-  end
-end
-
-internal_vmodl.each do |k, v|
-  unless k == '_typenames'
-    db[k] = v unless db[k]
-  else
-    tn['_typenames'] = tn['_typenames'] + v
-  end
-end
-
-db['_typenames'] = tn
-
-
-File.open(output_vmodl_filename, 'w') { |io| Marshal.dump db, io }

data/examples/annotate.rb

@@ -1,57 +0,0 @@
-# Copyright (c) 2011-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-require 'trollop'
-require 'rbvmomi'
-require 'rbvmomi/trollop'
-
-VIM = RbVmomi::VIM
-CMDS = %w(get set)
-
-opts = Trollop.options do
-  banner <<-EOS
-Annotate a VM.
-
-Usage:
-    annotate.rb [options] VM get
-    annotate.rb [options] VM set annotation
-
-Commands: #{CMDS * ' '}
-
-VIM connection options:
-    EOS
-
-    rbvmomi_connection_opts
-
-    text <<-EOS
-
-VM location options:
-    EOS
-
-    rbvmomi_datacenter_opt
-
-    text <<-EOS
-
-Other options:
-  EOS
-
-  stop_on CMDS
-end
-
-vm_name = ARGV[0] or Trollop.die("no VM name given")
-cmd = ARGV[1] or Trollop.die("no command given")
-abort "invalid command" unless CMDS.member? cmd
-Trollop.die("must specify host") unless opts[:host]
-
-vim = VIM.connect opts
-
-dc = vim.serviceInstance.find_datacenter(opts[:datacenter]) or abort "datacenter not found"
-vm = dc.find_vm(vm_name) or abort "VM not found"
-
-case cmd
-when 'get'
-  puts vm.config.annotation
-when 'set'
-  value = ARGV[2] or Trollop.die("no annotation given")
-  vm.ReconfigVM_Task(:spec => VIM.VirtualMachineConfigSpec(:annotation => value)).wait_for_completion
-end

data/examples/cached_ovf_deploy.rb

@@ -1,124 +0,0 @@
-#!/usr/bin/env ruby
-
-# Copyright (c) 2012-2017 VMware, Inc.  All Rights Reserved.
-# SPDX-License-Identifier: MIT
-
-require 'trollop'
-require 'rbvmomi'
-require 'rbvmomi/trollop'
-require 'rbvmomi/utils/deploy'
-require 'rbvmomi/utils/admission_control'
-require 'yaml'
-
-VIM = RbVmomi::VIM
-
-opts = Trollop.options do
-  banner <<-EOS
-Deploy an OVF to a cluster, using a cached template if available.
-
-Usage:
-    cached_ovf_deploy.rb [options] <vmname> <ovfurl>
-
-VIM connection options:
-    EOS
-
-    rbvmomi_connection_opts
-
-    text <<-EOS
-
-VM location options:
-    EOS
-
-    rbvmomi_datacenter_opt
-    rbvmomi_datastore_opt
-
-    text <<-EOS
-
-Other options:
-  EOS
-
-  opt :template_name, "Name to give to the (cached) template", :type => :string
-  opt :template_path, "Path where templates are stored", :default => 'templates', :type => :string
-  opt :computer_path, "Path to the cluster to deploy into", :type => :string
-  opt :network, "Name of the network to attach template to", :type => :string
-  opt :vm_folder_path, "Path to VM folder to deploy VM into", :type => :string
-  opt :lease, "Lease in days", :type => :int, :default => 3
-end
-
-Trollop.die("must specify host") unless opts[:host]
-Trollop.die("no cluster path given") unless opts[:computer_path]
-template_folder_path = opts[:template_path]
-template_name = opts[:template_name] or Trollop.die("no template name given")
-vm_name = ARGV[0] or Trollop.die("no VM name given")
-ovf_url = ARGV[1] or Trollop.die("No OVF URL given")
-
-vim = VIM.connect opts
-dc = vim.serviceInstance.find_datacenter(opts[:datacenter]) or abort "datacenter not found"
-
-root_vm_folder = dc.vmFolder
-vm_folder = root_vm_folder
-if opts[:vm_folder_path]
-  vm_folder = root_vm_folder.traverse(opts[:vm_folder_path], VIM::Folder)
-end
-template_folder = root_vm_folder.traverse!(template_folder_path, VIM::Folder)
-
-scheduler = AdmissionControlledResourceScheduler.new(
-  vim,
-  :datacenter => dc,
-  :computer_names => [opts[:computer_path]],
-  :vm_folder => vm_folder,
-  :rp_path => '/',
-  :datastore_paths => [opts[:datastore]],
-  :max_vms_per_pod => nil, # No limits
-  :min_ds_free => nil, # No limits
-)
-scheduler.make_placement_decision
-
-datastore = scheduler.datastore
-computer = scheduler.pick_computer
-# XXX: Do this properly
-if opts[:network]
-  network = computer.network.find{|x| x.name == opts[:network]}
-else
-  network = computer.network[0]
-end
-
-lease_tool = LeaseTool.new
-lease = opts[:lease] * 24 * 60 * 60
-deployer = CachedOvfDeployer.new(
-  vim, network, computer, template_folder, vm_folder, datastore
-)
-template = deployer.lookup_template template_name
-
-if !template
-  puts "#{Time.now}: Uploading/Preparing OVF template ..."
-  
-  template = deployer.upload_ovf_as_template(
-    ovf_url, template_name,
-    :run_without_interruptions => true,
-    :config => lease_tool.set_lease_in_vm_config({}, lease)
-  )
-end
-
-puts "#{Time.now}: Cloning template ..."
-config = {
-  :numCPUs => opts[:cpus],
-  :memoryMB => opts[:memory],
-}
-config = lease_tool.set_lease_in_vm_config(config, lease)
-vm = deployer.linked_clone template, vm_name, config
-
-puts "#{Time.now}: Powering On VM ..."
-# XXX: Add a retrying version?
-vm.PowerOnVM_Task.wait_for_completion
-
-puts "#{Time.now}: Waiting for VM to be up ..."
-ip = nil
-while !(ip = vm.guest_ip)
-  sleep 5
-end
-
-puts "#{Time.now}: VM got IP: #{ip}"
-
-puts "#{Time.now}: Done"
-