Create undercover-report command

[rafayet-monon]

What happened 👀

The previous method to create the report undercover -c $compare_git_ref > coverage/undercover.txt was not so user friendly.

Insight 📝

To fix this we created a new CLI command undercover-report which takes the same arguments as undercover and saves the output in a file for the danger-undercover to read from.

undercover-report -c origin/development

Proof Of Work 📹

Tested the implementation in our internal project and it's working seamlessly 🤩

• No Changes

• Changes in new commits

[andyduong1920]

IMO I prefer the original once, the differences between each solution is only the > coverage/undercover.txt which I don't think it's big, the undercover-report looks like hiding the output option there.

Also, I guess we can use undercover -c $compare_git_ref without the > coverage/undercover.txt, I mean that could be used in another case, not our case, but that is possible to run just `undercover -c $compare_git_ref, please correct me if I'm wrong.

so

1️⃣ undercover -c origin/development > coverage/undercover.txt

vs

2️⃣ undercover-report -c origin/development

I prefer the 1️⃣ solution

[rafayet-monon]

IMO I prefer the original once, the differences between each solution is only the > coverage/undercover.txt which I don't think it's big, the undercover-report looks like hiding the output option there.

Thank you @andyduong1920. As you know the first initiative was undercover -c origin/development > coverage/undercover.txt. But when running this in semaphore it kept saying you don't have permission to create this file. I guess it was a problem with the root issue which was fixable.
But, I thought if I wanted to implement in other projects as well it was too much work for just a plugin. So I changed it this way. to reduce complexity. Also, I plan to create a -o $output_path option.

Also, I guess we can use undercover -c $compare_git_ref without the > coverage/undercover.txt, I mean that could be used in another case, not our case, but that is possible to run just `undercover -c $compare_git_ref, please correct me if I'm wrong.

Absolutely, we can do that. Everything from undercover is still available. undercover-report just adds one extra layer.

Also, I created an issue in undercover for a -o $output_path option. If they want it this solution can be reverted.

Let me know your thoughts :)

[olivierobert]

I don't share the opinion of @andyduong1920 on this as I prefer this version in the sense that it favours convention (using a default path) while still allowing custom configuration to be passed. In the end, it's simpler to use.

[olivierobert]

What is receive(:)` for?

[rafayet-monon]

receive(:)` is to mock the -

undercover #{args&.join(' ')} CLI command output.

[olivierobert]

Wow, I would not have guessed. So a comment would help future devs, yourself included.

[olivierobert]

One minor improvement for code discovery would be to have a constant for this:

DEFAULT_PATH = 'coverage/undercover.txt'.freeze

def report(undercover_path = DEFAULT_PATH, sticky: true)

[rafayet-monon]

Fixed in 8bd4983

[olivierobert]

Please add some extra comment for the specs. The rest looks good to me.