Code Coverage for Csharp in Visual Studio IDE
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. You can skip and go to the fourth step to generate reports if you see the rk-coverage.txt file.
Coverage data file not found after testing.
RKTracer tool uses the following approaches to save coverage data.
- Run unit/functional testing, and at the end RKTracer tool will automatically save coverage data on the host/embedded target/server machine, that is, write coverage data to the rk-coverage.txt file.
- Send a signal to the application running in an infinite loop to trigger and save coverage data.
- The application under test has crashed in the middle of testing on the host or target device. RKTracer saves coverage data to rk-coverage.txt and generate reports to check the point of a crash in reports.
- Embedded devices without a file system or not connected to host while testing. In this case, rktracer RAW mode comes in to picture. You need to save the coverage data from the RKTracer variable.
Suppose you cannot find the rk-coverage.txt file in the project working folder or target server machine. An application under test has not exited within the proper shutdown hook, i.e., Runtime. get runtime().addShutdownHook(new Thread()), or your application might be running in an infinite loop or live application
Save coverage data when a particular function is executed at runtime testing.
Identify a function/method name in your application (ensure this function/method is not excluded from RKTracer instrumentation or file with this function). Then copy the function name and edit the rktracer.config in the RKTracer installation folder.
For C# programming language: Add a new line at the end of rktracer.config file with “c#-function-writeout” and function name. Here the function name is case sensitive, and you should also add empty braces, i.e., () at the end of a function name. In case if you have a function with an input parameter, it should still be empty braces. You can add multiple function names with one space to the list, as shown below.
- c#-function-writeout main()
- c#-function-writeout main() OnCreate() fun()
After adding function name to rktracer.config file. You need to rebuild the application to re-instrument using rktracer. Coverage data will be saved to the rk-coverage.txt file when this function executes at runtime testing.
Send a signal to save coverage data.
We can send a signal to the application running in an infinite loop to save coverage data to rk-coverage.txt.
- Windows: send a kill signal using keys in the keyboard, i.e., Control+Pause/break. Contact support if you would like to add additional signal command to save coverage data at runtime testing.
- Linux/Unix: Send a SIGWINCH signal: killall -SIGWINCH a.out or kill -SIGWINCH Process ID number.
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
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.
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.
instrument *source-file-X.cs *source-file-Y.cs *source-file-Z.cs
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.