Support wildcards for coverage report paths

[vilchik-elena]

Currently property for coverage LCOV report paths doesn't accept paths with wildcards. This might be very useful when path is not stable (e.g. see question on SOF).

Property name: sonar.javascript.lcov.reportPaths

• Docs for coverage import in SonarJS
• Docs for patterns in SonarQube

We should decide whether this feature should be implemented for old properties (still supported for SQ < 6.2):

• sonar.javascript.lcov.reportPath
• sonar.javascript.lcov.itReportPath

Example:
"sonar.javascript.lcov.reportPaths=reports/*" would match
reports/report1.lcov
reports/report2.lcov

"sonar.javascript.lcov.reportPaths=**/report.lcov" would match
reports1/report.lcov
reports2/report.lcov

[ivandalbosco]

+1
As regards SQ < 6.2: I suggest we simply pick the cheapest solution between support and non support of wild cards.

[ideadapt]

I use something like

{ type: 'lcov', dir: 'test/reports/unit/coverage/lcov/', subdir: function(browser) {
    // keep a consistent browser name across different OS & browser versions
    return browser.toLowerCase().split(/[ /-]/)[0];
  }
}

to generate a version neutral path. Found at https://github.com/karma-runner/karma-coverage/blob/master/docs/configuration.md

[vilchik-elena]

There is implementation for wildcard support in sonarGo and SonarPython. We should migrate it to sonar-analyzer-commons

[hzdavid]

so Could we use wildcards to . sonar.jacoco.reportPaths now ?

[fadc80]

Is there any chance to see this issue resolved soon?

[roy-bakker-new10]

Would still love this!

[dblees]

sonar.jacoco.reportPaths and sonar.jacoco.classes .. this does not seem to support wildcards .. is this correct? If so, until this is supported this feels brittle. every time a codebase changes, this forces maintenance of configuration to capture reports and classes. please consider this feature. thanks.

[Rai-Rai]

👍
Need support for wildcards for sonar.typescript.lcov.reportPaths really desperate....

[vilchik-elena]

@Rai-Rai since last release (SonarTS 2.0 and SonarJS 6.0) there is single logic and property to load coverage for TS and JS: sonar.javascript.lcov.reportPaths

[brenuart]

Would love this too - and not only for SonarJS but not only for coverage report paths but others as well, like:

• sonar.javascript.lcov.reportPaths
• sonar.typescript.tslint.reportPaths
• sonar.testExecutionReportPaths (generic report)

As @vilchik-elena said, they all share a common logic located in sonar-analyzer-commons (https://github.com/SonarSource/sonar-analyzer-commons/blob/master/commons/src/main/java/org/sonarsource/analyzer/commons/ExternalReportProvider.java#L35) - can't we simply adapt it to support ANT-style patterns for instance?

Would you consider a PR for this ?

[brenuart]

Any chance this issue gets some attention from maintainers? At least some indication about whether this feature request makes sense or not.. ?
Ping @andrey-tyukin-sonarsource, @vilchik-elena ...

[pburkindine]

Also badly need this feature for js/ts

[clok]

Bump. This would be very helpful!

[lpcruz]

Bumping this as well--- currently in a situation where we need to support multiple lcov reports so having it be a capability of Sonar itself would be amazing.

[mariamatthews]

Note: I am aware that this is now closed and merged in the new version, but for those who cannot upgrade

Hi guys, could I suggest using a quick bash script before your SonarQube runs that would identify the file/folder locations for you as a workaround?

Putting the below path and updating the packages folder name to the root folder of your projects should find the exact locations for you.

Code:

  - bash: |
      for entry in packages/*/
      do
      if [ "$entry" == "packages/common/" ] ; then
            continue;
      fi
      testPaths=${testPaths}${entry}test-report.xml,
      coveragePaths=${coveragePaths}${entry}coverage/lcov.info,
      done
      testPaths=${testPaths%,}
      coveragePaths=${coveragePaths%,}
      echo "Test and coverage reports paths found: "
      echo "Test reports: $testPaths"
      echo "Coverage reports: $coveragePaths"
      echo "Setting pipeline variables..."
      echo "##vso[task.setvariable variable=TESTPATHS]$testPaths"
      echo "##vso[task.setvariable variable=COVERAGEPATHS]$coveragePaths"
    displayName: Getting report paths for SonarQube

The above task would iterate over the folders and add the files found within the temporary Azure Pipelines variables.
The if statement is where you could add any folders you would like it to skip.

This means that you can set SonarQube reportPaths like:

      sonar.testExecutionReportPaths=$(TESTPATHS)
      sonar.javascript.lcov.reportPaths=$(COVERAGEPATHS)

Let me know if you have found it useful and if it worked for you (in the case where you can't upgrade your SonarQube instance) 🧡

[hoch4]

This workaround works well too

#!/bin/sh
coverage=$(find -type f -name '*coverage.lcov' -printf "%p,")
testResults=$(find -type f -name '*test-result.xml' -printf "%p,")

mvn sonar:sonar \
  -Dsonar.projectKey=my.project.key.from.sonarqube \
  -Dsonar.host.url=http://mysonarqubeserver.com:9000 \
  -Dsonar.login=kd94kaek94ad9duiope67fbn89vbnnn89dw \
  -Dsonar.sources="." \
  -Dsonar.tests="." \
  -Dsonar.test.inclusions="**/*.spec.ts" \
  -Dsonar.javascript.lcov.reportPaths="${coverage}" \
  -Dsonar.testExecutionReportPaths="${testResults}"

[arobinson]

I'm still having this problem. I've tried both * and ** with no luck with sonar.javascript.lcov.reportPaths

Using

export SONAR_SCANNER_VERSION="5.0.1.3006"

And

"sonarqube-scanner": "^3.3.0

Error:

14:47:08  INFO: No LCOV files were found using /home/ec2-user/workspace/Client/some-workspace/test-results/coverage/*.lcov.info
14:47:08  WARN: No coverage information will be saved because all LCOV files cannot be found.

I archived the test-results/coverage folder as part of the Jenkins job, and verified the path is correct and should have matched 4 files. Also, from the error, it does not sound like it is using the code that was in the fix for this issue.

What version needs to be used to obtain the fix?