Skip to content

OpenCppCoverage/OpenCppCoveragePlugin

Repository files navigation

OpenCppCoveragePlugin

Official Visual Studio Plugin for OpenCppCoverage

OpenCppCoverage is an open source code coverage tool for C++ under Windows. You can find more information about this project here.

This repository contains only the Visual Studio plugin sources.

Usage

To install and use this plugin, please see the Visual Studio Gallery page. You can also install the NuGet package OpenCppCoverage Plugin.

Documentation is available here.

For questions, you can create a discussion here. If you find a bug, you can create an issue here.

Development

Compilation

You have 2 Visual Studio solution files but Visual Studio 2017 is always required. Please also make sure you have Visual Studio 2017 version 15.8.X.

CppCoveragePlugin.sln

This is the default solution file and it requires only Visual Studio 2017.

CppCoveragePluginVS2013.sln

This is a Visual Studio 2017 solution file but it also requires:

This solution should be used only to generate a plugin compatible with Visual Studio 2013, 2015 and 2017.

OpenCppCoverage

You should install the latest version of OpenCppCoverage:

  • OpenCppCoverageSetup-x64-X.X.X.exe: into VSPackage\OpenCppCoverage-x64
  • OpenCppCoverageSetup-x86-X.X.X.exe: into VSPackage\OpenCppCoverage-x86

You can also copy past the binaries from an existing installation into these folders. Binaries inside VSPackage\OpenCppCoverage-x86 can be the same as VSPackage\OpenCppCoverage-x64 (The opposite is not true).

Run the plugin

  • Set VSPackage as StartUp Project.
  • In VSPackage Properties, tab Debug:
    • Select Start external program and set value to C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\devenv.exe (Update this path if you installed Visual Studio to another location).
    • Add /RootSuffix Exp as Command line arguments.

If you have an issue when running the plugin, you can try to reset Visual Studio Experimental instance:

"C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VSSDK\VisualStudioIntegration\Tools\Bin\CreateExpInstance.exe" /Reset /VSInstance=15.0 /RootSuffix=Exp

Run unit tests

You can run the tests with Test Explorer window. To run VSPackage_IntegrationTests you need to expand Solution items in Solution Explorer and set Active Load and Web Test Settings for IntegrationTests.testsettings. If you have a COM error when running tests, you can select IntegrationTests.testsettings file from Visual Studio menu: Test/Test Settings/Select Test Settings File. For VSPackage_UnitTests you need to do the same but with UnitTests.testsettings.

If a test failed, you can try to run it again. You can also reset Visual Studio Experimental instance.