Publish Code Coverage in Azure DevOps
Integrate the RKTracer tool in Azure DevOps. Generate and Publish Code Coverage report in Azure DevOps Project Pipeline.
Install the RKTracer plugin in Azure DevOps from Marketplace
The RKTracer should be installed with a valid license.
Step 1: To install the rktracer plugin. Go to the browser marketplace.
Step 2: Search rktracer in the search bar and install the RKTracer plugin.
Integrate RKTracer tool ,Generate and Publish Code Coverage in Azure DevOps Pipeline
Edit the project pipeline in Azure DevOps, and you need to make the following changes.
Step 1: You need to disable the auto-generated code coverage by Microsoft.
– name: disable.coverage.autogenerate
Step 2: Before you build your project, make sure you have turned on the RKTracer tool.
For example, in a visual studio.
– script: rktracer -vs -on – *sln
displayName: “RKTracer ON”
Step 3: Build and Test the Application, i.e., unit testing or functional testing.
Step 4: Generate RKTracer Code Coverage reports in XML format.
– script: rkresults -xml -nolaunch
Step 5: Convert the RKTracer Coverage Reports to Cobertura format.
– task: reportgenerator@4
Step 6: Publish Code Coverage Reports in Azure DevOps using the following task.
– task: PublishCodeCoverageResults@1
Example RKTracer Reports in Azure DevOps
You can see the test result as shown in the following screenshot.
You can also see the code coverage summary report in the code coverage section. You can see different Code Coverage Metrics like Line Coverage, Statement coverage, and Multiple Condition Coverage.
Code Coverage shows zero percentage.
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 with the proper exit handler, i.e., atexit() handler, or your application might be running in an infinite loop. You can use the following two methods to save coverage data from memory to the file system.
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()
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.
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 *.c = 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.c *source-file-Y.c *source-file-Z.c
function-instrument fun_X() fun_Y() fun_Z()
ignore *.c = Ignore all C programming source files
instrument *file-X.c *file-Y.c *file-Z.c = 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() = But instrument or don’t ignore these three functions from these three files.