Merge pull request #9729 from github/redsun82/swift-extraction

Swift: extract `ProtocolCompositionType` and all `BuiltinType`s

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/schema.yml

@@ -14,22 +14,22 @@ _directories:
 
 Element:
   is_unknown: predicate
-  _pragma: skip_qltest
+  _pragma: qltest_skip
 
 File:
   name: string
 
 Locatable:
   location: Location?
-  _pragma: skip_qltest
+  _pragma: qltest_skip
 
 Location:
   file: File
   start_line: int
   start_column: int
   end_line: int
   end_column: int
-  _pragma: skip_qltest
+  _pragma: qltest_skip
 
 Type:
   diagnostics_name: string
@@ -85,6 +85,7 @@ AnyMetatypeType:
 
 BuiltinType:
   _extends: Type
+  _pragma: qltest_collapse_hierarchy
 
 DependentMemberType:
   _extends: Type
@@ -114,6 +115,7 @@ PlaceholderType:
 
 ProtocolCompositionType:
   _extends: Type
+  members: Type*
 
 ExistentialType:
   _extends: Type
@@ -393,7 +395,7 @@ EnumIsCaseExpr:
 
 ErrorExpr:
   _extends: Expr
-  _pragma: skip_qltest  # unexpected emission
+  _pragma: qltest_skip  # unexpected emission
 
 ExplicitCastExpr:
   _extends: Expr
@@ -468,7 +470,7 @@ ObjCSelectorExpr:
   _children:
     sub_expr: Expr
   method: AbstractFunctionDecl
-  _pragma: skip_qltest  # to be tested in integration tests
+  _pragma: qltest_skip  # to be tested in integration tests
 
 OneWayExpr:
   _extends: Expr
@@ -510,7 +512,7 @@ SequenceExpr:
   _extends: Expr
   _children:
     elements: Expr*
-  _pragma: skip_qltest  # we should really never extract these, as these should be resolved to trees of operations
+  _pragma: qltest_skip  # we should really never extract these, as these should be resolved to trees of operations
 
 SuperRefExpr:
   _extends: Expr
@@ -542,7 +544,7 @@ TypeExpr:
 UnresolvedDeclRefExpr:
   _extends: Expr
   name: string?
-  _pragma: skip_qltest  # we should really never extract these
+  _pragma: qltest_skip  # we should really never extract these
 
 UnresolvedDotExpr:
   _extends: Expr
@@ -553,15 +555,15 @@ UnresolvedDotExpr:
 UnresolvedMemberExpr:
   _extends: Expr
   name: string
-  _pragma: skip_qltest  # we should really never extract these
+  _pragma: qltest_skip  # we should really never extract these
 
 UnresolvedPatternExpr:
   _extends: Expr
-  _pragma: skip_qltest  # we should really never extract these
+  _pragma: qltest_skip  # we should really never extract these
 
 UnresolvedSpecializeExpr:
   _extends: Expr
-  _pragma: skip_qltest  # we should really never extract these
+  _pragma: qltest_skip  # we should really never extract these
 
 VarargExpansionExpr:
   _extends: Expr
@@ -698,6 +700,7 @@ BuiltinIntegerLiteralType:
 
 BuiltinIntegerType:
   _extends: AnyBuiltinIntegerType
+  _pragma: qltest_uncollapse_hierarchy
   width: int?
 
 NestedArchetypeType:
@@ -830,11 +833,11 @@ ArrayToPointerExpr:
 
 BridgeFromObjCExpr:
   _extends: ImplicitConversionExpr
-  _pragma: skip_qltest  # to be tested in integration tests
+  _pragma: qltest_skip  # to be tested in integration tests
 
 BridgeToObjCExpr:
   _extends: ImplicitConversionExpr
-  _pragma: skip_qltest  # to be tested in integration tests
+  _pragma: qltest_skip  # to be tested in integration tests
 
 ClassMetatypeToObjectExpr:
   _extends: ImplicitConversionExpr
@@ -844,7 +847,7 @@ CollectionUpcastConversionExpr:
 
 ConditionalBridgeFromObjCExpr:
   _extends: ImplicitConversionExpr
-  _pragma: skip_qltest  # to be tested in integration tests
+  _pragma: qltest_skip  # to be tested in integration tests
 
 CovariantFunctionConversionExpr:
   _extends: ImplicitConversionExpr

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:]))