Using Verify as a standalone tool from the command line

[flcdrg]

Is the feature request related to a problem

Sometimes I'm working on a system (eg a CI/CD pipeline) where a file is generated and I would love to be able to use something like Verify to compare the file against an expected output.

Describe the solution

Providing a command line tool that embeds the Verify functionality, such that you can run it something like:

verify.cli path/to/fileToTest.json

The tool would return a non-zero exit code if the comparison failed, so it could be used to signal failure in a script or automated pipeline.

Describe alternatives considered

• I could create a whole .NET test project just to load the file, but that seems like overkill.
• I can do a simple file compare in a scripting language, but then I don't get the same kind of useful context if the files are slightly different.

Additional context

I've been working on a proof of concept over at https://github.com/flcdrg/Verify/tree/cli. If you're receptive to the idea then happy to turn that into a PR once it's ready for public consumption.

[SimonCropp]

looking at the POC it doesnt seem to need any changes in the core of verify? so it could be deployed as an isolated tool?

[flcdrg]

That was my original plan, but unless I've misunderstood something, it seemed to rely on internal classes. I'll take another look to see if that's not actually the case now

[SimonCropp]

also does this overlap with https://github.com/VerifyTests/Verify.Terminal ?

paging @patriksvensson for input

[flcdrg]

Confirmed. The code depends on the InnerVerifier class which is currently internal to Verify

[patriksvensson]

@SimonCropp I'm not sure I follow, to be honest. Is this so Verify could be used as a pure diff tool?

[flcdrg]

@patriksvensson yes, that's my intention. I could be wrong, but I think it's a different use to what Verify.Terminal is doing.

[SimonCropp]

i am making InnerVerifier public #728
so it should unlock you shipping your cli as a separate project

[flcdrg]

Cool. More than happy to have it separate.

[patriksvensson]

If you want to add the functionality to the Verify.Tool project as a new command, it's OK with me btw 😊

[SimonCropp]

@flcdrg let me know if i can help. and when u r ready, lets add it here https://github.com/VerifyTests/Verify#extensions

[flcdrg]

@SimonCropp thanks for the support!

@patriksvensson I'll get a simple version working and then we can look to see if it makes sense to merge it in.