Description / Features

This plugin adds basic support of C++ language into SonarQube.

Current feature list:

• Basic size metrics:
  
  • Files (number of)
  • Lines
  • Lines of comments
  • Lines of code
  • Lines of commented out code
• Static code checking via virtually any static analyser tool. And possibility of extension of their coding rules.
• Dynamic checking for memory management problems via Valgrind
• Cyclomatic (McCabe) complexity metrics including: 
  
  • Projects complexity
  • Average function/method complexity
  • Average file complexity
  • Complexity distributions
• Code coverage metrics including:
  
  • Unit test overage (line and branch)
  • Integration test coverage (line and branch)
  • Overall branch coverage (line and branch)
• Unit test execution metrics including:
  
  • Successfully executed tests
  • Failed tests
  • Skipped tests
  • Execution time
• Recognition of code duplication
• Basic highlighting mode for C++ in SonarQube UI

Dependencies

The Cxx-Plugin has an obligatory dependency on Java (of course... the plugin itself and all runners are Java programs).

Moreover, there are optional dependencies on:

• Various external code analyzers:
  • Cppcheck. Detects a wide range of problems ranging from performance issues and resource leakage to undefined behaviour. Binary packets are available on/for various platforms. Using the latest release pays off in general; compile from source if in doubt.
  • RATS. Detects (potential) security problems in code, sensible for code bases with increased security requirements. Use binary packages or compile from source.
  • Vera++. Focuses on code style issues. There's a binary package for Windows, users of other platforms are likely to compile themselves.
  • Valgrind (memcheck). Detects various memory management problems at runtime. Basically Linux only; just use the packages from your distribution.
  • CppNcss. Provides cyclomatic (McCabe) complexity measures. This is a Java program distributed as a zip archive. Just unpack and make sure the "bin" directory is in PATH.
  • Pc-Lint. Static analyser from Gimpel
• GCC, gcov, gcovr, Bullseye and Python for coverage determination. Install Python and place the script somewhere on the PATH.  

Installation

1. Install the plugin through the Update Center or download it into the SONARQUBE_HOME/extensions/plugins directory
2. Restart the SonarQubeserver

Quick Configuration Guide

Cxx plugin uses the following properties during analysis. See here for the ways how to pass them to the plugin.

 Note: Report paths are always relative to projects path.

Known Limitations

• Some analyzers (RATS, most notably) may have issues and crash occasionally.
• Valgrind is only available on a subset of UNIX platforms.

Roadmap

Following items are in the queue (more or less...):

• Use SSLR technology
• Integrate compiler warnings

• Implement the dependency analysis (package tangle index metric)

Change Log

Version 0.2 (17 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-2676	Allow extension of rules for supported code checkers by reusing extensions/rules folder in Sonar
	SONARPLUGINS-2671	Generic sensor for importing violations
	SONARPLUGINS-2670	Provide support for the overall test coverage metric
	SONARPLUGINS-2669	Provide support for Common Rules
	SONARPLUGINS-2668	Update plugin to be compatible with Sonar 3.0 API
	SONARPLUGINS-2415	Support cppcheck 1.56 and 1.57
	SONARPLUGINS-2170	Rename Cxx Plugin to 'C++ (Community)'
	SONARPLUGINS-2104	Provide support for RATS 2.3
	SONARPLUGINS-2103	Provide support for cppcheck 1.55
	SONARPLUGINS-2039	Provide support for cppcheck 1.54
	SONARPLUGINS-1994	Provide support for PC-lint
	SONARPLUGINS-1991	CPPNCSS fails to parse some reports with message: "Cannot find the CNN-label"
	SONARPLUGINS-1944	Vera++ to checkstyle perl script doesn't manage errors
	SONARPLUGINS-1942	Extended RATS rules
	SONARPLUGINS-1877	Support Windows and Unix style reports in CPPNCSS
	SONARPLUGINS-1833	Vera++ fails to parse reports with "name=error"
	SONARPLUGINS-1756	Provide support for BullseyeCoverage

Version 0.1 (18 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-2278	Code Coverage for C++ with CXX plugin
	SONARPLUGINS-1800	Integration of cppcheck 1.54
	SONARPLUGINS-1767	CXXRatsSensor crashes due to RATS bug
	SONARPLUGINS-1754	Sonar - Cxx plugin - CxxXunitSensor parser only allows one Testsuite
	SONARPLUGINS-1751	Sonar CXX Plugin does not work with Sonar 3.0
	SONARPLUGINS-1726	CxxLineCounter leaks file descriptors
	SONARPLUGINS-1717	CxxXunitSensor, 3 default xslt embedded
	SONARPLUGINS-1690	GPL header licence mismatch
	SONARPLUGINS-1688	Cleanup rules, rule profiles and rule repositories
	SONARPLUGINS-1687	SCM Activity Plugin compatibility
	SONARPLUGINS-1686	Remove unnecessary Maven dependency
	SONARPLUGINS-1611	Update c++ file extensions supported
	SONARPLUGINS-1599	Fix for paths management in Windows environment and drilling
	SONARPLUGINS-1576	Internal XSLT transformer for XunitSensor
	SONARPLUGINS-1211	Update rats-profile.xml and rats.xml for rats 2.3
	SONARPLUGINS-967	sonar-cxx-plugin does not recognize uninitVar cppcheck violation
	SONARPLUGINS-954	coverage parsing error when line referenced twice
	SONARPLUGINS-792	Complete RATS integration