Merge pull request github#15381 from geoffw0/cppfiles

geoffw0 · web-flow · commit d19ad493139a · 2024-01-26T18:18:27.000Z
C++: Report any extracted file as successfully extracted
diff --git a/cpp/ql/src/Diagnostics/ExtractedFiles.ql b/cpp/ql/src/Diagnostics/ExtractedFiles.ql
@@ -1,16 +1,13 @@
 /**
- * @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 cpp/diagnostics/successfully-extracted-files
  * @tags successfully-extracted-files
  */
 
 import cpp
-import ExtractionProblems
 
 from File f
-where
-  not exists(ExtractionProblem e | e.getFile() = f) and
-  exists(f.getRelativePath())
+where exists(f.getRelativePath()) and f.fromSource()
 select f, "File successfully extracted."
diff --git a/cpp/ql/src/change-notes/2024-01-19-extracted-files.md b/cpp/ql/src/change-notes/2024-01-19-extracted-files.md
@@ -0,0 +1,4 @@
+---
+category: minorAnalysis
+---
+* The diagnostic query `cpp/diagnostics/successfully-extracted-files` now considers any C/C++ file seen during extraction, even one with some errors, to be extracted / scanned. This affects the Code Scanning UI measure of scanned C/C++ files.
diff --git a/cpp/ql/test/query-tests/Diagnostics/ExtractedFiles.expected b/cpp/ql/test/query-tests/Diagnostics/ExtractedFiles.expected
@@ -0,0 +1,5 @@
+| containserror.cpp:0:0:0:0 | containserror.cpp | File successfully extracted. |
+| containswarning.cpp:0:0:0:0 | containswarning.cpp | File successfully extracted. |
+| doesnotcompile.cpp:0:0:0:0 | doesnotcompile.cpp | File successfully extracted. |
+| header.h:0:0:0:0 | header.h | File successfully extracted. |
+| successful.cpp:0:0:0:0 | successful.cpp | File successfully extracted. |
diff --git a/cpp/ql/test/query-tests/Diagnostics/ExtractedFiles.qlref b/cpp/ql/test/query-tests/Diagnostics/ExtractedFiles.qlref
@@ -0,0 +1 @@
+Diagnostics/ExtractedFiles.ql
diff --git a/cpp/ql/test/query-tests/Diagnostics/ExtractionErrors.expected b/cpp/ql/test/query-tests/Diagnostics/ExtractionErrors.expected
@@ -0,0 +1,2 @@
+| doesnotcompile.cpp:4:2:4:2 | Recoverable extraction error: identifier 'This' is undefined | Extraction failed in doesnotcompile.cpp with error "doesnotcompile.cpp", line 4: error: identifier "This" is undefined\n  \tThis is not correct C/C++ code.\n  \t^\n\n | 2 |
+| doesnotcompile.cpp:4:10:4:10 | Recoverable extraction error: expected a ';' | Extraction failed in doesnotcompile.cpp with error "doesnotcompile.cpp", line 4: error: expected a ";"\n  \tThis is not correct C/C++ code.\n  \t        ^\n\n | 2 |
diff --git a/cpp/ql/test/query-tests/Diagnostics/ExtractionErrors.qlref b/cpp/ql/test/query-tests/Diagnostics/ExtractionErrors.qlref
@@ -0,0 +1 @@
+Diagnostics/Internal/ExtractionErrors.ql
diff --git a/cpp/ql/test/query-tests/Diagnostics/ExtractionWarnings.expected b/cpp/ql/test/query-tests/Diagnostics/ExtractionWarnings.expected
@@ -0,0 +1,2 @@
+| doesnotcompile.cpp:4:2:4:2 | Recoverable extraction error: identifier 'This' is undefined | Extraction failed in doesnotcompile.cpp with warning "doesnotcompile.cpp", line 4: error: identifier "This" is undefined\n  \tThis is not correct C/C++ code.\n  \t^\n\n | 1 |
+| doesnotcompile.cpp:4:10:4:10 | Recoverable extraction error: expected a ';' | Extraction failed in doesnotcompile.cpp with warning "doesnotcompile.cpp", line 4: error: expected a ";"\n  \tThis is not correct C/C++ code.\n  \t        ^\n\n | 1 |
diff --git a/cpp/ql/test/query-tests/Diagnostics/ExtractionWarnings.qlref b/cpp/ql/test/query-tests/Diagnostics/ExtractionWarnings.qlref
@@ -0,0 +1 @@
+Diagnostics/ExtractionWarnings.ql
diff --git a/cpp/ql/test/query-tests/Diagnostics/FailedExtractorInvocations.expected b/cpp/ql/test/query-tests/Diagnostics/FailedExtractorInvocations.expected
diff --git a/cpp/ql/test/query-tests/Diagnostics/FailedExtractorInvocations.qlref b/cpp/ql/test/query-tests/Diagnostics/FailedExtractorInvocations.qlref
@@ -0,0 +1 @@
+Diagnostics/FailedExtractorInvocations.ql
diff --git a/cpp/ql/test/query-tests/Diagnostics/Info.expected b/cpp/ql/test/query-tests/Diagnostics/Info.expected
@@ -0,0 +1,6 @@
+| containserror.cpp:0:0:0:0 | containserror.cpp | query-tests/Diagnostics/containserror.cpp | fromSource, normalTermination |
+| containswarning.cpp:0:0:0:0 | containswarning.cpp | query-tests/Diagnostics/containswarning.cpp | fromSource, normalTermination |
+| doesnotcompile.cpp:0:0:0:0 | doesnotcompile.cpp | query-tests/Diagnostics/doesnotcompile.cpp | ExtractionProblem (severity 1), fromSource, normalTermination |
+| file://:0:0:0:0 |  |  |  |
+| header.h:0:0:0:0 | header.h | query-tests/Diagnostics/header.h | fromSource |
+| successful.cpp:0:0:0:0 | successful.cpp | query-tests/Diagnostics/successful.cpp | fromSource, normalTermination |
diff --git a/cpp/ql/test/query-tests/Diagnostics/Info.ql b/cpp/ql/test/query-tests/Diagnostics/Info.ql
@@ -0,0 +1,17 @@
+import cpp
+import Diagnostics.ExtractionProblems
+
+string describe(File f) {
+  exists(ExtractionProblem e | e.getFile() = f |
+    result = "ExtractionProblem (severity " + e.getSeverity().toString() + ")"
+  )
+  or
+  f.fromSource() and result = "fromSource"
+  or
+  exists(Compilation c | c.getAFileCompiled() = f |
+    (c.normalTermination() and result = "normalTermination")
+  )
+}
+
+from File f
+select f, concat(f.getRelativePath(), ", "), concat(describe(f), ", ")
diff --git a/cpp/ql/test/query-tests/Diagnostics/containserror.cpp b/cpp/ql/test/query-tests/Diagnostics/containserror.cpp
@@ -0,0 +1,5 @@
+// semmle-extractor-options: --expect_errors
+
+void containserror() {
+	#error An error!
+}
diff --git a/cpp/ql/test/query-tests/Diagnostics/containswarning.cpp b/cpp/ql/test/query-tests/Diagnostics/containswarning.cpp
@@ -0,0 +1,4 @@
+
+void containswarning() {
+	#warning A warning.
+}
diff --git a/cpp/ql/test/query-tests/Diagnostics/doesnotcompile.cpp b/cpp/ql/test/query-tests/Diagnostics/doesnotcompile.cpp
@@ -0,0 +1,5 @@
+// semmle-extractor-options: --expect_errors
+
+void doesnotcompile() {
+	This is not correct C/C++ code.
+}
diff --git a/cpp/ql/test/query-tests/Diagnostics/header.h b/cpp/ql/test/query-tests/Diagnostics/header.h
@@ -0,0 +1,2 @@
+
+// a header file
diff --git a/cpp/ql/test/query-tests/Diagnostics/successful.cpp b/cpp/ql/test/query-tests/Diagnostics/successful.cpp
@@ -0,0 +1,5 @@
+
+#include "header.h"
+
+void successful() {
+}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +---
 +category: minorAnalysis
 +---
 +* The diagnostic query `cpp/diagnostics/successfully-extracted-files` now considers any C/C++ file seen during extraction, even one with some errors, to be extracted / scanned. This affects the Code Scanning UI measure of scanned C/C++ files.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+\| doesnotcompile.cpp:4:2:4:2 \| Recoverable extraction error: identifier 'This' is undefined \| Extraction failed in doesnotcompile.cpp with error "doesnotcompile.cpp", line 4: error: identifier "This" is undefined\n \tThis is not correct C/C++ code.\n \t^\n\n \| 2 \|`
	`2`	`+\| doesnotcompile.cpp:4:10:4:10 \| Recoverable extraction error: expected a ';' \| Extraction failed in doesnotcompile.cpp with error "doesnotcompile.cpp", line 4: error: expected a ";"\n \tThis is not correct C/C++ code.\n \t ^\n\n \| 2 \|`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Diagnostics/Internal/ExtractionErrors.ql`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Diagnostics/FailedExtractorInvocations.ql`