Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 2.05 KB

sonarqube.md

File metadata and controls

57 lines (39 loc) · 2.05 KB
Raw

JaCoCo with SonarQube

SonarQube is a platform for both static code analysis and test code coverage analysis. It offers an open source Community Edition version, which is free but has some limitations.

SonarQube can be run locally by adding a SonarQube plugin to gradle and e.g. running SonarQube instance from docker.

Add Gradle plugin:

plugin {
    id("org.sonarqube") version "3.3"
}

To enable code coverage reports test coverage reports should be generated (explained in sections: Option 1 and Option 2).

Docker-compose file with minimal configuration:

version: "3"
services:
  sonarqube:
    image: sonarqube:lts
    ports:
      - 9000:9000
    environment:
      - SONAR_FORCEAUTHENTICATION=false

Then when sonar is up current project can be added to the analysis by running a command:

./gradlew sonarqube

Above mentioned configuration works when SonarQube is running on default url: http://localhost:9000 and jacoco reports are placed in default location. Otherwise these properties should be set: sonar.host.url, sonar.jacoco.reportPaths. Here can be found more information about sonarqube Gradle plugin.

Code coverage analysis with SonarQube:

Code Coverage with Sonar

Integration with Github Actions

Integration with github Actions wasn't a part of this spike, because it requires having a SonarQube instance deployed for the whole project, instead of using localhost version.

More information about Github Integration.

Github Action that helps to run the code analysis.

Limitations of the Community Edition version

  • Analysis of multiple branches is not supported
  • Reporting measures to branches and pull requests in Github not supported
  • Automatic detection of branches/pull requests in Github Actions not supported