miq_action_spec.rb

RSpec.describe MiqAction do
  describe "#invoke_or_queue" do
    before do
      @action = MiqAction.new
    end

    it "executes synchronous actions" do
      target = double("action")
      allow(target).to receive(:target_method)
      @action.instance_eval { invoke_or_queue(true, "__caller__", "role", nil, target, 'target_method', []) }
    end
  end

  context "#action_custom_automation" do
    before do
      tenant = FactoryBot.create(:tenant)
      group  = FactoryBot.create(:miq_group, :tenant => tenant)
      @user = FactoryBot.create(:user, :userid => "test", :miq_groups => [group])
      @vm   = FactoryBot.create(:vm_infra, :evm_owner => @user, :miq_group => group)
      @action = FactoryBot.create(:miq_action)
      expect(@action).not_to be_nil
      @action.options = {:ae_request => "test_custom_automation"}
      @args = {
        :object_type      => @vm.class.base_class.name,
        :object_id        => @vm.id,
        :user_id          => @vm.evm_owner.id,
        :miq_group_id     => @vm.miq_group.id,
        :tenant_id        => @vm.tenant.id,
        :attrs            => {:request => "test_custom_automation"},
        :instance_name    => "REQUEST",
        :automate_message => "create"
      }
    end

    it "synchronous" do
      expect(MiqAeEngine).to receive(:deliver).with(@args).once
      @action.action_custom_automation(@action, @vm, :synchronous => true)
    end

    it "asynchronous" do
      expect(MiqAeEngine).to receive(:deliver).never

      q_options = {
        :class_name  => 'MiqAeEngine',
        :method_name => 'deliver',
        :instance_id => nil,
        :args        => [@args],
        :role        => 'automate',
        :zone        => nil,
        :priority    => MiqQueue::HIGH_PRIORITY,
      }
      expect(MiqQueue).to receive(:put).with(q_options).once
      @action.action_custom_automation(@action, @vm, :synchronous => false)
    end

    it "passes source event to automate if set" do
      ems_event = FactoryBot.create(:ems_event, :event_type => "CloneVM_Task")
      args = {:attrs => {:request => "test_custom_automation", "EventStream::event_stream" => ems_event.id}}
      expect(MiqAeEngine).to receive(:deliver).with(hash_including(args)).once

      @action.action_custom_automation(@action, @vm, :synchronous => true, :source_event => ems_event)
    end
  end

  context "#action_evm_event" do
    it "for Vm" do
      ems = FactoryBot.create(:ems_infra)
      host = FactoryBot.create(:host)
      vm = FactoryBot.create(:vm_infra, :host => host, :ext_management_system => ems)
      action = FactoryBot.create(:miq_action)
      res = action.action_evm_event(action, vm, :policy => FactoryBot.create(:miq_policy))

      expect(res).to be_kind_of(MiqEvent)
      expect(res.target).to eq(vm)
    end

    it "for Datastore" do
      storage = FactoryBot.create(:storage)
      action  = FactoryBot.create(:miq_action)
      result  = action.action_evm_event(action, storage, :policy => FactoryBot.create(:miq_policy))

      expect(result).to be_kind_of(MiqEvent)
      expect(result.target).to eq(storage)
    end
  end

  context "#raise_automation_event" do
    before do
      @vm   = FactoryBot.create(:vm_infra)
      allow(@vm).to receive(:my_zone).and_return("vm_zone")
      FactoryBot.create(:miq_event_definition, :name => "raise_automation_event")
      FactoryBot.create(:miq_event_definition, :name => "vm_start")
      FactoryBot.create(:miq_action, :name => "raise_automation_event")
      @action = MiqAction.find_by(:name => "raise_automation_event")
      expect(@action).not_to be_nil
      @event = MiqEventDefinition.find_by(:name => "vm_start")
      expect(@event).not_to be_nil
      @aevent = {
        :vm     => @vm,
        :host   => nil,
        :ems    => nil,
        :policy => @policy,
      }
    end

    it "synchronous" do
      expect(MiqAeEvent).to receive(:raise_synthetic_event).with(@vm, @event.name, @aevent).once
      expect(MiqQueue).to receive(:put).never
      @action.action_raise_automation_event(@action, @vm, :vm => @vm, :event => @event, :policy => @policy, :synchronous => true)
    end

    it "synchronous, not passing vm in inputs hash" do
      expect(MiqAeEvent).to receive(:raise_synthetic_event).with(@vm, @event.name, @aevent).once
      expect(MiqQueue).to receive(:put).never
      @action.action_raise_automation_event(@action, @vm, :vm => nil, :event => @event, :policy => @policy, :synchronous => true)
    end

    it "asynchronous" do
      expect(MiqAeEvent).to receive(:raise_synthetic_event).never
      q_options = {
        :class_name  => "MiqAeEvent",
        :method_name => "raise_synthetic_event",
        :instance_id => nil,
        :args        => [@vm, @event.name, @aevent],
        :priority    => MiqQueue::HIGH_PRIORITY,
        :zone        => "vm_zone",
        :role        => "automate"
      }
      expect(MiqQueue).to receive(:put).with(q_options).once
      @action.action_raise_automation_event(@action, @vm, :vm => @vm, :event => @event, :policy => @policy, :synchronous => false)
    end
  end

  context "#action_ems_refresh" do
    before do
      FactoryBot.create(:miq_action, :name => "ems_refresh")
      @action = MiqAction.find_by(:name => "ems_refresh")
      expect(@action).not_to be_nil
      @zone1 = FactoryBot.create(:small_environment)
      @vm = @zone1.vms.first
    end

    it "synchronous" do
      expect(EmsRefresh).to receive(:refresh).with(@vm).once
      expect(EmsRefresh).to receive(:queue_refresh).never
      @action.action_ems_refresh(@action, @vm, {:vm => @vm, :policy => @policy, :event => @event, :synchronous => true})
    end

    it "asynchronous" do
      expect(EmsRefresh).to receive(:refresh).never
      expect(EmsRefresh).to receive(:queue_refresh).with(@vm).once
      @action.action_ems_refresh(@action, @vm, {:vm => @vm, :policy => @policy, :event => @event, :synchronous => false})
    end
  end

  context "#action_vm_stop" do
    before do
      @zone   = FactoryBot.create(:zone)
      @ems    = FactoryBot.create(:ems_infra, :zone => @zone)
      @host   = FactoryBot.create(:host)
      @vm     = FactoryBot.create(:vm_infra, :host => @host, :ext_management_system => @ems)
      @action = FactoryBot.create(:miq_action, :name => "vm_stop")
    end

    it "synchronous" do
      input = {:synchronous => true}
      expect(MiqQueue).not_to receive(:put)
      @action.action_vm_stop(@action, @vm, input)
    end

    it "asynchronous" do
      input = {:synchronous => false}
      @action.action_vm_stop(@action, @vm, input)

      expect(MiqQueue.count).to eq(1)
      expect(MiqQueue.where(:class_name => @vm.class.name).first).to have_attributes(
        :class_name  => @vm.class.name,
        :method_name => 'stop',
        :role        => 'ems_operations',
        :queue_name  => @ems.queue_name_for_ems_operations,
        :zone        => @ems.my_zone,
        :args        => []
      )
    end
  end

  context "#action_vm_retire" do
    before do
      @vm     = FactoryBot.create(:vm_infra)
      allow(@vm).to receive(:my_zone).and_return("vm_zone")
      @event  = FactoryBot.create(:miq_event_definition, :name => "assigned_company_tag")
      @action = FactoryBot.create(:miq_action, :name => "vm_retire")
    end

    it "synchronous" do
      input  = {:synchronous => true}

      Timecop.freeze do
        date   = Time.now.utc - 1.day

        expect(VmOrTemplate).to receive(:retire) do |vms, options|
          expect(vms).to eq([@vm])
          expect(options[:date]).to be_within(0.1).of(date)
        end
        @action.action_vm_retire(@action, @vm, input)
      end
    end

    it "asynchronous" do
      input = {:synchronous => false}
      zone  = FactoryBot.create(:zone)
      allow(@vm).to receive_messages(:my_zone => zone.name)

      Timecop.freeze do
        date   = Time.now.utc - 1.day

        @action.action_vm_retire(@action, @vm, input)
        expect(MiqQueue.count).to eq(1)
        msg = MiqQueue.first
        expect(msg.class_name).to eq(@vm.class.name)
        expect(msg.method_name).to eq('retire')
        expect(msg.args).to eq([[@vm], :date => date])
        expect(msg.zone).to eq(zone.name)
      end
    end
  end

  context "#action_container_image_analyze" do
    let(:container_image) { FactoryBot.create(:container_image) }
    let(:container_image_registry) { FactoryBot.create(:container_image_registry) }
    let(:event) { FactoryBot.create(:miq_event_definition, :name => "whatever") }
    let(:event_loop) { FactoryBot.create(:miq_event_definition, :name => "request_containerimage_scan") }
    let(:action) { FactoryBot.create(:miq_action, :name => "container_image_analyze") }

    it "scans container images" do
      expect(container_image).to receive(:scan).once
      action.action_container_image_analyze(action, container_image, :event => event)
    end

    it "avoids non container images" do
      error_message = "MIQ(action_container_image_analyze): Unable to perform action [#{action.description}],"\
        " object [#{container_image_registry.inspect}] is not a Container Image"

      expect(MiqPolicy.logger).to receive(:error).with(error_message)
      expect(action.action_container_image_analyze(action, container_image_registry, :event => event)).to be_nil
    end

    it "avoids an event loop" do
      error_message = "MIQ(action_container_image_analyze): Invoking action [#{action.description}] for event"\
        " [#{event_loop.description}] would cause infinite loop, skipping"

      expect(MiqPolicy.logger).to receive(:warn).with(error_message)
      expect(action.action_container_image_analyze(action, container_image, :event => event_loop)).to be_nil
    end
  end

  context "#action_container_image_annotate_scan_results" do
    let(:container_image) { FactoryBot.create(:container_image) }
    let(:event) { FactoryBot.create(:miq_event_definition, :name => "whatever") }
    let(:action) { FactoryBot.create(:miq_action, :name => "container_image_annotate_deny_execution") }

    it "will not annotate if the method is unavailable" do
      expect(MiqQueue).to receive(:put).exactly(0).times
      action.action_container_image_annotate_scan_results(action, container_image, :event => event)
    end
  end

  context '.create_default_actions' do
    context 'seeding default actions from a file with 3 csv rows and some comments' do
      before do
        stub_csv <<-CSV.strip_heredoc
          name,description
          audit,Generate Audit Event
          log,Generate log message
          # snmp,Generate an SNMP trap
          # sms,Send an SMS text message
          evm_event,Show EVM Event on Timeline
        CSV

        MiqAction.create_default_actions
      end

      it 'should create 3 new actions' do
        expect(MiqAction.count).to eq 3
      end

      it 'should set action_type to "default"' do
        expect(MiqAction.distinct.pluck(:action_type)).to eq ['default']
      end

      context 'when csv was changed and imported again' do
        before do
          stub_csv <<-CSV.strip_heredoc
            name,description
            audit,UPD: Audit Event
            # log,Generate log message
            snmp,Generate an SNMP trap
            evm_event,Show EVM Event on Timeline
          CSV

          MiqAction.create_default_actions
        end

        it "should not delete the actions that present in the DB but don't present in the file" do
          expect(MiqAction.where(:name => 'log')).to exist
        end

        it 'should update existing actions' do
          expect(MiqAction.where(:name => 'audit').pluck(:description)).to eq ['UPD: Audit Event']
        end

        it 'should create new actions' do
          expect(MiqAction.where(:name => 'snmp')).to exist
        end
      end

      def stub_csv(data)
        Tempfile.open(['actions', '.csv']) do |f|
          f.write(data)
          @tempfile = f # keep the reference in order to delete the file later
        end

        expect(MiqAction).to receive(:fixture_path).and_return(@tempfile.path)
      end

      after do
        @tempfile.unlink
      end
    end

    # 'integration' test to make sure that the real fixture file is well-formed
    context 'seeding default actions' do
      before { MiqAction.create_default_actions }

      it 'should create new actions' do
        expect(MiqAction.count).to be > 0
      end
    end
  end

  context '.create_script_actions_from_directory' do
    context 'when there are 3 files in the script directory' do
      before do
        @script_dir = Dir.mktmpdir
        stub_const('::MiqAction::SCRIPT_DIR', Pathname(@script_dir))
        FileUtils.touch %W(
          #{@script_dir}/script2.rb
          #{@script_dir}/script.1.sh
          #{@script_dir}/script3
        )
      end

      after do
        FileUtils.remove_entry_secure @script_dir
      end

      context 'seeding script actions from that directory' do
        before { MiqAction.create_script_actions_from_directory }
        let(:first_created_action) { MiqAction.order(:id).first! }

        it 'should create 3 new actions' do
          expect(MiqAction.count).to eq 3
        end

        it 'should assign script filename as action name' do
          expect(first_created_action.name).to eq 'script_1_sh'
        end

        it 'should set action_type to "script"' do
          expect(MiqAction.distinct.pluck(:action_type)).to eq ['script']
        end

        it 'should add description' do
          expect(first_created_action.description).to eq "Execute script: script.1.sh"
        end

        it 'should put full file path into options hash' do
          expect(first_created_action.options).to eq(:filename => "#{@script_dir}/script.1.sh")
        end

        context 'after one of the scripts is renamed' do
          before { FileUtils.mv("#{@script_dir}/script2.rb", "#{@script_dir}/run.bat") }

          context 'seeding script actions again' do
            before { MiqAction.create_script_actions_from_directory }

            it 'should not delete the old action' do
              expect(MiqAction.where(:name => 'script2_rb')).to exist
            end

            it 'should create a new action' do
              expect(MiqAction.where(:name => 'run_bat')).to exist
            end
          end
        end

        context 'seeding script actions again' do
          before { MiqAction.create_script_actions_from_directory }

          it 'should not add any new actions' do
            expect(MiqAction.count).to eq 3
          end
        end
      end
    end
  end

  context '#round_to_nearest_4mb' do
    it 'should round numbers to nearest 4 mb' do
      a = MiqAction.new

      expect(a.round_to_nearest_4mb(0)).to eq 0
      expect(a.round_to_nearest_4mb("2")).to eq 4
      expect(a.round_to_nearest_4mb(15)).to eq 16
      expect(a.round_to_nearest_4mb(16)).to eq 16
      expect(a.round_to_nearest_4mb(17)).to eq 20
    end
  end

  context 'validate action email should have correct type' do
    before do
      MiqRegion.seed
      ServerRole.seed
    end

    let(:miq_server) { EvmSpecHelper.local_miq_server }
    let(:action) { MiqAction.new }
    let(:inputs) { { :policy => nil, :synchronous => false } }

    let(:q_options) do
      {
        :class_name  => "MiqAction",
        :method_name => "queue_email",
        :instance_id => nil,
        :args        => [{:to => nil, :from => "cfadmin@cfserver.com"}],
        :role        => "notifier",
        :priority    => 20,
        :zone        => nil
      }
    end

    context 'when notifier role is off' do
      it 'is not generating a MiqAction invoking action_email' do
        expect(MiqQueue).not_to receive(:put).with(q_options)
        action.action_email(action, nil, inputs)
      end
    end

    context 'when notifier role is on' do
      before do
        miq_server.server_roles << ServerRole.where(:name => 'notifier')
        miq_server.save!
      end

      it 'should generate a MiqAction invoking action_email' do
        expect(MiqQueue).to receive(:put).with(q_options).once
        action.action_email(action, nil, inputs)
      end

      context 'when alerting' do
        before do
          NotificationType.instance_variable_set(:@names, nil)
          NotificationType.seed if NotificationType.all.empty?
        end

        let(:description) { 'my alert' }
        let(:alert) { MiqAlert.new(:description => description) }
        let(:event) { MiqEventDefinition.new(:name => "AlertEvent", :description => "Alert condition met") }
        let(:vm) { Vm.new(:name => "vm1") }
        let(:inputs) do
          {
            :policy          => alert,
            :event           => event,
            :synchronous     => false,
            :results         => true,
            :sequence        => 1,
            :triggering_type => "vm_retired",
            :triggering_data => {:subject => 'vm1'},
          }
        end

        let(:args) do
          [{
            :to              => nil,
            :from            => "cfadmin@cfserver.com",
            :subject         => "Alert Triggered: my alert, for (VM) vm1",
            :miq_action_hash => {
              :header            => "Alert Triggered",
              :policy_detail     => "Alert 'my alert', triggered",
              :event_description => "Alert condition met",
              :event_details     => "Virtual Machine vm1 has been retired.",
              :entity_type       => "Vm",
              :entity_name       => "vm1",
            }
          }]
        end

        it 'generates an MiqAlert email' do
          q_options[:args] = args

          expect(MiqQueue).to receive(:put).with(q_options).once
          action.action_email(action, vm, inputs)
        end
      end
    end
  end

  context 'run_ansible_playbook' do
    let(:tenant) { FactoryBot.create(:tenant) }
    let(:group)  { FactoryBot.create(:miq_group, :tenant => tenant) }
    let(:user) { FactoryBot.create(:user, :userid => "test", :miq_groups => [group]) }
    let(:vm)   { FactoryBot.create(:vm_infra, :evm_owner => user, :miq_group => group, :hardware => hardware) }
    let(:action) { FactoryBot.create(:miq_action, :name => "run_ansible_playbook", :options => action_options) }
    let(:stap) { FactoryBot.create(:service_template_ansible_playbook) }
    let(:ip1) { "1.1.1.94" }
    let(:ip2) { "1.1.1.96" }
    let(:event_name) { "Fred" }

    let(:miq_event_def) do
      FactoryBot.create(:miq_event_definition, :name => event_name)
    end
    let(:hardware) do
      FactoryBot.create(:hardware).tap do |h|
        h.ipaddresses << ip1
        h.ipaddresses << ip2
      end
    end

    let(:request_options) do
      { :manageiq_extra_vars => { "event_target" => vm.href_slug, "event_name" => event_name },
        :initiator           => 'control' }
    end

    shared_examples_for "#workflow check" do
      it "run playbook" do
        miq_request = instance_double(MiqRequest)
        allow(vm).to receive(:tenant_identity).and_return(user)
        expect(ServiceTemplate).to receive(:find).with(stap.id).and_return(stap)
        expect(stap).to receive(:provision_request).with(user, dialog_options, request_options).and_return(miq_request)

        action.action_run_ansible_playbook(action, vm, :event => miq_event_def)
      end
    end

    context "use event target" do
      let(:action_options) do
        { :service_template_id => stap.id,
          :use_event_target    => true }
      end
      let(:dialog_options) { {:hosts => ip1 } }

      it_behaves_like "#workflow check"
    end

    context "use localhost" do
      let(:action_options) do
        { :service_template_id => stap.id,
          :use_localhost       => true }
      end
      let(:dialog_options) { {:hosts => 'localhost' } }

      it_behaves_like "#workflow check"
    end

    context "use hosts" do
      let(:action_options) do
        { :service_template_id => stap.id,
          :hosts               => "ip1, ip2" }
      end
      let(:dialog_options) { {:hosts => 'ip1, ip2' } }

      it_behaves_like "#workflow check"
    end
  end

  describe "#destroy" do
    it "does not destroy this action if it referenced in at least one policy" do
      action = FactoryBot.create(:miq_action)
      FactoryBot.create(:miq_policy_content, :miq_action => action)
      expect { action.destroy! }.to raise_error(ActiveRecord::RecordNotDestroyed)
    end
  end
end