Skip to content

Install the Plugin

Jump to bottom
Günter Wirth edited this page Nov 15, 2024 · 17 revisions 
              Before you start, back up your SonarQube Database.
   Upgrade problems are rare, but you'll want the backup if anything does happen.

                  cxx-sslr-toolkit-x.y.z.jar is not a plugin.
                     Do not copy it to the plugins folder.

  • Use the cxx plugin Compatibility Matrix to select the correct plugin version for the SonarQube version you are using. SonarQube versions are based on different Java versions and also have different APIs and UIs.

    Hint: The cxx plugin competes with the SonarCFamily plugin and is therefore not supported by SonarSource in the Marketplace.

  • Before upgrading an existing version, be sure to read Upgrade-the-Plugin.

  • Download one of the released JAR packages and copy it into the SONARQUBE_HOME/extensions/plugins directory. Details can be found under Install a Plugin, Manual Installation.

    • sonar-cxx-plugin-x.y.z.jar: is the cxx plugin
    • cxx-sslr-toolkit-x.y.z.jar is not a plugin. Do not copy it to the plugins folder.

  • Restart the SonarQube Server to load and activate the cxx plugin.

  • Navigate to the Marketplace inside of SonarQube (Administration > Marketplace). The Marketplace should list CXX (Community) on the Installed tab.

  • Discover and update the CXX-specific properties in: Administration > General Settings > CXX and Administration > General Settings > CXX External Analyzers.

  • If you use the sonar.cxx.other.reportPaths sensor, you should configure the rules before scanning for the first time. Otherwise, any existing issues will be closed and displayed later in New Code.

  • Also remember to check the Quality Profile on a new SonarQube Server. Are the rules you are using enabled?

  • SonarScanner version

    • If you're running SonarQube 9.9 with Java 11 as scanner runtime environment, the latest compatible SonarScanner version is 4.8.x.
    • Later SonarScanner versions require Java 17 as runtime environment.
    • Install a Java version (e.g http://jdk.java.net/archive/) and update JAVA_HOME to point to the installation directory.

Additional tools:

  • cxx-sslr-toolkit-x.y.z.jar: is an additional tool to create an AST from parsed source code. The tool is useful to create XPath checks and to verify if the plugin can parse the source code.
  • Hint: cxx-sslr-toolkit-x.y.z.jar is not a plugin. Do not copy it to the plugins folder. If the JAR file does not contain a SonarQube plugin, the following error message appears in the LOG file when the server is started: ERROR Web server startup failed java.lang.NullPointerException: Plugin key is missing from manifest.

            Wiki Home             Issue Tracker             Releases             Contributors             License

Clone this wiki locally