Rust: Path resolution for static items

Author: hvitved

rust/ql/lib/codeql/rust/elements/StaticAccess.qll

@@ -0,0 +1,7 @@
+/**
+ * This module provides the public class `StaticAccess`.
+ */
+
+private import internal.StaticImpl
+
+final class StaticAccess = Impl::StaticAccess;

rust/ql/lib/codeql/rust/elements/internal/ConstImpl.qll

@@ -24,7 +24,9 @@ module Impl {
    * const X: i32 = 42;
    * ```
    */
-  class Const extends Generated::Const { }
+  class Const extends Generated::Const {
+    override string toStringImpl() { result = "const " + this.getName().getText() }
+  }
 
   /**
    * A constant access.

rust/ql/lib/codeql/rust/elements/internal/StaticImpl.qll

@@ -659,6 +659,38 @@ private class ConstItemNode extends AssocItemNode instanceof Const {
   override TypeParam getTypeParam(int i) { none() }
 }
 
+private class StaticItemNode extends ItemNode instanceof Static {
+  override string getName() { result = Static.super.getName().getText() }
+
+  override Namespace getNamespace() { result.isValue() }
+
+  override Visibility getVisibility() { result = Static.super.getVisibility() }
+
+  override Attr getAnAttr() { result = Static.super.getAnAttr() }
+
+  override TypeParam getTypeParam(int i) { none() }
+
+  override predicate hasCanonicalPath(Crate c) { this.hasCanonicalPathPrefix(c) }
+
+  bindingset[c]
+  private string getCanonicalPathPart(Crate c, int i) {
+    i = 0 and
+    result = this.getCanonicalPathPrefix(c)
+    or
+    i = 1 and
+    result = "::"
+    or
+    i = 2 and
+    result = this.getName()
+  }
+
+  language[monotonicAggregates]
+  override string getCanonicalPath(Crate c) {
+    this.hasCanonicalPath(c) and
+    result = strictconcat(int i | i in [0 .. 2] | this.getCanonicalPathPart(c, i) order by i)
+  }
+}
+
 private class TypeItemTypeItemNode extends NamedItemNode, TypeItemNode instanceof TypeItem {
   override string getName() { result = TypeItem.super.getName().getText() }
 

rust/ql/lib/codeql/rust/internal/PathResolution.qll

@@ -11,6 +11,7 @@ import codeql.rust.elements.AssignmentOperation
 import codeql.rust.elements.BitwiseOperation
 import codeql.rust.elements.ComparisonOperation
 import codeql.rust.elements.ConstAccess
+import codeql.rust.elements.StaticAccess
 import codeql.rust.elements.DerefExpr
 import codeql.rust.elements.LiteralExprExt
 import codeql.rust.elements.LogicalOperation

rust/ql/lib/rust.qll

@@ -10,10 +10,6 @@ private import utils.test.InlineExpectationsTest
 private module ResolveTest implements TestSig {
   string getARelevantTag() { result = ["item", "target", "item_not_target"] }
 
-  private predicate itemAt(ItemNode i, string filepath, int line) {
-    i.getLocation().hasLocationInfo(filepath, _, _, line, _)
-  }
-
   private predicate commmentAt(string text, string filepath, int line) {
     exists(Comment c |
       c.getLocation().hasLocationInfo(filepath, line, _, _, _) and
@@ -23,6 +19,10 @@ private module ResolveTest implements TestSig {
     )
   }
 
+  private predicate itemAt(ItemNode i, string filepath, int line) {
+    i.getLocation().hasLocationInfo(filepath, _, _, line, _)
+  }
+
   private predicate item(ItemNode i, string value) {
     exists(string filepath, int line | itemAt(i, filepath, line) |
       if i instanceof SourceFile

rust/ql/lib/utils/test/PathResolutionInlineExpectationsTest.qll

@@ -20,3 +20,12 @@ class CrateElement extends Element {
 class Builtin extends AstNode {
   Builtin() { this.getFile().getAbsolutePath().matches("%/builtins/%.rs") }
 }
+
+predicate commmentAt(string text, string filepath, int line) {
+  exists(Comment c |
+    c.getLocation().hasLocationInfo(filepath, line, _, _, _) and
+    c.getCommentText().trim() = text and
+    c.fromSource() and
+    not text.matches("$%")
+  )
+}

rust/ql/test/TestUtils.qll

@@ -1,8 +1,11 @@
 testFailures
 constAccess
-| main.rs:17:13:17:24 | GLOBAL_CONST | main.rs:1:1:1:29 | Const |
-| main.rs:19:13:19:24 | STRING_CONST | main.rs:2:1:2:35 | Const |
-| main.rs:21:13:21:33 | ...::ASSOC_CONST | main.rs:9:5:9:33 | Const |
-| main.rs:23:13:23:35 | ...::MODULE_CONST | main.rs:13:5:13:38 | Const |
-| main.rs:25:8:25:19 | GLOBAL_CONST | main.rs:1:1:1:29 | Const |
-| main.rs:29:16:29:36 | ...::ASSOC_CONST | main.rs:9:5:9:33 | Const |
+| main.rs:17:13:17:24 | GLOBAL_CONST | main.rs:1:1:1:29 | const GLOBAL_CONST |
+| main.rs:19:13:19:24 | STRING_CONST | main.rs:2:1:2:35 | const STRING_CONST |
+| main.rs:21:13:21:33 | ...::ASSOC_CONST | main.rs:9:5:9:33 | const ASSOC_CONST |
+| main.rs:23:13:23:35 | ...::MODULE_CONST | main.rs:13:5:13:38 | const MODULE_CONST |
+| main.rs:26:16:26:27 | GLOBAL_CONST | main.rs:1:1:1:29 | const GLOBAL_CONST |
+| main.rs:30:16:30:36 | ...::ASSOC_CONST | main.rs:9:5:9:33 | const ASSOC_CONST |
+| main.rs:33:20:33:31 | GLOBAL_CONST | main.rs:1:1:1:29 | const GLOBAL_CONST |
+| main.rs:39:17:39:28 | STRING_CONST | main.rs:38:9:38:43 | const STRING_CONST |
+| main.rs:43:21:43:32 | STRING_CONST | main.rs:42:13:42:48 | const STRING_CONST |

rust/ql/test/library-tests/const_access/const_access.expected

@@ -5,15 +5,25 @@ import TestUtils
 query predicate constAccess(ConstAccess ca, Const c) { toBeTested(ca) and c = ca.getConst() }
 
 module ConstAccessTest implements TestSig {
+  private predicate constAt(Const c, string filepath, int line) {
+    c.getLocation().hasLocationInfo(filepath, _, _, line, _)
+  }
+
   string getARelevantTag() { result = "const_access" }
 
   predicate hasActualResult(Location location, string element, string tag, string value) {
-    exists(ConstAccess ca |
+    exists(ConstAccess ca, Const c, string filepath, int line |
       toBeTested(ca) and
       location = ca.getLocation() and
       element = ca.toString() and
       tag = "const_access" and
-      value = ca.getConst().getName().getText()
+      c = ca.getConst() and
+      constAt(c, filepath, line)
+    |
+      commmentAt(value, filepath, line)
+      or
+      not commmentAt(_, filepath, line) and
+      value = c.getName().getText()
     )
   }
 }

rust/ql/test/library-tests/const_access/const_access.ql

@@ -15,18 +15,34 @@ mod my_module {
 
 fn use_consts() {
     let x = GLOBAL_CONST; // $ const_access=GLOBAL_CONST
-    
+
     let s = STRING_CONST; // $ const_access=STRING_CONST
-    
+
     let y = MyStruct::ASSOC_CONST; // $ const_access=ASSOC_CONST
-    
+
     let z = my_module::MODULE_CONST; // $ const_access=MODULE_CONST
-    
-    if GLOBAL_CONST > 0 { // $ const_access=GLOBAL_CONST
+
+    #[rustfmt::skip]
+    let _ = if GLOBAL_CONST > 0 { // $ const_access=GLOBAL_CONST
         println!("positive");
-    }
-    
+    };
+
     let arr = [MyStruct::ASSOC_CONST; 5]; // $ const_access=ASSOC_CONST
+
+    #[rustfmt::skip]
+    let _ = if let GLOBAL_CONST = 0 { // $ const_access=GLOBAL_CONST
+        println!("zero");
+    };
+
+    {
+        const STRING_CONST: &str = "inner"; // Inner1
+        let _ = STRING_CONST; // $ const_access=Inner1
+
+        {
+            const STRING_CONST: &str = "inner2"; // Inner2
+            let _ = STRING_CONST; // $ const_access=Inner2
+        }
+    }
 }
 
 fn main() {