Merge pull request #16431 from michaelnebel/java/madinlinetest

Java: Models as Data inline like test.

Author: michaelnebel

java/ql/test/TestUtilities/InlineMadTest.qll

@@ -0,0 +1,65 @@
+import java as J
+
+private signature module InlineMadTestLangSig {
+  /**
+   * A base class of callables for modeling.
+   */
+  class Callable;
+
+  /**
+   * Gets a relevant code comment for `c`, if any.
+   */
+  string getComment(Callable c);
+}
+
+private module InlineMadTestImpl<InlineMadTestLangSig Lang> {
+  private class Callable = Lang::Callable;
+
+  signature module InlineMadTestConfigSig {
+    /**
+     * Gets the kind of a captured model.
+     */
+    string getKind();
+
+    /**
+     * Gets a captured model for `c`, if any.
+     */
+    string getCapturedModel(Callable c);
+  }
+
+  module InlineMadTest<InlineMadTestConfigSig Input> {
+    private string expects(Callable c) {
+      Lang::getComment(c).regexpCapture(" *(SPURIOUS-)?" + Input::getKind() + "=(.*)", 2) = result
+    }
+
+    query predicate unexpectedModel(string msg) {
+      exists(Callable c, string flow |
+        flow = Input::getCapturedModel(c) and
+        not flow = expects(c) and
+        msg = "Unexpected " + Input::getKind() + " found: " + flow
+      )
+    }
+
+    query predicate expectedModel(string msg) {
+      exists(Callable c, string e |
+        e = expects(c) and
+        not e = Input::getCapturedModel(c) and
+        msg = "Expected " + Input::getKind() + " missing: " + e
+      )
+    }
+  }
+}
+
+private module InlineMadTestLang implements InlineMadTestLangSig {
+  class Callable = J::Callable;
+
+  string getComment(Callable c) {
+    exists(J::Javadoc doc |
+      hasJavadoc(c, doc) and
+      isNormalComment(doc) and
+      result = doc.getChild(0).toString()
+    )
+  }
+}
+
+import InlineMadTestImpl<InlineMadTestLang>

java/ql/test/utils/modelgenerator/dataflow/CaptureNeutralModels.expected

@@ -1,25 +1,2 @@
-| p;Factory;getIntValue;();summary;df-generated |
-| p;FinalClass;returnsConstant;();summary;df-generated |
-| p;FluentAPI$Inner;notThis;(String);summary;df-generated |
-| p;ImmutablePojo;getX;();summary;df-generated |
-| p;Joiner;length;();summary;df-generated |
-| p;ParamFlow;ignorePrimitiveReturnValue;(String);summary;df-generated |
-| p;ParamFlow;mapType;(Class);summary;df-generated |
-| p;Pojo;doNotSetValue;(String);summary;df-generated |
-| p;Pojo;getBigDecimal;();summary;df-generated |
-| p;Pojo;getBigInt;();summary;df-generated |
-| p;Pojo;getBoxedArray;();summary;df-generated |
-| p;Pojo;getBoxedCollection;();summary;df-generated |
-| p;Pojo;getBoxedValue;();summary;df-generated |
-| p;Pojo;getFloatArray;();summary;df-generated |
-| p;Pojo;getIntValue;();summary;df-generated |
-| p;Pojo;getPrimitiveArray;();summary;df-generated |
-| p;PrivateFlowViaPublicInterface$SPI;openStreamNone;();summary;df-generated |
-| p;PrivateFlowViaPublicInterface;createAnSPIWithoutTrackingFile;(File);summary;df-generated |
-| p;Sinks;copyFileToDirectory;(Path,Path,CopyOption[]);summary;df-generated |
-| p;Sinks;propagate;(String);summary;df-generated |
-| p;Sinks;readUrl;(URL,Charset);summary;df-generated |
-| p;Sources;readUrl;(URL);summary;df-generated |
-| p;Sources;socketStream;();summary;df-generated |
-| p;Sources;sourceToParameter;(InputStream[],List);summary;df-generated |
-| p;Sources;wrappedSocketStream;();summary;df-generated |
+unexpectedModel
+expectedModel

java/ql/test/utils/modelgenerator/dataflow/CaptureNeutralModels.ql

@@ -0,0 +1,11 @@
+import java
+import utils.modelgenerator.internal.CaptureSummaryFlowQuery
+import TestUtilities.InlineMadTest
+
+module InlineMadTestConfig implements InlineMadTestConfigSig {
+  string getCapturedModel(Callable c) { result = captureNoFlow(c) }
+
+  string getKind() { result = "neutral" }
+}
+
+import InlineMadTest<InlineMadTestConfig>

java/ql/test/utils/modelgenerator/dataflow/CaptureNeutralModels.qlref

@@ -1,5 +1,2 @@
-| p;PrivateFlowViaPublicInterface$SPI;true;openStream;();;Argument[this];path-injection;df-generated |
-| p;Sinks;true;copyFileToDirectory;(Path,Path,CopyOption[]);;Argument[0];path-injection;df-generated |
-| p;Sinks;true;copyFileToDirectory;(Path,Path,CopyOption[]);;Argument[1];path-injection;df-generated |
-| p;Sinks;true;readUrl;(URL,Charset);;Argument[0];request-forgery;df-generated |
-| p;Sources;true;readUrl;(URL);;Argument[0];request-forgery;df-generated |
+unexpectedModel
+expectedModel

java/ql/test/utils/modelgenerator/dataflow/CaptureSinkModels.expected

@@ -0,0 +1,11 @@
+import java
+import utils.modelgenerator.internal.CaptureModels
+import TestUtilities.InlineMadTest
+
+module InlineMadTestConfig implements InlineMadTestConfigSig {
+  string getCapturedModel(Callable c) { result = captureSink(c) }
+
+  string getKind() { result = "sink" }
+}
+
+import InlineMadTest<InlineMadTestConfig>

java/ql/test/utils/modelgenerator/dataflow/CaptureSinkModels.ql

@@ -1,5 +1,2 @@
-| p;Sources;true;readUrl;(URL);;ReturnValue;remote;df-generated |
-| p;Sources;true;socketStream;();;ReturnValue;remote;df-generated |
-| p;Sources;true;sourceToParameter;(InputStream[],List);;Argument[0].ArrayElement;remote;df-generated |
-| p;Sources;true;sourceToParameter;(InputStream[],List);;Argument[1].Element;remote;df-generated |
-| p;Sources;true;wrappedSocketStream;();;ReturnValue;remote;df-generated |
+unexpectedModel
+expectedModel

java/ql/test/utils/modelgenerator/dataflow/CaptureSinkModels.qlref

@@ -0,0 +1,11 @@
+import java
+import utils.modelgenerator.internal.CaptureModels
+import TestUtilities.InlineMadTest
+
+module InlineMadTestConfig implements InlineMadTestConfigSig {
+  string getCapturedModel(Callable c) { result = captureSource(c) }
+
+  string getKind() { result = "source" }
+}
+
+import InlineMadTest<InlineMadTestConfig>