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/groovy.html|width=700|height=220|frameborder=0}
Your browser does not support iframes.
{iframe}</pre></td></tr></table><table class="wysiwyg-macro" data-macro-name="tip" data-macro-parameters="title=Live example" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e3RpcDp0aXRsZT1MaXZlIGV4YW1wbGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p>If you want to see a live example of the capabilities of the Groovy plugin, you can have a look at the analysis of the <a href="http://nemo.sonarsource.org/dashboard/index/org.codenarc:CodeNarc">CodeNarc project on Nemo</a>.</p></td></tr></table><h1>Description / Features</h1><p>The plugin enables analysis of Groovy projects within Sonar.</p><p>It is compatible with <span>the </span><a class="confluence-link" href="/display/SONAR/Issues+Report+Plugin" data-linked-resource-id="230398911" data-linked-resource-type="page" data-linked-resource-default-alias="Issues Report Plugin" data-base-url="http://docs.codehaus.org">Issues Report plugin</a><span> to run pre-commit local analysis.</span></p><p>It leverages <a href="http://codenarc.sourceforge.net/">CodeNarc</a> for coding rules violations, <a href="http://gmetrics.sourceforge.net/">Gmetrics</a> for cyclomatic complexity and <a href="http://cobertura.sourceforge.net/">Cobertura</a> for code coverage.</p><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Plugin</p></th><th class="confluenceTh"><p>0.1</p></th><th class="confluenceTh"><p>0.2</p></th><th class="confluenceTh"><p>0.3</p></th><th class="confluenceTh"><p>0.4</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">0.5</span></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">0.6</span></th></tr><tr><td class="confluenceTd"><p>CodeNarc</p></td><td class="confluenceTd"><p>0.9</p></td><td class="confluenceTd"><p>0.9</p></td><td class="confluenceTd"><p>0.13</p></td><td class="confluenceTd"><p>0.15</p></td><td colspan="1" class="confluenceTd">0.16.1</td><td colspan="1" class="confluenceTd">0.17</td></tr><tr><td class="confluenceTd"><p>GMetrics</p></td><td class="confluenceTd"><p>0.2</p></td><td class="confluenceTd"><p>0.2</p></td><td class="confluenceTd"><p>0.3</p></td><td class="confluenceTd"><p>0.3</p></td><td colspan="1" class="confluenceTd">0.4</td><td colspan="1" class="confluenceTd">0.5</td></tr><tr><td class="confluenceTd"><p>cobertura-maven-plugin</p></td><td class="confluenceTd"><p><img class="emoticon emoticon-cross" data-emoticon-name="cross" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/error.png" alt="(error)" title="(error)" /></p></td><td class="confluenceTd"><p>2.4</p></td><td class="confluenceTd"><p>2.5</p></td><td class="confluenceTd"><p>2.5</p></td><td colspan="1" class="confluenceTd">2.5.1</td><td colspan="1" class="confluenceTd">2.5.1</td></tr></tbody></table><h1>Installation</h1><ol><li>Install the Groovy 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><h3>Run a Sonar Analysis with the Sonar Runner (Recommended Way)</h3><p>To launch a Sonar analysis of your Groovy project, use the <a href="http://docs.codehaus.org/display/SONAR/Analyzing+with+Sonar+Runner">Sonar Runner</a>.</p><p>A sample project is available on github that can be <a class="external-link" href="https://github.com/SonarSource/sonar-examples" rel="nofollow">browsed</a> or <a class="external-link" href="https://github.com/SonarSource/sonar-examples/zipball/master" rel="nofollow">downloaded</a>: /projects/languages/groovy/groovy-sonar-runner.</p><h3>Run a Sonar Analysis with the other Analyzers</h3><p><a href="http://docs.codehaus.org/display/SONAR/Analyzing+with+Maven">Maven</a> and <a href="http://docs.codehaus.org/display/SONAR/Analyzing+with+Ant+Task">Ant</a> can also be used to launch analysis on Groovy projects.</p><p>A Maven sample project is available on github that can be <a class="external-link" href="https://github.com/SonarSource/sonar-examples" rel="nofollow">browsed</a> or <a class="external-link" href="https://github.com/SonarSource/sonar-examples/zipball/master" rel="nofollow">downloaded</a>: /projects/languages/groovy/groovy-maven.</p><h3>Advanced Usage</h3><p>It is possible to reuse previously generated report from CodeNarc by setting the sonar.groovy.codenarc.reportPath property.</p><h1>Metrics</h1><p>See <a class="confluence-link" href="/display/SONAR/Metric+definitions" data-linked-resource-id="230397406" data-linked-resource-type="page" data-linked-resource-default-alias="Metric definitions" data-base-url="http://docs.codehaus.org">Metrics documentation page</a>.</p><h1>Known Limitations</h1><p>The source directory must be added to the pom.xml, even if the project is built with Maven. This comes from the fact that Sonar does not call gmaven plugin.</p><h1>Change Log</h1><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAwLjZ8cmVuZGVyTW9kZT1zdGF0aWN8d2lkdGg9OTAwfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eXx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xODQ5NSZwaWQ9MTE5MTEmc29ydGVyL2ZpZWxkPWlzc3Vla2V5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|renderMode=static|title=Version 0.6|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=18495&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=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAwLjV8cmVuZGVyTW9kZT1zdGF0aWN8d2lkdGg9OTAwfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eXx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xODIyNSZwaWQ9MTE5MTEmc29ydGVyL2ZpZWxkPWlzc3Vla2V5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|renderMode=static|title=Version 0.5|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=18225&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=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAwLjR8cmVuZGVyTW9kZT1zdGF0aWN8d2lkdGg9OTAwfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eXx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xNzQ3OCZwaWQ9MTE5MTEmc29ydGVyL2ZpZWxkPWlzc3Vla2V5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|renderMode=static|title=Version 0.4|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=17478&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=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAwLjN8cmVuZGVyTW9kZT1zdGF0aWN8d2lkdGg9OTAwfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eXx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xNjgzNyZwaWQ9MTE5MTEmc29ydGVyL2ZpZWxkPWlzc3Vla2V5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|renderMode=static|title=Version 0.3|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16837&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=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAwLjJ8cmVuZGVyTW9kZT1zdGF0aWN8d2lkdGg9OTAwfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eXx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xNjc0NCZwaWQ9MTE5MTEmc29ydGVyL2ZpZWxkPWlzc3Vla2V5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|renderMode=static|title=Version 0.2|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16744&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=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAwLjF8cmVuZGVyTW9kZT1zdGF0aWN8d2lkdGg9OTAwfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eXx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xNjYyNiZwaWQ9MTE5MTEmc29ydGVyL2ZpZWxkPWlzc3Vla2V5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|renderMode=static|title=Version 0.1|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=16626&amp;pid\=11911&amp;sorter/field\=issuekey&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p>