Add custom path state search queries for languages beyond C++

.github/workflows/copilot-setup-steps.yaml

@@ -34,5 +34,47 @@ jobs:
       - name: Copilot Setup - Install CodeQL
         uses: ./.github/actions/install-codeql
 
-      - name: Copilot Setup - Install CodeQL packs
-        uses: ./.github/actions/install-codeql-packs
+      - name: Copilot Setup - Install CodeQL packs (common)
+        uses: ./.github/actions/install-codeql-packs
+        with:
+          language: common
+
+      - name: Copilot Setup - Install CodeQL packs (cpp)
+        uses: ./.github/actions/install-codeql-packs
+        with:
+          language: cpp
+
+      - name: Copilot Setup - Install CodeQL packs (csharp)
+        uses: ./.github/actions/install-codeql-packs
+        with:
+          language: csharp
+
+      - name: Copilot Setup - Install CodeQL packs (go)
+        uses: ./.github/actions/install-codeql-packs
+        with:
+          language: go 
+
+      - name: Copilot Setup - Install CodeQL packs (java)
+        uses: ./.github/actions/install-codeql-packs
+        with:
+          language: java
+
+      - name: Copilot Setup - Install CodeQL packs (javascript)
+        uses: ./.github/actions/install-codeql-packs
+        with:
+          language: javascript
+
+      - name: Copilot Setup - Install CodeQL packs (python)
+        uses: ./.github/actions/install-codeql-packs
+        with:
+          language: python
+
+      - name: Copilot Setup - Install CodeQL packs (ruby)
+        uses: ./.github/actions/install-codeql-packs
+        with:
+          language: ruby
+
+      - name: Copilot Setup - Install CodeQL packs (swift)
+        uses: ./.github/actions/install-codeql-packs
+        with:
+          language: swift

.gitignore

@@ -0,0 +1,2 @@
+# CodeQL CLI installation directory
+codeql_home/

cpp/src/qtil/cpp/graph/CustomPathStateProblem.qll

@@ -0,0 +1,5 @@
+private import qtil.locations.CustomPathStateProblem
+private import qtil.cpp.locations.Locatable
+private import cpp
+// Import the C++ specific configuration for making custom path state problems.
+import PathStateProblem<Location, CppLocatableConfig>

cpp/test/qtil/cpp/graph/CustomPathStateProblemTest.expected

@@ -0,0 +1,3 @@
+edges
+nodes
+#select

cpp/test/qtil/cpp/graph/CustomPathStateProblemTest.ql

@@ -0,0 +1,30 @@
+// Minimal test to make sure CustomPathStateProblem works with C++ code.
+import cpp
+import qtil.cpp.graph.CustomPathStateProblem
+
+module CallGraphPathStateProblemConfig implements CustomPathStateProblemConfigSig {
+  class Node = Variable;
+
+  class State = int; // Track search depth
+
+  predicate start(Node n, int depth) { n.getName() = "start" and depth = 0 }
+
+  bindingset[depth]
+  predicate end(Node n, int depth) { n.getName() = "end" and depth >= 0 }
+
+  bindingset[depth1]
+  bindingset[depth2]
+  predicate edge(Variable a, int depth1, Variable b, int depth2) {
+    depth2 = depth1 + 1 and
+    exists(Initializer initA |
+      a.getInitializer() = initA and
+      initA.getExpr().(VariableAccess).getTarget() = b
+    )
+  }
+}
+
+import CustomPathStateProblem<CallGraphPathStateProblemConfig>
+
+from Variable start, Variable end
+where problem(start, end)
+select start, end, "Path from $@ to $@.", start.getName(), start, end.getName(), end

csharp/src/qtil/csharp/graph/CustomPathStateProblem.qll

@@ -0,0 +1,5 @@
+private import qtil.locations.CustomPathStateProblem
+private import qtil.csharp.locations.Locatable
+private import csharp
+// Import the C# specific configuration for making custom path state problems.
+import PathStateProblem<Location, CsharpLocatableConfig>

csharp/test/qtil/csharp/graph/CustomPathStateProblemTest.expected

@@ -0,0 +1,3 @@
+edges
+nodes
+#select

csharp/test/qtil/csharp/graph/CustomPathStateProblemTest.ql

@@ -0,0 +1,31 @@
+// Minimal test to make sure CustomPathStateProblem works with C# code.
+import csharp
+import qtil.csharp.graph.CustomPathStateProblem
+
+module CallGraphPathStateProblemConfig implements CustomPathStateProblemConfigSig {
+  class Node = LocalVariable;
+
+  class State = int; // Track search depth
+
+  predicate start(Node n, int depth) { n.getName() = "start" and depth = 0 }
+
+  bindingset[depth]
+  predicate end(Node n, int depth) { n.getName() = "end" and depth >= 0 }
+
+  bindingset[depth1]
+  bindingset[depth2]
+  predicate edge(LocalVariable a, int depth1, LocalVariable b, int depth2) {
+    depth2 = depth1 + 1 and
+    exists(LocalVariableDeclExpr declA, LocalVariableDeclExpr declB |
+      declA.getVariable() = a and
+      declB.getVariable() = b and
+      declA.getInitializer().(VariableAccess).getTarget() = b
+    )
+  }
+}
+
+import CustomPathStateProblem<CallGraphPathStateProblemConfig>
+
+from LocalVariable start, LocalVariable end
+where problem(start, end)
+select start, end, "Path from $@ to $@.", start.getName(), start, end.getName(), end

go/src/qtil/go/graph/CustomPathStateProblem.qll

@@ -0,0 +1,5 @@
+private import qtil.locations.CustomPathStateProblem
+private import qtil.go.locations.Locatable
+private import go
+// Import the Go specific configuration for making custom path state problems.
+import PathStateProblem<DbLocation, GoLocatableConfig>

go/test/qtil/go/graph/CustomPathStateProblemTest.expected

@@ -0,0 +1,9 @@
+edges
+| test.go:4:5:4:7 | mid | test.go:6:5:6:7 | end |  |  |
+| test.go:5:5:5:9 | start | test.go:4:5:4:7 | mid |  |  |
+nodes
+| test.go:4:5:4:7 | mid | semmle.label | mid |
+| test.go:5:5:5:9 | start | semmle.label | start |
+| test.go:6:5:6:7 | end | semmle.label | end |
+#select
+| test.go:5:5:5:9 | start | test.go:6:5:6:7 | end | Path from $@ to $@. | start | test.go:5:5:5:9 | start | end | test.go:6:5:6:7 | end |

go/test/qtil/go/graph/CustomPathStateProblemTest.ql

@@ -0,0 +1,30 @@
+// Minimal test to make sure CustomPathStateProblem works with Go code.
+import go
+import qtil.go.graph.CustomPathStateProblem
+
+module CallGraphPathStateProblemConfig implements CustomPathStateProblemConfigSig {
+  class Node = Ident;
+
+  class State = int; // Track search depth
+
+  predicate start(Node n, int depth) { n.getName() = "start" and depth = 0 }
+
+  bindingset[depth]
+  predicate end(Node n, int depth) { n.getName() = "end" and depth >= 0 }
+
+  bindingset[depth1]
+  bindingset[depth2]
+  predicate edge(Ident a, int depth1, Ident b, int depth2) {
+    depth2 = depth1 + 1 and
+    exists(Assignment assign |
+      assign.getLhs().(Name).getTarget().getDeclaration() = a and
+      assign.getRhs().(Name).getTarget().getDeclaration() = b
+    )
+  }
+}
+
+import CustomPathStateProblem<CallGraphPathStateProblemConfig>
+
+from Ident start, Ident end
+where problem(start, end)
+select start, end, "Path from $@ to $@.", start.getName(), start, end.getName(), end

java/src/qtil/java/graph/CustomPathStateProblem.qll

@@ -0,0 +1,5 @@
+private import qtil.locations.CustomPathStateProblem
+private import qtil.java.locations.Locatable
+private import java
+// Import the Java specific configuration for making custom path state problems.
+import PathStateProblem<Location, JavaLocatableConfig>

java/test/qtil/java/graph/CustomPathStateProblemTest.expected

@@ -0,0 +1,3 @@
+edges
+nodes
+#select

java/test/qtil/java/graph/CustomPathStateProblemTest.ql

@@ -0,0 +1,31 @@
+// Minimal test to make sure CustomPathStateProblem works with Java code.
+import java
+import qtil.java.graph.CustomPathStateProblem
+
+module CallGraphPathStateProblemConfig implements CustomPathStateProblemConfigSig {
+  class Node = LocalVariableDecl;
+
+  class State = int; // Track search depth
+
+  predicate start(Node n, int depth) { n.getName() = "start" and depth = 0 }
+
+  bindingset[depth]
+  predicate end(Node n, int depth) { n.getName() = "end" and depth >= 0 }
+
+  bindingset[depth1]
+  bindingset[depth2]
+  predicate edge(LocalVariableDecl a, int depth1, LocalVariableDecl b, int depth2) {
+    depth2 = depth1 + 1 and
+    exists(LocalVariableDeclExpr declA, LocalVariableDeclExpr declB |
+      declA.getVariable() = a and
+      declB.getVariable() = b and
+      declA.getInit().(VarAccess).getVariable() = b
+    )
+  }
+}
+
+import CustomPathStateProblem<CallGraphPathStateProblemConfig>
+
+from LocalVariableDecl start, LocalVariableDecl end
+where problem(start, end)
+select start, end, "Path from $@ to $@.", start.getName(), start, end.getName(), end

javascript/src/qtil/javascript/graph/CustomPathStateProblem.qll

@@ -0,0 +1,5 @@
+private import qtil.locations.CustomPathStateProblem
+private import qtil.javascript.locations.Locatable
+private import javascript
+// Import the javascript specific configuration for making custom path state problems.
+import PathStateProblem<DbLocation, JavascriptLocatableConfig>

javascript/test/qtil/javascript/graph/CustomPathStateProblemTest.expected

@@ -0,0 +1,9 @@
+edges
+| test.js:2:9:2:11 | mid | test.js:4:9:4:11 | end |  |  |
+| test.js:3:9:3:13 | start | test.js:2:9:2:11 | mid |  |  |
+nodes
+| test.js:2:9:2:11 | mid | semmle.label | mid |
+| test.js:3:9:3:13 | start | semmle.label | start |
+| test.js:4:9:4:11 | end | semmle.label | end |
+#select
+| test.js:3:9:3:13 | start | test.js:4:9:4:11 | end | Path from $@ to $@. | start | test.js:3:9:3:13 | start | end | test.js:4:9:4:11 | end |

javascript/test/qtil/javascript/graph/CustomPathStateProblemTest.ql

@@ -0,0 +1,28 @@
+// Minimal test to make sure CustomPathStateProblem works with Javascript code.
+import javascript
+import qtil.javascript.graph.CustomPathStateProblem
+
+module CallGraphPathStateProblemConfig implements CustomPathStateProblemConfigSig {
+  class Node = VarDecl;
+
+  class State = int; // Track search depth
+
+  predicate start(Node n, int depth) { n.getAVariable().getName() = "start" and depth = 0 }
+
+  bindingset[depth]
+  predicate end(Node n, int depth) { n.getAVariable().getName() = "end" and depth >= 0 }
+
+  bindingset[depth1]
+  bindingset[depth2]
+  predicate edge(VarDecl a, int depth1, VarDecl b, int depth2) {
+    depth2 = depth1 + 1 and
+    a.getAVariable().getAnAssignedExpr() = b.getAVariable().getAnAccess()
+  }
+}
+
+import CustomPathStateProblem<CallGraphPathStateProblemConfig>
+
+from VarDecl start, VarDecl end
+where problem(start, end)
+select start, end, "Path from $@ to $@.", start.getAVariable().getName(), start,
+  end.getAVariable().getName(), end

python/src/qtil/python/graph/CustomPathStateProblem.qll

@@ -0,0 +1,5 @@
+private import qtil.locations.CustomPathStateProblem
+private import qtil.python.locations.Locatable
+private import python
+// Import the python specific configuration for making custom path state problems.
+import PathStateProblem<Location, PythonLocatableConfig>

python/test/qtil/python/graph/CustomPathStateProblemTest.expected

@@ -0,0 +1,9 @@
+edges
+| test.py:4:5:4:7 | mid | test.py:3:5:3:7 | end |  |  |
+| test.py:5:5:5:9 | start | test.py:4:5:4:7 | mid |  |  |
+nodes
+| test.py:3:5:3:7 | end | semmle.label | end |
+| test.py:4:5:4:7 | mid | semmle.label | mid |
+| test.py:5:5:5:9 | start | semmle.label | start |
+#select
+| test.py:5:5:5:9 | start | test.py:3:5:3:7 | end | Path from $@ to $@. | start | test.py:5:5:5:9 | start | end | test.py:3:5:3:7 | end |

python/test/qtil/python/graph/CustomPathStateProblemTest.ql

@@ -0,0 +1,32 @@
+// Minimal test to make sure CustomPathStateProblem works with python code.
+import python
+import qtil.python.graph.CustomPathStateProblem
+
+module CallGraphPathStateProblemConfig implements CustomPathStateProblemConfigSig {
+  class Node = Name;
+
+  class State = int; // Track search depth
+
+  predicate start(Node n, int depth) { n.getId() = "start" and depth = 0 }
+
+  bindingset[depth]
+  predicate end(Node n, int depth) { n.getId() = "end" and depth >= 0 }
+
+  bindingset[depth1]
+  bindingset[depth2]
+  predicate edge(Name a, int depth1, Name b, int depth2) {
+    depth2 = depth1 + 1 and
+    exists(Assign assign, Variable varA, Variable varB |
+      assign.defines(varA) and
+      assign.getValue().(Name).uses(varB) and
+      a.defines(varA) and
+      b.defines(varB)
+    )
+  }
+}
+
+import CustomPathStateProblem<CallGraphPathStateProblemConfig>
+
+from Name start, Name end
+where problem(start, end)
+select start, end, "Path from $@ to $@.", start.getId(), start, end.getId(), end

ruby/src/qtil/ruby/graph/CustomPathStateProblem.qll

@@ -0,0 +1,5 @@
+private import qtil.locations.CustomPathStateProblem
+private import qtil.ruby.locations.Locatable
+private import ruby
+// Import the Ruby specific configuration for making custom path state problems.
+import PathStateProblem<Location, RubyLocatableConfig>

ruby/test/qtil/ruby/ast/TwoOperandsTest.expected

@@ -0,0 +1,2 @@
+| test.rb:6:13:6:17 | ... + ... | test.rb:6:13:6:13 | a | test.rb:6:17:6:17 | b |
+| test.rb:7:13:7:17 | ... + ... | test.rb:7:17:7:17 | a | test.rb:7:13:7:13 | b |

ruby/test/qtil/ruby/ast/test.rb

@@ -0,0 +1,9 @@
+def f1
+  v_end = 42
+  v_mid = v_end  
+  a = 1
+  b = 2
+  result1 = a + b
+  result2 = b + a
+  v_start = v_mid
+end

ruby/test/qtil/cpp/format/QlFormatTest.expected → ruby/test/qtil/ruby/format/QlFormatTest.expected

@@ -1 +1 @@
-| test.rb:2:5:2:9 | ... = ... | Variable x has initializer $@. | test.rb:2:9:2:9 | test.rb:2:9:2:9 | 0 | file://:0:0:0:0 | (none) | [unused] |
+| test.rb:2:5:2:9 | ... = ... | Variable x has initializer $@. | test.rb:2:9:2:9 | test.rb:2:9:2:9 | 0 | file://:0:0:0:0 | (none) | [unused] |

ruby/test/qtil/ruby/graph/CustomPathProblemTest.expected

@@ -0,0 +1,9 @@
+edges
+| test.rb:6:3:6:9 | v_start | test.rb:8:3:8:7 | v_mid |  |  |
+| test.rb:8:3:8:7 | v_mid | test.rb:2:3:2:7 | v_end |  |  |
+nodes
+| test.rb:2:3:2:7 | v_end | semmle.label | v_end |
+| test.rb:6:3:6:9 | v_start | semmle.label | v_start |
+| test.rb:8:3:8:7 | v_mid | semmle.label | v_mid |
+#select
+| test.rb:6:3:6:9 | v_start | test.rb:2:3:2:7 | v_end | Path from $@ to $@. | v_start | test.rb:6:3:6:9 | v_start | v_end | test.rb:2:3:2:7 | v_end |