Implement remove_from_provider/check_removed_from_provider

Author: agrare

app/models/miq_retire_task/state_machine.rb

@@ -7,19 +7,31 @@ def run_retire
 
   def start_retirement
     if source.retired?
-      fail!("#{self.class.model_being_retired} already retired")
+      return fail!("#{self.class.model_being_retired} already retired")
     elsif source.retiring?
-      fail!("#{self.class.model_being_retired} already in the process of being retired")
+      return fail!("#{self.class.model_being_retired} already in the process of being retired")
     end
 
     create_retiring_notification!
     source.start_retirement
+    signal :remove_from_provider
+  end
+
+  def remove_from_provider
+    signal :check_removed_from_provider
+  end
+
+  def check_removed_from_provider
     signal :finish_retirement
   end
 
   def finish_retirement
     source.finish_retirement
     create_retired_notification!
+    signal :delete_from_vmdb
+  end
+
+  def delete_from_vmdb
     signal :finish
   end
 

app/models/orchestration_stack_retire_task.rb

@@ -1,6 +1,12 @@
 class OrchestrationStackRetireTask < MiqRetireTask
+  include StateMachine
+
   default_value_for :request_type, "orchestration_stack_retire"
 
+  def stack
+    source
+  end
+
   def self.base_model
     OrchestrationStackRetireTask
   end

app/models/orchestration_stack_retire_task/state_machine.rb

@@ -0,0 +1,19 @@
+module OrchestrationStackRetireTask::StateMachine
+  extend ActiveSupport::Concern
+
+  def remove_from_provider
+    stack.raw_delete_stack if stack.raw_exists?
+
+    signal :check_removed_from_provider
+  end
+
+  def check_removed_from_provider
+    status, _reason = stack.normalized_live_status
+    if status == 'not_exist' || status == 'delete_complete'
+      signal :finish_retirement
+    else
+      stack.queue_refresh
+      requeue_phase
+    end
+  end
+end

app/models/vm_retire_task/state_machine.rb

@@ -7,24 +7,59 @@ def run_retire
 
   def check_vm_power_state
     if vm.power_state != "off"
-      _log.info("Powering Off VM <#{vm.name}> in provider <#{vm.ext_management_system&.name}>")
+      _log.info("#{log_prefix} is running, powering off...")
       vm.stop
       signal :poll_vm_stopped
     else
-      _log.info("VM <#{vm.name}> stopped, retiring...")
+      _log.info("#{log_prefix} is stopped, retiring...")
       signal :start_retirement
     end
   end
 
   def poll_vm_stopped
-    _log.info("VM:<#{vm.name}> on Provider:<#{vm.ext_management_system&.name}> has Power State:<#{vm.power_state}>")
+    _log.info("#{log_prefix} has Power State:<#{vm.power_state}>")
 
     if vm.power_state != "off"
-      _log.info("VM:<#{vm.name}> on Provider:<#{vm.ext_management_system&.name}> has not stopped")
+      _log.info("#{log_prefix} has not stopped")
       requeue_phase
     else
-      _log.info("VM:<#{vm.name}> on Provider:<#{vm.ext_management_system&.name}> has stopped, retiring...")
+      _log.info("#{log_prefix} has stopped, retiring...")
       signal :start_retirement
     end
   end
+
+  def remove_from_provider
+    case options[:removal_type]
+    when "remove_from_disk"
+      if vm.miq_provision || vm.is_tagged_with?("retire_full", :ns => "/managed/lifecycle")
+        _log.info("#{log_prefix} Removing from disk...")
+        vm.remove_from_disk(false)
+      else
+        _log.info("#{log_prefix} was not provisioned by us, not removing from disk")
+      end
+    when "unregister"
+      _log.info("#{log_prefix} Unregistering...")
+      vm.unregister
+    else
+      _log.error("#{log_prefix} Unknown retirement type [#{options[:removal_type]}]")
+      return fail!("Unknown retirement type")
+    end
+
+    signal :check_removed_from_provider
+  end
+
+  def check_removed_from_provider
+    if vm.ext_management_system
+      _log.info("#{log_prefix} not yet removed from provider...")
+      vm.queue_refresh
+      requeue_phase
+    else
+      _log.info("#{log_prefix} removed from provider...")
+      signal :finish_retirement
+    end
+  end
+
+  def log_prefix
+    "VM:<#{vm.name}> on Provider:<#{vm.ext_management_system&.name}>"
+  end
 end

spec/models/orchestration_stack_retire_task_spec.rb

@@ -32,7 +32,12 @@
   end
 
   describe "#run_retire" do
-    before { NotificationType.seed }
+    before do
+      NotificationType.seed
+      expect(orchestration_stack).to receive(:raw_exists?).and_return(true)
+      expect(orchestration_stack).to receive(:raw_delete_stack)
+      expect(orchestration_stack).to receive(:normalized_live_status).and_return("delete_complete")
+    end
 
     it "creates notifications" do
       orchestration_stack_retire_task.run_retire

spec/models/vm_retire_task_spec.rb

@@ -1,9 +1,11 @@
 RSpec.describe VmRetireTask do
   let(:user) { FactoryBot.create(:user_with_group) }
-  let(:vm) { FactoryBot.create(:vm, :raw_power_state => power_state) }
+  let(:ems)  { FactoryBot.create(:ext_management_system) }
+  let(:vm)   { FactoryBot.create(:vm, :ext_management_system => ems, :raw_power_state => power_state) }
   let!(:miq_server) { EvmSpecHelper.local_miq_server }
   let(:miq_request) { FactoryBot.create(:vm_retire_request, :requester => user) }
-  let(:vm_retire_task) { FactoryBot.create(:vm_retire_task, :source => vm, :miq_request => miq_request, :options => {:src_ids => [vm.id]}) }
+  let(:vm_retire_task) { FactoryBot.create(:vm_retire_task, :source => vm, :miq_request => miq_request, :options => task_options) }
+  let(:task_options)   { {:src_ids => [vm.id]} }
   let(:approver) { FactoryBot.create(:user_miq_request_approver) }
   let(:power_state) { "unknown" }
 
@@ -84,7 +86,7 @@
     before { NotificationType.seed }
 
     it "creates a vm_retiring notification" do
-      expect(vm_retire_task).to receive(:finish_retirement)
+      expect(vm_retire_task).to receive(:remove_from_provider)
       vm_retire_task.signal(:start_retirement)
 
       vm_retiring_notifications = Notification.of_type(:vm_retiring)
@@ -93,7 +95,7 @@
     end
 
     it "start the vm retirement process" do
-      expect(vm_retire_task).to receive(:finish_retirement)
+      expect(vm_retire_task).to receive(:remove_from_provider)
       vm_retire_task.signal(:start_retirement)
       expect(vm.reload.retirement_state).to eq("retiring")
     end
@@ -125,6 +127,69 @@
     end
   end
 
+  describe "#remove_from_provider" do
+    context "with removal_type=remove_from_disk" do
+      let(:task_options) { {:src_ids => [vm.id], :removal_type => "remove_from_disk"} }
+
+      it "doesn't delete from disk if we didn't provision it" do
+        expect(vm).not_to receive(:remove_from_disk)
+        expect(vm_retire_task).to receive(:check_removed_from_provider)
+        vm_retire_task.signal(:remove_from_provider)
+      end
+
+      context "with tag lifecycle retire_full" do
+        before { vm.tag_with("retire_full", :ns => "/managed/lifecycle") }
+
+        it "calls remove_from_disk" do
+          expect(vm).to receive(:remove_from_disk)
+          expect(vm_retire_task).to receive(:check_removed_from_provider)
+          vm_retire_task.signal(:remove_from_provider)
+        end
+      end
+    end
+
+    context "with removal_type=unregister" do
+      let(:task_options) { {:src_ids => [vm.id], :removal_type => "unregister"} }
+
+      it "calls unregister" do
+        expect(vm).to receive(:unregister)
+        expect(vm_retire_task).to receive(:check_removed_from_provider)
+        vm_retire_task.signal(:remove_from_provider)
+      end
+    end
+
+    context "with missing removal_type" do
+      it "raises an exception" do
+        vm_retire_task.signal(:remove_from_provider)
+        expect(vm_retire_task.reload).to have_attributes(
+          :state   => "finished",
+          :status  => "Error",
+          :message => "Unknown retirement type"
+        )
+      end
+    end
+  end
+
+  describe "#check_removed_from_provider" do
+    context "with an active vm" do
+      it "queues a refresh and requeues the state" do
+        expect(vm_retire_task).not_to receive(:finish_retirement)
+        vm_retire_task.signal(:check_removed_from_provider)
+        expect(vm_retire_task.reload.phase).to eq("check_removed_from_provider")
+        expect(MiqQueue.first).to have_attributes(:class_name => described_class.name, :method_name => "check_removed_from_provider")
+      end
+    end
+
+    context "with an archived vm" do
+      let(:vm) { FactoryBot.create(:vm, :ext_management_system => nil, :raw_power_state => power_state) }
+
+      it "signals finish_retirement" do
+        expect(vm_retire_task).to receive(:finish_retirement)
+        vm_retire_task.signal(:check_removed_from_provider)
+      end
+    end
+  end
+
   describe "#finish_retirement" do
     before do
       NotificationType.seed