Merge pull request #5740 from tamasvajk/feature/diag

C#: Add extraction error diagnostic query

Author: tamasvajk

csharp/change-notes/2021-04-23-model-error-extraction.md

@@ -0,0 +1,2 @@
+lgtm,codescanning
+* Program model errors are now extracted in standalone extraction.

csharp/extractor/Semmle.Extraction/Context.cs

@@ -376,15 +376,27 @@ private void ExtractionError(Message msg)
             Extractor.Message(msg);
         }
 
+        private void ExtractionError(InternalError error)
+        {
+            ExtractionError(new Message(error.Message, error.EntityText, CreateLocation(error.Location), error.StackTrace, Severity.Error));
+        }
+
+        private void ReportError(InternalError error)
+        {
+            if (!Extractor.Standalone)
+                throw error;
+
+            ExtractionError(error);
+        }
+
         /// <summary>
         /// Signal an error in the program model.
         /// </summary>
         /// <param name="node">The syntax node causing the failure.</param>
         /// <param name="msg">The error message.</param>
         public void ModelError(SyntaxNode node, string msg)
         {
-            if (!Extractor.Standalone)
-                throw new InternalError(node, msg);
+            ReportError(new InternalError(node, msg));
         }
 
         /// <summary>
@@ -394,8 +406,7 @@ public void ModelError(SyntaxNode node, string msg)
         /// <param name="msg">The error message.</param>
         public void ModelError(ISymbol symbol, string msg)
         {
-            if (!Extractor.Standalone)
-                throw new InternalError(symbol, msg);
+            ReportError(new InternalError(symbol, msg));
         }
 
         /// <summary>
@@ -404,8 +415,7 @@ public void ModelError(ISymbol symbol, string msg)
         /// <param name="msg">The error message.</param>
         public void ModelError(string msg)
         {
-            if (!Extractor.Standalone)
-                throw new InternalError(msg);
+            ReportError(new InternalError(msg));
         }
 
         /// <summary>

csharp/ql/src/Diagnostics/DiagnosticExtractionErrors.ql

@@ -0,0 +1,63 @@
+/**
+ * @name Extraction errors
+ * @description List all errors reported by the extractor or the compiler. Extractor errors are
+ *              limited to those files where there are no compilation errors.
+ * @kind diagnostic
+ * @id cs/diagnostics/extraction-errors
+ */
+
+import csharp
+import semmle.code.csharp.commons.Diagnostics
+
+private newtype TDiagnosticError =
+  TCompilerError(CompilerError c) or
+  TExtractorError(ExtractorError e)
+
+abstract private class DiagnosticError extends TDiagnosticError {
+  abstract string getMessage();
+
+  abstract string toString();
+
+  abstract Location getLocation();
+
+  string getLocationMessage() {
+    if getLocation().getFile().fromSource()
+    then result = " in " + getLocation().getFile()
+    else result = ""
+  }
+}
+
+private class DiagnosticCompilerError extends DiagnosticError {
+  CompilerError c;
+
+  DiagnosticCompilerError() { this = TCompilerError(c) }
+
+  override string getMessage() {
+    result = "Compiler error" + this.getLocationMessage() + ": " + c.getMessage()
+  }
+
+  override string toString() { result = c.toString() }
+
+  override Location getLocation() { result = c.getLocation() }
+}
+
+private class DiagnosticExtractorError extends DiagnosticError {
+  ExtractorError e;
+
+  DiagnosticExtractorError() {
+    this = TExtractorError(e) and
+    not exists(CompilerError ce | ce.getLocation().getFile() = e.getLocation().getFile())
+  }
+
+  override string getMessage() {
+    result =
+      "Unexpected " + e.getOrigin() + " error" + this.getLocationMessage() + ": " + e.getText()
+  }
+
+  override string toString() { result = e.toString() }
+
+  override Location getLocation() { result = e.getLocation() }
+}
+
+from DiagnosticError error
+select error.getMessage(), 2

csharp/ql/src/Diagnostics/DiagnosticNoExtractionErrors.ql

@@ -0,0 +1,17 @@
+/**
+ * @name Successfully extracted files
+ * @description A list of all files in the source code directory that were extracted
+ *              without encountering an extraction or compiler error in the file.
+ * @kind diagnostic
+ * @id cs/diagnostics/successfully-extracted-files
+ */
+
+import csharp
+import semmle.code.csharp.commons.Diagnostics
+
+from File file
+where
+  file.fromSource() and
+  not exists(ExtractorError e | e.getLocation().getFile() = file) and
+  not exists(CompilerError e | e.getLocation().getFile() = file)
+select file, ""

csharp/ql/test/library-tests/diagnostics/A.cs

@@ -0,0 +1,4 @@
+public class A
+{
+    public void M() { }
+}

csharp/ql/test/library-tests/diagnostics/DiagnosticExtractorErrors.expected

@@ -0,0 +1 @@
+| Unexpected C# extractor error in Program.cs: Unable to resolve target for call. (Compilation error?) | 2 |

csharp/ql/test/library-tests/diagnostics/DiagnosticExtractorErrors.qlref

@@ -0,0 +1 @@
+Diagnostics/DiagnosticExtractionErrors.ql

csharp/ql/test/library-tests/diagnostics/DiagnosticNoExtractorErrors.expected

@@ -0,0 +1 @@
+| A.cs:0:0:0:0 | A.cs |  |

csharp/ql/test/library-tests/diagnostics/DiagnosticNoExtractorErrors.qlref

@@ -0,0 +1 @@
+Diagnostics/DiagnosticNoExtractionErrors.ql

csharp/ql/test/library-tests/diagnostics/Program.cs

@@ -0,0 +1,17 @@
+// semmle-extractor-options: --standalone
+
+using System;
+
+class Class
+{
+    static void Main(string[] args)
+    {
+        int z = GetParamLength(__arglist(1, 2));
+    }
+
+    public static int GetParamLength(__arglist)
+    {
+        ArgIterator iterator = new ArgIterator(__arglist);
+        return iterator.GetRemainingCount();
+    }
+}