Merge pull request #4207 from RasmusWL/python-typetracker-small-fixes

Python: Small fixes for TypeTracker

Author: tausbn

python/ql/src/experimental/dataflow/TypeTracker.qll

@@ -1,8 +1,8 @@
 /** Step Summaries and Type Tracking */
 
-import python
-import internal.DataFlowPublic
-import internal.DataFlowPrivate
+private import python
+private import internal.DataFlowPublic
+private import internal.DataFlowPrivate
 
 /** Any string that may appear as the name of an attribute or access path. */
 class AttributeName extends string {
@@ -144,7 +144,7 @@ private newtype TTypeTracker = MkTypeTracker(Boolean hasCall, OptionalAttributeN
  * It is recommended that all uses of this type are written in the following form,
  * for tracking some type `myType`:
  * ```
- * Node myType(DataFlow::TypeTracker t) {
+ * DataFlow::Node myType(DataFlow::TypeTracker t) {
  *   t.start() and
  *   result = < source of myType >
  *   or
@@ -153,7 +153,7 @@ private newtype TTypeTracker = MkTypeTracker(Boolean hasCall, OptionalAttributeN
  *   )
  * }
  *
- * DataFlow::SourceNode myType() { result = myType(DataFlow::TypeTracker::end()) }
+ * DataFlow::Node myType() { result = myType(DataFlow::TypeTracker::end()) }
  * ```
  *
  * Instead of `result = myType(t2).track(t2, t)`, you can also use the equivalent
@@ -280,3 +280,10 @@ class TypeTracker extends TTypeTracker {
     result = this
   }
 }
+
+module TypeTracker {
+  /**
+   * Gets a valid end point of type tracking.
+   */
+  TypeTracker end() { result.end() }
+}

python/ql/test/experimental/dataflow/typetracking/tracked.ql

@@ -1,8 +1,9 @@
 import python
+import experimental.dataflow.DataFlow
 import experimental.dataflow.TypeTracker
 import TestUtilities.InlineExpectationsTest
 
-Node tracked(TypeTracker t) {
+DataFlow::Node tracked(TypeTracker t) {
   t.start() and
   result.asCfgNode() = any(NameNode n | n.getId() = "tracked")
   or
@@ -15,7 +16,7 @@ class TrackedTest extends InlineExpectationsTest {
   override string getARelevantTag() { result = "tracked" }
 
   override predicate hasActualResult(Location location, string element, string tag, string value) {
-    exists(Node e, TypeTracker t |
+    exists(DataFlow::Node e, TypeTracker t |
       e = tracked(t) and
       tag = "tracked" and
       location = e.getLocation() and
@@ -25,14 +26,14 @@ class TrackedTest extends InlineExpectationsTest {
   }
 }
 
-Node int_type(TypeTracker t) {
+DataFlow::Node int_type(TypeTracker t) {
   t.start() and
   result.asCfgNode() = any(CallNode c | c.getFunction().(NameNode).getId() = "int")
   or
   exists(TypeTracker t2 | result = int_type(t2).track(t2, t))
 }
 
-Node string_type(TypeTracker t) {
+DataFlow::Node string_type(TypeTracker t) {
   t.start() and
   result.asCfgNode() = any(CallNode c | c.getFunction().(NameNode).getId() = "str")
   or
@@ -45,7 +46,7 @@ class TrackedIntTest extends InlineExpectationsTest {
   override string getARelevantTag() { result = "int" }
 
   override predicate hasActualResult(Location location, string element, string tag, string value) {
-    exists(Node e, TypeTracker t |
+    exists(DataFlow::Node e, TypeTracker t |
       e = int_type(t) and
       tag = "int" and
       location = e.getLocation() and
@@ -61,7 +62,7 @@ class TrackedStringTest extends InlineExpectationsTest {
   override string getARelevantTag() { result = "str" }
 
   override predicate hasActualResult(Location location, string element, string tag, string value) {
-    exists(Node e, TypeTracker t |
+    exists(DataFlow::Node e, TypeTracker t |
       e = string_type(t) and
       tag = "str" and
       location = e.getLocation() and