fhchina / opencover

A code coverage tool for .NET 2 and above, support for 32 and 64 processes with both branch and sequence points; roots proudly based in PartCover

The latest releases can be downloaded from releases or from the OpenCover mirror site on bitbucket. Alternatively why not try the nuget package (this is the most popular).

Master

The primary repo for the project is on GitHub and is also where the wiki and issues are managed from.

Licence

All Original Software is licensed under the MIT Licence and does not apply to any other 3rd party tools, utilities or code which may be used to develop this application.

If anyone is aware of any licence violations that this code may be making please inform the developers so that the issue can be investigated and rectified.

WIKI

Please review the wiki pages on how to use OpenCover and take particular interest in the Usage guide.

Service support

Note that .zip and .nuget packages (at least) will not ACL files so that a low-privilege service can execute them -- manually add the service principal with read/execute privilege to the OpenCover.Profiler.dll ACLs, either through explorer properties or by a Get-Acl/Set-Acl PowerShell script.

Launching the profiling operation must be done with Administrator privilege -- this is required to even start the service, and is also needed to create the global objects and set the per-service environment that registers the COM object. Assuming that the COM objects have been pre-registered, the command line to use is like

OpenCover.console.exe -service:byname -target:<service name> -output:coverage.xml

As this is a blocking operation, launching the coverage gathering a separate process as

start-process OpenCover.console.exe @("-target:<service name>", "-service:byName", "-output:<service name>coverage.xml")

or equivalent in your test scripts.

The byname qualifier is used to prevent races if multiple services are being started concurrently by injecting the OpenCover profiling information to the service specific environment.

Issues

Please raise issues on GitHub, if you can repeat the issue then please provide a sample to make it easier for us to also repeat it and then implement a fix. Please do not hijack unrelated issues, I would rather you create a new issue than add noise to an unrelated issue.

Dropbox is very useful for sharing files alternatively you could create a gist.

Building

You will need:

1. Visual Studio VS2013 (Community Edition) or later with C# and C++
2. WiX 3.9 or later (http://wix.codeplex.com/releases/view/136891)
3. Specflow (http://visualstudiogallery.msdn.microsoft.com/9915524d-7fb0-43c3-bb3c-a8a14fbd40ee)

All other software should be included with this repository.

NANT scripts (encapsulated by the build.bat file) are used to build the project outside visual studio and will run all unit tests.

To build the code in 32-bit Debug mode just run Build in the root of the project folder.

To build a release package including installer, zip and nuget packages use

build create-release

Build Server

The OpenCover team is using Appveyor for automated building. It runs a staged equivalent of

build create-release

and stores all the information about tests, coverage and other build artefacts; you can use these builds if you want to be 'cutting' edge but support will be limited.

We have also suppied the appveyor.yml to make it easy for any forks to have their own builds on AppVeyor. If you send a pull-request the CI system will test your commits (which saves the team time if we do it ourselves)

Coverage

The current OpenCover coverage (found by dogfooding OpenCover on its own tests) can be viewed here

Code Coverage via Coveralls

Reports

For local viewing of the output from OpenCover start here.

Latest Drop as ZIP

No Git? Don't worry you can download the latest code as a zip file.

Thanks

I would like to thank

• JetBrains for my Open Source ReSharper licence,
• AppVeyor for allowing free build CI services for Open Source projects,
• Coveralls for allowing free services for Open Source projects,
• NDepend for my NDepend licence.
• the guys at CodeBetter, Devlicious and Los Techies who orignally arranged my MSDN licence all those years ago without which I doubt I'd have been able to start OpenCover (now no longer needed as we can build OpenCover using the VS2013 Community Edition),
• the NextGenUG and their free swag from where I got lots of useful tools,

I'd also like to thank my family, employers, colleagues and friends for all their support.