Inner classes are not properly handled by the plugin in GMetrics results parsing

Also note that inner classes don't necessarily come in the form supplied in the example. Here is another valid inner class in a Groovy file that fails.

class Approval extends BaseDomain {

 enum Status {
  HOLD("HOLD"),
  REJECTED("REJECTED"),
  APPROVED("APPROVED")

  final String value
  Status(String value) { this.value = value  }
  String toString() { value }
  String getKey() { name() }
  static list() { [HOLD, REJECTED, APPROVED]  }
 }
....
}

Given that inner classes and inner enums terminate the build, is there any sort of workaround? (Other than not using them at all).

Hi Todd,

You could disable the gmetrics analysis by setting a dummy location. A la...

sonar.groovy.gmetrics.reportPath=non-existing.xml

The same goes for codenarc. See Advanced usage: http://docs.codehaus.org/display/SONAR/Groovy+Plugin

You might want to look at https://jira.codehaus.org/browse/SONARPLUGINS-737 for some more info. I'll update the java source work-around now.

Below is a patch against the 0.4 I've been applying (since 0.3) to work around the inner class exception. This is not a fix but passes the file thru and let's CodeNarc do what it's going to do. Most of the metrics are fine and I just see a few false positives ("Unused Private Fields", etc). There are fewer false positives under 0.4, presumably due to the upgrade of Codenarc. IMO this is much better than failing the entire analysis.

Index: src/main/java/org/sonar/plugins/groovy/foundation/GroovyFile.java
===================================================================
--- src/main/java/org/sonar/plugins/groovy/foundation/GroovyFile.java   (revision 4777)
+++ src/main/java/org/sonar/plugins/groovy/foundation/GroovyFile.java   (working copy)
@@ -47,9 +47,7 @@

   public GroovyFile(String key, boolean unitTest) {
     super();
-    if (key != null && key.indexOf('$') >= 0) {
-      throw new IllegalArgumentException("Groovy inner classes are not supported : " + key);
-    }
+
     String realKey = StringUtils.trim(key);
     this.unitTest = unitTest;

@@ -69,9 +67,7 @@

   public GroovyFile(String packageKey, String className, boolean unitTest) {
     super();
-    if (className != null && className.indexOf('$') >= 0) {
-      throw new IllegalArgumentException("Groovy inner classes are not supported : " + className);
-    }
+
     this.filename = className.trim();
     String key;
     if (StringUtils.isBlank(packageKey)) {

To clarify - this issue is a mix of two problems :

• known limitation as it were reported here against first version of plugin - inner classes not properly handled, which does not lead to an exception, but leads to incorrect results
• exception thrown during analysis as it was reported in SONARPLUGINS-1123, which means that project can't be analysed in general

First behaviour is acceptable for me for the moment, since we know about it, but don't know how to deal with it.
And I unsuccessfully tried to reproduce second one.

I tried with a real-world projects (CodeNarc 0.9 and GMetrics 0.4) and tried to create my own project to reproduce IllegalArgumentException, but was unable to do this in a combination of Sonar 2.12 and Sonar Groovy Plugin 0.4 : see SONARPLUGINS-597.zip, which contains Maven project with two groovy files - one with enum and another one with two classes.

So question is what I'm doing wrong and could someone provide a real-world Maven project to reproduce exception?

Maven project and log reproducing groovy inner class problem.

Sorry for the delay getting back to this (requesting maven slows me down). I attached a maven project and log file showing the analysis failure when a groovy file contains an inner class. This is against 0.5 of the sonar-groovy-plugin. Applying my earlier patch allows the analysis to complete.

Since groovy has inner class support, will we see a fix for this? I ran into this myself with one of our projects and applied the patch given (Commented out offending lines) to get it to work here.

This is fixed, but as consequence property "sonar.groovy.gmetrics.reportPath" not available anymore.

Manually tested with example provided in the ticket.

Integration test is in place.