python: make ArgumentNode publicly usable

yoff · web-flow · commit fe0c5d8ee5e1 · 2022-06-23T08:48:55.000Z
- add `getCall`
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowPublic.qll b/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowPublic.qll
@@ -322,6 +322,9 @@ SourceParameterNode parameterNode(Parameter p) { result.getParameter() = p }
 abstract class ArgumentNode extends Node {
   /** Holds if this argument occurs at the given position in the given call. */
   abstract predicate argumentOf(DataFlowCall call, ArgumentPosition pos);
+
+  /** Gets the call in which this node is an argument, if any. */
+  final DataFlowSourceCall getCall() { this.argumentOf(result, _) }
 }
 
 /** A data flow node that represents a call argument. */
@@ -335,9 +338,6 @@ class ArgumentSourceNode extends ArgumentNode {
   predicate sourceArgumentOf(DataFlowSourceCall call, ArgumentPosition pos) {
     this = call.getArg(pos)
   }
-
-  /** Gets the call in which this node is an argument. */
-  final DataFlowSourceCall getCall() { this.argumentOf(result, _) }
 }
 
 /**
diff --git a/python/ql/test/experimental/dataflow/TestUtil/MaximalFlowTest.qll b/python/ql/test/experimental/dataflow/TestUtil/MaximalFlowTest.qll
@@ -35,7 +35,7 @@ class MaximalFlowsConfig extends DataFlow::Configuration {
   override predicate isSink(DataFlow::Node node) {
     exists(node.getLocation().getFile().getRelativePath()) and
     not any(CallNode c).getArg(_) = node.asCfgNode() and
-    not node instanceof DataFlow::ArgumentSourceNode and
+    not node instanceof DataFlow::ArgumentNode and
     not node.asCfgNode().(NameNode).getId().matches("SINK%") and
     not exists(DataFlow::Node succ | DataFlow::localFlowStep(node, succ))
   }
diff --git a/python/ql/test/experimental/dataflow/TestUtil/RoutingTest.qll b/python/ql/test/experimental/dataflow/TestUtil/RoutingTest.qll
@@ -43,7 +43,7 @@ abstract class RoutingTest extends InlineExpectationsTest {
   }
 
   pragma[inline]
-  private string fromFunc(DataFlow::ArgumentSourceNode fromNode) {
+  private string fromFunc(DataFlow::ArgumentNode fromNode) {
     result = fromNode.getCall().getNode().(CallNode).getFunction().getNode().(Name).getId()
   }
 
diff --git a/python/ql/test/experimental/dataflow/callGraphConfig.qll b/python/ql/test/experimental/dataflow/callGraphConfig.qll
@@ -11,7 +11,7 @@ class CallGraphConfig extends DataFlow::Configuration {
   override predicate isSource(DataFlow::Node node) {
     node instanceof DataFlowPrivate::ReturnNode
     or
-    node instanceof DataFlow::ArgumentSourceNode
+    node instanceof DataFlow::ArgumentNode
   }
 
   override predicate isSink(DataFlow::Node node) {
diff --git a/python/ql/test/experimental/dataflow/coverage/classesCallGraph.ql b/python/ql/test/experimental/dataflow/coverage/classesCallGraph.ql
@@ -11,7 +11,7 @@ class CallGraphConfig extends DataFlow::Configuration {
     node instanceof DataFlowPrivate::ReturnNode
     or
     // These sources should allow for the non-standard call syntax
-    node instanceof DataFlow::ArgumentSourceNode
+    node instanceof DataFlow::ArgumentNode
   }
 
   override predicate isSink(DataFlow::Node node) {

Original file line number	Diff line number	Diff line change
`@@ -322,6 +322,9 @@ SourceParameterNode parameterNode(Parameter p) { result.getParameter() = p }`
`322`	`322`	`abstract class ArgumentNode extends Node {`
`323`	`323`	`/** Holds if this argument occurs at the given position in the given call. */`
`324`	`324`	`abstract predicate argumentOf(DataFlowCall call, ArgumentPosition pos);`
	`325`	`+`
	`326`	`+ /** Gets the call in which this node is an argument, if any. */`
	`327`	`+ final DataFlowSourceCall getCall() { this.argumentOf(result, _) }`
`325`	`328`	`}`
`326`	`329`
`327`	`330`	`/** A data flow node that represents a call argument. */`
`@@ -335,9 +338,6 @@ class ArgumentSourceNode extends ArgumentNode {`
`335`	`338`	`predicate sourceArgumentOf(DataFlowSourceCall call, ArgumentPosition pos) {`
`336`	`339`	`this = call.getArg(pos)`
`337`	`340`	`}`
`338`		`-`
`339`		`- /** Gets the call in which this node is an argument. */`
`340`		`- final DataFlowSourceCall getCall() { this.argumentOf(result, _) }`
`341`	`341`	`}`
`342`	`342`
`343`	`343`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ class MaximalFlowsConfig extends DataFlow::Configuration {`
`35`	`35`	`override predicate isSink(DataFlow::Node node) {`
`36`	`36`	`exists(node.getLocation().getFile().getRelativePath()) and`
`37`	`37`	`not any(CallNode c).getArg(_) = node.asCfgNode() and`
`38`		`- not node instanceof DataFlow::ArgumentSourceNode and`
	`38`	`+ not node instanceof DataFlow::ArgumentNode and`
`39`	`39`	`not node.asCfgNode().(NameNode).getId().matches("SINK%") and`
`40`	`40`	`not exists(DataFlow::Node succ \| DataFlow::localFlowStep(node, succ))`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ abstract class RoutingTest extends InlineExpectationsTest {`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`pragma[inline]`
`46`		`- private string fromFunc(DataFlow::ArgumentSourceNode fromNode) {`
	`46`	`+ private string fromFunc(DataFlow::ArgumentNode fromNode) {`
`47`	`47`	`result = fromNode.getCall().getNode().(CallNode).getFunction().getNode().(Name).getId()`
`48`	`48`	`}`
`49`	`49`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ class CallGraphConfig extends DataFlow::Configuration {`
`11`	`11`	`override predicate isSource(DataFlow::Node node) {`
`12`	`12`	`node instanceof DataFlowPrivate::ReturnNode`
`13`	`13`	`or`
`14`		`- node instanceof DataFlow::ArgumentSourceNode`
	`14`	`+ node instanceof DataFlow::ArgumentNode`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`override predicate isSink(DataFlow::Node node) {`