Ruby: add def= tags to API graph test

Author: asgerf

ruby/ql/test/library-tests/dataflow/api-graphs/test1.rb

@@ -1,6 +1,6 @@
 MyModule #$ use=getMember("MyModule")
 print MyModule.foo #$ use=getMember("MyModule").getMethod("foo").getReturn()
-Kernel.print(e) #$ use=getMember("Kernel").getMethod("print").getReturn()
+Kernel.print(e) #$ use=getMember("Kernel").getMethod("print").getReturn() def=getMember("Kernel").getMethod("print").getParameter(0)
 Object::Kernel #$ use=getMember("Kernel")
 Object::Kernel.print(e)  #$ use=getMember("Kernel").getMethod("print").getReturn()
 begin
@@ -13,7 +13,7 @@
 Foo::Bar::Baz #$ use=getMember("Foo").getMember("Bar").getMember("Baz")
 
 Const = [1, 2, 3] #$ use=getMember("Array").getMethod("[]").getReturn()
-Const.each do |c| #$ use=getMember("Const").getMethod("each").getReturn()
+Const.each do |c| #$ use=getMember("Const").getMethod("each").getReturn() def=getMember("Const").getMethod("each").getBlock()
     puts c #$ use=getMember("Const").getMethod("each").getBlock().getParameter(0)
 end
 
@@ -60,3 +60,5 @@ class C4 < C2 #$ use=getMember("C2")
 
 M1::C1.new.m #$ use=getMember("M1").getMember("C1").getMethod("new").getReturn().getMethod("m").getReturn()
 M2::C3.new.m #$ use=getMember("M2").getMember("C3").getMethod("new").getReturn().getMethod("m").getReturn()
+
+Foo.foo(a,b:c) #$ use=getMember("Foo").getMethod("foo").getReturn() def=getMember("Foo").getMethod("foo").getParameter(0) def=getMember("Foo").getMethod("foo").getKeywordParameter("b")

ruby/ql/test/library-tests/dataflow/api-graphs/use.ql

@@ -6,20 +6,26 @@ import codeql.ruby.ApiGraphs
 class ApiUseTest extends InlineExpectationsTest {
   ApiUseTest() { this = "ApiUseTest" }
 
-  override string getARelevantTag() { result = "use" }
+  override string getARelevantTag() { result = ["use", "def"] }
 
-  private predicate relevantNode(API::Node a, DataFlow::Node n, Location l) {
-    n = a.getAUse() and
-    l = n.getLocation()
+  private predicate relevantNode(API::Node a, DataFlow::Node n, Location l, string tag) {
+    l = n.getLocation() and
+    (
+      tag = "use" and
+      n = a.getAUse()
+      or
+      tag = "def" and
+      n = a.getARhs()
+    )
   }
 
   override predicate hasActualResult(Location location, string element, string tag, string value) {
-    exists(API::Node a, DataFlow::Node n | relevantNode(a, n, location) |
-      tag = "use" and
+    tag = "use" and // def tags are always optional
+    exists(API::Node a, DataFlow::Node n | relevantNode(a, n, location, tag) |
       // Only report the longest path on this line:
       value =
         max(API::Node a2, Location l2, DataFlow::Node n2 |
-          relevantNode(a2, n2, l2) and
+          relevantNode(a2, n2, l2, tag) and
           l2.getFile() = location.getFile() and
           l2.getStartLine() = location.getStartLine()
         |
@@ -34,8 +40,7 @@ class ApiUseTest extends InlineExpectationsTest {
   // We also permit optional annotations for any other path on the line.
   // This is used to test subclass paths, which typically have a shorter canonical path.
   override predicate hasOptionalResult(Location location, string element, string tag, string value) {
-    exists(API::Node a, DataFlow::Node n | relevantNode(a, n, location) |
-      tag = "use" and
+    exists(API::Node a, DataFlow::Node n | relevantNode(a, n, location, tag) |
       element = n.toString() and
       value = getAPath(a, _)
     )