vmware_web_service 2.0.3 → 3.1.0

data/lib/VMwareWebService/VixDiskLib/VixDiskLibServer.rb

@@ -11,19 +11,17 @@ require 'VMwareWebService/VixDiskLib/vdl_wrapper'
 class VixDiskLibError < RuntimeError
 end
 
-LOG_FILE    = ENV["LOG_FILE"]
-
-$vim_log = Logger.new LOG_FILE
-
 class VDDKFactory
   include DRb::DRbUndumped
   attr_accessor :shutdown
   attr_accessor :running
+  attr_reader   :logger
 
   def initialize
     @shutdown = nil
     @started = nil
     @running = nil
+    @logger  = Logger.new($stdout)
   end
 
   def init
@@ -45,14 +43,14 @@ class VDDKFactory
     thr = DRb.thread
     DRb.stop_service
     thr.join unless thr.nil?
-    $vim_log.info "Finished shutting down DRb"
+    logger.info "Finished shutting down DRb"
   end
 
   def shut_down_service(msg)
-    $vim_log.info msg.to_s
+    logger.info msg.to_s
     VdlWrapper.__exit__ if @started
     @running = true
-    $vim_log.info "VdlWrapper.__exit__ finished"
+    logger.info "VdlWrapper.__exit__ finished"
     shut_down_drb
   end
 
@@ -95,11 +93,13 @@ begin
   STDOUT.sync = true
   STDERR.sync = true
 
+  logger = Logger.new($stdout)
+
   DRb.start_service(nil, vddk)
   DRb.primary_server.verbose = true
   uri_used = DRb.uri
   Thread.abort_on_exception = true
-  $vim_log.info "Started DRb service on URI #{uri_used}"
+  logger.info "Started DRb service on URI #{uri_used}"
   #
   # Now write the URI used back to the parent (client) process to let it know which port was selected.
   #
@@ -115,21 +115,21 @@ begin
   trap('TERM') { vddk.shut_down_service("Termination Signal received"); exit }
 
   Thread.new do
-    $vim_log.info "Monitoring Thread"
+    logger.info "Monitoring Thread"
     #
     # This will block until the SmartProxyWorker (our parent) exits
     #
     proc_reader.read
-    $vim_log.info "Shutting down VixDiskLibServer - Worker has exited"
+    logger.info "Shutting down VixDiskLibServer - Worker has exited"
     exit
   end
   #
   # If we haven't been marked as started yet, wait for it.
   # We may return immediately because startup (and more) has already happened.
   #
-  $vim_log.info "calling watchdog for startup"
+  logger.info "calling watchdog for startup"
   vddk.wait_for_status("started", 1800)
-  $vim_log.info "startup has happened, shutdown flag is #{vddk.shutdown}"
+  logger.info "startup has happened, shutdown flag is #{vddk.shutdown}"
   #
   # Wait for the DRb server thread to finish before exiting.
   #
@@ -142,8 +142,8 @@ begin
   end
 
   vddk.shut_down_service("Shutting Down VixDiskLibServer")
-  $vim_log.info "Service has stopped"
+  logger.info "Service has stopped"
 rescue => err
-  $vim_log.error "VixDiskLibServer ERROR: [#{err}]"
-  $vim_log.debug "VixDiskLibServer ERROR: [#{err.backtrace.join("\n")}]"
+  logger.error "VixDiskLibServer ERROR: [#{err}]"
+  logger.debug "VixDiskLibServer ERROR: [#{err.backtrace.join("\n")}]"
 end

data/lib/VMwareWebService/VixDiskLib/vdl_wrapper.rb

@@ -2,16 +2,14 @@ require 'drb/drb'
 require 'sync'
 require 'ffi-vix_disk_lib/api_wrapper'
 require 'VMwareWebService/VimTypes'
+require 'VMwareWebService/logging'
 require 'time'
 
-LOG_FILE    = ENV["LOG_FILE"]
-
-$vim_log = Logger.new LOG_FILE
-
 VixDiskLibApi = FFI::VixDiskLib::ApiWrapper
 class VdlWrapper
   extend FFI::VixDiskLib::ApiWrapper
   include DRb::DRbUndumped
+  include VMwareWebService::Logging
 
   @initialized       = false
   @server_disk_count = 0
@@ -22,9 +20,9 @@ class VdlWrapper
     @vddk = server
   end
 
-  @info_log  = ->(s) { $vim_log.info "VMware(VixDiskLib): #{s}" }
-  @warn_log  = ->(s) { $vim_log.warn "VMware(VixDiskLib): #{s}" }
-  @error_log = ->(s) { $vim_log.error "VMware(VixDiskLib): #{s}" }
+  @info_log  = ->(s) { logger.info "VMware(VixDiskLib): #{s}" }
+  @warn_log  = ->(s) { logger.warn "VMware(VixDiskLib): #{s}" }
+  @error_log = ->(s) { logger.error "VMware(VixDiskLib): #{s}" }
 
   def self.init
     return if @initialized
@@ -34,10 +32,10 @@ class VdlWrapper
   end
 
   def self.dumpDisks(server_name)
-    $vim_log.warn "*** Open VdlDisks for server #{server_name}" if $vim_log
+    logger.warn "*** Open VdlDisks for server #{server_name}"
     @connection.dumpDisks unless @connection.nil? || @connection.serverName != server_name
     @vddk.running = true
-    $vim_log.warn "*** Open VdlDisks end" if $vim_log
+    logger.warn "*** Open VdlDisks end"
   end
 
   def self.inc_server_disk_count
@@ -53,7 +51,7 @@ class VdlWrapper
   end
 
   def self.connect(connect_parms)
-    $vim_log.info "VdlWrapper.connect: #{connect_parms[:server_name]}" if $vim_log
+    logger.info "VdlWrapper.connect: #{connect_parms[:server_name]}"
     raise VixDiskLibError, "VixDiskLib is not initialized" unless @initialized
     raise VixDiskLibError, "Already connected to #{@connection.serverName}" if @connection
     @connection = VdlConnection.new(connect_parms, @vddk)
@@ -61,7 +59,7 @@ class VdlWrapper
   end
 
   def self.__disconnect__(conn_obj)
-    $vim_log.info "VdlWrapper.__disconnect__: #{conn_obj.serverName}" if $vim_log
+    logger.info "VdlWrapper.__disconnect__: #{conn_obj.serverName}"
     raise VixDiskLibError, "VixDiskLib is not initialized" unless @initialized
     FFI::VixDiskLib::API.disconnect(conn_obj.vdl_connection)
     @connection = nil
@@ -76,7 +74,7 @@ class VdlWrapper
     # the DRb service (this process) to segfault during the exit sequence.
     #
     # super
-    $vim_log.info "VixDiskLib has exited cleanly"
+    logger.info "VixDiskLib has exited cleanly"
     @vddk.running = true
     @vddk.shutdown = true
     @initialized = nil
@@ -92,7 +90,7 @@ class VdlConnection
 
   def initialize(connect_parms, vddk)
     @serverName     = connect_parms[:server_name]
-    $vim_log.info "VdlConnection.initialize: #{@serverName}" if $vim_log
+    logger.info "VdlConnection.initialize: #{@serverName}"
     @vdl_connection  = VixDiskLibApi.connect(connect_parms)
     @disks           = []
     @disk_lock       = Sync.new
@@ -100,10 +98,10 @@ class VdlConnection
   end
 
   def disconnect
-    $vim_log.info "VdlConnection.disconnect: #{@serverName}" if $vim_log
+    logger.info "VdlConnection.disconnect: #{@serverName}"
     @disk_lock.synchronize(:EX) do
       if !@vdl_connection
-        $vim_log.warn "VDLConnection.disconnect: server: #{@serverName} not connected" if $vim_log
+        logger.warn "VDLConnection.disconnect: server: #{@serverName} not connected"
       else
         __close_disks__
         VdlWrapper.__disconnect__(self)
@@ -119,7 +117,7 @@ class VdlConnection
     @vddk.running = true
     @disk_lock.sync_lock(:SH) if (unlock = !@disk_lock.sync_locked?)
     @disks.each do |d|
-      $vim_log.warn "    VdlDisk: #{d.path}, opened: #{d.timeStamp}" if $vim_log
+      logger.warn "    VdlDisk: #{d.path}, opened: #{d.timeStamp}"
     end
   ensure
     @disk_lock.sync_unlock if unlock
@@ -132,11 +130,11 @@ class VdlConnection
       disk = VdlDisk.new(self, path, flags)
       @disks << disk
       nd = VdlWrapper.inc_server_disk_count
-      $vim_log.info "VdlConnection.getDisk: #{@serverName} open disks = #{nd}" if $vim_log
-      if nd >= MAX_DISK_WARN && $vim_log
-        $vim_log.warn "VdlConnection::getDisk: connection to server: #{@serverName}"
-        $vim_log.warn "VdlConnection::getDisk: number of open disks = #{nd}"
-        $vim_log.warn "VdlConnection::getDisk: subsequent open calls may fail"
+      logger.info "VdlConnection.getDisk: #{@serverName} open disks = #{nd}"
+      if nd >= MAX_DISK_WARN
+        logger.warn "VdlConnection::getDisk: connection to server: #{@serverName}"
+        logger.warn "VdlConnection::getDisk: number of open disks = #{nd}"
+        logger.warn "VdlConnection::getDisk: subsequent open calls may fail"
         VdlWrapper.dumpDisks(@serverName)
       end
       return disk
@@ -149,11 +147,11 @@ class VdlConnection
     @vddk.running = true
     VixDiskLibApi.close(diskObj.handle)
     if !@vdl_connection
-      $vim_log.warn "VDLConnection.disconnect: server: #{@serverName} not connected" if $vim_log
+      logger.warn "VDLConnection.disconnect: server: #{@serverName} not connected"
     else
       @disks.delete(diskObj)
       nd = VdlWrapper.dec_server_disk_count
-      $vim_log.warn "VdlConnection.__close_disk__: #{@serverName} open disks = #{nd}" if $vim_log
+      logger.warn "VdlConnection.__close_disk__: #{@serverName} open disks = #{nd}"
     end
   ensure
     @disk_lock.sync_unlock if unlock
@@ -163,7 +161,7 @@ class VdlConnection
     raise VixDiskLibError,
           "VdlConnection::__close_disks__: exclusive disk lock not held" unless @disk_lock.sync_exclusive?
     if !@vdl_connection
-      $vim_log.warn "VDLConnection.disconnect: server: #{@serverName} not connected" if $vim_log
+      logger.warn "VDLConnection.disconnect: server: #{@serverName} not connected"
     else
       @disks.each(&:close)
     end
@@ -173,6 +171,7 @@ end # class VdlConnection
 
 class VdlDisk
   include DRb::DRbUndumped
+  include VMwareWebService::Logging
 
   attr_reader :path, :flags, :handle, :sectorSize, :timeStamp, :info
 
@@ -180,7 +179,7 @@ class VdlDisk
 
   def initialize(conn_obj, path, flags)
     @time_stamp = Time.now
-    $vim_log.debug "VdlDisk.new <#{object_id}>: opening #{path}" if $vim_log && $vim_log.debug?
+    logger.debug { "VdlDisk.new <#{object_id}>: opening #{path}" }
     @connection = conn_obj
     @handle = VixDiskLibApi.open(@connection.vdl_connection, path, flags)
     @path = path
@@ -196,11 +195,11 @@ class VdlDisk
   end
 
   def close
-    $vim_log.debug "VdlDisk.close <#{ssId}>: closing #{@path}" if $vim_log && $vim_log.debug?
+    logger.debug { "VdlDisk.close <#{ssId}>: closing #{@path}" }
     @vddk.running = true
     @handle_lock.synchronize(:EX) do
       if !@handle
-        $vim_log.debug "VdlDisk.close: #{@path} not open" if $vim_log && $vim_log.debug?
+        logger.debug { "VdlDisk.close: #{@path} not open" }
       else
         @connection.__close_disk__(self)
         @handle = nil

data/lib/VMwareWebService/exception.rb

@@ -2,8 +2,6 @@ module MiqException
   class Error < RuntimeError; end
 
   class MiqVimError < Error; end
-  class MiqVimBrokerStaleHandle < MiqVimError; end
-  class MiqVimBrokerUnavailable < MiqVimError; end
   # MiqVimResourceNotFound is derived from RuntimeError to ensure it gets marshalled over DRB properly.
   # TODO: Rename MiqException::Error class to avoid issues returning derived error classes over DRB.
   #       Then change MiqVimResourceNotFound to derive from MiqVimError

data/lib/VMwareWebService/logging.rb

@@ -0,0 +1,16 @@
+module VMwareWebService
+  class << self
+    attr_writer :logger
+  end
+
+  def self.logger
+    require "logger"
+    @logger ||= Logger.new(nil)
+  end
+
+  module Logging
+    def logger
+      VMwareWebService.logger
+    end
+  end
+end

data/lib/VMwareWebService/version.rb

@@ -1,3 +1,3 @@
 module VMwareWebService
-  VERSION = '2.0.3'.freeze
+  VERSION = '3.1.0'.freeze
 end

data/lib/vmware_web_service.rb

@@ -5,3 +5,5 @@ autoload :VimArray,  'VMwareWebService/VimTypes'
 autoload :VimString, 'VMwareWebService/VimTypes'
 autoload :VimFault,  'VMwareWebService/VimTypes'
 autoload :VimClass,  'VMwareWebService/VimTypes'
+
+require "VMwareWebService/logging"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vmware_web_service
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 3.1.0
 platform: ruby
 authors:
 - ManageIQ Developers
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-15 00:00:00.000000000 Z
+date: 2022-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,7 +19,7 @@ dependencies:
         version: 5.2.4.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 5.2.4.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: ffi-vix_disk_lib
   requirement: !ruby/object:Gem::Requirement
@@ -107,21 +107,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: manageiq-password
+  name: manageiq-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -162,42 +148,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.52'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.52'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
 description: A ruby interface to Vmware Web Services SDK
-email:
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/VMwareWebService/DMiqVim.rb
-- lib/VMwareWebService/DMiqVimSync.rb
 - lib/VMwareWebService/MiqCustomFieldsManager.rb
 - lib/VMwareWebService/MiqHostAdvancedOptionManager.rb
 - lib/VMwareWebService/MiqHostDatastoreSystem.rb
@@ -209,11 +179,8 @@ files:
 - lib/VMwareWebService/MiqHostVirtualNicManager.rb
 - lib/VMwareWebService/MiqVim.rb
 - lib/VMwareWebService/MiqVimAlarmManager.rb
-- lib/VMwareWebService/MiqVimBroker.rb
-- lib/VMwareWebService/MiqVimBrokerMods.rb
 - lib/VMwareWebService/MiqVimClientBase.rb
 - lib/VMwareWebService/MiqVimCluster.rb
-- lib/VMwareWebService/MiqVimCoreUpdater.rb
 - lib/VMwareWebService/MiqVimCustomizationSpecManager.rb
 - lib/VMwareWebService/MiqVimDataStore.rb
 - lib/VMwareWebService/MiqVimDump.rb
@@ -238,7 +205,7 @@ files:
 - lib/VMwareWebService/broker_timeout.rb
 - lib/VMwareWebService/esx_thumb_print.rb
 - lib/VMwareWebService/exception.rb
-- lib/VMwareWebService/miq_fault_tolerant_vim.rb
+- lib/VMwareWebService/logging.rb
 - lib/VMwareWebService/thumb_print.rb
 - lib/VMwareWebService/vcenter_thumb_print.rb
 - lib/VMwareWebService/version.rb
@@ -4445,23 +4412,23 @@ homepage: https://github.com/ManageIQ/vmware_web_service
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.2
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: A ruby interface to Vmware Web Services SDK
 test_files: []

data/lib/VMwareWebService/DMiqVim.rb

@@ -1,95 +0,0 @@
-require 'VMwareWebService/MiqVim'
-require 'VMwareWebService/DMiqVimSync'
-
-#
-# Class used to wrap locked object and return it through DRB.
-#
-class MiqDrbReturn
-  attr_accessor :obj, :lock
-
-  def initialize(obj, lock = nil)
-    @obj = obj
-    @lock = lock
-  end
-end
-
-class DMiqVim < MiqVim
-  alias_method :serverPrivateConnect, :connect
-  alias_method :serverPrivateDisconnect, :disconnect
-  alias_method :conditionalCopy, :deepClone
-
-  include DRb::DRbUndumped
-  include DMiqVimSync
-
-  # @param server [String] DNS name or IP address of the vCenter Server 
-  # @param username [String] Username to connect to the vCenter Server
-  # @param password [String] Password to connect to the vCenter Server
-  # @param broker [MiqVimBroker] Instance of the broker worker this connection belongs to
-  # @param preLoad [Bool] Should the cache be built before returning the connection (default: false)
-  # @param debugUpdates [Bool] Should we print debug info for each update (default: false)
-  # @param notifyMethod [Method] A optional method to call for each update (default: nil)
-  # @param cacheScope [Symbol] A pre-defined set of properties to cache (default: nil)
-  # @param maxWait [Integer] How many seconds to wait before breaking out of WaitForUpdates (default: 60)
-  # @param maxObjects [Integer] How many objects to return from each WaitForUpdates page (default: 250)
-  def initialize(server, username, password, broker, preLoad = false, debugUpdates = false, notifyMethod = nil, cacheScope = nil, maxWait = 60, maxObjects = 250)
-    super(server, username, password, cacheScope, monitor_updates = true, preLoad, debugUpdates, notifyMethod, maxWait, maxObjects)
-
-    @broker                 = broker
-    @connectionShuttingDown = false
-    @connectionRemoved      = false
-  end
-
-  def monitor(preLoad)
-    log_prefix = "DMiqVim.monitor (#{@connId})"
-    begin
-      monitorUpdates(preLoad)
-    rescue Exception => err
-      # if handleSessionNotAuthenticated(err)
-      #   $vim_log.info "#{log_prefix}: Restarting Update Monitor" if $vim_log
-      #   retry
-      # end
-      $vim_log.info "#{log_prefix}: returned from monitorUpdates via #{err.class} exception" if $vim_log
-      @error = err
-    ensure
-      $vim_log.info "#{log_prefix}: returned from monitorUpdates" if $vim_log
-      if @updateMonitorReady && !@broker.shuttingDown
-        @broker.connTrySync(:EX, server, username) do |key|
-          @broker.removeMiqVimSS(key, self)
-        end
-
-        if @notifyMethod
-          @notifyMethod.call(:server   => @server,
-                             :username => @username,
-                             :op       => 'MiqVimRemoved',
-                             :error    => @error
-                            )
-        end
-      end
-    end
-  end
-
-  def shutdownConnection
-    return if @connectionShuttingDown
-    log_prefix = "DMiqVim.shutdownConnection (#{@connId})"
-    $vim_log.info "#{log_prefix}: for address=<#{@server}>, username=<#{@username}>...Starting" if $vim_log
-    @connectionShuttingDown = true
-    serverPrivateDisconnect if self.isAlive?
-    $vim_log.info "#{log_prefix}: for address=<#{@server}>, username=<#{@username}>...Complete" if $vim_log
-  end
-
-  def connectionRemoved?
-    @connectionRemoved
-  end
-
-  def connectionRemoved
-    @connectionRemoved = true
-  end
-
-  def connect
-    (true)
-  end
-
-  def disconnect
-    (true)
-  end
-end # class DMiqVim

data/lib/VMwareWebService/DMiqVimSync.rb

@@ -1,45 +0,0 @@
-
-module DMiqVimSync
-  #
-  # This method is called - with the cacheLock held - when returning an object from the cache to the client.
-  # It used to produce a full recursive copy of the object before releasing the lock.
-  # When used in the broker, the DRB layer would then marshal the copy of the object to return it to the remote client.
-  # This new scheme enables us to hold the cacheLock until after DRB marshals the object, eliminating the need
-  # for this method to produce a full recursive copy.
-  #
-  # The lock count of the cacheLock is incremented, so when this method's caller releases the lock, the lock
-  # will still be held. The object to be returned and the cacheLock are wraped in a MiqDrbReturn object
-  # and returned to the DRB layer, which will marshal the object and release the lock. See below.
-  #
-  def dupObj(obj)
-    return(obj) unless @cacheLock.sync_locked?
-    $vim_log.debug "DMiqVim::dupObj: LOCKING [#{Thread.current.object_id}] <#{obj.object_id}>" if $vim_log.debug?
-    @cacheLock.sync_lock(:SH)
-    (MiqDrbReturn.new(obj, @cacheLock))
-  end
-end # module DMiqVimSync
-
-class DRb::DRbMessage
-  alias_method :dump_original, :dump
-
-  #
-  # This is the DRB half of the dupObj locking scheme. If we get a MiqDrbReturn object,
-  # we marshal the object it wraps and release the lock.
-  #
-  def dump(obj, error = false)
-    #
-    # Place a temp hold on the object until the client registers it.
-    #
-    obj.holdBrokerObj if obj.respond_to?(:holdBrokerObj)
-
-    return(dump_original(obj, error)) unless obj.kind_of?(MiqDrbReturn)
-    begin
-      return(dump_original(obj.obj, error))
-    ensure
-      if obj.lock && obj.lock.sync_locked?
-        $vim_log.debug "DRb::DRbMessage.dump: UNLOCKING [#{Thread.current.object_id}] <#{obj.obj.object_id}>" if $vim_log.debug?
-        obj.lock.sync_unlock
-      end
-    end
-  end
-end # class DRb::DRbMessage