vmware_web_service 2.1.1 → 3.0.0

data/lib/VMwareWebService/VimService.rb

@@ -1,8 +1,11 @@
 require "handsoap"
 require 'active_support/core_ext/numeric/bytes'
+require 'VMwareWebService/logging'
 require 'VMwareWebService/VimTypes'
 
 class VimService < Handsoap::Service
+  include VMwareWebService::Logging
+
   attr_reader :sic, :about, :apiVersion, :isVirtualCenter, :v20, :v2, :v4, :v5, :v6, :serviceInstanceMor, :session_cookie
 
   Handsoap.http_driver = :HTTPClient
@@ -1291,14 +1294,14 @@ class VimService < Handsoap::Service
       if @xml_payload_len > @xml_payload_max
         @xml_payload_len = 0
 
-        $vim_log.debug("#{log_prefix} Running garbage collection")
+        logger.debug("#{log_prefix} Running garbage collection")
 
         # Force a GC, because Ruby's GC is triggered on number of objects without
         #   regard to size.  The object we just freed may not be released right away.
         gc_time = Benchmark.realtime { GC.start }
 
         gc_log_level = gc_time >= 5 ? :warn : :debug
-        $vim_log.send(gc_log_level, "#{log_prefix} Garbage collection took #{gc_time} seconds")
+        logger.send(gc_log_level, "#{log_prefix} Garbage collection took #{gc_time} seconds")
       end
     end
   end

data/lib/VMwareWebService/VixDiskLib/VixDiskLib.rb

@@ -2,6 +2,8 @@ require 'drb/drb'
 require 'sync'
 require 'ffi-vix_disk_lib/const'
 require 'ffi-vix_disk_lib/enum'
+require 'VMwareWebService/logging'
+
 #
 # The path to the VixDiskLib directory to be added to the process' LD_LIBRARY_PATH
 #
@@ -17,6 +19,8 @@ end
 SERVER_PATH = File.expand_path(__dir__)
 
 class VixDiskLib
+  include VMwareWebService::Logging
+
   VIXDISKLIB_FLAG_OPEN_READ_ONLY = FFI::VixDiskLib::API::VIXDISKLIB_FLAG_OPEN_READ_ONLY
   @initialized = nil
   @drb_services = []
@@ -66,12 +70,12 @@ class VixDiskLib
       i = 0
       @drb_services.each do |vdl_service|
         i += 1
-        $vim_log.info "VixDiskLib.exit: shutting down service #{i} of #{@drb_services.size}" if $vim_log
+        logger.info "VixDiskLib.exit: shutting down service #{i} of #{@drb_services.size}"
         unless vdl_service.nil?
           begin
             vdl_service.shutdown = true
           rescue DRb::DRbConnError
-            $vim_log.info "VixDiskLib.exit: DRb connection closed due to service shutdown.  Continuing" if $vim_log
+            logger.info "VixDiskLib.exit: DRb connection closed due to service shutdown.  Continuing"
           end
         end
       end
@@ -95,8 +99,8 @@ class VixDiskLib
     end
 
     my_env["LD_LIBRARY_PATH"] = (my_env["LD_LIBRARY_PATH"].to_s.split(':') << VIXDISKLIB_PATH).compact.join(":")
-    raise VixDiskLibError, "VixDiskLib.connect() failed: No $vim_log defined" unless $vim_log
-    my_env["LOG_FILE"] = $vim_log.logdev.filename.to_s if $vim_log.logdev.kind_of?(Logger::LogDevice)
+    raise VixDiskLibError, "VixDiskLib.connect() failed: No logger defined" unless logger
+    my_env["LOG_FILE"] = logger.logdev.filename.to_s if logger.logdev.kind_of?(Logger::LogDevice)
 
     my_env
   end
@@ -112,7 +116,7 @@ class VixDiskLib
     server_cmd = "ruby #{SERVER_PATH}/VixDiskLibServer.rb"
     log_target = my_env["LOG_FILE"] ? [my_env["LOG_FILE"], "a"] : $stdout
 
-    $vim_log.info "VixDiskLib.start_service: running command = #{server_cmd}"
+    logger.info "VixDiskLib.start_service: running command = #{server_cmd}"
 
     pid = Kernel.spawn(my_env, server_cmd,
                        [:out, :err]     => log_target,
@@ -122,7 +126,7 @@ class VixDiskLib
     uri_writer.close
     proc_reader.close
     Process.detach(pid)
-    $vim_log.info "VixDiskLibServer Process #{pid} started" if $vim_log
+    logger.info "VixDiskLibServer Process #{pid} started"
     DRb.start_service
     retry_num = 5
     uri       = get_uri(uri_reader)

data/lib/VMwareWebService/VixDiskLib/VixDiskLibServer.rb

@@ -11,17 +11,17 @@ require 'VMwareWebService/VixDiskLib/vdl_wrapper'
 class VixDiskLibError < RuntimeError
 end
 
-$vim_log = Logger.new $stdout
-
 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
@@ -43,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
 
@@ -93,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.
   #
@@ -113,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.
   #
@@ -140,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,14 +2,14 @@ require 'drb/drb'
 require 'sync'
 require 'ffi-vix_disk_lib/api_wrapper'
 require 'VMwareWebService/VimTypes'
+require 'VMwareWebService/logging'
 require 'time'
 
-$vim_log = Logger.new $stdout
-
 VixDiskLibApi = FFI::VixDiskLib::ApiWrapper
 class VdlWrapper
   extend FFI::VixDiskLib::ApiWrapper
   include DRb::DRbUndumped
+  include VMwareWebService::Logging
 
   @initialized       = false
   @server_disk_count = 0
@@ -20,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
@@ -32,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
@@ -51,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)
@@ -59,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
@@ -74,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
@@ -90,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
@@ -98,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)
@@ -117,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
@@ -130,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
@@ -147,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
@@ -161,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
@@ -171,6 +171,7 @@ end # class VdlConnection
 
 class VdlDisk
   include DRb::DRbUndumped
+  include VMwareWebService::Logging
 
   attr_reader :path, :flags, :handle, :sectorSize, :timeStamp, :info
 
@@ -178,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
@@ -194,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.1.1'.freeze
+  VERSION = '3.0.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.1.1
+  version: 3.0.0
 platform: ruby
 authors:
 - ManageIQ Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-10 00:00:00.000000000 Z
+date: 2021-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -121,7 +121,7 @@ dependencies:
       - !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,20 +162,6 @@ 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
@@ -196,8 +182,6 @@ 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 +193,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 +219,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
@@ -4451,9 +4432,9 @@ 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:
   - - ">="