Created log_object method in System/CommonMethods/Utils class.

[billfitzgerald0120]

This is a new method which can then be included into the other methods using the Embedded method feature. Originally this was dump_root but the name was changed to log_object.
This method will allow logging of root, current and any object passed to it.

#350

@miq-bot add_label enhancement
@miq-bot assign @gmcculloug

[gmcculloug]

Since the goal is to use this as an embedded method we do not want the method to be called from here. The automate method that embeds it would inject the call where needed.

Also need to consider moving it to another namespace in Automate where other common embedded methods would live.

cc @tinaafitz @mkanoor

[tinaafitz]

@billfitzgerald0120 Can we add a new class for these types of utilities in /System/CommonMethods/Utils?

[tinaafitz]

@billfitzgerald0120 The method should have the module information.

  module Automate
    module System
      module CommonMethods
        module Utils

[tinaafitz]

@billfitzgerald0120 Can we add the module information and move this method to the new class /System/CommonMethods/Utils?

[mkanoor]

@billfitzgerald0120 to aid in testing we need to be able to inject dependencies. we won't have a $evm when we test
so this might be a better way of accomplishing the same thing

def dump_root(handle = $evm)
    handle.log("info", "Root:<handle.root> Attributes - Begin")
    handle.root.attributes.sort.each { |k, v| handle.log("info", "  Attribute - #{k}: #{v}") }
    handle.log("info", "Root:<handle.root> Attributes - End")
    handle.log("info", "")
 end

[mkanoor]

@billfitzgerald0120 can you add a spec for this.
You can look at this https://gist.github.com/jeffwarnica/bfc885ab7bd7197d626a55fa81913cc5 for some ideas on how to implement it

[mkanoor]

@billfitzgerald0120 this needs the modules and also the name of a class preferably Utils.
And the dump_root should be a class method

def self.dump_root(handle = $evm)
....
end

[gmcculloug]

@billfitzgerald0120 The branch this is built on is dump_root and the PR title use to reference that, but now this is all logging methods. I would have expected this to be a new PR to add more common functionality, not remove the dump_root logic. I'm confused. 😕

[billfitzgerald0120]

@gmcculloug @mkanoor @tinaafitz Madhu and I changed dump_root to log_object yesterday. I will change this to WIP. We need to discuss with Tina and Madhu.

[gmcculloug]

I totally misread the code change, I see now what you are doing. Sorry about that. 😊

[billfitzgerald0120]

@tinaafitz Please Review

[tinaafitz]

@billfitzgerald0120 Looks good.
@mkanoor Please review.

[miq-bot]

Checked commit billfitzgerald0120@10f0ca6 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. 👍