Swift: Make file checking in tests more strict

jketema · jketema · commit ce5c48192ea3 · 2025-04-22T10:41:12.000+02:00
With Swift 6.1 the extractor will start to extract files outside of the test
directory. These files and their elements we do not want to see in our tests.
diff --git a/swift/ql/test/TestUtils.qll b/swift/ql/test/TestUtils.qll
@@ -6,7 +6,8 @@ import codeql.swift.elements.expr.internal.DotSyntaxCallExpr
 
 cached
 predicate toBeTested(Element e) {
-  e instanceof File
+  e instanceof File and
+  (exists(e.(File).getRelativePath()) or e instanceof UnknownFile)
   or
   e instanceof ParameterizedProtocolType
   or
diff --git a/swift/ql/test/library-tests/elements/decl/enumdecl/enumdecl.ql b/swift/ql/test/library-tests/elements/decl/enumdecl/enumdecl.ql
@@ -21,5 +21,5 @@ string describe(Decl d) {
 }
 
 from Decl d
-where d.getLocation().getFile().getName() != ""
+where exists(d.getLocation().getFile().getRelativePath())
 select d, strictconcat(describe(d), ", ")
diff --git a/swift/ql/test/library-tests/elements/decl/function/function.ql b/swift/ql/test/library-tests/elements/decl/function/function.ql
@@ -27,6 +27,6 @@ string describe(Function f) {
 
 from Function f
 where
-  not f.getFile() instanceof UnknownFile and
+  exists(f.getFile().getRelativePath()) and
   not f.getName().matches("%init%")
 select f, concat(describe(f), ", ")
diff --git a/swift/ql/test/library-tests/elements/type/nominaltype/nominaltype.ql b/swift/ql/test/library-tests/elements/type/nominaltype/nominaltype.ql
@@ -16,7 +16,7 @@ string describe(Type t) {
 
 from VarDecl v, Type t
 where
-  v.getLocation().getFile().getBaseName() != "" and
+  exists(v.getLocation().getFile().getRelativePath()) and
   not v.getName() = "self" and
   t = v.getType()
 select v, t.toString(), concat(describe(t), ", ")
diff --git a/swift/ql/test/library-tests/elements/type/nominaltype/nominaltypedecl.ql b/swift/ql/test/library-tests/elements/type/nominaltype/nominaltypedecl.ql
@@ -14,7 +14,7 @@ string describe(TypeDecl td) {
 
 from VarDecl v, TypeDecl td
 where
-  v.getLocation().getFile().getBaseName() != "" and
+  exists(v.getLocation().getFile().getRelativePath()) and
   not v.getName() = "self" and
   (
     td = v.getType().(NominalType).getDeclaration() or
diff --git a/swift/ql/test/library-tests/elements/type/numerictype/numerictype.ql b/swift/ql/test/library-tests/elements/type/numerictype/numerictype.ql
@@ -14,6 +14,6 @@ string describe(Type t) {
 
 from VarDecl v, Type t
 where
-  v.getLocation().getFile().getBaseName() != "" and
+  exists(v.getLocation().getFile().getRelativePath()) and
   t = v.getType()
 select v, t.toString(), concat(describe(t), ", ")
diff --git a/swift/ql/test/library-tests/elements/type/pointertypes/pointertypes.ql b/swift/ql/test/library-tests/elements/type/pointertypes/pointertypes.ql
@@ -22,6 +22,6 @@ string describe(Type t) {
 
 from VarDecl v, Type t
 where
-  v.getLocation().getFile().getBaseName() != "" and
+  exists(v.getLocation().getFile().getRelativePath()) and
   t = v.getType()
 select v, t.toString(), strictconcat(describe(t), ", ")
diff --git a/swift/ql/test/query-tests/Diagnostics/Info.ql b/swift/ql/test/query-tests/Diagnostics/Info.ql
@@ -3,4 +3,5 @@ import swift
 string describe(File f) { (f.isSuccessfullyExtracted() and result = "isSuccessfullyExtracted") }
 
 from File f
+where exists(f.getRelativePath()) or f instanceof UnknownFile
 select f, concat(f.getRelativePath(), ", "), concat(describe(f), ", ")

Original file line number	Diff line number	Diff line change
`@@ -21,5 +21,5 @@ string describe(Decl d) {`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`from Decl d`
`24`		`-where d.getLocation().getFile().getName() != ""`
	`24`	`+where exists(d.getLocation().getFile().getRelativePath())`
`25`	`25`	`select d, strictconcat(describe(d), ", ")`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ string describe(TypeDecl td) {`
`14`	`14`
`15`	`15`	`from VarDecl v, TypeDecl td`
`16`	`16`	`where`
`17`		`- v.getLocation().getFile().getBaseName() != "" and`
	`17`	`+ exists(v.getLocation().getFile().getRelativePath()) and`
`18`	`18`	`not v.getName() = "self" and`
`19`	`19`	`(`
`20`	`20`	`td = v.getType().(NominalType).getDeclaration() or`