Branch coverage always shows up as "no data found" in the PR comment

[balaji-nordic]

Hello all,

I am using the v1.4.0 version of github-actions-report-lcov. This is how I invoke it from my github workflow.

      - name: Report code coverage
        uses: zgosalvez/[email protected]
        with:
          coverage-files: coverage.info
          github-token: ${{ secrets.GITHUB_TOKEN }}
          minimum-coverage: 10
          artifact-name: code-coverage-report
          working-directory: local

I notice that when the job completes, the PR comment it leaves always has "no data found" for the branch coverage. It does however report reasonable numbers for lines and functions coverage. What could be wrong? In the log, I see the following (just pasting the relevant lines)

....
Writing directory view page.
Overall coverage rate:
  lines......: 47.2% (7623 of 16157 lines)
  functions..: 53.6% (1016 of 1896 functions)
  branches...: 37.0% (3142 of 8500 branches)
Total file count: 841 ---- Processed file #208 (24.7%)
Total file count: 841 ---- Processed file #415 (49.3%)
Total file count: 841 ---- Processed file #627 (74.5%)
Total file count: 841 ---- Processed file #834 (99.1%)
Total size of all the files uploaded is 2156030 bytes
Finished uploading artifact code-coverage-report. Reported size is 2156030 bytes. There were 0 items that failed to upload
[command]/usr/bin/lcov --add-tracefile coverage.info --output-file /tmp/__zgosalvez_github-actions-report-lcov/lcov.info
Combining tracefiles.
Reading tracefile coverage.info
Writing data to /tmp/__zgosalvez_github-actions-report-lcov/lcov.info
Summary coverage rate:
  lines......: 47.2% (7623 of 16157 lines)
  functions..: 53.6% (1016 of 1896 functions)
  branches...: no data found
[command]/usr/bin/lcov --summary /tmp/__zgosalvez_github-actions-report-lcov/lcov.info
Reading tracefile /tmp/__zgosalvez_github-actions-report-lcov/lcov.info
Summary coverage rate:
  lines......: 47.2% (7623 of 16157 lines)
  functions..: 53.6% (1016 of 1896 functions)
  branches...: no data found
[command]/usr/bin/lcov --list /tmp/__zgosalvez_github-actions-report-lcov/lcov.info --list-full-path
Reading tracefile /tmp/__zgosalvez_github-actions-report-lcov/lcov.info
                                                                                                                                                   

As can be seen, the branch coverage does get populated correctly in what appears to be the first of the three runs. The second and third runs however do not have any branch coverage data. Anyone knows why lcov is invoked three times? And why the branch coverage data gets removed after the second and third runs?

[zgosalvez]

Interesting. My projects never produce the coverage rate for branches so I never had the chance to confirm that. I think the issue occurs when the script attempts to merge all of the coverages. I'm not sure if it's a limitation of the lcov command.

github-actions-report-lcov/src/main.js

Lines 80 to 97 in 7b8cc5c

	async function mergeCoverages(coverageFiles, tmpPath) {
	// This is broken for some reason:
	//const mergedCoverageFile = path.resolve(tmpPath, 'lcov.info');
	const mergedCoverageFile = tmpPath + '/lcov.info';
	const args = [];
	for (const coverageFile of coverageFiles) {
	args.push('--add-tracefile');
	args.push(coverageFile);
	}
	args.push('--output-file');
	args.push(mergedCoverageFile);
	await exec.exec('lcov', args);
	return mergedCoverageFile;
	}

Can you try running the command manually? Or if the repo is public, maybe I can check it myself (but please be patient — I only have weekends to sit on things).

[balaji-nordic]

Thanks @zgosalvez for the quick answer. Here is my PR where I am trying to get this to work -> balaji-nordic/sdk-nrf#3 . It is a public repo. So you should be able to see changes and the logs.

P.S: I too work sporadically on this. So there is no rush :-)

[zgosalvez]

I forked it, but I don't know how to generate the lcov files. Mind sharing the process or attaching a sample here?

[balaji-nordic]

I use a tool called twister to run unit tests and generate coverage report. You can see how I do it here -> https://github.com/balaji-nordic/sdk-nrf/blob/9d90c21de1a5de9646e9589d524180d0fc5fbd24/.github/workflows/unittest.yml#L36
But here is a sample coverage file generated by running one unit test in the repo ->
coverage.zip

[balaji-nordic]

Fixed by #19