From 72f2107c7b8f7dc14789ce7800172e1f64ac2f7a Mon Sep 17 00:00:00 2001
From: Oleg Barenboim <chessbyte@gmail.com>
Date: Wed, 20 Nov 2019 14:02:02 +0100
Subject: [PATCH] Subclass VmScan job as
 ManageIQ::Providers::Vmware::InfraManager::Scanning::Job

---
 .../vmware/infra_manager/scanning.rb          |   3 +
 .../vmware/infra_manager/scanning/job.rb      | 313 ++++++++++++++++++
 .../vm_or_template_shared/scanning.rb         |   4 +
 .../vmware/infra_manager/vm_scan_spec.rb      |   4 +-
 4 files changed, 322 insertions(+), 2 deletions(-)
 create mode 100644 app/models/manageiq/providers/vmware/infra_manager/scanning.rb
 create mode 100644 app/models/manageiq/providers/vmware/infra_manager/scanning/job.rb

diff --git a/app/models/manageiq/providers/vmware/infra_manager/scanning.rb b/app/models/manageiq/providers/vmware/infra_manager/scanning.rb
new file mode 100644
index 000000000..7567f9e5e
--- /dev/null
+++ b/app/models/manageiq/providers/vmware/infra_manager/scanning.rb
@@ -0,0 +1,3 @@
+class ManageIQ::Providers::Vmware::InfraManager::Scanning
+  require_nested :Job
+end
diff --git a/app/models/manageiq/providers/vmware/infra_manager/scanning/job.rb b/app/models/manageiq/providers/vmware/infra_manager/scanning/job.rb
new file mode 100644
index 000000000..2d69d91a9
--- /dev/null
+++ b/app/models/manageiq/providers/vmware/infra_manager/scanning/job.rb
@@ -0,0 +1,313 @@
+class ManageIQ::Providers::Vmware::InfraManager::Scanning::Job < VmScan
+  # Make updates to default state machine to take into account snapshots and VimBroker
+  def load_transitions
+    super.tap do |transactions|
+      transactions.merge!(
+        :start_snapshot     => {'before_scan'               => 'snapshot_create',
+                                'waiting_for_broker'        => 'snapshot_create'},
+        :snapshot_complete  => {'snapshot_create'           => 'check_host_credentials',
+                                'snapshot_delete'           => 'synchronizing'},
+        :start_scan         => {'check_host_credentials'    => 'scanning'},
+        :snapshot_delete    => {'scanning'                  => 'snapshot_delete'},
+        :broker_unavailable => {'snapshot_create'           => 'waiting_for_broker'},
+        :data               => {'snapshot_create'           => 'scanning',
+                                'scanning'                  => 'scanning',
+                                'snapshot_delete'           => 'snapshot_delete',
+                                'synchronizing'             => 'synchronizing',
+                                'finished'                  => 'finished'}
+      )
+    end
+  end
+
+  def before_scan
+    signal(:start_snapshot)
+  end
+
+  def call_snapshot_create
+    _log.info("Enter")
+
+    begin
+      context[:snapshot_mor] = nil
+
+      options[:snapshot] = :skipped
+      options[:use_existing_snapshot] = false
+
+      begin
+        proxy = MiqServer.find(miq_server_id)
+
+        # Check if the broker is available
+        if MiqServer.use_broker_for_embedded_proxy? && !MiqVimBrokerWorker.available?
+          _log.warn("VimBroker is not available")
+          signal(:broker_unavailable)
+          return
+        end
+
+        if proxy && proxy.forceVmScan
+          options[:snapshot] = :smartProxy
+          _log.info("Skipping snapshot creation, it will be performed by the SmartProxy")
+          context[:snapshot_mor] = options[:snapshot_description] = snapshotDescription("(embedded)")
+          log_start_user_event_message
+        else
+          set_status("Creating VM snapshot")
+
+          return unless create_snapshot
+        end
+      end
+      signal(:snapshot_complete)
+    rescue => err
+      _log.log_backtrace(err)
+      signal(:abort, err.message, "error")
+      return
+    rescue Timeout::Error
+      msg = case options[:snapshot]
+            when :smartProxy, :skipped then "Request to log snapshot user event with EMS timed out."
+            else "Request to create snapshot timed out"
+            end
+      _log.error(msg)
+      signal(:abort, msg, "error")
+    end
+  end
+
+  def wait_for_vim_broker
+    _log.info("Enter")
+    i = 0
+    loop do
+      set_status("Waiting for VimBroker to become available (#{i += 1})")
+      sleep(60)
+      _log.info("Checking VimBroker connection status.  Count=[#{i}]")
+      break if MiqVimBrokerWorker.available?
+    end
+
+    signal(:start_snapshot)
+  end
+
+  def check_host_credentials
+    _log.info("Enter")
+
+    begin
+      host = MiqServer.find(miq_server_id)
+      vm = VmOrTemplate.find(target_id)
+      # Send down metadata to allow the host to make decisions.
+      scan_args = create_scan_args(vm)
+      options[:ems_list] = scan_args["ems"]
+      options[:categories] = vm.scan_profile_categories(scan_args["vmScanProfiles"])
+
+      # If the host supports VixDisk Lib then we need to validate that the host has the required credentials set.
+      ems_list = scan_args["ems"]
+      scan_ci_type = ems_list['connect_to']
+      if host.is_vix_disk? && ems_list[scan_ci_type] && (ems_list[scan_ci_type][:username].nil? || ems_list[scan_ci_type][:password].nil?)
+        context[:snapshot_mor] = nil unless options[:snapshot] == :created
+        raise _("no credentials defined for %{type} %{name}") % {:type => scan_ci_type,
+                                                                 :name => ems_list[scan_ci_type][:hostname]}
+      end
+
+      if ems_list[scan_ci_type]
+        _log.info("[#{host.name}] communicates with [#{scan_ci_type}:#{ems_list[scan_ci_type][:hostname]}"\
+                  "(#{ems_list[scan_ci_type][:address]})] to scan vm [#{vm.name}]")
+      end
+      signal(:start_scan)
+    rescue Timeout::Error
+      message = "timed out attempting to scan, aborting"
+      _log.error(message)
+      signal(:abort, message, "error")
+      return
+    rescue => message
+      _log.log_backtrace(message)
+      signal(:abort, message.message, "error")
+    end
+  end
+
+  def config_snapshot
+    snapshot = {"use_existing" => options[:use_existing_snapshot],
+                "description"  => options[:snapshot_description]}
+    snapshot['create_free_percent'] = ::Settings.snapshots.create_free_percent
+    snapshot['remove_free_percent'] = ::Settings.snapshots.remove_free_percent
+    snapshot['name'] = context[:snapshot_mor]
+    snapshot
+  end
+
+  def create_scan_args(vm)
+    super.tap do |scan_args|
+      scan_args['snapshot'] = config_snapshot
+      scan_args['snapshot']['forceFleeceDefault'] = false if vm.scan_via_ems? && vm.template?
+    end
+  end
+
+  def call_snapshot_delete
+    _log.info("Enter")
+
+    # TODO: remove snapshot here if Vm was running
+    vm = VmOrTemplate.find(target_id)
+    if context[:snapshot_mor]
+      mor = context[:snapshot_mor]
+      context[:snapshot_mor] = nil
+
+      if options[:snapshot] == :smartProxy
+        set_status("Snapshot delete was performed by the SmartProxy")
+      else
+        set_status("Deleting VM snapshot: reference: [#{mor}]")
+      end
+
+      if vm.ext_management_system
+        _log.info("Deleting snapshot: reference: [#{mor}]")
+        begin
+          delete_snapshot(mor, vm)
+        rescue => err
+          _log.error(err.to_s)
+          return
+        rescue Timeout::Error
+          msg = "Request to delete snapshot timed out"
+          _log.error(msg)
+        end
+
+        unless options[:snapshot] == :smartProxy
+          _log.info("Deleted snapshot: reference: [#{mor}]")
+          set_status("Snapshot deleted: reference: [#{mor}]")
+        end
+      else
+        _log.error("Deleting snapshot: reference: [#{mor}], No Providers available to delete snapshot")
+        set_status("No Providers available to delete snapshot, skipping", "error")
+      end
+    else
+      set_status("Snapshot was not taken, delete not required") if options[:snapshot] == :skipped
+      log_end_user_event_message(vm)
+    end
+
+    signal(:snapshot_complete)
+  end
+
+  def delete_snapshot(mor, vm = nil)
+    vm ||= VmOrTemplate.find(target_id)
+    if mor
+      begin
+        if vm.ext_management_system
+          if options[:snapshot] == :smartProxy
+            log_end_user_event_message(vm)
+            delete_snapshot_by_description(mor, vm)
+          else
+            user_event = end_user_event_message(vm)
+            vm.ext_management_system.vm_remove_snapshot(vm, :snMor => mor, :user_event => user_event)
+          end
+        else
+          raise _("No Providers available to delete snapshot")
+        end
+      rescue => err
+        _log.error(err.message)
+        _log.log_backtrace(err, :debug)
+      end
+    else
+      log_end_user_event_message(vm)
+    end
+  end
+
+  def delete_snapshot_by_description(mor, vm)
+    if mor
+      ems_type = 'host'
+      options[:ems_list] = vm.ems_host_list
+      miqVimHost = options[:ems_list][ems_type]
+
+      miqVim = nil
+      # Make sure we were given a host to connect to and have a non-nil encrypted password
+      if miqVimHost && !miqVimHost[:password].nil?
+        server = miqVimHost[:hostname] || miqVimHost[:ipaddress]
+        begin
+          password_decrypt = ManageIQ::Password.decrypt(miqVimHost[:password])
+          if MiqServer.use_broker_for_embedded_proxy?(ems_type)
+            $vim_broker_client ||= MiqVimBroker.new(:client, MiqVimBrokerWorker.drb_port)
+            miqVim = $vim_broker_client.getMiqVim(server, miqVimHost[:username], password_decrypt)
+          else
+            require 'VMwareWebService/MiqVim'
+            miqVim = MiqVim.new(server, miqVimHost[:username], password_decrypt)
+          end
+
+          vimVm = miqVim.getVimVm(vm.path)
+          vimVm.removeSnapshotByDescription(mor, true) unless vimVm.nil?
+        ensure
+          vimVm.release if vimVm rescue nil
+          miqVim.disconnect unless miqVim.nil?
+        end
+      end
+    end
+  end
+
+  def process_cancel(*args)
+    begin
+      delete_snapshot_and_reset_snapshot_mor("canceling")
+      super
+    rescue => err
+      _log.log_backtrace(err)
+    end
+
+    super
+  end
+
+  def process_abort(*args)
+    begin
+      delete_snapshot_and_reset_snapshot_mor("aborting")
+      super
+    rescue => err
+      _log.log_backtrace(err)
+    end
+
+    super
+  end
+
+  def snapshot_complete
+    if state == 'scanning'
+      scanning
+      call_scan
+    else
+      call_synchronize
+    end
+  end
+
+
+  # All other signals
+  alias_method :start_snapshot,     :call_snapshot_create
+  alias_method :snapshot_delete,    :call_snapshot_delete
+  alias_method :broker_unavailable, :wait_for_vim_broker
+
+  private
+
+  def create_snapshot(vm = nil)
+    vm ||= VmOrTemplate.find(target_id)
+    if vm.ext_management_system
+      sn_description = snapshotDescription
+      _log.info("Creating snapshot, description: [#{sn_description}]")
+      user_event = start_user_event_message(vm)
+      options[:snapshot] = :server
+      begin
+        # TODO: should this be a vm method?
+        sn = vm.ext_management_system.vm_create_evm_snapshot(vm, :desc => sn_description, :user_event => user_event).to_s
+      rescue Exception => err
+        msg = "Failed to create evm snapshot with EMS. Error: [#{err.class.name}]: [#{err}]"
+        _log.error(msg)
+        err.kind_of?(MiqException::MiqVimBrokerUnavailable) ? signal(:broker_unavailable) : signal(:abort, msg, "error")
+        return false
+      end
+      context[:snapshot_mor] = sn
+      _log.info("Created snapshot, description: [#{sn_description}], reference: [#{context[:snapshot_mor]}]")
+      set_status("Snapshot created: reference: [#{context[:snapshot_mor]}]")
+      options[:snapshot] = :created
+      options[:use_existing_snapshot] = true
+      return true
+    else
+      signal(:abort, "No Providers available to create snapshot, skipping", "error")
+      return false
+    end
+  end
+
+  def snapshotDescription(type = nil)
+    Snapshot.evm_snapshot_description(jobid, type)
+  end
+
+  def delete_snapshot_and_reset_snapshot_mor(log_verb)
+    unless context[:snapshot_mor].nil?
+      mor = context[:snapshot_mor]
+      context[:snapshot_mor] = nil
+      set_status("Deleting snapshot before #{log_verb} job")
+      delete_snapshot(mor)
+    end
+  end
+
+end
diff --git a/app/models/manageiq/providers/vmware/infra_manager/vm_or_template_shared/scanning.rb b/app/models/manageiq/providers/vmware/infra_manager/vm_or_template_shared/scanning.rb
index 84bb0075d..268c61f34 100644
--- a/app/models/manageiq/providers/vmware/infra_manager/vm_or_template_shared/scanning.rb
+++ b/app/models/manageiq/providers/vmware/infra_manager/vm_or_template_shared/scanning.rb
@@ -10,6 +10,10 @@ module ManageIQ::Providers::Vmware::InfraManager::VmOrTemplateShared::Scanning
     end
   end
 
+  def scan_job_class
+    ManageIQ::Providers::Vmware::InfraManager::Scanning::Job
+  end
+
   def perform_metadata_scan(ost)
     require 'MiqVm/MiqVm'
 
diff --git a/spec/models/manageiq/providers/vmware/infra_manager/vm_scan_spec.rb b/spec/models/manageiq/providers/vmware/infra_manager/vm_scan_spec.rb
index 25afbc621..d99855714 100644
--- a/spec/models/manageiq/providers/vmware/infra_manager/vm_scan_spec.rb
+++ b/spec/models/manageiq/providers/vmware/infra_manager/vm_scan_spec.rb
@@ -115,8 +115,8 @@
             @job.reload
           end
 
-          it "should go to state of 'wait_for_policy'" do
-            expect(@job.state).to eq('wait_for_policy')
+          it "should go to state of 'checking_policy'" do
+            expect(@job.state).to eq('checking_policy')
             expect(MiqQueue.where(:class_name => "MiqAeEngine", :method_name => "deliver").count).to eq(1)
           end