add test and fix default property values

Author: anamnavi

src/code/PSScriptRequires.cs

@@ -38,12 +38,12 @@ public sealed class PSScriptRequires
         /// <summary>
         /// The assemblies this script requires, specified like: #requires -Assembly path\to\foo.dll#requires -Assembly "System.Management.Automation, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" 
         /// </summary>
-        public string[] RequiredAssemblies { get; private set; }
+        public string[] RequiredAssemblies { get; private set; } = Utils.EmptyStrArray;
 
         /// <summary>
         /// The PowerShell Edition this script requires, specified like: #requires -PSEdition Desktop
         /// </summary>
-        public string[] RequiredPSEditions { get; private set; }
+        public string[] RequiredPSEditions { get; private set; } = Utils.EmptyStrArray;
 
         /// <summary>
         /// The PowerShell version this script requires, specified like: #requires -Version 3
@@ -179,14 +179,12 @@ internal string[] EmitContent()
             {
                 psRequiresLines.Add(String.Empty);
                 psRequiresLines.Add("#Requires -RunAsAdministrator");
-                psRequiresLines.Add(String.Empty);
             }
 
             if (!String.IsNullOrEmpty(RequiredApplicationId))
             {
                 psRequiresLines.Add(String.Empty);
                 psRequiresLines.Add(String.Format("#Requires -ShellId {0}", RequiredApplicationId));
-                psRequiresLines.Add(String.Empty);
             }
 
             if (RequiredAssemblies.Length > 0)
@@ -196,19 +194,6 @@ internal string[] EmitContent()
                 {
                     psRequiresLines.Add(String.Format("#Requires -Assembly {0}", assembly));
                 }
-
-                psRequiresLines.Add(String.Empty);
-            }
-
-            if (RequiredModules.Length > 0)
-            {
-                psRequiresLines.Add(String.Empty);
-                foreach (ModuleSpecification moduleSpec in RequiredModules)
-                {
-                    psRequiresLines.Add(String.Format("#Requires -Module {0}", moduleSpec.ToString()));
-                }
-
-                psRequiresLines.Add(String.Empty);
             }
 
             if (RequiredPSEditions.Length > 0)
@@ -218,14 +203,22 @@ internal string[] EmitContent()
                 {
                     psRequiresLines.Add(String.Format("#Requires -PSEdition {0}", psEdition));
                 }
-
-                psRequiresLines.Add(String.Empty);
             }
 
             if (RequiredPSVersion != null)
             {
                 psRequiresLines.Add(String.Empty);
                 psRequiresLines.Add(String.Format("#Requires -Version {0}", RequiredPSVersion.ToString()));
+            }
+
+            if (RequiredModules.Length > 0)
+            {
+                psRequiresLines.Add(String.Empty);
+                foreach (ModuleSpecification moduleSpec in RequiredModules)
+                {
+                    psRequiresLines.Add(String.Format("#Requires -Module {0}", moduleSpec.ToString()));
+                }
+
                 psRequiresLines.Add(String.Empty);
             }
 

test/PSScriptFileInfoTests/UpdatePSScriptFileInfo.Tests.ps1

@@ -264,6 +264,34 @@ Describe "Test Update-PSScriptFileInfo" -tags 'CI' {
         $results -like "*#Requires*ModuleName*Version*" | Should -BeTrue
     }
 
+    It "update script file with varying Required properties (IsElevationRequired, RequiredApplicationId, RequiredAssembliesRequiredPSEditions, RequiredPSVersion) should retain those Require statements" {
+        $testScriptWithRequiredProperties = Join-Path -Path $script:testScriptsFolderPath -ChildPath "ScriptWithAllRequiresProperties.ps1"
+        Update-PSScriptFileInfo -Path $testScriptWithRequiredProperties -Version "2.0.0.0"
+        Test-PSScriptFileInfo $testScriptWithRequiredProperties | Should -Be $true
+
+        $requiredApplicationId = "Shell"
+        $requiredAssemblies = @("path\to\foo.dll")
+        $requiredPSEditions = @("Desktop")
+        $requiredPSVersion = "5.1"
+
+        Test-Path -Path $testScriptWithRequiredProperties | Should -BeTrue
+        $results = Get-Content -Path $testScriptWithRequiredProperties -Raw
+        $results.Contains("#Requires -RunAsAdministrator") | Should -BeTrue
+        $results -like "*#Requires -ShellId*" | Should -BeTrue
+        $results -like "*#Requires*Assembly*" | Should -BeTrue
+        $results -like "*#Requires*PSEdition*" | Should -BeTrue
+        $results -like "*#Requires*Version*" | Should -BeTrue
+
+        $scriptFileObj = Get-PSScriptFileInfo -Path $testScriptWithRequiredProperties
+        $scriptFileObj.ScriptRequiresComment.RequiredModules[0] | Should -Be "Microsoft.PowerShell.PSResourceGet"
+        $scriptFileObj.ScriptRequiresComment.IsElevationRequired | Should -Be $true
+        $scriptFileObj.ScriptRequiresComment.RequiredApplicationId | Should -Be $requiredApplicationId
+        $scriptFileObj.ScriptRequiresComment.RequiredAssemblies | Should -Be $requiredAssemblies
+        $scriptFileObj.ScriptRequiresComment.RequiredPSEditions | Should -Be $requiredPSEditions
+        $scriptFileObj.ScriptRequiresComment.RequiredPSVersion | Should -Be $requiredPSVersion
+        $scriptFileObj.ScriptMetadataComment.Version | Should -Be "2.0.0.0"
+    }
+
     It "update script file RequiredScripts property" {
         $requiredScript1 = "RequiredScript1"
         $requiredScript2 = "RequiredScript2"

test/testFiles/testScripts/ScriptWithAllRequiresProperties.ps1

@@ -0,0 +1,54 @@
+<#PSScriptInfo
+
+.VERSION 2.0.0.0
+
+.GUID 3951be04-bd06-4337-8dc3-a620bf539fbd
+
+.AUTHOR annavied
+
+.COMPANYNAME 
+
+.COPYRIGHT 
+
+.TAGS 
+
+.LICENSEURI 
+
+.PROJECTURI 
+
+.ICONURI 
+
+.EXTERNALMODULEDEPENDENCIES 
+
+.REQUIREDSCRIPTS 
+
+.EXTERNALSCRIPTDEPENDENCIES 
+
+.RELEASENOTES
+
+
+.PRIVATEDATA
+
+
+#>
+
+#Requires -RunAsAdministrator
+
+#Requires -ShellId Shell
+
+#Requires -Assembly path\to\foo.dll
+
+#Requires -PSEdition Desktop
+
+#Requires -Version 5.1
+
+#Requires -Module Microsoft.PowerShell.PSResourceGet
+
+<#
+
+.DESCRIPTION
+        This is a test script
+
+    .SYNOPSIS
+        Test the Update-PSScriptFileInfo cmdlet
+#>