Python: CG trace: Add some tests using classes

RasmusWL · RasmusWL · commit 89e8202d1182 · 2020-07-21T11:16:52.000+02:00
diff --git a/python/tools/recorded-call-graph-metrics/example/class-simple.py b/python/tools/recorded-call-graph-metrics/example/class-simple.py
@@ -0,0 +1,44 @@
+def func(self, arg):
+    print("func", self, arg)
+
+
+class Foo(object):
+    def __init__(self, arg):
+        print("Foo.__init__", self, arg)
+
+    def some_method(self):
+        print("Foo.some_method", self)
+        return self
+
+    f = func
+
+    @staticmethod
+    def some_staticmethod():
+        print("Foo.some_staticmethod")
+
+    @classmethod
+    def some_classmethod(cls):
+        print("Foo.some_classmethod", cls)
+
+
+foo = Foo(42)
+foo.some_method()
+foo.f(10)
+foo.some_staticmethod()
+foo.some_classmethod()
+foo.some_method().some_method().some_method()
+
+
+Foo.some_staticmethod()
+Foo.some_classmethod()
+
+
+class Bar(object):
+    def wat(self):
+        print("Bar.wat")
+
+
+# these calls to Bar() are not recorded (since no __init__ function)
+bar = Bar()
+bar.wat()
+Bar().wat()
diff --git a/python/tools/recorded-call-graph-metrics/ql/RecordedCalls.qll b/python/tools/recorded-call-graph-metrics/ql/RecordedCalls.qll
@@ -24,6 +24,10 @@ class XMLRecordedCall extends XMLElement {
     // 2. result.getCall() issubset this.getCall()
     not exists(Call call | call = result.getCall() | not this.getCall() = call)
   }
+
+  override string toString() {
+    result = this.getName() + " (<..>/" + this.getXMLCall().get_filename_data().regexpCapture(".*/([^/]+)$", 1) + ":" + this.getXMLCall().get_linenum_data() + ")"
+  }
 }
 
 class XMLCall extends XMLElement {
@@ -74,6 +78,10 @@ class XMLPythonCallee extends XMLCallee {
 
   Function getCallee() {
     result.getLocation().hasLocationInfo(this.get_filename_data(), this.get_linenum_data(), _, _, _)
+    or
+    // if function has decorator, the call will be recorded going to the first
+    result.getADecorator().getLocation().hasLocationInfo(this.get_filename_data(), this.get_linenum_data(), _, _, _)
+
   }
 }
 
diff --git a/python/tools/recorded-call-graph-metrics/recreate-db.sh b/python/tools/recorded-call-graph-metrics/recreate-db.sh
@@ -17,6 +17,7 @@ PYTHON_EXTRACTOR=$(codeql resolve extractor --language=python)
 cg-trace --xml "$XMLDIR"/simple.xml example/simple.py
 cg-trace --xml "$XMLDIR"/builtins.xml example/builtins.py
 cg-trace --xml "$XMLDIR"/multiple-on-one-line.xml example/multiple-on-one-line.py
+cg-trace --xml "$XMLDIR"/class-simple.xml example/class-simple.py
 
 
 rm -rf "$DB"

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,10 @@ class XMLRecordedCall extends XMLElement {`
`24`	`24`	`// 2. result.getCall() issubset this.getCall()`
`25`	`25`	`not exists(Call call \| call = result.getCall() \| not this.getCall() = call)`
`26`	`26`	`}`
	`27`	`+`
	`28`	`+ override string toString() {`
	`29`	`+ result = this.getName() + " (<..>/" + this.getXMLCall().get_filename_data().regexpCapture(".*/([^/]+)$", 1) + ":" + this.getXMLCall().get_linenum_data() + ")"`
	`30`	`+ }`
`27`	`31`	`}`
`28`	`32`
`29`	`33`	`class XMLCall extends XMLElement {`
`@@ -74,6 +78,10 @@ class XMLPythonCallee extends XMLCallee {`
`74`	`78`
`75`	`79`	`Function getCallee() {`
`76`	`80`	`result.getLocation().hasLocationInfo(this.get_filename_data(), this.get_linenum_data(), _, _, _)`
	`81`	`+ or`
	`82`	`+ // if function has decorator, the call will be recorded going to the first`
	`83`	`+ result.getADecorator().getLocation().hasLocationInfo(this.get_filename_data(), this.get_linenum_data(), _, _, _)`
	`84`	`+`
`77`	`85`	`}`
`78`	`86`	`}`
`79`	`87`