vmware_web_service 0.4.10 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55282eac83a1152907a531201ac903f05f0c282cdcb60cd807ab4e695fc3e945
-  data.tar.gz: 1dd7bb1f11ed5121ae33989e09a0fb4abebb1c4efc4125d4e964a7ba433d99cb
+  metadata.gz: 9a3fda957a5c3f40ee4cb771e4dfb68ffcabaec2b511c3088a9070de7c816e96
+  data.tar.gz: 2f411a8da658bf1112f7f589909c10ada57265e9f9f230acb346dffcf7199b93
 SHA512:
-  metadata.gz: 5d762d75ce5e3590b078fe64c813b8a9d7bd6865017f1fde052d52003e6b0a1986bcf72d9888ca78a47544b899f1f8cc16383e68222b35d0a8716af8c1463dc1
-  data.tar.gz: 1f4eb2f599c2c35ea2d7f8f5d9dc7e9b0ef14b8298596501c27acbd38e878705683c28459f82c1dad42eac6cab12cdd8433b360361019a26cdd2e067312289f4
+  metadata.gz: 72ffcec7bdefef9325d1f28f2fa80ea9ee75585d69523ad852adeec32a836bd505fa1fdfeb80572f52963762c63852970d100d1e6c313909eda1a3fece8cf618
+  data.tar.gz: 3aaf49a620c290efc30a14171c052e8cccfc900a82c7d386b627a92a124c28cdfb4a705e86e4f483faac174bfe24a9a169bdc7e459692cda04f3954bac56be76

data/lib/VMwareWebService/DMiqVim.rb

@@ -1,5 +1,4 @@
 require 'VMwareWebService/MiqVim'
-require 'VMwareWebService/MiqVimUpdate'
 require 'VMwareWebService/DMiqVimSync'
 
 #
@@ -20,66 +19,24 @@ class DMiqVim < MiqVim
   alias_method :conditionalCopy, :deepClone
 
   include DRb::DRbUndumped
-  include MiqVimUpdate
   include DMiqVimSync
 
-  attr_reader :updateThread
-
+  # @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)
+    super(server, username, password, cacheScope, monitor_updates = true, preLoad, debugUpdates, notifyMethod, maxWait, maxObjects)
 
-    log_prefix        = "DMiqVim.initialize (#{@connId})"
-    @broker         = broker
-    @updateMonitorReady   = false
-    @error          = nil
-    @notifyMethod     = notifyMethod
+    @broker                 = broker
     @connectionShuttingDown = false
-    @connectionRemoved    = false
-    @debugUpdates     = debugUpdates
-    @maxWait          = maxWait
-    @maxObjects       = maxObjects
-
-    checkForOrphanedMonitors
-    $vim_log.info "#{log_prefix}: starting update monitor thread" if $vim_log
-    @updateThread = Thread.new { monitor(preLoad) }
-    @updateThread[:vim_connection_id] = connId
-    $vim_log.info "#{log_prefix}: waiting for update monitor to become ready" if $vim_log
-    until @updateMonitorReady
-      raise @error unless @error.nil?
-      break unless @updateThread.alive?
-      Thread.pass
-    end
-    $vim_log.info "#{log_prefix}: update monitor ready" if $vim_log
-  end
-
-  # VC sometimes throws: Handsoap::Fault { :code => 'ServerFaultCode', :reason => 'The session is not authenticated.' }
-  # Handle this condition by reconnecting and monitoring again
-  # See http://communities.vmware.com/thread/190531
-  def handleSessionNotAuthenticated(err)
-    return false unless err.respond_to?(:reason) && err.reason == 'The session is not authenticated.'
-
-    log_prefix = "DMiqVim.handleSessionNotAuthenticated (#{@connId})"
-    $vim_log.error "#{log_prefix}: Reconnecting Session because '#{err.reason}'" if $vim_log
-    $vim_log.info "#{log_prefix}: Session(server=#{server}, username=#{username}) isAlive? => #{self.isAlive?.inspect}" if $vim_log
-
-    begin
-      $vim_log.info  "#{log_prefix}: Disconnecting Session" if $vim_log
-      serverPrivateDisconnect
-      $vim_log.info  "#{log_prefix}: Disconnecting Session...Complete" if $vim_log
-    rescue => disconnect_err
-      $vim_log.error "#{log_prefix}: Disconnecting Session...Error #{disconnect_err}" if $vim_log
-    end
-
-    begin
-      $vim_log.info  "#{log_prefix}: Connecting Session" if $vim_log
-      serverPrivateConnect
-      $vim_log.info  "#{log_prefix}: Connecting Session...Complete" if $vim_log
-    rescue => connect_err
-      $vim_log.error "#{log_prefix}: Connecting Session...Error #{connect_err}" if $vim_log
-      @error = err
-    end
-
-    @error.nil?
+    @connectionRemoved      = false
   end
 
   def monitor(preLoad)
@@ -116,31 +73,10 @@ class DMiqVim < MiqVim
     log_prefix = "DMiqVim.shutdownConnection (#{@connId})"
     $vim_log.info "#{log_prefix}: for address=<#{@server}>, username=<#{@username}>...Starting" if $vim_log
     @connectionShuttingDown = true
-    stopUpdateMonitor
-    begin
-      if @updateThread != Thread.current && @updateThread.alive?
-        $vim_log.info "#{log_prefix}: waiting for Update Monitor Thread...Starting" if $vim_log
-        @updateThread.join
-        $vim_log.info "#{log_prefix}: waiting for Update Monitor Thread...Complete" if $vim_log
-      end
-    rescue => err
-    end
     serverPrivateDisconnect if self.isAlive?
     $vim_log.info "#{log_prefix}: for address=<#{@server}>, username=<#{@username}>...Complete" if $vim_log
   end
 
-  def checkForOrphanedMonitors
-    log_prefix = "DMiqVim.checkForOrphanedMonitors (#{@connId})"
-    $vim_log.debug "#{log_prefix}: called..."
-    Thread.list.each do |thr|
-      next unless thr[:vim_connection_id] == connId
-      $vim_log.error "#{log_prefix}: Terminating orphaned update monitor <#{thr.object_id}>"
-      thr.raise "Orphaned update monitor (#{@connId}) <#{thr.object_id}>, terminated by <#{Thread.current.object_id}>"
-      thr.wakeup
-    end
-    $vim_log.debug "#{log_prefix}: done."
-  end
-
   def connectionRemoved?
     @connectionRemoved
   end

data/lib/VMwareWebService/MiqVim.rb

@@ -13,15 +13,39 @@ require 'VMwareWebService/MiqVimEventHistoryCollector'
 require 'VMwareWebService/MiqCustomFieldsManager'
 require 'VMwareWebService/MiqVimAlarmManager'
 require 'VMwareWebService/MiqVimCustomizationSpecManager'
+require 'VMwareWebService/MiqVimUpdate'
 
 class MiqVim < MiqVimInventory
   include MiqVimVdlConnectionMod
   include MiqPbmInventory
+  include MiqVimUpdate
 
-  def initialize(server, username, password, cacheScope = nil)
-    super
+  attr_reader :updateThread, :monitor_updates
+
+  # @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 cacheScope [Symbol] A pre-defined set of properties to cache (default: nil)
+  # @param monitor_updates [Bool] Should a thread be started to monitor updates (default: false)
+  # @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 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, cacheScope = nil, monitor_updates = false, preLoad = false, debugUpdates = false, notifyMethod = nil, maxWait = 60, maxObjects = 250)
+    super(server, username, password, cacheScope)
 
     pbm_initialize(self)
+
+    @monitor_updates    = monitor_updates
+    @updateMonitorReady = false
+    @error              = nil
+    @notifyMethod       = notifyMethod
+    @debugUpdates       = debugUpdates
+    @maxWait            = maxWait
+    @maxObjects         = maxObjects
+
+    start_monitor_updates_thread(preLoad) if @monitor_updates
   end
 
   def getVimVm(path)
@@ -227,6 +251,60 @@ class MiqVim < MiqVimInventory
   end
 
   def disconnect
+    shutdown_monitor_updates_thread if @monitor_updates
+
     super
   end
+
+  private
+
+  def start_monitor_updates_thread(preLoad)
+    checkForOrphanedMonitors
+    log_prefix          = "MiqVim.initialize (#{@connId})"
+    $vim_log.info "#{log_prefix}: starting update monitor thread" if $vim_log
+    @updateThread = Thread.new { monitor(preLoad) }
+    @updateThread[:vim_connection_id] = connId
+    $vim_log.info "#{log_prefix}: waiting for update monitor to become ready" if $vim_log
+    until @updateMonitorReady
+      raise @error unless @error.nil?
+      break unless @updateThread.alive?
+      Thread.pass
+    end
+    $vim_log.info "#{log_prefix}: update monitor ready" if $vim_log
+  end
+
+  def checkForOrphanedMonitors
+    log_prefix = "MiqVim.checkForOrphanedMonitors (#{@connId})"
+    $vim_log.debug "#{log_prefix}: called..."
+    Thread.list.each do |thr|
+      next unless thr[:vim_connection_id] == connId
+      $vim_log.error "#{log_prefix}: Terminating orphaned update monitor <#{thr.object_id}>"
+      thr.raise "Orphaned update monitor (#{@connId}) <#{thr.object_id}>, terminated by <#{Thread.current.object_id}>"
+      thr.wakeup
+    end
+    $vim_log.debug "#{log_prefix}: done."
+  end
+
+  def monitor(preLoad)
+    log_prefix = "MiqVim.monitor (#{@connId})"
+    begin
+      monitorUpdates(preLoad)
+    rescue Exception => err
+      $vim_log.info "#{log_prefix}: returned from monitorUpdates via #{err.class} exception" if $vim_log
+      @error = err
+    end
+  end
+
+  def shutdown_monitor_updates_thread
+    log_prefix = "MiqVim.disconnect (#{@connId})"
+    stopUpdateMonitor
+    begin
+      if @updateThread != Thread.current && @updateThread.alive?
+        $vim_log.info "#{log_prefix}: waiting for Update Monitor Thread...Starting" if $vim_log
+        @updateThread.join
+        $vim_log.info "#{log_prefix}: waiting for Update Monitor Thread...Complete" if $vim_log
+      end
+    rescue
+    end
+  end
 end # module MiqVim

data/lib/VMwareWebService/version.rb

@@ -1,3 +1,3 @@
 module VMwareWebService
-  VERSION = '0.4.10'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vmware_web_service
 version: !ruby/object:Gem::Version
-  version: 0.4.10
+  version: 1.0.0
 platform: ruby
 authors:
 - ManageIQ Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-22 00:00:00.000000000 Z
+date: 2020-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport