How Can We Help?
< All Topics
Print

Integrate RKTracer with Visual Studio IDE and generate code coverage for C# Applications

How to integrate the RKTracer tool with Visual Studio IDE (2005 to 2019)?

Open a command prompt and execute the following command to integrate the RKTracer tool with visual studio IDE.

rktracer -vs -integrate

 

On successful integration of the RKTracer tool, you should see the following information in the command prompt.

How to generate code coverage in Visual Studio IDE for C# projects?

Make sure you’re able to build and test the application. Testing can be of unit/functional testing on a host or server machine

Step 1: Enable the RKTracer tool 

goto Tools→ RKTracer ON

 

Step 2: Rebuild the application to the instrument with the RKTracer tool.

 

Step 3: Test the instrumented application.

It can be unit testing or functional testing/integration testing.

Post-testing, the RKTracer tool will save coverage data to the rk-coverage.txt file. if you’re testing the instrumented application on the server, you need to copy rk-coverage.txt from the server machine to the application working folder in the build machine.

Step 4: Reports to generate a code coverage report.

Go to –> Tools menu –> RKTracer Report to generate Html reports.RKTracer tool will take coverage data file “rk-coverage.txt” and map with JSON files (generated during instrumentation) in the rktracer folder and generate the HTML reports. You can manually open the HTML report using index.html.

Generate code coverage for selected functions/files/folder

Generate coverage reports  for the selected folders

C:\project\sound\drivers\base\power\

C:\project\sound\drivers\base\power\firmware_loader\

C:\project\sound\drivers\core\

C:\project\sound\security\keys\

C:\project\sound\security\lockdown\

Suppose you need code coverage for source files from three different folders, i.e., core, keys, power, and ignore coverage for folders firmware_loader and lockdown. Edit rktracer.config in the RKTracer installation folder and go to the end of the file add the following information. 

ignore *.cs

instrument */power/* */core/* */keys/*

never */firmware_loader/* */lockdown/*

ignore *.cs = Ignores all C# source files from instrumentation

Instrument = Instrument source files from given folders

never = ignore selected folder  

Generate coverage reports only for selected functions from three different files.

fun_X() in source-file-X 

fun_Y() in source-file-Y

fun_Z() in source-file-Z

Suppose you need code coverage for selected functions from three different files. Edit rktracer.config in the RKTracer installation folder and go to the end of the file and set the following variables as shown below.  

ignore *.cs

instrument *source-file-X.cs *source-file-Y.cs *source-file-Z.cs

function-ignore *

function-instrument fun_X() fun_Y() fun_Z()

ignore *.cs = Ignore all C# programming source files

instrument *file-X.cs *file-Y.cs *file-Z.cs   = Instrument only these three source files.

function-ignore * = Then ignore all functions in the above three files.

function-instrument fun_X() fun_Y() fun_Z() = Don’t ignore these three functions from these three files from instrumentation.

Next Code Coverage for dotnet Csharp projects in command line mode
Table of Contents