Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<h1>Creation of a profile for a external tool - Mandatory before running a analysis</h1>The creation of a rule set for the external tool re-uses the concept of <a class="confluence-link" href="/pages/viewpage.action?pageId=230398146" data-linked-resource-id="230398146" data-linked-resource-type="page" data-linked-resource-default-alias="Extending Rules in C++ Analysers" data-base-url="http://docs.codehaus.org">Extending Rules in C++ Analysers</a> therefore the only thing needed is a xml file with the definition of the rules and their respective activation in sonar. The rules xml file needs to be installed under <ul><li>[Server Dir]\extensions\rules\cxxexternal</li></ul><h1>Importing the violation report for the external tool</h1>The property sonar.cxx.externalrules.reportPath is used to point to the location of the report (relative to project root). The following table describes the format of the report<table class="confluenceTable"><tbody><tr><th class="confluenceTh">Xml Description - RNG-Schema</th><th class="confluenceTh">Example</th></tr><tr><td colspan="1" class="confluenceTd"><pre>&lt;element name=&quot;results&quot; xmlns=&quot;http://relaxng.org/ns/structure/1.0&quot;&gt;
 &lt;zeroOrMore&gt;
 &lt;element name=&quot;error&quot;&gt;
 &lt;attribute name=&quot;file&quot;/&gt;
 &lt;attribute name=&quot;msg&quot;/&gt;
 &lt;attribute name=&quot;id&quot;/&gt;
 &lt;attribute name=&quot;line&quot;&gt;
 &lt;data type=&quot;integer&quot; datatypeLibrary=&quot;http://www.w3.org/2001/XMLSchema-datatypes&quot; /&gt;
 &lt;/attribute&gt;
 &lt;text/&gt;
 &lt;/element&gt;
 &lt;/zeroOrMore&gt;
&lt;/element&gt;</pre></td><td colspan="1" class="confluenceTd">&lt;?xml version=&quot;1.0&quot;?&gt; &lt;results&gt; &lt;error file=&quot;sources/utils/code_chunks.cpp&quot; line=&quot;1&quot; id=&quot;cxxexternal-unusedFunction&quot; msg=&quot;The function 'foo' is never used&quot;/&gt; &lt;error file=&quot;sources/utils/utils.cpp&quot; line=&quot;1&quot; id=&quot;cxxexternal-unusedFunction&quot; msg=&quot;The function 'utils' is never used&quot;/&gt; &lt;/results&gt;</td></tr><tr><td class="highlight confluenceTd" colspan="1">Attribute</td><td class="highlight confluenceTd" colspan="1">Description</td></tr><tr><td colspan="1" class="confluenceTd">file</td><td colspan="1" class="confluenceTd">source file, relative to project path</td></tr><tr><td colspan="1" class="confluenceTd">line</td><td colspan="1" class="confluenceTd">line of the violation</td></tr><tr><td colspan="1" class="confluenceTd">id</td><td colspan="1" class="confluenceTd">id of the rule, mapped a rule in sonar. See &quot;Enable the rules in Sonar server&quot; below</td></tr><tr><td colspan="1" class="confluenceTd">msg</td><td colspan="1" class="confluenceTd">description of the violation</td></tr></tbody></table><h1>List of third party tools and their profiles</h1><table class="confluenceTable"><tbody><tr><th class="confluenceTh">Tool</th><th class="confluenceTh">Source</th><th colspan="1" class="confluenceTh">Usage</th><th colspan="1" class="confluenceTh">Rules Profile / Needed scripts</th></tr><tr><td colspan="1" class="confluenceTd">cpplint</td><td colspan="1" class="confluenceTd"><a href="http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml">Home Page</a><a href="http://google-styleguide.googlecode.com/svn/trunk/cpplint/cpplint.py">Download Tool</a></td><td colspan="1" class="confluenceTd">Create the rules profile and the modified cpplint python script as follow:<ul><li style="list-style-type: none;"><ul><li>python cpplint_createrules.py cpplint.py</li></ul></li></ul>This will generate the following files:<ul><li style="list-style-type: none;"><ul><li>cpplint.xml that should installed in extensions/rules/cxxexternal</li><li>cpplint_mod.py that should be used to check the code</li></ul></li></ul>After this you can run the cpplint_mod.py against any source file like this:<ul><li style="list-style-type: none;"><ul><li>python cpplint_mod.py source.cpp 2&gt; report.txt</li></ul></li></ul>The output file report.txt needs to be converted to xml format described above. For convenience a perl script is available here and can be run as follow:<ul><li style="list-style-type: none;"><ul><li>perl cpplintReport2checkstyleReport.perl report.txt cpplint-result-0.xml</li></ul></li></ul></td><td colspan="1" class="confluenceTd"><a href="https://github.com/SonarCommunity/sonar-cxx/blob/master/sonar-cxx-plugin/src/tools/cpplint_createrules.py">Create Rules Script</a><a href="https://github.com/SonarCommunity/sonar-cxx/blob/master/sonar-cxx-plugin/src/tools/cpplintReport2checkstyleReport.perl">CppLint Report Converter Script</a></td></tr></tbody></table><table class="wysiwyg-macro" data-macro-name="info" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm99&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body">This is maintained by the community, so if you want to share additional rules profiles or tool do so by using the <a href="http://sonar.15.n6.nabble.com/">sonar user mailing list</a></td></tr></table><table class="wysiwyg-macro" data-macro-name="info" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm99&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body">The list above is provided without any warranty, therefore you may need to debug the scripts or tools in order to make them work</td></tr></table>