Merge pull request github#12489 from geoffw0/typealiastests

geoffw0 · web-flow · commit e4837f7da90a · 2023-03-13T10:38:43.000Z
Swift: Skeleton + tests for type alias support
diff --git a/swift/ql/.generated.list b/swift/ql/.generated.list
@@ -352,7 +352,6 @@ ql/lib/codeql/swift/elements/type/SugarType.qll 0833a0f1bd26b066817f55df7a58243d
 ql/lib/codeql/swift/elements/type/SyntaxSugarType.qll 699fe9b4805494b62416dc86098342a725020f59a649138e6f5ba405dd536db5 a7a002cf597c3e3d0fda67111116c61a80f1e66ab8db8ddb3e189c6f15cadda6
 ql/lib/codeql/swift/elements/type/TupleType.qll 1dc14882028be534d15e348fba318c0bb1b52e692ca833987e00c9a66a1921ad 0b34c17ce9db336d0be9a869da988f31f10f754d6ffab6fa88791e508044edd2
 ql/lib/codeql/swift/elements/type/TupleTypeConstructor.qll 060633b22ee9884cb98103b380963fac62a02799461d342372cfb9cc6303d693 c9a89f695c85e7e22947287bcc32909b1f701168fd89c3598a45c97909e879f4
-ql/lib/codeql/swift/elements/type/TypeAliasType.qll 8149cc01f6d47ab10c0e20f1892af5e5d778e11a76be5f4752ad349a4c5b4fa4 760c79b9b581cc645f1002ca892656d406d3d339267fd58e765738257dbb45ce
 ql/lib/codeql/swift/elements/type/TypeAliasTypeConstructor.qll f63ada921beb95d5f3484ab072aa4412e93adfc8e7c0b1637273f99356f5cb13 f90d2789f7c922bc8254a0d131e36b40db1e00f9b32518633520d5c3341cd70a
 ql/lib/codeql/swift/elements/type/TypeReprConstructor.qll 2bb9c5ece40c6caed9c3a614affc0efd47ad2309c09392800ad346bf369969bf 30429adc135eb8fc476bc9bc185cff0a4119ddc0e618368c44f4a43246b5287f
 ql/lib/codeql/swift/elements/type/UnarySyntaxSugarType.qll 712c7e75b8169a80a44a6609da7f5a39cc4f36773eb520c8824ea09295c6929c 0b113b1a7834779fabfa046a64c6d256cde0f510edb84da253e89d36f41f8241
diff --git a/swift/ql/lib/codeql/swift/elements/type/Type.qll b/swift/ql/lib/codeql/swift/elements/type/Type.qll
@@ -2,4 +2,13 @@ private import codeql.swift.generated.type.Type
 
 class Type extends Generated::Type {
   override string toString() { result = this.getName() }
+
+  /**
+   * Gets this type after any type aliases have been resolved. For example in
+   * the following code, the underlying type of `MyInt` is `Int`:
+   * ```
+   * typealias MyInt = Int
+   * ```
+   */
+  Type getUnderlyingType() { result = this }
 }
diff --git a/swift/ql/lib/codeql/swift/elements/type/TypeAliasType.qll b/swift/ql/lib/codeql/swift/elements/type/TypeAliasType.qll
@@ -1,4 +1,16 @@
-// generated by codegen/codegen.py, remove this comment if you wish to edit this file
+private import codeql.swift.elements.type.Type
 private import codeql.swift.generated.type.TypeAliasType
 
-class TypeAliasType extends Generated::TypeAliasType { }
+class TypeAliasType extends Generated::TypeAliasType {
+  /**
+   * Gets the aliased type of this type alias type.
+   *
+   * For example the aliased type of `MyInt` in the following code is `Int`:
+   * ```
+   * typealias MyInt = Int
+   * ```
+   */
+  Type getAliasedType() { none() } // TODO: not yet implemented.
+
+  override Type getUnderlyingType() { result = this } // TODO: not yet implemented.
+}
diff --git a/swift/ql/test/extractor-tests/declarations/all.expected b/swift/ql/test/extractor-tests/declarations/all.expected
diff --git a/swift/ql/test/extractor-tests/declarations/all.ql b/swift/ql/test/extractor-tests/declarations/all.ql
@@ -1,5 +1,10 @@
 import swift
 
+string describe(Decl decl) {
+  //result = "getAliasedType:" + decl.(TypeAliasDecl).getAliasedType().toString() TODO: not yet implemented
+  none()
+}
+
 from Decl decl
 where decl.getLocation().getFile().getName().matches("%swift/ql/test%")
-select decl
+select decl, concat(describe(decl), ", ")
diff --git a/swift/ql/test/extractor-tests/declarations/declarations.swift b/swift/ql/test/extractor-tests/declarations/declarations.swift
@@ -178,3 +178,7 @@ func ifConfig() {
   12
   #endif
 }
+
+class B {}
+typealias A = B
+typealias C = Int?
diff --git a/swift/ql/test/library-tests/ast/PrintAst.expected b/swift/ql/test/library-tests/ast/PrintAst.expected
@@ -4218,6 +4218,20 @@ declarations.swift:
 #  173|     getElement(5): [IfConfigDecl] #if ...
 #  174|     getElement(6): [IntegerLiteralExpr] 9
 #  175|     getElement(7): [IntegerLiteralExpr] 10
+#  182| [ClassDecl] B
+#  182|   getMember(0): [DestructorDecl] B.deinit()
+#  182|       InterfaceType = (B) -> () -> ()
+#  182|     getSelfParam(): [ParamDecl] self
+#  182|         Type = B
+#  182|     getBody(): [BraceStmt] { ... }
+#  182|   getMember(1): [ConstructorDecl] B.init()
+#  182|       InterfaceType = (B.Type) -> () -> B
+#  182|     getSelfParam(): [ParamDecl] self
+#  182|         Type = B
+#  182|     getBody(): [BraceStmt] { ... }
+#  182|       getElement(0): [ReturnStmt] return
+#  183| [TypeAliasDecl] A
+#  184| [TypeAliasDecl] C
 expressions.swift:
 #    1| [TopLevelCodeDecl] { ... }
 #    1|   getBody(): [BraceStmt] { ... }
diff --git a/swift/ql/test/library-tests/ast/declarations.swift b/swift/ql/test/library-tests/ast/declarations.swift
@@ -178,3 +178,7 @@ func ifConfig() {
   12
   #endif
 }
+
+class B {}
+typealias A = B
+typealias C = Int?
diff --git a/swift/ql/test/library-tests/elements/type/nominaltype/nominaltype.expected b/swift/ql/test/library-tests/elements/type/nominaltype/nominaltype.expected
@@ -0,0 +1,13 @@
+| nominaltype.swift:35:6:35:6 | a | A | A |  |
+| nominaltype.swift:36:6:36:6 | a_alias | A_alias | A_alias |  |
+| nominaltype.swift:37:6:37:6 | a_optional_alias | A_optional_alias | A_optional_alias |  |
+| nominaltype.swift:38:6:38:6 | b1 | B1 | B1 | getABaseType:A |
+| nominaltype.swift:39:6:39:6 | b2 | B2 | B2 |  |
+| nominaltype.swift:40:6:40:6 | b1_alias | B1_alias | B1_alias |  |
+| nominaltype.swift:41:6:41:6 | b2_alias | B2_alias | B2_alias |  |
+| nominaltype.swift:42:6:42:6 | p | P | P |  |
+| nominaltype.swift:43:6:43:6 | p_alias | P_alias | P_alias |  |
+| nominaltype.swift:44:6:44:6 | c1 | C1 | C1 | getABaseType:P |
+| nominaltype.swift:45:6:45:6 | c2 | C2 | C2 |  |
+| nominaltype.swift:46:6:46:6 | c1_alias | C1_alias | C1_alias |  |
+| nominaltype.swift:47:6:47:6 | c2_alias | C2_alias | C2_alias |  |
diff --git a/swift/ql/test/library-tests/elements/type/nominaltype/nominaltype.ql b/swift/ql/test/library-tests/elements/type/nominaltype/nominaltype.ql
@@ -0,0 +1,14 @@
+import swift
+
+string describe(Type t) {
+  result = "getAliasedType:" + t.(TypeAliasType).getAliasedType()
+  or
+  result = "getABaseType:" + t.(NominalType).getABaseType()
+}
+
+from VarDecl v, Type t
+where
+  v.getLocation().getFile().getBaseName() != "" and
+  not v.getName() = "self" and
+  t = v.getType()
+select v, t.toString(), t.getUnderlyingType(), concat(describe(t), ", ")
diff --git a/swift/ql/test/library-tests/elements/type/nominaltype/nominaltype.swift b/swift/ql/test/library-tests/elements/type/nominaltype/nominaltype.swift
@@ -0,0 +1,48 @@
+
+class A {
+}
+
+typealias A_alias = A
+
+typealias A_optional_alias = A?
+
+class B1 : A {
+}
+
+class B2 : A_alias {
+}
+
+typealias B1_alias = B1
+
+typealias B2_alias = B2
+
+protocol P {
+}
+
+typealias P_alias = P
+
+class C1 : P {
+}
+
+class C2 : P_alias {
+}
+
+typealias C1_alias = C1
+
+typealias C2_alias = C2
+
+func test() {
+	var a : A
+	var a_alias : A_alias
+	var a_optional_alias : A_optional_alias
+	var b1 : B1
+	var b2 : B2
+	var b1_alias : B1_alias
+	var b2_alias : B2_alias
+	var p : P
+	var p_alias : P_alias
+	var c1 : C1
+	var c2 : C2
+	var c1_alias : C1_alias
+	var c2_alias : C2_alias
+}
diff --git a/swift/ql/test/library-tests/elements/type/nominaltype/nominaltypedecl.expected b/swift/ql/test/library-tests/elements/type/nominaltype/nominaltypedecl.expected
@@ -0,0 +1,11 @@
+| nominaltype.swift:35:6:35:6 | a | A |  |
+| nominaltype.swift:36:6:36:6 | a_alias | A_alias |  |
+| nominaltype.swift:37:6:37:6 | a_optional_alias | A_optional_alias |  |
+| nominaltype.swift:38:6:38:6 | b1 | B1 | getABaseType:A |
+| nominaltype.swift:39:6:39:6 | b2 | B2 | getABaseType:A_alias |
+| nominaltype.swift:40:6:40:6 | b1_alias | B1_alias |  |
+| nominaltype.swift:41:6:41:6 | b2_alias | B2_alias |  |
+| nominaltype.swift:44:6:44:6 | c1 | C1 | getABaseType:P |
+| nominaltype.swift:45:6:45:6 | c2 | C2 | getABaseType:P_alias |
+| nominaltype.swift:46:6:46:6 | c1_alias | C1_alias |  |
+| nominaltype.swift:47:6:47:6 | c2_alias | C2_alias |  |
diff --git a/swift/ql/test/library-tests/elements/type/nominaltype/nominaltypedecl.ql b/swift/ql/test/library-tests/elements/type/nominaltype/nominaltypedecl.ql
@@ -0,0 +1,17 @@
+import swift
+
+string describe(TypeDecl td) {
+  //result = "getAliasedType:" + td.(TypeAliasDecl).getAliasedType() TODO: not yet implemented.
+  //or
+  result = "getABaseType:" + td.(NominalTypeDecl).getABaseType()
+}
+
+from VarDecl v, TypeDecl td
+where
+  v.getLocation().getFile().getBaseName() != "" and
+  not v.getName() = "self" and
+  (
+    td = v.getType().(NominalType).getDeclaration() or
+    td = v.getType().(TypeAliasType).getDecl()
+  )
+select v, td.toString(), concat(describe(td), ", ")

Original file line number	Diff line number	Diff line change
`@@ -178,3 +178,7 @@ func ifConfig() {`
`178`	`178`	`12`
`179`	`179`	`#endif`
`180`	`180`	`}`
	`181`	`+`
	`182`	`+class B {}`
	`183`	`+typealias A = B`
	`184`	`+typealias C = Int?`