Dataflow: Add test for FlowState.

Author: aschackmull

java/ql/test/library-tests/dataflow/state/A.java

@@ -0,0 +1,34 @@
+import java.util.function.*;
+
+public class A {
+  Object source(String state) { return null; }
+
+  void sink(Object x, String state) { }
+
+  void stateBarrier(Object x, String state) { }
+
+  Object step(Object x, String s1, String s2) { return null; }
+
+  void check(Object x) { }
+
+  void test1() {
+    Object x = source("A");
+    check(x); // $ pFwd=A-A pRev=A-B
+    x = step(x, "A", "B");
+    check(x); // $ pFwd=A-B pRev=A-A pRev=B-B
+    sink(x, "A");
+    sink(x, "B"); // $ flow=A
+  }
+
+  void test2(Supplier<Boolean> b) {
+    Object x = b.get() ? source("A") : source("B");
+    check(x); // $ pFwd=A-A pFwd=B-B pRev=B-B pRev=B-C pRev=C-C
+    x = b.get() ? x : step(x, "B", "C");
+    check(x); // $ pFwd=A-A pFwd=B-B pFwd=B-C pRev=B-B pRev=C-C
+    stateBarrier(x, "A");
+    check(x); // $ pFwd=B-B pFwd=B-C pRev=A-A pRev=B-B pRev=C-C
+    sink(x, "A");
+    sink(x, "B"); // $ flow=B
+    sink(x, "C"); // $ flow=B
+  }
+}

java/ql/test/library-tests/dataflow/state/test.expected

@@ -0,0 +1,98 @@
+import java
+import semmle.code.java.dataflow.DataFlow
+import TestUtilities.InlineExpectationsTest
+import DataFlow
+
+class TestState extends FlowState {
+  TestState() { src(_, this) or sink(_, this) or step(_, _, this, _) or step(_, _, _, this) }
+}
+
+predicate src(Node n, string s) {
+  exists(MethodAccess ma |
+    n.asExpr() = ma and
+    ma.getMethod().hasName("source") and
+    ma.getAnArgument().(StringLiteral).getValue() = s
+  )
+}
+
+predicate sink(Node n, string s) {
+  exists(MethodAccess ma |
+    ma.getMethod().hasName("sink") and
+    n.asExpr() = ma.getArgument(0) and
+    ma.getArgument(1).(StringLiteral).getValue() = s
+  )
+}
+
+predicate bar(Node n, string s) {
+  exists(MethodAccess ma |
+    ma.getMethod().hasName("stateBarrier") and
+    n.asExpr() = ma.getArgument(0) and
+    ma.getArgument(1).(StringLiteral).getValue() = s
+  )
+}
+
+predicate step(Node n1, Node n2, string s1, string s2) {
+  exists(MethodAccess ma |
+    ma.getMethod().hasName("step") and
+    n1.asExpr() = ma.getArgument(0) and
+    ma.getArgument(1).(StringLiteral).getValue() = s1 and
+    ma.getArgument(2).(StringLiteral).getValue() = s2 and
+    ma = n2.asExpr()
+  )
+}
+
+predicate checkNode(Node n) { n.asExpr().(Argument).getCall().getCallee().hasName("check") }
+
+class Conf extends Configuration {
+  Conf() { this = "qltest:state" }
+
+  override predicate isSource(Node n) { none() }
+
+  override predicate isSource(Node n, FlowState s) { src(n, s) }
+
+  override predicate isSink(Node n) { none() }
+
+  override predicate isSink(Node n, FlowState s) { sink(n, s) }
+
+  override predicate isBarrier(Node n, FlowState s) { bar(n, s) }
+
+  override predicate isAdditionalFlowStep(Node n1, FlowState s1, Node n2, FlowState s2) {
+    step(n1, n2, s1, s2)
+  }
+
+  override int explorationLimit() { result = 0 }
+}
+
+class HasFlowTest extends InlineExpectationsTest {
+  HasFlowTest() { this = "HasFlowTest" }
+
+  override string getARelevantTag() { result = ["pFwd", "pRev", "flow"] }
+
+  override predicate hasActualResult(Location location, string element, string tag, string value) {
+    tag = "flow" and
+    exists(PathNode src, PathNode sink, Conf conf |
+      conf.hasFlowPath(src, sink) and
+      sink.getNode().getLocation() = location and
+      element = sink.toString() and
+      value = src.getState()
+    )
+    or
+    tag = "pFwd" and
+    exists(PartialPathNode src, PartialPathNode node, Conf conf |
+      conf.hasPartialFlow(src, node, _) and
+      checkNode(node.getNode()) and
+      node.getNode().getLocation() = location and
+      element = node.toString() and
+      value = src.getState() + "-" + node.getState()
+    )
+    or
+    tag = "pRev" and
+    exists(PartialPathNode node, PartialPathNode sink, Conf conf |
+      conf.hasPartialFlowRev(node, sink, _) and
+      checkNode(node.getNode()) and
+      node.getNode().getLocation() = location and
+      element = node.toString() and
+      value = node.getState() + "-" + sink.getState()
+    )
+  }
+}