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/totalquality.html|width=700|height=250|frameborder=0}
Your browser does not support iframes.
{iframe}</pre></td></tr></table><h1>Description / Features</h1><p>Total Quality plugin combines four domain measures (architecture, design, code, and tests) in order to calculate a global and unified project quality health. Plugin provides metrics at project level only.</p><p>The default formula is:</p><p>TQ = 0.25*ARCH + 0.25*DES + 0.25*CODE + 0.25*TS</p><p>or </p><p>TQ = 0.25*ARCH + 0.25*DES + 0.25*CODE + 0.25*OVERALL_TS (if computing Quality with IT Tests is enabled)</p><p>where:</p><h3>Architecture (ARCH)</h3><p>ARCH = 100 - TI</p><blockquote><p>TI = Tangle Index</p></blockquote><h3>Design (DES)</h3><p>DES = 0.15*NOM + 0.15*LCOM + 0.25*RFC 0.25*CBO + 0.20*DIT</p><blockquote><p>NOM = (1 - (class_complexity - 12) / (acel * 12)) * 50 + (1 - (method_complexity - 2.5) / (acel * 2.5)) * 50</p></blockquote><blockquote><p>LCOM = (1 - (lack_of_cohesion_of_method - 1) / (acel * 1)) * 100</p></blockquote><blockquote><p>RFC = (1 - (response_for_class - 50) / (acel * 50)) * 100</p></blockquote><blockquote><p>CBO = (1 - (efferent_coupling - 5) / (acel * 5)) * 100</p></blockquote><blockquote><p>DIT = (1 - (depth_of_inheritance_tree - 5) / (acel * 5)) * 100</p></blockquote><p><em>acel</em> is an accelerator factor whose value can be configured in the Sonar settings page. <br /> The default threshold for each metric can be also configured (for instance, 50 is the default response_for_class threshold).</p><h3>Code (CODE)</h3><p>Code = 0.15*DOC + 0.45*RULES + 0.40*DRYNESS</p><blockquote><p>DOC = Documented API density</p></blockquote><blockquote><p>RULES = Rules compliance index</p></blockquote><blockquote><p>DRYNESS = 100 - Duplicated lines density</p></blockquote><h3>Test (TS)</h3><p>Testing quality is based on coverage metric family (coverage, and test success).</p><p>Test = 0.80*COV + 0.20*SUC</p><blockquote><p>COV = Code coverage</p></blockquote><blockquote><p>SUC = Unit Tests success density</p></blockquote><h3>Overall Test (OVERALL_TS)</h3><p>Testing quality is based on coverage metric family (coverage, and test success).</p><p>Test = 0.60*TS + 0.40*IT_COV</p><blockquote><p>TS = Test Quality of Unit Tests</p></blockquote><blockquote><p>IT_COV = Integration Tests coverage</p></blockquote><h1>Installation</h1><ol><li>Install the Total Quality plugin through the <a href="http://docs.codehaus.org/display/SONAR/Update+Center">Update Center</a> or download it into the SONAR_HOME/extensions/plugins directory</li><li>Restart the Sonar server</li></ol><h1>Usage</h1><p>Run an analysis on the project to compute the Total Quality metrics.</p><p>Every threshold and every formula should be configured with administration view.<br /> If you want to remove a metric just do,</p><p>&quot;ARCH=0.25 DESIGN=0.25 CODE=0.50 TESTS=0.00&quot;</p><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">To enable the computation of IT Tests in Test Quality metric you need to enable it by setting &quot;true&quot; <em>the sonar.tq.it_tests.enabled </em>property at global or project level.</td></tr></table><h1>TODO</h1><ul><li><a href="http://jira.codehaus.org/browse/SONARPLUGINS-415">SONARPLUGINS-415</a></li></ul><h1>Change Log</h1><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAxLjF8cmVuZGVyTW9kZT1zdGF0aWN8d2lkdGg9OTAwfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eXx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xNzYyMyZwaWQ9MTE5MTEmc29ydGVyL2ZpZWxkPWlzc3Vla2V5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|renderMode=static|title=Release 1.1|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=17623&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=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAxLjAuMnxyZW5kZXJNb2RlPXN0YXRpY3x3aWR0aD05MDB8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5fHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_Zml4Zm9yPTE2OTI2JnBpZD0xMTkxMSZzb3J0ZXIvZmllbGQ9aXNzdWVrZXkmc29ydGVyL29yZGVyPURFU0MmdGVtcE1heD0xMDAwfQ&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|renderMode=static|title=Release 1.0.2|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16926&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=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAxLjAuMXxyZW5kZXJNb2RlPXN0YXRpY3x3aWR0aD05MDB8Y29sdW1ucz10eXBlO2tleTtzdW1tYXJ5O3ByaW9yaXR5fHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_Zml4Zm9yPTE2NTQyJnBpZD0xMTkxMSZzb3J0ZXIvZmllbGQ9aXNzdWVrZXkmc29ydGVyL29yZGVyPURFU0MmdGVtcE1heD0xMDAwfQ&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|renderMode=static|title=Release 1.0.1|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16542&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=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9UmVsZWFzZSAxLjB8cmVuZGVyTW9kZT1zdGF0aWN8d2lkdGg9OTAwfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eXx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xNjI4OSZwaWQ9MTE5MTEmc29ydGVyL2ZpZWxkPWlzc3Vla2V5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|renderMode=static|title=Release 1.0|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16289&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p>