codeql/python/ql/test/experimental/dataflow/TestUtil/RoutingTest.qll

import python
import semmle.python.dataflow.new.DataFlow
import TestUtilities.InlineExpectationsTest
private import semmle.python.dataflow.new.internal.PrintNode

/**
 * A routing test is designed to test that values are routed to the
 * correct arguments of the correct functions. It is assumed that
 * the functions tested sink their arguments sequentially, that is
 * `SINK1(arg1)`, etc.
 */
abstract class RoutingTest extends InlineExpectationsTest {
  bindingset[this]
  RoutingTest() { any() }

  abstract string flowTag();

  abstract predicate relevantFlow(DataFlow::Node fromNode, DataFlow::Node toNode);

  override string getARelevantTag() { result in ["func", this.flowTag()] }

  override predicate hasActualResult(Location location, string element, string tag, string value) {
    exists(DataFlow::Node fromNode, DataFlow::Node toNode | this.relevantFlow(fromNode, toNode) |
      location = fromNode.getLocation() and
      element = fromNode.toString() and
      (
        tag = this.flowTag() and
        if "\"" + tag + "\"" = this.fromValue(fromNode)
        then value = ""
        else value = this.fromValue(fromNode)
        or
        tag = "func" and
        value = this.toFunc(toNode) and
        not value = this.fromFunc(fromNode)
      )
    )
  }

  pragma[inline]
  private string fromValue(DataFlow::Node fromNode) {
    result = "\"" + prettyNode(fromNode).replaceAll("\"", "'") + "\""
  }

  pragma[inline]
  private string fromFunc(DataFlow::ArgumentNode fromNode) {
    result = fromNode.getCall().getNode().(CallNode).getFunction().getNode().(Name).getId()
  }

  pragma[inline]
  private string toFunc(DataFlow::Node toNode) {
    result = toNode.getEnclosingCallable().getCallableValue().getScope().getQualifiedName() // TODO: More robust pretty printing?
  }
}