Adding log_and_notify method into log_object embedded method.

[billfitzgerald0120]

This utility method allows an user to create a notification and log message with a single method call.
You can create an info, warning, success or error notification.
You can create an info, warn or error log message.

@miq-bot add_label enhancement

[billfitzgerald0120]

@miq-bot add_reviewer @tinaafitz

[mkanoor]

@billfitzgerald0120 What is this trying to do, does notify use warning instead of warn, if the caller is passing in level couldn't we enforce that the level be "info","warn",or"error"

[billfitzgerald0120]

@mkanoor yes, notify uses warning and the log uses warn. The notify accepts info, warning,
error and success. The log accepts info, warn and error. For level, If a invalid value like 'fred' is passed in then it is changed to 'info' for both notify and log.

[billfitzgerald0120]

[mkanoor]

@billfitzgerald0120 Instead of using a function can we just use a hash e.g

NOTIFY_LEVEL_TO_LOG_LEVEL = { 
  'info'    => 'info',
  'warning' => 'warn',
  'error'   => 'error',
  'success' => 'info'
}
NOTIFY_LEVEL_TO_LOG_LEVEL.default = 'info'

To fetch values you could use something like

puts NOTIFY_LEVEL_TO_LOG_LEVEL['fred']
puts NOTIFY_LEVEL_TO_LOG_LEVEL['warning']

[billfitzgerald0120]

@mkanoor Do you want me to change this also?

def self.notify_level(level)
  notify_level = level == "warn" ? "warning" : level
  %w(info warning error success).include?(notify_level) ? notify_level : "info"
end

[mkanoor]

@billfitzgerald0120 We need to decide if the level passed into this method is a notify level or a log_level.

When this function is called will the user pass in level to be one of these ("info","error","warn","debug") or would it pass in the notify level ("success","error","warning","info") We have to pick one.

I was thinking it would be the notify level and then we would map from the notify_level to the log_level
so when we call

def self.log_and_notify(notify_level, message, subject, handle = $evm)
  raise "Invalid notify level #{notify_level}" unless NOTIFY_LEVEL_TO_LOG_LEVEL.keys.include?(notify_level.downcase)
  handle.create_notification(:level => notify_level.downcase, :message => message, :subject => subject)
  handle.log(NOTIFY_LOG_TO_LOG_LEVEL(notify_level.downcase), message)
end

[mkanoor]

@billfitzgerald0120 Do you want to change the comment to say :notify_level instead of level

[mkanoor]

@billfitzgerald0120 Also here in the command the level should be notify level

[billfitzgerald0120]

@mkanoor Changed comments as requested, please review

[miq-bot]

Checked commit billfitzgerald0120@60959c6 with ruby 2.3.3, rubocop 0.52.1, haml-lint 0.20.0, and yamllint 1.10.0
2 files checked, 0 offenses detected
Everything looks fine. 🏆

[mkanoor]

For QE to test this feature

1. Create an Automate domain or use an existing writeable Automate domain
2. Create a new Automate Method
3. In the Automate Method screen embed ManageIQ/System/CommonMethods/Utils/log_object you can pick this method from the UI tree picker
4. In your method add a line akin to

ManageIQ::Automate::System::CommonMethods::Utils::LogObject.log_and_notify(:info, "Hello Testing Log & Notify", $evm.root['vm'], $evm)

5. Check the logs
6. In your UI session you should see a notification
   This method needs a vm object to be passed in you can do that from the Simulation Screen and pick

[billfitzgerald0120]

Screenshot of method:

Screenshot of simulation:

[ganeshhubale]

@billfitzgerald0120 @mkanoor
Is this RFE back-ported to 5.9z?

[gmcculloug]

@ganeshhubale No, as an enhancement these changes normally would not be back-ported. This is available in the Hammer release.