Merge pull request #15385 from geoffw0/swiftfiles

Swift: Report any extracted file as successfully extracted

Author: geoffw0

swift/ql/lib/codeql/swift/elements/File.qll

@@ -32,4 +32,23 @@ class File extends Generated::File {
         )
       )
   }
+
+  /**
+   * Gets the relative path of this file from the root folder of the
+   * analyzed source location. The relative path of the root folder itself
+   * would be the empty string.
+   *
+   * This has no result if the file is outside the source root, that is,
+   * if the root folder is not a reflexive, transitive parent of this file.
+   */
+  string getRelativePath() {
+    exists(string absPath, string pref |
+      absPath = this.getAbsolutePath() and sourceLocationPrefix(pref)
+    |
+      absPath = pref and result = ""
+      or
+      absPath = pref.regexpReplaceAll("/$", "") + "/" + result and
+      not result.matches("/%")
+    )
+  }
 }

swift/ql/src/change-notes/2024-01-19-extracted-files.md

@@ -0,0 +1,4 @@
+---
+category: minorAnalysis
+---
+* The diagnostic query `swift/diagnostics/successfully-extracted-files` now considers any Swift file seen during extraction, even one with some errors, to be extracted / scanned. This affects the Code Scanning UI measure of scanned Swift files.

swift/ql/src/diagnostics/SuccessfullyExtractedFiles.ql renamed to swift/ql/src/diagnostics/ExtractedFiles.ql

@@ -1,6 +1,6 @@
 /**
- * @name Successfully extracted files
- * @description Lists all files in the source code directory that were extracted without encountering a problem in the file.
+ * @name Extracted files
+ * @description Lists all files in the source code directory that were extracted.
  * @kind diagnostic
  * @id swift/diagnostics/successfully-extracted-files
  * @tags successfully-extracted-files
@@ -9,5 +9,5 @@
 import swift
 
 from File f
-where f.isSuccessfullyExtracted()
+where exists(f.getRelativePath())
 select f, "File successfully extracted."

swift/ql/test/query-tests/Diagnostics/ExtractedFiles.expected

@@ -0,0 +1,2 @@
+| error.swift:0:0:0:0 | error.swift | File successfully extracted. |
+| main.swift:0:0:0:0 | main.swift | File successfully extracted. |

swift/ql/test/query-tests/Diagnostics/ExtractedFiles.qlref

@@ -0,0 +1 @@
+diagnostics/ExtractedFiles.ql

swift/ql/test/query-tests/Diagnostics/Info.expected

@@ -0,0 +1,3 @@
+| error.swift:0:0:0:0 | error.swift | query-tests/Diagnostics/error.swift |  |
+| file://:0:0:0:0 |  |  |  |
+| main.swift:0:0:0:0 | main.swift | query-tests/Diagnostics/main.swift | isSuccessfullyExtracted |

swift/ql/test/query-tests/Diagnostics/Info.ql

@@ -0,0 +1,6 @@
+import swift
+
+string describe(File f) { (f.isSuccessfullyExtracted() and result = "isSuccessfullyExtracted") }
+
+from File f
+select f, concat(f.getRelativePath(), ", "), concat(describe(f), ", ")