Add version parameter for checking module manifest

Author: Kapil Borle

Engine/Helper.cs

@@ -1604,8 +1604,11 @@ public bool GetNamedArgumentAttributeValue(NamedAttributeArgumentAst namedAttrib
 
         public static IEnumerable<string> GetModuleManifestKeys(Version powershellVersion)
         {
+            if (powershellVersion == null)
+            {
+                throw new ArgumentNullException("powershellVersion");
+            }
             var keys = new List<string>();
-
             var keysCommon = new List<string> {
                     "RootModule",
                     "ModuleVersion",
@@ -1635,25 +1638,31 @@ public static IEnumerable<string> GetModuleManifestKeys(Version powershellVersio
                     "PrivateData",
                     "HelpInfoURI",
                     "DefaultCommandPrefix"};
-
             keys.AddRange(keysCommon);
-
-            // default to version 5.0
-            if (powershellVersion == null || powershellVersion.Equals(new Version("5.0")))
+            if (powershellVersion.Equals(new Version("5.0")))
             {
                 keys.Add("DscResourcesToExport");
             }
+            else if (!powershellVersion.Equals(new Version("4.0"))
+                && !powershellVersion.Equals(new Version("3.0")))
+            {
+                throw new ArgumentException("Invalid PowerShell version. Choose from 3.0, 4.0 or 5.0");
+            }
             return keys;
         }
 
-        public static bool IsModuleManifest(string filepath)
+        public static bool IsModuleManifest(string filepath, Version powershellVersion)
         {
             Token[] tokens;
             ParseError[] errors;
             if (filepath == null)
             {
                 throw new ArgumentNullException("filepath");
             }
+            if (powershellVersion == null)
+            {
+                throw new ArgumentNullException("powershellVersion");
+            }
             if (!Path.GetExtension(filepath).Equals(".psd1", StringComparison.OrdinalIgnoreCase))
             {
                 return false;
@@ -1667,7 +1676,9 @@ public static bool IsModuleManifest(string filepath)
             {
                 return false;
             }
-            var keys = GetModuleManifestKeys(null);
+            var keys = GetModuleManifestKeys(powershellVersion);
+
+            // check if all the keys in hast.keyvaluepairs are present in keys
             int matchCount = 0;
             foreach(var pair in hast.KeyValuePairs)
             {

Tests/Rules/AvoidUnloadableModuleOrMissingRequiredFieldInManifest.tests.ps1

@@ -56,13 +56,35 @@ ModuleVersion = '1.0.0.0'
     Context "Validate the contents of a .psd1 file" {
         It "detects a valid module manifest file" {
             $filepath = Join-Path $directory "TestManifest/ManifestGood.psd1"
-            [Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper]::IsModuleManifest($filepath) | Should Be $true
+            [Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper]::IsModuleManifest($filepath, [version]"5.0") | Should Be $true
         }
 
         It "detects a .psd1 file which is not module manifest" {
             $filepath = Join-Path $directory "TestManifest/PowerShellDataFile.psd1"
-            [Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper]::IsModuleManifest($filepath) | Should Be $false
+            [Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper]::IsModuleManifest($filepath, [version]"5.0") | Should Be $false
         }
+
+        It "detects valid module manifest file for PSv5" {
+            $filepath = Join-Path $directory "TestManifest/ManifestGoodPSv5.psd1"
+            [Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper]::IsModuleManifest($filepath, [version]"5.0") | Should Be $true
+        }
+
+        It "does not validate PSv5 module manifest file for PSv3 check" {
+            $filepath = Join-Path $directory "TestManifest/ManifestGoodPSv5.psd1"
+            [Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper]::IsModuleManifest($filepath, [version]"3.0") | Should Be $false
+        }
+
+        It "detects valid module manifest file for PSv4" {
+            $filepath = Join-Path $directory "TestManifest/ManifestGoodPSv4.psd1"
+            [Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper]::IsModuleManifest($filepath, [version]"4.0") | Should Be $true
+        }
+
+        It "detects valid module manifest file for PSv3" {
+            $filepath = Join-Path $directory "TestManifest/ManifestGoodPSv3.psd1"
+            [Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper]::IsModuleManifest($filepath, [version]"3.0") | Should Be $true
+        }
+
+
     }
 }