...

Connect to the wrong Oracle schema

When having 2 Sonar two sonarqube schemas on the same Oracle instance, especially if they are in 2 different versions, Sonar can SonarQubecan get confused and picks the first it finds. In that case, there are two known workarounds:
1. Remove the DBA rights to the Sonar sonarqube users in Oracle
2. Use sonar.hibernate.default_schema in sonar.properties to set the schema. In that case, -Dsonar.hibernate.default_schema should be used as well during project analysis.

...

Failed to start on Windows Vista

Sonar SonarQube seems unable to start when installed under the folder "Program Files" in VISTA. It should therefore not be installed there.

Failed to launch the

...

SonarQubeservice on Windows platform with a LocalSystem account

This error happens when the temporary file path specified for the Local System doesn't exist. Assuming that environment variables have their default settings and that Windows is installed on the ‘C’ drive, the following paths should exist:

...

In most cases, the "Temp" folder is missing and should be created. See SONAR-2660.

Failed to start

...

SonarQubewith Oracle due to bad USERS table structure

When another(s) USERS table exists in the Oracle DB, if the sonar sonarqube user has read access on this other USERS table, the Sonar SonarQube web server can't start and an exception like the following one is thrown:

...

See SONAR-2549.
To fix this issue, the rights of the sonar oracle sonarqube Oracle user must be decreased to remove read access on the other(s) USERS table(s).

...

For some proxies exception "java.net.ProtocolException: Server redirected too many times" might mean incorrect username or password.

Can

...

SonarQuberun in HTTPS mode

No. But you can run Sonar in SonarQubein a standard HTTPS infrastructure using reverse proxy (note also that URL rewriting is necessary till the following ticket is fixed: SONAR-2296).

Security

I have locked myself out

There is currently nothing that stops you removing from every user and every group the global administrator role. the global administrator role. You then have no other solution than make an manual update in the Sonar database to get back in control.

INSERT INTO user_roles(user_id, role) VALUES ((select id from users where login='mylogin'), 'admin');

I lost the admin password

In case you lost the admin password of your Sonar instance, you can reset it by running the following update statement :

update users set crypted_password = '88c991e39bb88b94178123a849606905ebf440f5', salt='6522f3c5007ae910ad690bb1bdbf264a34884c6d' where login = 'admin'

This will reset the password to admin.

General

I am not getting expected new violations in the differential views of drill-down ?

3 reasons can explain this :

• This service only shows "Added Violations", not fixed ones. Therefore the number you see in this service can be different from the dashboard.
• The algorithm used to detect if a violation is new is very good but still perfectible. Therefore new violations can sometimes appear only because Sonar did not recognize it existed already
• You are looking at a period of X days which goes beyond the first analysis made after migration to Sonar 2.5. In this case there can be a discrepancy due to the fact that prior to 2.5, Sonar was not collecting the info necessary to build this service. This issue will disappear as soon as period does not go beyond first analysis.

How to remove false-positive violations ?

NOSONAR

You can use the mechanism embedded in underlying rules violation engine (//NOPMD...) or the generic mechanism implemented in Sonar : Put //NOSONAR at the end of the line of the violation. This will suppress the violation.

SuppressWarnings

The //NOSONAR tag is useful to deactivate all rules at a given line but is not suitable to deactivate all rules (or only a given rule) for all the lines of a method or a class. This is why support for @SuppressWarnings("all") has been added to Sonar.

Use the switch-off plugin

http://docs.codehaus.org/display/SONAR/Switch+Off+Violations+Plugin

Switch off violation

You can use the Review feature to flag a violation as false-positive directly from the user interface.

Analyzing Source Code

Java

Source Tree Directory

The source directory tree has to match the package declarations.

For example, the following class:

package com.mycompany.mypackage;
...

should be located in the following directory: [myBaseDir]/com/mycompany/mypackage/MyClass.java.

Otherwise you would get such an error while running your analysis:

Exception in thread "main" org.sonar.batch.bootstrapper.BootstrapException: org.sonar.squid.api.AnalysisException: Got an exception - org.so
nar.squid.api.AnalysisException: The source directory does not correspond to the package declaration com.mycompany.mypackage, file : ..\src\MyClass.java
...

...

in this case the reverse proxy must be configured to set the value 'X_FORWARDED_PROTO: https' in each HTTP request header. Without this property, redirection initiated by the SonarQube server will fall back on HTTP).

Solaris: Issue with JRuby 1.6.6+ (should be fixed with JRuby  1.7.0)

Standalone:

Due to the following JRuby issue: https://jira.codehaus.org/browse/JRUBY-6494, the following line has to be added in conf/wrapper.conf:

wrapper.java.additional.3=-Djruby.native.enabled=false

See SONAR-4046 for more information.

Tomcat:

Note that this property has to be set when launching Tomcat (as the wrapper.conf file is not used when deploying in application server).

Analysis

What is the difference between org.codehaus.mojo:sonar-maven-plugin and org.codehaus.sonar:sonar-maven-plugin?

Here is the rational: Sonar need SonarQubeneeds a Maven plugin to perform analysis of your project. This plugin is part of Sonar project SonarQubeproject so the name of this plugin is org.codehaus.sonar:sonar-maven-plugin because codehaus is hosting the project. Each time there is a new version of SonarSonarQube, there is a new version of the Sonar Maven plugin. For a given version of the Sonar SonarQube server, you MUST run the same version of the Sonar Maven plugin. It means that you would have to run:

mvn org.codehaus.sonar:sonar-maven-plugin:2.5:sonar

if you have installed Sonar 2SonarQube2.5.
As this is very annoying to type, you could add the the groupId in your settings.xml. This way you could type:

...

BUT in this case the latest version of the Maven Sonar plugin would be taken. As soon as Sonar 2SonarQube2.6 would be released, Maven would automatically use the plugin in version 2.6. If you don't plan to upgrade your Sonar your SonarQube server, it will fail. The answer to this problem is already well-known: define all versions of your plugins in the pom. So you would add:

<plugin>
        <groupId>org.codehaus.sonar</groupId>
        <artifactId>sonar-maven-plugin</artifactId>
        <version>2.5</version>
      </plugin>

in all pom (or in corporate pom). And you would have to update your projects each time you are updating sonar serverSonarQubeserver. Very annoying but that's not all.
What if you have an integration/acceptance/pre-production instance of Sonar SonarQube in version 2.5, and a production version in version 2.4? You can't analyse the same project with the two instances because you have fixed the version of the sonar Maven plugin to version 2.5 in the pom. You may finally make it works with external properties or any other ugly hack.

The solution proposed by Sonar team is to use a a bootstrap plugin plugin. This plugin:

• is hosted in org.codehaus.mojo groupId in order to save the settings.xml configuration
• is supposed to be very stable (ie do not change for each Sonar server SonarQubeserver release)

When you run

mvn sonar:sonar

...

. The bootstrap plugin will query Sonar SonarQube server to find its version, then fork a new build to run the the normal plugin  plugin with

mvn org.codehaus.sonar:sonar:maven-plugin:XX:sonar

where where XX is  is the version previously returned by the server. This way you can analyse analyze the same project with different versions of Sonar SonarQube and still running the same command line (except Sonar SonarQube hostname of course) and without having to modify the pom.

Most of the time you need latest version of the boostrap plugin, so no need to fix its version in your pom, except if you want to test a particular version (an old one or a SNAPSHOT for example).

Maven mirrors : the maven plugin fails to resolve org.codehaus.sonar.runtime.* dependencies

This issue occurs when using a Sonar version prior to 2.2. To fix it, it's recommended to upgrade Sonar and the maven plugin to version 1.0-beta-2 (for Maven 2 projects) or 2.0-beta-2 (for Maven 3 projects).

Sonar embeds its own maven repository which is used by the Sonar maven plugin to download all Sonar extensions like pmd, checkstyle, findbugs, etc. If you get this error, it's certainly because your Maven configuration prevents Sonar from accessing its own Maven repository. Your maven settings.xml file must certainly contain a section called <mirror> which should look like this :

<mirror>
    <id>nexus</id>
    <mirrorOf>*</mirrorOf>
    <url>http://nexus/</url>
    <name>Central maven repository</name>
</mirror>

According to this section, Maven redirects all calls to the repository called 'nexus', so Sonar maven repository is never touched and Sonar maven plugin fails to resolve org.codehaus.sonar.runtime.* dependencies. Two solutions to solve this issue:

• If you have Maven version 2.0.9 or higher, just change the value of <mirrorOf> by

  Code Block
  <mirrorOf>*,!sonar</mirrorOf>

• Or configure your central maven repository (eg. Nexus, Archiva or Artifactory) to use the Sonar internal repository (http://sonar:9000/deploy/maven).

Error resolving version for 'org.codehaus.mojo:sonar-maven-plugin': Plugin requires Maven version 3.0

This error means that you're using Maven 2.0.10 or Maven 2.0.11. Due to to SONAR-1994, you must add the following lines to the pom.xml file :

<build>
  <pluginManagement>
    <plugins>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>sonar-maven-plugin</artifactId>
        <version>1.0</version>
      </plugin>
    </plugins>
  </pluginManagement>
</build>

Cobertura exception on Linux System while accessing the cobertura.ser file

When reading the cobertura.ser file, the Cobertura Maven plugin tries to get a lock on that file. This locking mechanism generates an exception on Linux Systems Systems SONAR-172.

The current workaround is to add the following lines to the pom.xml file (thanks to Wouter de Vaal) :

<plugin>
   <groupId>org.apache.maven.plugins</groupId>
   <artifactId>maven-surefire-plugin</artifactId>
   <version>2.4.3</version>
   <configuration>
      <systemProperties>
         <property>
            <name>cobertura.use.java.nio</name>
            <value>false</value>
         </property>
      </systemProperties>
   </configuration>
</plugin>

The plugin 'org.apache.maven.plugins:maven-sonar-plugin' does not exist or no valid version could be found

If you get this error message after launching the maven command line "mvn sonar:sonar" add the "-U" parameter to the command line. Maven will then update its local repository with the latest version of the Sonar Maven plugin.

If adding the "-U" parameter doesn't fix your issue, you've certainly encountered Maven bug bug MNG-4001. The only known workaround is to delete the org\codehaus\mojo directory in your local Maven repository. Of course, if your local Maven repository is synchronized with a repository manager like Nexus, this operation must be also done on the repository manager side.

Maven fails with an OutOfMemoryError

Increase the maven available memory by setting the environment variable :

MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=256m"

Maven fails with a SecurityException

The message of the root exception is

...

You must also sign Sonar libraries in your Maven repository or used unsigned CGLIB library.

Maven fails with a NoClassDefFoundError

Typically error message looks like :

...

1. Your Maven repository (local or remote) contains corrupted JARs.
2. You have exceeded limit of open files - see see http://markmail.org/message/wvfvafgrga5b6tnd.

Maven fails because of Maven Enforcer violations

You have to add the parameter -Denforcer.skip=true to the Maven command-line.

Failed to resolve stax2-api artifact

The following error occurs when using Maven Archiva 1.1. It must be upgraded to 1.2.1.

[INFO] Failed to resolve artifact.

No versions are present in the repository for the artifact with a range [3.0.0,3.1.0)
org.codehaus.woodstox:stax2-api:jar:null

Findbugs fails on timeout

...

INVALID HASH

While running an analysis, you may face the following error:

[java] Timeout: killed the sub-process
...
[Fatal Error] :-1:-1: Premature end of file.

Add the findbugs-maven-plugin to the plugins section of the pom and configure the parameter "timeout".

0% code coverage reported whereas unit tests are correctly executed

This problem occurs when using the Maven Cobertura Plugin and a special configuration of the Maven Surefire Plugin preventing unit tests to be forked. This problem can be solved by removing the line "<forkMode>never</forkMode>" in the Maven configuration file (see SONAR-1445 and MCOBERTURA-70).

My project only builds with JDK1.4

As Sonar can only run with JDK1.5 or higher, some configuration should be added to the pom.xml to indicate that the project requires JDK1.4:

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <source>1.4</source>
          <target>1.4</target>
        </configuration>
      </plugin>

12:20:22.426 INFO  - Install plugins
12:20:22.426 DEBUG - Download index of plugins
12:20:22.426 DEBUG - Download:
http://localhost:9000/deploy/plugins/index.txt (no proxy)
12:20:23.019 DEBUG - Download /deploy/plugins/xxx/sonar-xxx-plugin-X.Y.jar to C:\Documents and Settings\myUser\.sonar\cache\_tmp\1369156823019-681
...
...
INFO: EXECUTION FAILURE
...
...
ERROR: Error during Sonar runner execution
org.sonar.runner.impl.RunnerException: Unable to execute Sonar
...
...
Caused by: java.lang.IllegalStateException: INVALID HASH: File C:\Documents and Settings\myUser\.sonar\cache\_tmp\1369156823019-681 was expected to have
hash bc7b831dce659cbfa238c0d6f961409b but was downloaded with hash d41d8cd98f00b204e9800998ecf8427e
...

It means that the analyzer encountered an issue while downloading the plugins from the SonarQubeserver to the machine running the project analysis.

This error could be due either to:

• A connection issue with the SonarQubeserver. Check with your network administrator.
• A user quota issue. Indeed, by default, all the plugins are downloaded to the local space of the user running the analysis. Some companies set restrictions in terms of local user space, hence the issue. The workaround is to set the 'SONAR_USER_HOME' environment variable on the machine running the analysis to a directory with enough available space to download all the plugins. 

General

Failed to analyse a project as another analysis on the same project seems to be running at the same time (Sonar 3.4 only)

In SonarQube3.4 (SONAR-3306) a new semaphore mechanism has been introduced to prevent launching several analysis on the same project in parallel. But in some cases when an analysis of a project is unexpectedly interrupted, the lock of the semaphore is sometimes not released and in such case it's up to the System administrator to relaunch the project analysis with the property 'sonar.forceAnalysis=true'. This limitation has been fixed in SonarQube 3.5 (SONAR-4053). 

How to remove false positive issues?

NOSONAR

You can use the mechanism embedded in rules engine (//NOPMD...) or the generic mechanism implemented in SonarQube: put //NOSONAR at the end of the line of the issue. This will suppress the issue.

SuppressWarnings

The //NOSONAR tag is useful to deactivate all rules at a given line but is not suitable to deactivate all rules (or only a given rule) for all the lines of a method or a class. This is why support for @SuppressWarnings("all") has been added to SonarQube.

Use the Switch Off Violations plugin

http://docs.codehaus.org/display/SONAR/Switch+Off+Violations+Plugin

Switch off issues

You can review an issue to flag it as false positive directly from the user interface.