Swift: add possibility to collapse class hierarchy in tests

Author: redsun82

swift/codegen/generators/qlgen.py

@@ -30,7 +30,7 @@ class ModifiedStubMarkedAsGeneratedError(Error):
 def get_ql_property(cls: schema.Class, prop: schema.Property):
     common_args = dict(
         type=prop.type if not prop.is_predicate else "predicate",
-        skip_qltest="skip_qltest" in prop.pragmas,
+        qltest_skip="qltest_skip" in prop.pragmas,
         is_child=prop.is_child,
         is_optional=prop.is_optional,
         is_predicate=prop.is_predicate,
@@ -69,13 +69,14 @@ def get_ql_property(cls: schema.Class, prop: schema.Property):
 
 
 def get_ql_class(cls: schema.Class):
+    pragmas = {k: True for k in cls.pragmas if k.startswith("ql")}
     return ql.Class(
         name=cls.name,
         bases=cls.bases,
         final=not cls.derived,
         properties=[get_ql_property(cls, p) for p in cls.properties],
         dir=cls.dir,
-        skip_qltest="skip_qltest" in cls.pragmas,
+        **pragmas,
     )
 
 
@@ -143,7 +144,7 @@ def _get_all_properties_to_be_tested(cls: ql.Class, lookup: typing.Dict[str, ql.
     # deduplicate using id
     already_seen = set()
     for c, p in _get_all_properties(cls, lookup):
-        if not (c.skip_qltest or p.skip_qltest or id(p) in already_seen):
+        if not (c.qltest_skip or p.qltest_skip or id(p) in already_seen):
             already_seen.add(id(p))
             yield ql.PropertyForTest(p.getter, p.type, p.is_single, p.is_predicate, p.is_repeated)
 
@@ -156,6 +157,20 @@ def _partition(l, pred):
     return res
 
 
+def _is_in_qltest_collapsed_hierachy(cls: ql.Class, lookup: typing.Dict[str, ql.Class]):
+    return cls.qltest_collapse_hierarchy or _is_under_qltest_collapsed_hierachy(cls, lookup)
+
+
+def _is_under_qltest_collapsed_hierachy(cls: ql.Class, lookup: typing.Dict[str, ql.Class]):
+    return not cls.qltest_uncollapse_hierarchy and any(
+        _is_in_qltest_collapsed_hierachy(lookup[b], lookup) for b in cls.bases)
+
+
+def _should_skip_qltest(cls: ql.Class, lookup: typing.Dict[str, ql.Class]):
+    return cls.qltest_skip or not (cls.final or cls.qltest_collapse_hierarchy) or _is_under_qltest_collapsed_hierachy(
+        cls, lookup)
+
+
 def generate(opts, renderer):
     input = opts.schema
     out = opts.ql_output
@@ -196,7 +211,7 @@ def generate(opts, renderer):
         classes), out / 'GetImmediateParent.qll')
 
     for c in classes:
-        if not c.final or c.skip_qltest:
+        if _should_skip_qltest(c, lookup):
             continue
         test_dir = test_out / c.path
         test_dir.mkdir(parents=True, exist_ok=True)

swift/codegen/lib/ql.py

@@ -37,7 +37,7 @@ class Property:
     is_optional: bool = False
     is_predicate: bool = False
     is_child: bool = False
-    skip_qltest: bool = False
+    qltest_skip: bool = False
 
     def __post_init__(self):
         if self.tableparams:
@@ -79,7 +79,9 @@ class Class:
     properties: List[Property] = field(default_factory=list)
     dir: pathlib.Path = pathlib.Path()
     imports: List[str] = field(default_factory=list)
-    skip_qltest: bool = False
+    qltest_skip: bool = False
+    qltest_collapse_hierarchy: bool = False
+    qltest_uncollapse_hierarchy: bool = False
 
     def __post_init__(self):
         self.bases = sorted(self.bases)

swift/codegen/test/test_qlgen.py

@@ -480,13 +480,13 @@ def test_test_properties_skipped(opts, generate_tests):
     write(opts.ql_test_output / "Derived" / "test.swift")
     assert generate_tests([
         schema.Class("Base", derived={"Derived"}, properties=[
-            schema.SingleProperty("x", "string", pragmas=["skip_qltest", "foo"]),
-            schema.RepeatedProperty("y", "int", pragmas=["bar", "skip_qltest"]),
+            schema.SingleProperty("x", "string", pragmas=["qltest_skip", "foo"]),
+            schema.RepeatedProperty("y", "int", pragmas=["bar", "qltest_skip"]),
         ]),
         schema.Class("Derived", bases={"Base"}, properties=[
-            schema.PredicateProperty("a", pragmas=["skip_qltest"]),
+            schema.PredicateProperty("a", pragmas=["qltest_skip"]),
             schema.OptionalProperty(
-                "b", "int", pragmas=["bar", "skip_qltest", "baz"]),
+                "b", "int", pragmas=["bar", "qltest_skip", "baz"]),
         ]),
     ]) == {
         "Derived/Derived.ql": ql.ClassTester(class_name="Derived"),
@@ -496,7 +496,7 @@ def test_test_properties_skipped(opts, generate_tests):
 def test_test_base_class_skipped(opts, generate_tests):
     write(opts.ql_test_output / "Derived" / "test.swift")
     assert generate_tests([
-        schema.Class("Base", derived={"Derived"}, pragmas=["skip_qltest", "foo"], properties=[
+        schema.Class("Base", derived={"Derived"}, pragmas=["qltest_skip", "foo"], properties=[
             schema.SingleProperty("x", "string"),
             schema.RepeatedProperty("y", "int"),
         ]),
@@ -510,12 +510,54 @@ def test_test_final_class_skipped(opts, generate_tests):
     write(opts.ql_test_output / "Derived" / "test.swift")
     assert generate_tests([
         schema.Class("Base", derived={"Derived"}),
-        schema.Class("Derived", bases={"Base"}, pragmas=["skip_qltest", "foo"], properties=[
+        schema.Class("Derived", bases={"Base"}, pragmas=["qltest_skip", "foo"], properties=[
             schema.SingleProperty("x", "string"),
             schema.RepeatedProperty("y", "int"),
         ]),
     ]) == {}
 
 
+def test_test_class_hierarchy_collapse(opts, generate_tests):
+    write(opts.ql_test_output / "Base" / "test.swift")
+    assert generate_tests([
+        schema.Class("Base", derived={"D1", "D2"}, pragmas=["foo", "qltest_collapse_hierarchy"]),
+        schema.Class("D1", bases={"Base"}, properties=[schema.SingleProperty("x", "string")]),
+        schema.Class("D2", bases={"Base"}, derived={"D3"}, properties=[schema.SingleProperty("y", "string")]),
+        schema.Class("D3", bases={"D2"}, properties=[schema.SingleProperty("z", "string")]),
+    ]) == {
+        "Base/Base.ql": ql.ClassTester(class_name="Base"),
+    }
+
+
+def test_test_class_hierarchy_uncollapse(opts, generate_tests):
+    for d in ("Base", "D3", "D4"):
+        write(opts.ql_test_output / d / "test.swift")
+    assert generate_tests([
+        schema.Class("Base", derived={"D1", "D2"}, pragmas=["foo", "qltest_collapse_hierarchy"]),
+        schema.Class("D1", bases={"Base"}, properties=[schema.SingleProperty("x", "string")]),
+        schema.Class("D2", bases={"Base"}, derived={"D3", "D4"}, pragmas=["qltest_uncollapse_hierarchy", "bar"]),
+        schema.Class("D3", bases={"D2"}),
+        schema.Class("D4", bases={"D2"}),
+    ]) == {
+        "Base/Base.ql": ql.ClassTester(class_name="Base"),
+        "D3/D3.ql": ql.ClassTester(class_name="D3"),
+        "D4/D4.ql": ql.ClassTester(class_name="D4"),
+    }
+
+
+def test_test_class_hierarchy_uncollapse_at_final(opts, generate_tests):
+    for d in ("Base", "D3"):
+        write(opts.ql_test_output / d / "test.swift")
+    assert generate_tests([
+        schema.Class("Base", derived={"D1", "D2"}, pragmas=["foo", "qltest_collapse_hierarchy"]),
+        schema.Class("D1", bases={"Base"}, properties=[schema.SingleProperty("x", "string")]),
+        schema.Class("D2", bases={"Base"}, derived={"D3"}),
+        schema.Class("D3", bases={"D2"}, pragmas=["qltest_uncollapse_hierarchy", "bar"]),
+    ]) == {
+        "Base/Base.ql": ql.ClassTester(class_name="Base"),
+        "D3/D3.ql": ql.ClassTester(class_name="D3"),
+    }
+
+
 if __name__ == '__main__':
     sys.exit(pytest.main([__file__] + sys.argv[1:]))

swift/ql/test/extractor-tests/generated/File/File.ql

@@ -2,9 +2,10 @@
 import codeql.swift.elements
 import TestUtils
 
-from File x, string getName
+from File x, string isUnknown, string getName
 where
   toBeTested(x) and
   not x.isUnknown() and
+  (if x.isUnknown() then isUnknown = "yes" else isUnknown = "no") and
   getName = x.getName()
-select x, "getName:", getName
+select x, "isUnknown:", isUnknown, "getName:", getName

swift/ql/test/extractor-tests/generated/Location/MISSING_SOURCE.txt

@@ -0,0 +1,4 @@
+// generated by codegen/codegen.py
+
+After a swift source file is added in this directory and codegen/codegen.py is run again, test queries
+will appear and this file will be deleted

swift/ql/test/extractor-tests/generated/decl/AccessorDecl/AccessorDecl.ql

@@ -3,16 +3,17 @@ import codeql.swift.elements
 import TestUtils
 
 from
-  AccessorDecl x, Type getInterfaceType, string getName, string isGetter, string isSetter,
-  string isWillSet, string isDidSet
+  AccessorDecl x, string isUnknown, Type getInterfaceType, string getName, string isGetter,
+  string isSetter, string isWillSet, string isDidSet
 where
   toBeTested(x) and
   not x.isUnknown() and
+  (if x.isUnknown() then isUnknown = "yes" else isUnknown = "no") and
   getInterfaceType = x.getInterfaceType() and
   getName = x.getName() and
   (if x.isGetter() then isGetter = "yes" else isGetter = "no") and
   (if x.isSetter() then isSetter = "yes" else isSetter = "no") and
   (if x.isWillSet() then isWillSet = "yes" else isWillSet = "no") and
   if x.isDidSet() then isDidSet = "yes" else isDidSet = "no"
-select x, "getInterfaceType:", getInterfaceType, "getName:", getName, "isGetter:", isGetter,
-  "isSetter:", isSetter, "isWillSet:", isWillSet, "isDidSet:", isDidSet
+select x, "isUnknown:", isUnknown, "getInterfaceType:", getInterfaceType, "getName:", getName,
+  "isGetter:", isGetter, "isSetter:", isSetter, "isWillSet:", isWillSet, "isDidSet:", isDidSet

swift/ql/test/extractor-tests/generated/decl/AccessorDecl/AccessorDecl_getLocation.ql

@@ -0,0 +1,7 @@
+// generated by codegen/codegen.py
+import codeql.swift.elements
+import TestUtils
+
+from AccessorDecl x
+where toBeTested(x) and not x.isUnknown()
+select x, x.getLocation()

swift/ql/test/extractor-tests/generated/decl/AssociatedTypeDecl/AssociatedTypeDecl.ql

@@ -2,10 +2,11 @@
 import codeql.swift.elements
 import TestUtils
 
-from AssociatedTypeDecl x, Type getInterfaceType, string getName
+from AssociatedTypeDecl x, string isUnknown, Type getInterfaceType, string getName
 where
   toBeTested(x) and
   not x.isUnknown() and
+  (if x.isUnknown() then isUnknown = "yes" else isUnknown = "no") and
   getInterfaceType = x.getInterfaceType() and
   getName = x.getName()
-select x, "getInterfaceType:", getInterfaceType, "getName:", getName
+select x, "isUnknown:", isUnknown, "getInterfaceType:", getInterfaceType, "getName:", getName

swift/ql/test/extractor-tests/generated/decl/AssociatedTypeDecl/AssociatedTypeDecl_getLocation.ql

@@ -0,0 +1,7 @@
+// generated by codegen/codegen.py
+import codeql.swift.elements
+import TestUtils
+
+from AssociatedTypeDecl x
+where toBeTested(x) and not x.isUnknown()
+select x, x.getLocation()

swift/ql/test/extractor-tests/generated/decl/ClassDecl/ClassDecl.ql

@@ -2,11 +2,13 @@
 import codeql.swift.elements
 import TestUtils
 
-from ClassDecl x, Type getInterfaceType, string getName, Type getType
+from ClassDecl x, string isUnknown, Type getInterfaceType, string getName, Type getType
 where
   toBeTested(x) and
   not x.isUnknown() and
+  (if x.isUnknown() then isUnknown = "yes" else isUnknown = "no") and
   getInterfaceType = x.getInterfaceType() and
   getName = x.getName() and
   getType = x.getType()
-select x, "getInterfaceType:", getInterfaceType, "getName:", getName, "getType:", getType
+select x, "isUnknown:", isUnknown, "getInterfaceType:", getInterfaceType, "getName:", getName,
+  "getType:", getType