Add policy checking for the retirement request.

[lfu]

All events are sent to automate for processing since Event Switchboard PR.
Since then the policy checking for prevent action has changed from a sync process to an async process.

Part of #14641.

https://bugzilla.redhat.com/show_bug.cgi?id=1439331

@miq-bot assign @gmcculloug
@miq-bot add_label bug, darga/yes, euwe/yes

[miq-bot]

@lfu Cannot apply the following labels because they are not recognized: control, automate

[gmcculloug]

@tinaafitz @mkanoor Please review

[mkanoor]

@lfu
Can this method be converted to the new style with namespaces.
e.g. https://github.com/ManageIQ/manageiq-content/blob/master/content/automate/ManageIQ/AutomationManagement/AnsibleTower/Operations/Methods.class/__methods__/available_credentials.rb
Also can we add a spec for this.

[mkanoor]

@lfu In the Spec we might want to stub the exit method. The spec is tested outside of the Automate Engine

[mkanoor]

@lfu we should check if event is nil?

[lfu]

@mkanoor I think it can reach this point in automate only if the event stream object exists.

[tinaafitz]

@lfu Should the request_orchestration_stack_retire policy instance be changed as well?

[lfu]

@tinaafitz request_orchestration_stack_retire is not defined in db/fixtures/miq_event_definitions.csv which means it is not one of the policy events. Do you think it should be a policy event so users can make policies based on it? If that is the case, it needs to be added into the files first.

[mkanoor]

@lfu have you thought of making this as a builtin method like these
https://github.com/ManageIQ/manageiq/blob/master/lib/miq_automation_engine/engine/miq_ae_engine/miq_ae_builtin_method.rb#L108

[mkanoor]

@lfu we should also be creating a notification when this method stops the process, e.g if retirement is requested and we dont raise a notification users would think retirement is stuck.
@tinaafitz please comment.

[tinaafitz]

@mkanoor @lfu Yes, it would be important to create a notification if the prevent policy stops the process. Since the method is generic, we could just use "event.message" as the notification message.
Here's an example of the create_notification:
https://github.com/tinaafitz/manageiq-content/blob/master/content/automate/ManageIQ/Cloud/VM/Retirement/StateMachines/VMRetirement.class/__methods__/update_retirement_status.rb#L41

[tinaafitz]

@lfu Spoke to @bzwei about stack retirement. These changes should apply to the orchestration_stack retirement request as well. We can add it to the db/fixtures/miq_event_definitions.csv.

[miq-bot]

Checked commit lfu@f814bd8 with ruby 2.2.6, rubocop 0.47.1, and haml-lint 0.20.0
0 files checked, 0 offenses detected
Everything looks good. 🏆

[lfu]

@miq-bot add_label fine/yes

[tinaafitz]

@lfu Looks good.

[simaishi]

Fine backport details:

$ git log -1
commit b795b481722c08fc837668b6c779bbb8ac047387
Author: Greg McCullough <gmccullo@redhat.com>
Date:   Fri Apr 7 14:37:54 2017 -0400

    Merge pull request #86 from lfu/prevent_retirement_request
    
    Add policy checking for the retirement request.
    (cherry picked from commit c6c51d4e6580c866334629b627cefb955fd1801d)

[simaishi]

Euwe backport (to manageiq repo) details:

$ git log -1
commit 58b5c37c809081b02816ea5583b1b0595f19b86f
Author: Satoe Imaishi <simaishi@redhat.com>
Date:   Mon Apr 17 14:01:35 2017 -0400

    Merge pull request #86 from lfu/prevent_retirement_request
    
    Add policy checking for the retirement request.
    (cherry picked from commit c6c51d4e6580c866334629b627cefb955fd1801d)
    
    https://bugzilla.redhat.com/show_bug.cgi?id=1440402