Merge pull request #8695 from atorralba/atorralba/stub-generator-annotation-types

Java: Add support for Annotation types stub generation

Author: atorralba

java/ql/src/utils/stub-generator/MinimalStubsFromSource.ql

@@ -20,6 +20,8 @@ class UsedInSource extends GeneratedDeclaration {
       this = any(RefType t | t.fromSource())
       or
       this = any(TypeAccess ta | ta.fromSource())
+      or
+      this = any(Annotation a | a.getAnnotatedElement().fromSource()).getType()
     )
   }
 }

java/ql/src/utils/stub-generator/Stubs.qll

@@ -16,7 +16,8 @@ abstract private class GeneratedType extends ClassOrInterface {
   }
 
   private string stubKeyword() {
-    this instanceof Interface and result = "interface"
+    this instanceof Interface and
+    (if this instanceof AnnotationType then result = "@interface" else result = "interface")
     or
     this instanceof Class and
     (if this instanceof EnumType then result = "enum" else result = "class")
@@ -27,19 +28,29 @@ abstract private class GeneratedType extends ClassOrInterface {
   }
 
   private string stubStaticModifier() {
-    if this.isStatic() then result = "static " else result = ""
+    if this.(NestedType).isStatic() then result = "static " else result = ""
   }
 
   private string stubAccessibilityModifier() {
     if this.isPublic() then result = "public " else result = ""
   }
 
+  private string stubAnnotations() {
+    result =
+      concat(Annotation an |
+        this.(AnnotationType).getAnAnnotation() = an
+      |
+        stubAnnotation(an), "\n" order by an.getType().getQualifiedName()
+      )
+  }
+
   /** Gets the entire Java stub code for this type. */
   final string getStub() {
     result =
-      this.stubAbstractModifier() + this.stubStaticModifier() + this.stubAccessibilityModifier() +
-        this.stubKeyword() + " " + this.getName() + stubGenericArguments(this, true) +
-        this.stubBaseTypesString() + "\n{\n" + this.stubMembers() + "}"
+      this.stubAnnotations() + this.stubAbstractModifier() + this.stubStaticModifier() +
+        this.stubAccessibilityModifier() + this.stubKeyword() + " " + this.getName() +
+        stubGenericArguments(this, true) + this.stubBaseTypesString() + "\n{\n" + this.stubMembers()
+        + "}"
   }
 
   private RefType getAnInterestingBaseType() {
@@ -60,7 +71,9 @@ abstract private class GeneratedType extends ClassOrInterface {
           else cls = ""
         ) and
         (
-          if exists(this.getAnInterestingBaseType().(Interface))
+          if
+            exists(this.getAnInterestingBaseType().(Interface)) and
+            not this instanceof AnnotationType
           then (
             (if this instanceof Class then int_kw = " implements " else int_kw = " extends ") and
             interface = concat(stubTypeName(this.getAnInterestingBaseType().(Interface)), ", ")
@@ -96,15 +109,14 @@ abstract private class GeneratedType extends ClassOrInterface {
   }
 
   final Type getAGeneratedType() {
-    result = this.getAnInterestingBaseType()
-    or
-    result = this.getAGeneratedMember().(Callable).getReturnType()
-    or
-    result = this.getAGeneratedMember().(Callable).getAParameter().getType()
-    or
-    result = this.getAGeneratedMember().(Field).getType()
-    or
-    result = this.getAGeneratedMember().(NestedType)
+    result = this.getAnInterestingBaseType() or
+    result = this.getAGeneratedMember().(Callable).getReturnType() or
+    result = this.getAGeneratedMember().(Callable).getAParameter().getType() or
+    result = this.getAGeneratedMember().(Field).getType() or
+    result = this.getAGeneratedMember().(NestedType) or
+    result = this.(AnnotationType).getAnAnnotation().getType() or
+    result = this.(AnnotationType).getAnAnnotation().getValue(_).getType() or
+    result = this.(AnnotationType).getAnAnnotation().getAnArrayValue(_).getType()
   }
 }
 
@@ -391,6 +403,47 @@ private string stubMember(Member m) {
   )
 }
 
+language[monotonicAggregates]
+private string stubAnnotation(Annotation a) {
+  if exists(a.getValue(_))
+  then
+    result =
+      "@" + a.getType().getName() + "(" +
+        concat(string name, Expr value |
+          value = a.getValue(name)
+        |
+          name + "=" + stubAnnotationValue(value), ","
+        ) + ")"
+  else result = "@" + a.getType().getName()
+}
+
+language[monotonicAggregates]
+private string stubAnnotationValue(Expr value) {
+  result = value.(FieldAccess).getField().getQualifiedName()
+  or
+  (
+    value instanceof Literal or
+    value instanceof CompileTimeConstantExpr
+  ) and
+  if value instanceof StringLiteral
+  then result = "\"\""
+  else result = stubDefaultValue(value.getType())
+  or
+  result = stubAnnotation(value)
+  or
+  result = value.(TypeLiteral).getReferencedType().getName() + ".class"
+  or
+  value instanceof ArrayInit and
+  result =
+    "{" +
+      concat(int i, Expr arrayElement |
+        i >= 0 and
+        arrayElement = value.(ArrayInit).getInit(i)
+      |
+        stubAnnotationValue(arrayElement), "," order by i
+      ) + "}"
+}
+
 bindingset[s]
 private string indent(string s) { result = "    " + s.replaceAll("\n", "\n    ") + "\n" }
 

java/ql/src/utils/stub-generator/makeStubs.py

@@ -99,8 +99,8 @@ def check_file_exists(path):
 dbDir = os.path.join(workDir, "db")
 
 
-def print_javac_output():
-    logFiles = glob.glob(os.path.join(dbDir, "log", "javac-output*"))
+def print_javac_output(db_dir):
+    logFiles = glob.glob(os.path.join(db_dir, "log", "javac-output*"))
 
     if not(logFiles):
         print("\nNo javac output found.")
@@ -124,7 +124,7 @@ def run(cmd):
 print("Stubbing qltest in", testDir)
 
 if run(['codeql', 'database', 'create', '--language=java', '--source-root='+projectDir, dbDir]):
-    print_javac_output()
+    print_javac_output(dbDir)
     print("codeql database create failed. Please fix up the test before proceeding.")
     exit(1)
 
@@ -167,7 +167,9 @@ def run(cmd):
 print("Verifying stub correctness")
 
 if run(['codeql', 'test', 'run', testDir]):
-    print_javac_output()
+    test_db_dir = glob.glob(os.path.join(testDir, "*.testproj"))
+    if test_db_dir:
+        print_javac_output(test_db_dir[0])
     print('\nTest failed. You may need to fix up the generated stubs.')
     exit(1)
 

java/ql/test/query-tests/Stubs/Minimal/MinimalStubsFromSource.expected

@@ -0,0 +1,5 @@
+noGeneratedStubs
+multipleGeneratedStubs
+#select
+| org.test.SampleAnnotationType | // Generated automatically from org.test.SampleAnnotationType for testing purposes\n\npackage org.test;\n\nimport java.lang.annotation.Annotation;\nimport java.lang.annotation.ElementType;\nimport java.lang.annotation.Target;\n\n@Target(value={java.lang.annotation.ElementType.METHOD})public @interface SampleAnnotationType\n{\n}\n |
+| org.test.SampleType | // Generated automatically from org.test.SampleType for testing purposes\n\npackage org.test;\n\n\npublic class SampleType\n{\n    public Object sampleField = null;\n    public SampleType(){}\n    public void sampleMethod(){}\n}\n |

java/ql/test/query-tests/Stubs/Minimal/MinimalStubsFromSource.qlref

@@ -0,0 +1 @@
+utils/stub-generator/MinimalStubsFromSource.ql

java/ql/test/query-tests/Stubs/Minimal/Test.java

@@ -0,0 +1,13 @@
+import org.test.SampleAnnotationType;
+import org.test.SampleType;
+
+public class Test {
+
+    @SampleAnnotationType
+    public void test() {
+        new SampleType().sampleField = null;
+        new SampleType().sampleMethod();
+    }
+
+}
+

java/ql/test/query-tests/Stubs/Minimal/options

@@ -0,0 +1 @@
+//semmle-extractor-options: --javac-args -cp ${testdir}/testlib.jar

java/ql/test/query-tests/Stubs/Minimal/testlib.jar

@@ -0,0 +1,5 @@
+# testlib
+
+Library for testing stub generation (we need a binary dependency because normal stubs are source files, and thus are excluded by the stub generator).
+
+Run `generate.sh` to update `testlib.jar` in the test directory.

java/ql/test/query-tests/Stubs/testlib/README.md

@@ -0,0 +1,3 @@
+#/bin/bash
+javac org/test/*.java
+jar cf ../Minimal/testlib.jar org/test/*.class