Automate - Refactoring infra vm check_powered_off method.

content/automate/ManageIQ/Infrastructure/VM/Retirement/StateMachines/Methods.class/__methods__/check_powered_off.rb

@@ -2,24 +2,60 @@
 # Description: This method checks to see if the VM has been powered off or suspended
 #
 
-# Get vm from root object
-vm = $evm.root['vm']
-
-if vm
-  power_state = vm.attributes['power_state']
-  ems = vm.ext_management_system
-  $evm.log('info', "VM:<#{vm.name}> on provider:<#{ems.try(:name)} has Power State:<#{power_state}>")
-
-  # If VM is powered off or suspended exit
-
-  if %w(off suspended).include?(power_state)
-    # Bump State
-    $evm.root['ae_result'] = 'ok'
-  elsif power_state == "never"
-    # If never then this VM is a template so exit the retirement state machine
-    $evm.root['ae_result'] = 'error'
-  else
-    $evm.root['ae_result']     = 'retry'
-    $evm.root['ae_retry_interval'] = '60.seconds'
+module ManageIQ
+  module Automate
+    module Infrastructure
+      module VM
+        module Retirement
+          module StateMachines
+            class CheckPoweredOff
+              def initialize(handle = $evm)
+                @handle = handle
+              end
+
+              def main
+                check_power_state(vm)
+              end
+
+              private
+
+              def vm
+                raise "ERROR - vm object not passed in" unless @handle.root['vm']
+                @handle.root['vm']
+              end
+
+              def check_power_state(vm)
+                ems = vm.ext_management_system
+                if ems.nil?
+                  @handle.log('info', "Skipping check powered on for VM:<#{vm(:name)}> "\
+                                      "with no EMS")
+                  return
+                end
+
+                power_state = vm.power_state
+                @handle.log('info', "VM:<#{vm.name}> on Provider:<#{ems.name}> has Power State:<#{power_state}>")
+
+                # If VM is powered off or suspended exit
+
+                if %w(off suspended).include?(power_state)
+                  # Bump State
+                  @handle.root['ae_result'] = 'ok'
+                elsif power_state == "never"
+                  # If never then this VM is a template so exit the retirement state machine
+                  @handle.root['ae_result'] = 'error'
+                else
+                  @handle.root['ae_result'] = 'retry'
+                  @handle.root['ae_retry_interval'] = '60.seconds'
+                end
+              end
+            end
+          end
+        end
+      end
+    end
   end
 end
+
+if __FILE__ == $PROGRAM_NAME
+  ManageIQ::Automate::Infrastructure::VM::Retirement::StateMachines::CheckPoweredOff.new.main
+end

spec/content/automate/ManageIQ/Infrastructure/VM/Retirement/StateMachines/Methods.class/__methods__/check_powered_off_spec.rb

@@ -0,0 +1,96 @@
+require_domain_file
+
+describe ManageIQ::Automate::Infrastructure::VM::Retirement::StateMachines::CheckPoweredOff do
+  let(:zone) { FactoryGirl.create(:zone) }
+  let(:ems) { FactoryGirl.create(:ems_microsoft, :zone => zone) }
+  let(:vm) do
+    FactoryGirl.create(:vm_microsoft,
+                       :raw_power_state => "PowerOff",
+                       :ems_id          => ems.id)
+  end
+
+  let(:svc_model_vm) do
+    MiqAeMethodService::MiqAeServiceVm.find(vm.id)
+  end
+
+  let(:root_hash) do
+    { 'vm' => MiqAeMethodService::MiqAeServiceVm.find(vm.id) }
+  end
+
+  let(:root_object) do
+    Spec::Support::MiqAeMockObject.new(root_hash)
+  end
+
+  let(:ae_service) do
+    Spec::Support::MiqAeMockService.new(root_object).tap do |service|
+      current_object = Spec::Support::MiqAeMockObject.new
+      current_object.parent = root_object
+      service.object = current_object
+    end
+  end
+
+  it "returns 'ok' for a vm in powered_off state" do
+    described_class.new(ae_service).main
+    expect(ae_service.root['vm'].power_state).to eq("off")
+    expect(ae_service.root['ae_result']).to eq('ok')
+  end
+
+  shared_examples_for "#vm power state" do
+    it "check" do
+      vm.update_attributes(:raw_power_state => raw_power_state)
+      svc_model_vm
+      described_class.new(ae_service).main
+      expect(ae_service.root['vm'].power_state).to eq(power_state)
+      expect(ae_service.root['ae_result']).to eq(ae_result)
+    end
+  end
+
+  context "powered_on " do
+    let(:raw_power_state) { "Running" }
+    let(:power_state) { "on" }
+    let(:ae_result) { "retry" }
+    it_behaves_like "#vm power state"
+  end
+  context "unknown" do
+    let(:raw_power_state) { "unknown" }
+    let(:power_state) { "unknown" }
+    let(:ae_result) { "retry" }
+    it_behaves_like "#vm power state"
+  end
+  context "suspended" do
+    let(:raw_power_state) { "suspended" }
+    let(:power_state) { "unknown" }
+    let(:ae_result) { "retry" }
+    it_behaves_like "#vm power state"
+  end
+  context "never" do
+    let(:raw_power_state) { "never" }
+    let(:power_state) { "never" }
+    let(:ae_result) { "error" }
+    it_behaves_like "#vm power state"
+  end
+
+  context "exceptions" do
+    context "with no ems" do
+      let(:vm) do
+        FactoryGirl.create(:vm_microsoft, :raw_power_state => "PowerOff")
+      end
+
+      it "result is nil" do
+        expect(ae_service.root['ae_result']).to be_nil
+      end
+    end
+
+    context "with no vm" do
+      let(:root_hash) { {} }
+      let(:svc_model_service) { nil }
+      let(:vm) { nil }
+
+      it "raises the vm is nil exception" do
+        expect { described_class.new(ae_service).main }.to raise_error(
+          'ERROR - vm object not passed in'
+        )
+      end
+    end
+  end
+end