Jira (BOLT-1223) Inconsistencies in Result outputs vs access methods

[Chris Barker (JIRA)]

Title: Message Title

Chris Barker created an issue   Puppet Task Runner / BOLT-1223 Inconsistencies in Result outputs vs access methods Issue Type: Bug Affects Versions: BOLT 1.15.0 Assignee: Unassigned Created: 2019/04/02 4:20 AM Priority: Normal Reporter: Chris Barker There are major inconsistencies in how views a Result output vs how one accesses it. For example, running this command run_command('mkdir ~/boltexamples', $nodes).each | $result | { notice($result) } Provides me with a json hash output that looks easy to navigate (after piping through | python -mjson.tool: { "node": "puppet.c.splunk-217321.internal", "object": "mkdir ~/boltexamples", "result": { "exit_code": 0, "stderr": "", "stdout": "" }, "status": "success", "type": "command" } Now looking at this result, I would assume I could access the node name, object, result, and status just by referring to the hash keys, since that's what I'm looking at. Assuming I've not yet dove into the docs and I'm just reading existing code and want to poke around, I may go and do this: run_command('mkdir ~/boltexamples', $nodes).each | $result | { notice($result['node']) } Which is frustrating because the output I get is: Starting: command 'mkdir ~/boltexamples' on puppet.c.splunk-217321.internal Finished: command 'mkdir ~/boltexamples' with 0 failures in 2.28 sec   Finished: plan firstproject::firstplan in 5.1 sec Plan completed successfully with no result So I guess that's an empty hash? How do I actually access these variables? Now I have to go to the documentation to see what is what - which explains that I can access those as functions, but function names have no correllation to what I was just looking at, in fact we hide the mapping in the code here: https://github.com/puppetlabs/bolt/blob/master/lib/bolt/result.rb#L93-L99 Ah, now I see if I want the node name, I have to call $result.target.name - otherwise I just get the result of Target('puppet.c.splunk-217321.internal', {"user"=>"cbarker"}) Bonus surprise: I'd think I could get away with `$result.type` to see what type of function this was, but instead, I get the ruby definition of the object: Object[{name => 'Result', attributes => {'value' => Hash[String[1], Data], 'target' => Target}, functions => {'error' => Callable[[0, 0], Optional[Error]], 'message' => Callable[[0, 0], Optional[String]], 'ok' => Callable[[0, 0], Boolean], '[]' => Callable[[String[1]], Data]}}] Making the onscreen output of Bolt be logically consistent with methods to call and extract that data will be essential for new users to learn how to access and work with it. If we're going to to have `notice($result)` output a hash, I should be able to access the subhash without having to read the docs. So far I have yet to be able to access the equivalent of `$result["object"]` or `$result["type"]` even though that would be the logical way I could access it while looking at the output of the code. I can't tell if it is just undocumented or a bug or a mixture of both. Add Comment   This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.