Java stub generator doesn't use FQN for annotation values

Correction: The problem isn't the missing imports for the annotation types themselves (because the stub generator now uses fully qualified class names for them), but the missing imports for class names appearing in annotation attributes. Example:

package bar

import foo.Foo
import other.MyEnum

// generated stub code: @foo.Foo(MyEnum.MY_VALUE)
@Foo(val = MyEnum.MY_VALUE)
class Bar {}

Same problem exists for variations like @Foo(val=MyClass) and @Foo(val=MyClass.SOME_CONST).

shouldn't the stub generator use fully qualified names there too then?

Maybe. I don't know the exact reason for the switch to fully qualified class names in 1.7.5, and if it's done for all class names.

Attaching a patch that fixes the 3 related issues highlighted in here.

Looking great!

I'm still getting the same problem with https://svn.codehaus.org/groovy/branches/GROOVY_1_7_Xtrunk, rev. 20934:

foo/MyAnno.java:

package foo;

public @interface MyAnno {
  MyEnum val();
}

foo/MyEnum.java:

package foo;

public enum MyEnum { ONE, TWO }

bar/MyUser.groovy:

package bar

import foo.MyAnno
import foo.MyEnum

@MyAnno(val = MyEnum.ONE)
class MyUser {}                  

Generated stub for class MyUser:

package bar;

import java.lang.*;
import java.io.*;
import java.net.*;
import java.util.*;
import groovy.lang.*;
import groovy.util.*;

@foo.MyAnno(val=MyEnum.ONE) public class MyUser
  extends java.lang.Object  implements
    groovy.lang.GroovyObject {
public MyUser
() {}
public  groovy.lang.MetaClass getMetaClass() { return (groovy.lang.MetaClass)null;}
public  void setMetaClass(groovy.lang.MetaClass mc) { }
public  java.lang.Object invokeMethod(java.lang.String method, java.lang.Object arguments) { return null;}
public  java.lang.Object getProperty(java.lang.String property) { return null;}
public  void setProperty(java.lang.String property, java.lang.Object value) { }
}

Compile error:

[ERROR] /swd/prj/joints/target/generated-sources/groovy-stubs/main/bar/MyUser.java:[10,16] cannot find symbol
symbol: variable MyEnum
@foo.MyAnno(val=MyEnum.ONE) public class MyUser

[ERROR] /swd/prj/joints/target/generated-sources/groovy-stubs/main/bar/MyUser.java:[10,22] an enum annotation value must be an enum constant

I just ran the following test on trunk and stub gets generated just fine. You want to check what's wrong with your thing?

package org.codehaus.groovy.tools.stubgenerator

class Test4434Again extends StringSourcesStubTestCase {

    Map<String, String> provideSources() {
        debug = true
        delete = false
        [
            'foo/MyAnno.java': '''
                package foo;

                public @interface MyAnno {
                  MyEnum val();
                }
            ''',
            'foo/MyEnum.java': '''
                package foo;

                public enum MyEnum { ONE, TWO }
            ''',
            'bar/MyUser.groovy': '''
                package bar

                import foo.MyAnno
                import foo.MyEnum
                
                @MyAnno(val = MyEnum.ONE)
                class MyUser {}
            '''
        ]
    }

    void verifyStubs() {
        // all is well
    }
}

Here is how the stub gets generated (notice the part - @foo.MyAnno(val=foo.MyEnum.ONE) )

Sources compiled successfully
>>> Stubs generated
 -> MyUser.java
package bar;

import java.lang.*;
import java.io.*;
import java.net.*;
import java.util.*;
import groovy.lang.*;
import groovy.util.*;

@foo.MyAnno(val=foo.MyEnum.ONE) public class MyUser
  extends java.lang.Object  implements
    groovy.lang.GroovyObject {
public MyUser
() {}
public  groovy.lang.MetaClass getMetaClass() { return (groovy.lang.MetaClass)null;}
public  void setMetaClass(groovy.lang.MetaClass mc) { }
public  java.lang.Object invokeMethod(java.lang.String method, java.lang.Object arguments) { return null;}
public  java.lang.Object getProperty(java.lang.String property) { return null;}
public  void setProperty(java.lang.String property, java.lang.Object value) { }
}

No idea what's going on then. I'm definitely using the latest 1.7.6-SNAPSHOT. The only difference is that I'm building with GMaven because I don't know of a good way to diagnose joint compilation problems with groovyc (other than with a debugger).

I have no idea about GMaven.

The new joint compilation test infrastructure is one of my favorite pieces in groovy now!

Please run that test I have provided and tell me how the stub gets generated. If that is fine, the GMaven bit needs to be taken forward outside this JIRA issue.

All tests passed. No idea how I can find this test in the JUnit report because class names are missing in the report, but I assume it got run.

Which all tests? (if you mean the ones that are checked-in, of-course they pass!)

If u run the one test I provided just a few minutes back, it is run with 2 flags (debug = true, delete = false), which means that it will output stub code created and also leave the stub file un-deleted, which you should be able to go and inspect.

Both with trunk and 1.7.6, the code generated is fine.

> Which all tests?
All existing tests, plus the one you provided. I just added it to the sources (locally).

> If u run the one test I provided just a few minutes back
How do I run a single test class in the Ant build? Running tests in the Groovy project from IDEA is always problematic.

> How do I run a single test class in the Ant build? Running tests in the Groovy project from IDEA is always problematic.

Set testCase=<full test class name> in build.properties

Thanks for the Ant hint. I've meanwhile managed to run the test from IDEA and it passes. Output looks fine. Seems I'll have to debug GMaven again.

By the way, "ant test -DtestCase=org.codehaus.groovy.tools.stubgenerator.Test4434Again" also works.

Great. So I will mark this one back as Resolved since it's in GMaven domain now?

Btw, for running a single test, on the command-line, you can do:

ant -DtestCase=groovy.bugs.ABug test

> Great. So I will mark this one back as Resolved since it's in GMaven domain now?
Do as you please. Depending on my findings, I will reopen, add a GMaven issue, or bang my head against the wall (if it's a problem with my setup).

Reopen anytime you can be sure it is a core groovy issue, but don't just pick blindly from your 3 choices and reopen

Not a core groovy issue - explained why/how.

Looking at this with the debugger, the only explanation I have is that GMaven's JavaStubCompilationUnit behaves slightly differently than groovyc's JavaAwareCompilationUnit (JavaStubCompilationUnit vs. JavaAwareCompilationUnit is the only difference in the stack trace). With groovyc, AST for annotation attribute value MyEnum.ONE looks like this:

org.codehaus.groovy.ast.expr.PropertyExpression@4cdf4bfc[object: org.codehaus.groovy.ast.expr.ClassExpression@57f5b4d1[type: foo.MyEnum] property: ConstantExpression[ONE]]

But with GMaven, it looks like this:

org.codehaus.groovy.ast.expr.PropertyExpression@65f4ba51[object: org.codehaus.groovy.ast.expr.VariableExpression@25f45022[variable: MyEnum] property: ConstantExpression[ONE]]

I've opened GMAVEN-84.