Allow TypeNotFound parser errors (#957)

* Trim out TypeNotFoundParseErrors.

* Add verbose logging and test

* fix test syntax

* add test for -path parameter set

* use pester test drive

* fix tests to not run in library usage session

* Address PR comments about additional assertion and xml comment

* Remove unused dotnet-core NuGet feed that caused build failure due to downtime

* Fix typo and move string into resources

* fix compilation error (forgot to check-in file)

* fix typo to also build for psv3

* Since the using statement was introduced only inn v5, move to block that runs only on v5+

* fix tests by moving the tests (clearly a smell that something is wrong in this test script

* write warning on parse errors instead of verbose output and tweak message

* instead of returning a warning, return a diagnostic record with a custom rule name and tweak error message

* poke build due to sporadic AppVeyor failure on setup (not a test) -> rename variable

Author: bergmeister

Engine/ScriptAnalyzer.cs

@@ -1522,24 +1522,26 @@ public IEnumerable<DiagnosticRecord> AnalyzeScriptDefinition(string scriptDefini
                 return null;
             }
 
-            if (errors != null && errors.Length > 0)
+            var relevantParseErrors = RemoveTypeNotFoundParseErrors(errors, out List<DiagnosticRecord> diagnosticRecords);
+
+            if (relevantParseErrors != null && relevantParseErrors.Count > 0)
             {
-                foreach (ParseError error in errors)
+                foreach (var parseError in relevantParseErrors)
                 {
-                    string parseErrorMessage = String.Format(CultureInfo.CurrentCulture, Strings.ParseErrorFormatForScriptDefinition, error.Message.TrimEnd('.'), error.Extent.StartLineNumber, error.Extent.StartColumnNumber);
-                    this.outputWriter.WriteError(new ErrorRecord(new ParseException(parseErrorMessage), parseErrorMessage, ErrorCategory.ParserError, error.ErrorId));
+                    string parseErrorMessage = String.Format(CultureInfo.CurrentCulture, Strings.ParseErrorFormatForScriptDefinition, parseError.Message.TrimEnd('.'), parseError.Extent.StartLineNumber, parseError.Extent.StartColumnNumber);
+                    this.outputWriter.WriteError(new ErrorRecord(new ParseException(parseErrorMessage), parseErrorMessage, ErrorCategory.ParserError, parseError.ErrorId));
                 }
             }
 
-            if (errors != null && errors.Length > 10)
+            if (relevantParseErrors != null && relevantParseErrors.Count > 10)
             {
                 string manyParseErrorMessage = String.Format(CultureInfo.CurrentCulture, Strings.ParserErrorMessageForScriptDefinition);
                 this.outputWriter.WriteError(new ErrorRecord(new ParseException(manyParseErrorMessage), manyParseErrorMessage, ErrorCategory.ParserError, scriptDefinition));
 
                 return new List<DiagnosticRecord>();
             }
 
-            return this.AnalyzeSyntaxTree(scriptAst, scriptTokens, String.Empty);
+            return diagnosticRecords.Concat(this.AnalyzeSyntaxTree(scriptAst, scriptTokens, String.Empty));
         }
 
         /// <summary>
@@ -1644,6 +1646,33 @@ private static Encoding GetFileEncoding(string path)
             }
         }
 
+        /// <summary>
+        /// Inspects Parse errors and removes TypeNotFound errors that can be ignored since some types are not known yet (e.g. due to 'using' statements).
+        /// </summary>
+        /// <param name="parseErrors"></param>
+        /// <returns>List of relevant parse errors.</returns>
+        private List<ParseError> RemoveTypeNotFoundParseErrors(ParseError[] parseErrors, out List<DiagnosticRecord> diagnosticRecords)
+        {
+            var relevantParseErrors = new List<ParseError>();
+            diagnosticRecords = new List<DiagnosticRecord>();
+
+            foreach (var parseError in parseErrors)
+            {
+                // If types are not known due them not being imported yet, the parser throws an error that can be ignored
+                if (parseError.ErrorId != "TypeNotFound")
+                {
+                    relevantParseErrors.Add(parseError);
+                }
+                else
+                {
+                    diagnosticRecords.Add(new DiagnosticRecord(
+                        string.Format(Strings.TypeNotFoundParseErrorFound, parseError.Extent), parseError.Extent, "TypeNotFound", DiagnosticSeverity.Information, parseError.Extent.File));
+                }
+            }
+
+            return relevantParseErrors;
+        }
+
         private static Range SnapToEdges(EditableText text, Range range)
         {
             // todo add TextLines.Validate(range) and TextLines.Validate(position)
@@ -1806,6 +1835,7 @@ private IEnumerable<DiagnosticRecord> AnalyzeFile(string filePath)
             ParseError[] errors = null;
 
             this.outputWriter.WriteVerbose(string.Format(CultureInfo.CurrentCulture, Strings.VerboseFileMessage, filePath));
+            var diagnosticRecords = new List<DiagnosticRecord>();
 
             //Parse the file
             if (File.Exists(filePath))
@@ -1829,17 +1859,19 @@ private IEnumerable<DiagnosticRecord> AnalyzeFile(string filePath)
                         scriptAst = Parser.ParseFile(filePath, out scriptTokens, out errors);
                     }
 #endif //!PSV3
+                    var relevantParseErrors = RemoveTypeNotFoundParseErrors(errors, out diagnosticRecords);
+
                     //Runspace.DefaultRunspace = oldDefault;
-                    if (errors != null && errors.Length > 0)
+                    if (relevantParseErrors != null && relevantParseErrors.Count > 0)
                     {
-                        foreach (ParseError error in errors)
+                        foreach (var parseError in relevantParseErrors)
                         {
-                            string parseErrorMessage = String.Format(CultureInfo.CurrentCulture, Strings.ParserErrorFormat, error.Extent.File, error.Message.TrimEnd('.'), error.Extent.StartLineNumber, error.Extent.StartColumnNumber);
-                            this.outputWriter.WriteError(new ErrorRecord(new ParseException(parseErrorMessage), parseErrorMessage, ErrorCategory.ParserError, error.ErrorId));
+                            string parseErrorMessage = String.Format(CultureInfo.CurrentCulture, Strings.ParserErrorFormat, parseError.Extent.File, parseError.Message.TrimEnd('.'), parseError.Extent.StartLineNumber, parseError.Extent.StartColumnNumber);
+                            this.outputWriter.WriteError(new ErrorRecord(new ParseException(parseErrorMessage), parseErrorMessage, ErrorCategory.ParserError, parseError.ErrorId));
                         }
                     }
 
-                    if (errors != null && errors.Length > 10)
+                    if (relevantParseErrors != null && relevantParseErrors.Count > 10)
                     {
                         string manyParseErrorMessage = String.Format(CultureInfo.CurrentCulture, Strings.ParserErrorMessage, System.IO.Path.GetFileName(filePath));
                         this.outputWriter.WriteError(new ErrorRecord(new ParseException(manyParseErrorMessage), manyParseErrorMessage, ErrorCategory.ParserError, filePath));
@@ -1856,7 +1888,7 @@ private IEnumerable<DiagnosticRecord> AnalyzeFile(string filePath)
                 return null;
             }
 
-            return this.AnalyzeSyntaxTree(scriptAst, scriptTokens, filePath);
+            return diagnosticRecords.Concat(this.AnalyzeSyntaxTree(scriptAst, scriptTokens, filePath));
         }
 
         private bool IsModuleNotFoundError(ParseError error)

Engine/Strings.Designer.cs

@@ -324,4 +324,7 @@
   <data name="SettingsObjectCouldNotBResolved" xml:space="preserve">
     <value>Settings object could not be resolved.</value>
   </data>
+  <data name="TypeNotFoundParseErrorFound" xml:space="preserve">
+    <value>Ignoring 'TypeNotFound' parse error on type '{0}'. Check if the specified type is correct. This can also be due the type not being known at parse time due to types imported by 'using' statements.</value>
+  </data>
 </root>

Engine/Strings.resx

@@ -3,7 +3,6 @@
   <packageSources>
     <clear />
     <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
-    <add key="dotnet-core" value="https://dotnet.myget.org/F/dotnet-core/api/v3/index.json" />
     <add key="powershell-core" value="https://powershell.myget.org/F/powershell-core/api/v3/index.json" />
   </packageSources>
 </configuration>

NuGet.Config

@@ -551,4 +551,29 @@ Describe "Test -EnableExit Switch" {
             "$result" | Should -Not -BeLike $reportSummaryFor1Warning 
         }
     }
+
+    # using statements are only supported in v5+
+    if (!$testingLibraryUsage -and ($PSVersionTable.PSVersion -ge [Version]'5.0.0')) {
+        Describe "Handles parse errors due to unknown types" {
+            $script = @'
+                using namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels
+                using namespace Microsoft.Azure.Commands.Common.Authentication.Abstractions
+                Import-Module "AzureRm"
+                class MyClass { [IStorageContext]$StorageContext } # This will result in a parser error due to [IStorageContext] type that comes from the using statement but is not known at parse time
+'@
+            It "does not throw and detect one expected warning after the parse error has occured when using -ScriptDefintion parameter set" {
+                $warnings = Invoke-ScriptAnalyzer -ScriptDefinition $script
+                $warnings.Count | Should -Be 1
+                $warnings.RuleName | Should -Be 'TypeNotFound'
+            }
+
+            $testFilePath = "TestDrive:\testfile.ps1"
+            Set-Content $testFilePath -value $script
+            It "does not throw and detect one expected warning after the parse error has occured when using -Path parameter set" {
+                $warnings = Invoke-ScriptAnalyzer -Path $testFilePath
+                $warnings.Count | Should -Be 1
+                $warnings.RuleName | Should -Be 'TypeNotFound'
+            }
+        }
+    }
 }

Tests/Engine/InvokeScriptAnalyzer.tests.ps1

@@ -44,7 +44,7 @@ function Invoke-AppVeyorBuild {
         $BuildType,
 
         [Parameter(Mandatory)]
-        [ValidateSet('Release', 'PSv4Release', 'PSv4Release')]
+        [ValidateSet('Release', 'PSv3Release', 'PSv4Release')]
         $BuildConfiguration,
 
         [Parameter(Mandatory)]