mock classes, and add a Mock T class to QlBuiltins

erik-krogh · erik-krogh · commit 5db2f0aba085 · 2022-12-20T13:55:49.000+01:00
diff --git a/ql/ql/src/codeql_ql/ast/Ast.qll b/ql/ql/src/codeql_ql/ast/Ast.qll
@@ -877,22 +877,26 @@ class TypeDeclaration extends TTypeDeclaration, Declaration { }
  * A QL class.
  */
 class Class extends TClass, TypeDeclaration, ModuleDeclaration {
-  QL::Dataclass cls;
+  Mocks::ClassOrMock cls;
 
   Class() { this = TClass(cls) }
 
-  override Location getLocation() { result = cls.getName().getLocation() }
+  override Location getLocation() { result = cls.asLeft().getName().getLocation() }
 
   override string getAPrimaryQlClass() { result = "Class" }
 
-  override string getName() { result = cls.getName().getValue() }
+  override string getName() {
+    result = cls.asLeft().getName().getValue()
+    or
+    result = cls.asRight().getName()
+  }
 
   /**
    * Gets the characteristic predicate for this class.
    */
-  CharPred getCharPred() { toQL(result) = cls.getChild(_).(QL::ClassMember).getChild(_) }
+  CharPred getCharPred() { toQL(result) = cls.asLeft().getChild(_).(QL::ClassMember).getChild(_) }
 
-  AstNode getMember(int i) { toQL(result) = cls.getChild(i).(QL::ClassMember).getChild(_) }
+  AstNode getMember(int i) { toQL(result) = cls.asLeft().getChild(i).(QL::ClassMember).getChild(_) }
 
   QLDoc getQLDocFor(AstNode m) {
     exists(int i | result = this.getMember(i) and m = this.getMember(i + 1))
@@ -902,7 +906,7 @@ class Class extends TClass, TypeDeclaration, ModuleDeclaration {
    * Gets a predicate in this class.
    */
   ClassPredicate getAClassPredicate() {
-    toQL(result) = cls.getChild(_).(QL::ClassMember).getChild(_)
+    toQL(result) = cls.asLeft().getChild(_).(QL::ClassMember).getChild(_)
   }
 
   /**
@@ -921,18 +925,20 @@ class Class extends TClass, TypeDeclaration, ModuleDeclaration {
   /**
    * Gets a super-type referenced in the `extends` part of the class declaration.
    */
-  TypeExpr getASuperType() { toQL(result) = cls.getExtends(_) }
+  TypeExpr getASuperType() { toQL(result) = cls.asLeft().getExtends(_) }
 
   /**
    * Gets a type referenced in the `instanceof` part of the class declaration.
    */
-  TypeExpr getAnInstanceofType() { toQL(result) = cls.getInstanceof(_) }
+  TypeExpr getAnInstanceofType() { toQL(result) = cls.asLeft().getInstanceof(_) }
 
   /** Gets the type that this class is defined to be an alias of. */
-  TypeExpr getAliasType() { toQL(result) = cls.getChild(_).(QL::TypeAliasBody).getChild() }
+  TypeExpr getAliasType() { toQL(result) = cls.asLeft().getChild(_).(QL::TypeAliasBody).getChild() }
 
   /** Gets the type of one of the members that this class is defined to be a union of. */
-  TypeExpr getUnionMember() { toQL(result) = cls.getChild(_).(QL::TypeUnionBody).getChild(_) }
+  TypeExpr getUnionMember() {
+    toQL(result) = cls.asLeft().getChild(_).(QL::TypeUnionBody).getChild(_)
+  }
 
   /** Gets the class type defined by this class declaration. */
   Type getType() { result.getDeclaration() = this }
diff --git a/ql/ql/src/codeql_ql/ast/internal/AstMocks.qll b/ql/ql/src/codeql_ql/ast/internal/AstMocks.qll
@@ -14,11 +14,15 @@ private import codeql.util.Either
 // 1: Better type checking with distinct types.
 // 2: We don't get all the methods defined on strings, to confuse us.
 // 3: The Either type gets a type without bindingset on the charpred/toString.
-newtype TMockAst = TMockModule(string id) { id instanceof MockModule::Range }
+newtype TMockAst =
+  TMockModule(string id) { id instanceof MockModule::Range } or
+  TMockClass(string id) { id instanceof MockClass::Range }
 
 /** Gets a mocked Ast node from the string ID that represents it. */
 MockAst fromId(string id) {
   result = TMockModule(id)
+  or
+  result = TMockClass(id)
   // TODO: Other nodes.
 }
 
@@ -67,3 +71,27 @@ module MockModule {
 }
 
 class ModuleOrMock = Either<QL::Module, MockModule>::Either;
+
+/**
+ * A mocked class.
+ * Extend `MockClass::Range` to add new mocked classes.
+ */
+class MockClass extends MockAst, TMockClass {
+  MockClass::Range range;
+
+  MockClass() { this = TMockClass(range) }
+
+  final string getName() { result = range.getName() }
+}
+
+module MockClass {
+  abstract class Range extends string {
+    bindingset[this]
+    Range() { this = this }
+
+    /** Gets the name of this mocked class. */
+    abstract string getName();
+  }
+}
+
+class ClassOrMock = Either<QL::Dataclass, MockClass>::Either;
diff --git a/ql/ql/src/codeql_ql/ast/internal/AstNodes.qll b/ql/ql/src/codeql_ql/ast/internal/AstNodes.qll
@@ -12,7 +12,7 @@ newtype TAstNode =
   TClasslessPredicate(QL::ClasslessPredicate pred) or
   TVarDecl(QL::VarDecl decl) or
   TFieldDecl(QL::Field field) or
-  TClass(QL::Dataclass dc) or
+  TClass(Mocks::ClassOrMock cls) or
   TCharPred(QL::Charpred pred) or
   TClassPredicate(QL::MemberPredicate pred) or
   TDBRelation(Dbscheme::Table table) or
@@ -166,7 +166,7 @@ QL::AstNode toQL(AST::AstNode n) {
   or
   n = TFieldDecl(result)
   or
-  n = TClass(result)
+  n = TClass(any(Mocks::ClassOrMock m | m.asLeft() = result))
   or
   n = TCharPred(result)
   or
@@ -210,6 +210,8 @@ QL::AstNode toQL(AST::AstNode n) {
 Mocks::MockAst toMock(AST::AstNode n) {
   n = TModule(any(Mocks::ModuleOrMock m | m.asRight() = result))
   or
+  n = TClass(any(Mocks::ClassOrMock m | m.asRight() = result))
+  or
   none() // TODO: Remove, this is to loosen the type of `toMock` to avoid type-errors in WIP code.
 }
 
diff --git a/ql/ql/src/codeql_ql/ast/internal/Builtins.qll b/ql/ql/src/codeql_ql/ast/internal/Builtins.qll
@@ -106,8 +106,11 @@ module QlBuiltinsMocks {
 
     override string getName() { result = "QlBuiltins" }
 
-    override MockModule::Range getMember(int i) {
-      // TODO: T, InstSig
+    override string getMember(int i) {
+      // TODO: InstSig
+      i = 0 and
+      result instanceof EquivalenceRelation::SigClass
+      or
       i = 2 and
       result instanceof EquivalenceRelation::EquivalenceRelationModule
     }
@@ -118,7 +121,7 @@ module QlBuiltinsMocks {
    * The equivalent to the following is implemented: (TODO: WIP, MISSING THE LINES WITH //)
    * ```CodeQL
    * module QlBuiltins {
-   *  signature class T; //
+   *  signature class T;
    *  module InstSig<T MyT> { //
    *    signature predicate edgeSig(MyT a, MyT b); //
    *  }
@@ -129,6 +132,12 @@ module QlBuiltinsMocks {
    *}
    */
   module EquivalenceRelation {
+    class SigClass extends MockClass::Range {
+      SigClass() { this = "Mock: QlBuiltins::T" }
+
+      override string getName() { result = "T" }
+    }
+
     class EquivalenceRelationModule extends MockModule::Range {
       EquivalenceRelationModule() { this = "Mock: QlBuiltins::EquivalenceRelation" }
 
diff --git a/ql/ql/test/queries/style/MissingSecurityMetadata/MissingSecurityMetadata.expected b/ql/ql/test/queries/style/MissingSecurityMetadata/MissingSecurityMetadata.expected
@@ -1,2 +1,2 @@
-| testcases/BadNoSecurity.ql:1:1:15:9 | TopLevel | This query file is missing a `@tag security`. |
-| testcases/BadNoSeverity.ql:1:1:15:9 | TopLevel | This query file is missing a `@security-severity` tag. |
+| testcases/BadNoSecurity.ql:1:1:16:9 | TopLevel | This query file is missing a `@tag security`. |
+| testcases/BadNoSeverity.ql:1:1:16:9 | TopLevel | This query file is missing a `@security-severity` tag. |
diff --git a/ql/ql/test/queries/style/MissingSecurityMetadata/testcases/BadNoSecurity.ql b/ql/ql/test/queries/style/MissingSecurityMetadata/testcases/BadNoSecurity.ql
@@ -12,4 +12,5 @@
 import ql
 
 from Class c
+where none()
 select c
diff --git a/ql/ql/test/queries/style/MissingSecurityMetadata/testcases/BadNoSeverity.ql b/ql/ql/test/queries/style/MissingSecurityMetadata/testcases/BadNoSeverity.ql
@@ -12,4 +12,5 @@
 import ql
 
 from Class c
+where none()
 select c
diff --git a/ql/ql/test/queries/style/MissingSecurityMetadata/testcases/Good.ql b/ql/ql/test/queries/style/MissingSecurityMetadata/testcases/Good.ql
@@ -13,4 +13,5 @@
 import ql
 
 from Class c
+where none()
 select c
diff --git a/ql/ql/test/queries/style/MissingSecurityMetadata/testcases/GoodNoPrecision.ql b/ql/ql/test/queries/style/MissingSecurityMetadata/testcases/GoodNoPrecision.ql
@@ -11,4 +11,5 @@
 import ql
 
 from Class c
+where none()
 select c
diff --git a/ql/ql/test/queries/style/MissingSecurityMetadata/testcases/GoodNoSecurity.ql b/ql/ql/test/queries/style/MissingSecurityMetadata/testcases/GoodNoSecurity.ql
@@ -11,4 +11,5 @@
 import ql
 
 from Class c
+where none()
 select c
