SonarQube with Jest Unit Tests

25
votes

I've been trying to find out how to populate SonarQube with both my Jest Unit Tests and the .net Unit Tests.

I have a local version of SQ 6.7 and all the latest versions of the Javascript and C# Plugins.

When it comes to Jest, I have the sonar-jest-reporter to export a test-report.xml file, and also have the lcov.info file being generated.

SonarQube is able to read the lcov.info and I see a coverage %, but no matter what I set as include/exclude, or tests path, it will not show the tests associated with the source file.

The file structure is all .js and the .test.js are in the same directory with each module.

Any help with pointing me in the correct direction, or others who have encountered and overcome this issue that would be appreciated.

1
unit-testingsonarqubejestjs
Why do you want it to show the test files? The coverage is for your .js files not your .tests.js. Am I misunderstanding what you are trying to do? As far as I know the lcov file doesn't include data about which tests are associated with which source files. It only includes data on which lines/branches are covered by tests. - tehbeardedone
Where did you read this is possible in SonarQube? - Jeroen Heier
I see the count of unit tests, but when you select it, they are blank. That's what I am trying to figure out. Isn't that a feature of SQ to see the coverage and the tests? - Matt B.

1 Answers

42
votes

Looks like I've figured out the way to make it work. The trick is to have both sonar.sources and sonar.tests point to same directory (because we have both tests and source in the same directory) then use sonar.tests.inclusions to pattern match test files with .test.js or .spec.js extension.

Here's a sample sonar-project.properties which assumes the following:

  1. src/components/Foo/Foo.jsx the main component.
  2. src/components/Foo/Foo.spec.jsx the test file.
# Source
sonar.sources=src
# Where to find tests file, also src
sonar.tests=src
# But we get specific here
# We don't need to exclude it in sonar.sources because it is automatically taken care of
sonar.test.inclusions=src/**/*.spec.js,src/**/*.spec.jsx,src/**/*.test.js,src/**/*.test.jsx

# Now specify path of lcov and testlog
sonar.javascript.lcov.reportPaths=coverage/jest/lcov.info
sonar.testExecutionReportPaths=coverage/jest/testlog.xml

Now your test files will also show up.

More information here