gitlab-sonar-scanner-java-maven

NO LONGER SUPPORTED

Gitlab docker container to execute sonar-scanner analysis (Java, Apache Maven based applications)

Usage

1. Create/Update sonar-project.properties

# Required metadata
sonar.projectKey=spring-boot-default-skeleton
sonar.projectName=Spring Boot Default Skeleton
sonar.projectVersion=1.0

# Comma-separated paths to directories with sources (required)
sonar.sources=src/main/java

# Comma-separated paths to directories with tests
sonar.tests=src/test/java

# Comma-separated paths to directories with classes binaries
sonar.java.binaries=target/classes

# Tells SonarQube where the unit tests execution reports are
sonar.junit.reportsPath=target/surefire-reports

# Tells SonarQube where the unit tests code coverage report is
sonar.jacoco.reportPaths=target/jacoco.exec

# Encoding of the source files
sonar.sourceEncoding=UTF-8

# Exclude
sonar.exclusions=src/main/java/com/tech1/Application.java,\
  src/main/java/com/tech1/configuration/**/*,\
  src/main/java/com/tech1/domain/**/*,\
  src/main/java/com/tech1/properties/**/*,\
  src/main/java/com/tech1/resource/InfoResource.java

2. Create/Update .gitlab-ci.yml

stages:
- quality

sonarqube:
  stage: quality
  image: tech1/gitlab-sonar-scanner-java-maven
  variables:
    SONAR_HOST_URL: http://sonarqube.ipaddress
    SONAR_LOGIN: sonarqube_login
    SONAR_PASSWORD: sonarqube_password
  script:
  # know issues in java, apache maven based application
  # apk add --no-cache procps
  - mvn clean install 
  - sonar-scanner-ext

3. Install Sonar GitLab Plugin in your SonarQube

4. Create SonarQube user
5. Grant Execute Analysis permission on SonarQube project

Known issues

issue: maven-surefire-plugin issue: JIRA-1422
solution: install procps or downgrade to version: 2.20

Any ideas?

If you have any ideas, questions or suggestions, please don't hesitate to submit new Github issue.

License (GNU-GPLv3)

Copyright (c) 2018