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.

<table class="wysiwyg-macro" data-macro-name="unmigrated-inline-wiki-markup" data-macro-parameters="atlassian-macro-output-type=BLOCK" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e3VubWlncmF0ZWQtaW5saW5lLXdpa2ktbWFya3VwOmF0bGFzc2lhbi1tYWNyby1vdXRwdXQtdHlwZT1CTE9DS30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>{iframe:src=http://update.sonarsource.org/plugins/qualityindex.html|width=700|height=250|frameborder=0}
Your browser does not support iframes.
{iframe}</pre></td></tr></table><h1>Description / Features</h1><h2>Overview</h2><p>The Quality Index plugin combines a global measure (quality index) of quality with a measure of the method complexity (complexity factor).</p><p>The Quality Index measures 4 weighted axes of quality and combines them to give a global note between 0 and 10 to the project, 10 being the best.</p><p><img class="confluence-embedded-image" confluence-query-params="effects=drop-shadow" src="/download/attachments/231082376/qi.png?version=1&amp;modificationDate=1371687475495&amp;effects=drop-shadow" data-image-src="/download/attachments/231082376/qi.png?version=1&amp;modificationDate=1371687475495&amp;effects=drop-shadow" data-linked-resource-id="231377179" data-linked-resource-type="attachment" data-linked-resource-default-alias="qi.png" data-base-url="http://docs.codehaus.org" data-linked-resource-container-id="231082376" title="null > qi.png"></p><h2>Axes of Quality</h2><h3>Coding</h3><p>Coding issues: a PMD compliance index</p><p>Coding = (Blocker * 10 + Critical * 5 + Major * 3 + Minor + Info) / ValidLines</p><p>Where:</p><ul><li>ValidLines = Lines of Code - Duplicated Lines</li><li>Blocker = number of PMD blocker issues</li><li>Critical = number of PMD critical issues</li><li>Major = number of PMD major issues</li><li>Minor = number of PMD minor issues</li><li>Info = number of PMD info issues</li></ul><h3>Complexity</h3><p>Complexity = (Complexity&gt;30 * 10 + Complexity&gt;20 * 5 + Complexity&gt;10 * 3 + Complexity&gt;1) / ValidLines</p><p>Where:</p><ul><li><em>ValidLines</em> = Lines of Code - Duplicated Lines</li><li><em>Complexity&gt;X</em> = number of methods whose Complexity is greater than X</li></ul><h3>Coverage</h3><p>Coverage = <a class="confluence-link" href="/display/SONAR/Java+Metric+Definitions#JavaMetricDefinitions-metricUnitTestsCoverage" data-anchor="metricUnitTestsCoverage" data-linked-resource-id="230398300" data-linked-resource-type="page" data-linked-resource-default-alias="Java Metric Definitions#metricUnitTestsCoverage" data-base-url="http://docs.codehaus.org">Code coverage by unit tests</a>.</p><p>If there is no unit tests and thus no code coverage, the Coverage axis will get the worst grade.</p><h3>Style</h3><p>Style issues: a Checkstyle compliance index</p><p>Style = (Errors * 10 + Warnings) / ValidLines * 10</p><p>Where:</p><ul><li><em>ValidLines</em> = Lines of Code - Duplicated Lines</li><li><em>Errors</em> = number of Checkstyle blocker issues+ number of Checkstyle critical issues</li><li><em>Warnings</em> = number of Checkstyle major issues+ number of Checkstyle minor issues+ number of Checkstyle info issues</li></ul><h2>Quality Index</h2><p>Quality Index = 10 - 4.5 * <a class="confluence-link" href="#Coding" data-anchor="Coding" data-linked-resource-default-alias="Coding" data-base-url="http://docs.codehaus.org">Coding</a> - 2 * <a class="confluence-link" href="#Complexity" data-anchor="Complexity" data-linked-resource-default-alias="Complexity" data-base-url="http://docs.codehaus.org">Complexity</a> - 2 * <a class="confluence-link" href="#Coverage" data-anchor="Coverage" data-linked-resource-default-alias="Coverage" data-base-url="http://docs.codehaus.org">Coverage</a> - 1.5 * <a class="confluence-link" href="#Style" data-anchor="Style" data-linked-resource-default-alias="Style" data-base-url="http://docs.codehaus.org">Style</a></p><h2>Complexity Factor</h2><p>The Complexity Factor measures the complexity density.</p><p>Complexity Factor = (5 * Complexity&gt;30) * 100 / (Complexity&gt;1 + Complexity&gt;10 + Complexity&gt;20 + Complexity&gt;30)</p><p>Where:</p><ul><li><em>Complexity&gt;X</em> = number of methods whose Complexity is greater than X</li></ul><h1>Installation</h1><ol><li>Install the plugin through the <a href="http://docs.codehaus.org/display/SONAR/Update+Center" rel="nofollow">Update Center</a> or download it into the <em>SONARQUBE_HOME/extensions/plugins</em> directory</li><li>Restart the SonarQubeserver</li></ol><h1>Usage</h1><p>Run a new quality analysis and the metrics will be fed.</p><h1>Change Log</h1><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAxLjEuM3xoZWlnaHQ9NzB8cmVuZGVyTW9kZT1zdGF0aWN8d2lkdGg9OTAwfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eXx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xNzIwMiZwaWQ9MTE5MTEmc29ydGVyL2ZpZWxkPWlzc3Vla2V5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=70|renderMode=static|title=Version 1.1.3|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=17202&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p><p> </p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAxLjEuMnxoZWlnaHQ9NzB8cmVuZGVyTW9kZT1zdGF0aWN8d2lkdGg9OTAwfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eXx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xNjkxOCZwaWQ9MTE5MTEmc29ydGVyL2ZpZWxkPWlzc3Vla2V5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=70|renderMode=static|title=Version 1.1.2|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16918&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p><p> </p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAxLjEuMXxoZWlnaHQ9NTB8cmVuZGVyTW9kZT1zdGF0aWN8d2lkdGg9OTAwfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eXx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xNjI5MCZwaWQ9MTE5MTEmc29ydGVyL2ZpZWxkPWlzc3Vla2V5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|height=50|renderMode=static|title=Version 1.1.1|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16290&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p><p> </p>