Generate code coverage badge

[Adityanr]

build.cake modified to generate coverage badge in README.md using opencover and reportgenerator Closes #30

[Adityanr]

Hi @Marusyk Can you please register grok.NET repository at https://coveralls.io ?

I have done the following:

• Registered my local fork of grok.Net at coverall.io (https://coveralls.io/github/Adityanr/grok.net) and used that to generate a sample coverage badge at README.md ()
• Added environment variable, COVERALLS_REPO_TOKEN, which is used to authorize opencover test result uploads to coveralls for coverage badge generation.

The following needs to be done now:

1. Register grok.net repository (https://github.com/Marusyk/grok.net) at coveralls.
2. Click on details next to the newly registered repository name.
3. Fetch the generated or supposedly generated badge URL from the bottom section as follows:
4. Send me the coverage badge markdown URL obtained above so I can update README.md with the new badge URL and set the PR ready for review.
5. Add the Coveralls repo token obtained as an environment variable (COVERALLS_REPO_TOKEN) in the CI post merge build for main branch.
6. Update github workflows with Upload-Coverage-Report as target instead of Run-Unit-Tests

Thank you!

[Marusyk]

Hi @Adityanr wow, thank you very much for this

I've added the token as a Repository secret. Here is markdown

[![Coverage Status](https://coveralls.io/repos/github/Marusyk/grok.net/badge.svg?branch=main)](https://coveralls.io/github/Marusyk/grok.net?branch=main)

[Adityanr]

Hi @Adityanr wow, thank you very much for this

I've added the token as a Repository secret. Here is markdown

[![Coverage Status](https://coveralls.io/repos/github/Marusyk/grok.net/badge.svg?branch=main)](https://coveralls.io/github/Marusyk/grok.net?branch=main)

Hi @Marusyk I have update README.md with the new badge for main branch! It will display new coverage after main branch CI pipeline build is run. All it needs now is github workflow update. I don't seem to have a push access for that. Can you please make that change if this PR gets merged?

[Marusyk]

@Adityanr Could you please check Windows.yml

[Adityanr]

sure, lemme check @Marusyk

[Adityanr]

Hi, @Marusyk The build steps are working fine locally. Is the windows build server running as a container? If so maybe the user does not have appropriate permissions to register the opencover profiler. The following modification to Run-Unit-Tests target can be made for this to work:

Task("Run-Unit-Tests")
    .IsDependentOn("Build")
    .Does(() =>
{
    var projectFile = Directory("./src/Grok.Net.Tests") + File("Grok.Net.Tests.csproj");

    if(!BuildSystem.IsLocalBuild)
    {
        DotNetCoreTest(System.IO.Path.GetFullPath(projectFile), new DotNetCoreTestSettings()
        {
            Configuration = configuration
        });
    }
    else
    {
        OpenCover(tool => {
                tool.DotNetCoreTest(
                System.IO.Path.GetFullPath(projectFile),
                new DotNetCoreTestSettings()
                {
                    Configuration = configuration
                }
                );
            },
            testResultFile, new OpenCoverSettings() {
                Filters = { "-[*xunit*]*", "-[GrokNetTests.UnitTests]*", "+[*]*" },
                Register = "User"
            }
        );
    }
});

Added the Register = "User" for OpenCoverSettings. Should i raise another PR for the same?

[Marusyk]

Should i raise another PR for the same? Yes please