Merge pull request #542 from PowerShell/FixMissingModuleManifestMemberRule

Fix null reference exception in MissingModuleManifestField rule

Author: Kapil Borle

Rules/MissingModuleManifestField.cs

@@ -50,7 +50,11 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
                             System.Diagnostics.Debug.Assert(
                                 errorRecord.Exception != null && !String.IsNullOrWhiteSpace(errorRecord.Exception.Message), 
                                 Strings.NullErrorMessage);
-                            var hashTableAst = ast.Find(x => x is HashtableAst, false);                            
+                            var hashTableAst = ast.Find(x => x is HashtableAst, false);
+                            if (hashTableAst == null)
+                            {
+                                yield break;
+                            }
                             yield return new DiagnosticRecord(
                                 errorRecord.Exception.Message, 
                                 hashTableAst.Extent, 

Tests/Rules/AvoidUnloadableModuleOrMissingRequiredFieldInManifest.tests.ps1

@@ -1,20 +1,21 @@
-Import-Module PSScriptAnalyzer 
+Import-Module PSScriptAnalyzer
 $missingMessage = "The member 'ModuleVersion' is not present in the module manifest."
-$missingName = "PSMissingModuleManifestField"
+$missingMemberRuleName = "PSMissingModuleManifestField"
 $directory = Split-Path -Parent $MyInvocation.MyCommand.Path
 $violationFilepath = Join-Path $directory "TestBadModule\TestBadModule.psd1"
-$violations = Invoke-ScriptAnalyzer $violationFilepath | Where-Object {$_.RuleName -eq $missingName}
-$noViolations = Invoke-ScriptAnalyzer $directory\TestGoodModule\TestGoodModule.psd1 | Where-Object {$_.RuleName -eq $missingName}
+$violations = Invoke-ScriptAnalyzer $violationFilepath | Where-Object {$_.RuleName -eq $missingMemberRuleName}
+$noViolations = Invoke-ScriptAnalyzer $directory\TestGoodModule\TestGoodModule.psd1 | Where-Object {$_.RuleName -eq $missingMemberRuleName}
+$noHashtableFilepath = Join-Path $directory "TestBadModule\NoHashtable.psd1"
 
 Describe "MissingRequiredFieldModuleManifest" {
     BeforeAll {
         Import-Module (Join-Path $directory "PSScriptAnalyzerTestHelper.psm1")
     }
-    
+
     AfterAll{
         Remove-Module PSScriptAnalyzerTestHelper
-    }    
-    
+    }
+
     Context "When there are violations" {
         It "has 1 missing required field module manifest violation" {
             $violations.Count | Should Be 1
@@ -23,27 +24,33 @@ Describe "MissingRequiredFieldModuleManifest" {
         It "has the correct description message" {
             $violations.Message | Should Match $missingMessage
         }
-	
+
 	$numExpectedCorrections = 1
 	It "has $numExpectedCorrections suggested corrections" {
 	   $violations.SuggestedCorrections.Count | Should Be $numExpectedCorrections
 	}
-	
 
-	It "has the right suggested correction" {	
+
+	It "has the right suggested correction" {
 	   $expectedText = @'
 # Version number of this module.
 ModuleVersion = '1.0.0.0'
 '@
        $violations[0].SuggestedCorrections[0].Text | Should Match $expectedText
        Get-ExtentText $violations[0].SuggestedCorrections[0] $violationFilepath | Should Match ""
-    }       	
-}    
+    }
+}
 
     Context "When there are no violations" {
         It "returns no violations" {
             $noViolations.Count | Should Be 0
         }
     }
+
+    Context "When an .psd1 file doesn't contain a hashtable" {
+        It "does not throw exception" {
+            {Invoke-ScriptAnalyzer -Path $noHashtableFilepath -IncludeRule $missingMemberRuleName} | Should Not Throw
+        }
+    }
 }
 

Tests/Rules/TestBadModule/NoHashtable.psd1

@@ -0,0 +1 @@
+$x = "No hash table here"

appveyor.yml

@@ -6,7 +6,7 @@ clone_folder: c:\projects\psscriptanalyzer
 
 # Install Pester
 install: 
-    - cinst -y pester --version 3.3.13
+    - cinst -y pester --version 3.4.0
 
 # Build PSScriptAnalyzer using msbuild
 build: true