Turn AutomodelApplicationModeExtractCandidates into an inline-expectations test.

Author: Max Schaefer

java/ql/automodel/test/AutomodelApplicationModeExtraction/AutomodelApplicationModeExtractCandidates.expected

@@ -1,19 +1,2 @@
-| PluginImpl.java:5:27:5:37 | name | hudson | Plugin | configure | (String,String) |  | Parameter[0] | sourceModel |
-| PluginImpl.java:5:40:5:51 | value | hudson | Plugin | configure | (String,String) |  | Parameter[1] | sourceModel |
-| Test.java:19:3:19:11 | reference | java.util.concurrent.atomic | AtomicReference | set | (Object) | Argument[this] |  | sinkModel |
-| Test.java:19:3:19:24 | set(...) | java.util.concurrent.atomic | AtomicReference | set | (Object) |  | ReturnValue | sourceModel |
-| Test.java:24:3:24:10 | supplier | java.util.function | Supplier | get | () | Argument[this] |  | sinkModel |
-| Test.java:24:3:24:16 | get(...) | java.util.function | Supplier | get | () |  | ReturnValue | sourceModel |
-| Test.java:28:3:32:3 | copy(...) | java.nio.file | Files | copy | (Path,Path,CopyOption[]) |  | ReturnValue | sourceModel |
-| Test.java:36:10:38:3 | newInputStream(...) | java.nio.file | Files | newInputStream | (Path,OpenOption[]) |  | ReturnValue | sourceModel |
-| Test.java:37:4:37:11 | openPath | java.nio.file | Files | newInputStream | (Path,OpenOption[]) | Argument[0] |  | sinkModel |
-| Test.java:43:4:43:22 | get(...) | java.nio.file | Paths | get | (String,String[]) |  | ReturnValue | sourceModel |
-| Test.java:54:3:59:3 | walk(...) | java.nio.file | Files | walk | (Path,FileVisitOption[]) |  | ReturnValue | sourceModel |
-| Test.java:54:3:59:3 | walk(...) | java.nio.file | Files | walk | (Path,FileVisitOption[]) | Argument[1] |  | sinkModel |
-| Test.java:63:3:63:3 | c | java.net | URLConnection | getInputStream | () | Argument[this] |  | sinkModel |
-| Test.java:68:30:68:47 | writer | java.lang | Throwable | printStackTrace | (PrintWriter) |  | Parameter[0] | sourceModel |
-| Test.java:86:3:88:3 | list(...) | java.nio.file | Files | list | (Path) |  | ReturnValue | sourceModel |
-| Test.java:87:4:87:29 | createDirectories(...) | java.nio.file | Files | createDirectories | (Path,FileAttribute[]) |  | ReturnValue | sourceModel |
-| Test.java:90:3:92:3 | delete(...) | java.nio.file | Files | delete | (Path) |  | ReturnValue | sourceModel |
-| Test.java:91:4:91:4 | p | java.nio.file | Files | delete | (Path) | Argument[0] |  | sinkModel |
-| Test.java:95:4:95:4 | p | java.nio.file | Files | deleteIfExists | (Path) | Argument[0] |  | sinkModel |
+testFailures
+failures

java/ql/automodel/test/AutomodelApplicationModeExtraction/AutomodelApplicationModeExtractCandidates.ql

@@ -1,10 +1,26 @@
 import java
 import AutomodelApplicationModeCharacteristics
+import TestUtilities.InlineExpectationsTest
 
-from
-  Endpoint endpoint, Top t, string package, string type, string name, string signature,
-  string input, string output, string extensibleType
-where
-  isCandidate(endpoint, package, type, _, name, signature, input, output, _, extensibleType, _) and
-  t = endpoint.asTop()
-select t, package, type, name, signature, input, output, extensibleType
+module CandidateTest implements TestSig {
+  string getARelevantTag() { result in ["sourceModel", "sinkModel"] }
+
+  predicate hasActualResult(Location location, string element, string tag, string value) {
+    exists(
+      Endpoint endpoint, string name, string signature, string input, string output,
+      string extensibleType
+    |
+      isCandidate(endpoint, _, _, _, name, signature, input, output, _, extensibleType, _)
+    |
+      endpoint.asTop().getLocation() = location and
+      endpoint.toString() = element and
+      tag = extensibleType and
+      // for source models only the output is relevant, and vice versa for sink models
+      if extensibleType = "sourceModel"
+      then value = name + signature + ":" + output
+      else value = name + signature + ":" + input
+    )
+  }
+}
+
+import MakeTest<CandidateTest>

java/ql/automodel/test/AutomodelApplicationModeExtraction/PluginImpl.java

@@ -2,7 +2,7 @@
 
 public class PluginImpl extends Plugin {
     @Override
-    public void configure(String name, String value) {
+    public void configure(String name, String value) { // $ sourceModel=configure(String,String):Parameter[0] sourceModel=configure(String,String):Parameter[1]
         // ...
     }
 }

java/ql/automodel/test/AutomodelApplicationModeExtraction/Test.java

@@ -16,56 +16,59 @@
 class Test {
 	public static void main(String[] args) throws Exception {
 		AtomicReference<String> reference = new AtomicReference<>(); // uninteresting (parameterless constructor)
-		reference.set(args[0]); // arg[0] is not a candidate (modeled as value flow step)
-		// ^^^^^^ Argument[this] is a candidate
+		reference.set( // $ sinkModel=set(Object):Argument[this]
+			args[0] // not a sink candidate (modeled as a flow step)
+		);  // $ sourceModel=set(Object):ReturnValue
 	}
 
 	public static void callSupplier(Supplier<String> supplier) {
-		supplier.get(); // Argument[this] is a sink candidate; the call is a source candidate
+		supplier.get(); // $ sourceModel=get():ReturnValue sinkModel=get():Argument[this]
 	}
 
 	public static void copyFiles(Path source, Path target, CopyOption option) throws Exception {
-		Files.copy( // the call is a source candidate
+		Files.copy(
 			source, // positive example (known sink)
 			target, // positive example (known sink)
 			option // no candidate (not modeled, but source and target are modeled)
-		);
+		); // $ sourceModel=copy(Path,Path,CopyOption[]):ReturnValue
 	}
 
 	public static InputStream getInputStream(Path openPath) throws Exception {
-		return Files.newInputStream( // the call is a source candidate
-			openPath // positive example (known sink), candidate ("only" ai-modeled, and useful as a candidate in regression testing)
-		);
+		return Files.newInputStream(
+			openPath // $ sinkModel=newInputStream(Path,OpenOption[]):Argument[0] // positive example (known sink), candidate ("only" ai-modeled, and useful as a candidate in regression testing)
+		); // $ sourceModel=newInputStream(Path,OpenOption[]):ReturnValue
 	}
 
 	public static InputStream getInputStream(String openPath) throws Exception {
 		return Test.getInputStream( // the call is not a source candidate (argument to local call)
-			Paths.get(openPath) // no sink candidate (argument to local call); the call is a source candidate
+			Paths.get(
+				openPath // not a sink candidate (argument to local call)
+			) // $ sourceModel=get(String,String[]):ReturnValue
 		);
 	}
 
 	public static int compareFiles(File f1, File f2) {
-		return f1.compareTo( // compareTo call is a known sanitizer
+		return f1.compareTo(
 			f2 // negative sink example (modeled as not a sink)
 		); // the call is a negative source candidate (sanitizer)
 	}
 
 	public static void FilesWalkExample(Path p, FileVisitOption o) throws Exception {
-		Files.walk( // the call is a source candidate
+		Files.walk(
 			p, // negative sink example (modeled as a taint step)
-			o, // the implicit varargs array is a candidate
+			o, // the implicit varargs array is a candidate, annotated on the last line of the call
 			o // not a candidate (only the first arg corresponding to a varargs array
 			  // is extracted)
-		);
+		); // $ sourceModel=walk(Path,FileVisitOption[]):ReturnValue sinkModel=walk(Path,FileVisitOption[]):Argument[1]
 	}
 
 	public static void WebSocketExample(URLConnection c) throws Exception {
-		c.getInputStream(); // the call is a source example, c is a sink candidate
+		c.getInputStream(); // $ sinkModel=getInputStream():Argument[this] // not a source candidate (manual modeling)
 	}
 }
 
 class OverrideTest extends Exception {
-	public void printStackTrace(PrintWriter writer) { // writer is a source candidate because it overrides an existing method
+	public void printStackTrace(PrintWriter writer) { // $ sourceModel=printStackTrace(PrintWriter):Parameter[0]
 		return;
 	}
 
@@ -83,16 +86,16 @@ public FutureTask getTask() {
 
 class MoreTests {
 	public static void FilesListExample(Path p) throws Exception {
-		Files.list( // the call is a source candidate
-			Files.createDirectories(p) // the call is a source candidate, but not a sink candidate (modeled as a taint step)
-		);
+		Files.list(
+			Files.createDirectories(p) // $ sourceModel=createDirectories(Path,FileAttribute[]):ReturnValue // not a sink candidate (modeled as a taint step)
+		); // $ sourceModel=list(Path):ReturnValue
 
-		Files.delete( // not a source candidate (return type is void)
-			p // sink candidate
-		);
+		Files.delete(
+			p // $ sinkModel=delete(Path):Argument[0]
+		); // $ SPURIOUS: sourceModel=delete(Path):ReturnValue
 
-		Files.deleteIfExists( // not a source candidate (return type is boolean)
-			p // sink candidate
-		);
+		Files.deleteIfExists(
+			p // $ sinkModel=deleteIfExists(Path):Argument[0]
+		); // not a source candidate (return type is boolean)
 	}
 }

java/ql/automodel/test/qlpack.yml

@@ -7,6 +7,7 @@ groups:
 dependencies:
   codeql/java-all: ${workspace}
   codeql/java-automodel-queries: ${workspace}
+  codeql/java-tests: ${workspace}
 extractor: java
 tests: .
 warnOnImplicitThis: true