Merge pull request #384 from PowerShell/UpdateHelpFixBranch

Script Analyzer shouldn't automatically update help for modules

Author: raghushantha

Engine/ScriptAnalyzer.cs

@@ -554,13 +554,7 @@ private List<ExternalRule> GetExternalRule(string[] moduleNames)
                 {
                     posh.AddCommand("Get-Module").AddParameter("Name", moduleName).AddParameter("ListAvailable");
                     shortModuleName = posh.Invoke<PSModuleInfo>().First().Name;   
-
-                    // Invokes Update-Help for this module
-                    // Required since when invoking Get-Help later on, the cmdlet prompts for Update-Help interactively
-                    // By invoking Update-Help first, Get-Help will not prompt for downloading help later
-                    posh.AddCommand("Update-Help").AddParameter("Module", shortModuleName).AddParameter("Force");
-                    posh.Invoke();
-                    
+                                                            
                     // Invokes Get-Command and Get-Help for each functions in the module.
                     posh.Commands.Clear();
                     posh.AddCommand("Get-Command").AddParameter("Module", shortModuleName);
@@ -586,8 +580,21 @@ private List<ExternalRule> GetExternalRule(string[] moduleNames)
                         //Only add functions that are defined as rules.
                         if (param != null)
                         {
-                            posh.AddCommand("Get-Help").AddParameter("Name", funcInfo.Name);                            
-                            Collection<PSObject> helpContent = posh.Invoke();
+                            // On a new image, when Get-Help is run the first time, PowerShell offers to download updated help content
+                            // using Update-Help. This results in an interactive prompt - which we cannot handle
+                            // Workaround to prevent Update-Help from running is to set the following reg key
+                            // HKLM:\Software\Microsoft\PowerShell\DisablePromptToUpdateHelp
+                            // OR execute Update-Help in an elevated admin mode before running ScriptAnalyzer 
+                            Collection<PSObject> helpContent = null;
+                            try
+                            {
+                                posh.AddCommand("Get-Help").AddParameter("Name", funcInfo.Name);
+                                helpContent = posh.Invoke();
+                            }
+                            catch (Exception getHelpException)
+                            {
+                                this.outputWriter.WriteWarning(getHelpException.Message.ToString());
+                            }
 
                             // Retrieve "Description" field in the help content
                             string desc = String.Empty;

Tests/Engine/CustomizedRule.tests.ps1

@@ -6,6 +6,19 @@ if (!(Get-Module PSScriptAnalyzer) -and !$testingLibraryUsage)
 	Import-Module PSScriptAnalyzer
 }
 
+# Force Get-Help not to prompt for interactive input to download help using Update-Help
+# By adding this registry key we turn off Get-Help interactivity logic during ScriptRule parsing
+$null,"Wow6432Node" | ForEach-Object {
+	try
+	{
+		Set-ItemProperty -Name "DisablePromptToUpdateHelp" -Path "HKLM:\SOFTWARE\$($_)\Microsoft\PowerShell" -Value 1 -Force
+	} 
+	catch
+	{
+		# Ignore for cases when tests are running in non-elevated more or registry key does not exist or not accessible
+	}
+}
+
 $directory = Split-Path -Parent $MyInvocation.MyCommand.Path
 $message = "this is help"
 $measure = "Measure-RequiresRunAsAdministrator"
@@ -46,8 +59,20 @@ Describe "Test importing correct customized rules" {
 
             $customizedRulePath = Invoke-ScriptAnalyzer $directory\TestScript.ps1 -CustomizedRulePath $directory\samplerule\samplerule.psm1 | Where-Object {$_.Message -eq $message}
             $customizedRulePath.Count | Should Be 1
-        }
-       
+
+			# Force Get-Help not to prompt for interactive input to download help using Update-Help
+			# By adding this registry key we turn off Get-Help interactivity logic during ScriptRule parsing
+			$null,"Wow6432Node" | ForEach-Object {
+				try
+				{
+					Set-ItemProperty -Name "DisablePromptToUpdateHelp" -Path "HKLM:\SOFTWARE\$($_)\Microsoft\PowerShell" -Value 1 -Force
+				} 
+				catch
+				{
+					# Ignore for cases when tests are running in non-elevated more or registry key does not exist or not accessible
+				}
+			}
+        }       
     }
 
     Context "Test Get-ScriptAnalyzer with customized rules" {

Tests/Engine/LibraryUsage.tests.ps1

@@ -134,6 +134,19 @@ $runspace.Open();
 # Let other test scripts know we are testing library usage now
 $testingLibraryUsage = $true
 
+# Force Get-Help not to prompt for interactive input to download help using Update-Help
+# By adding this registry key we force to turn off Get-Help interactivity logic during ScriptRule parsing
+$null,"Wow6432Node" | ForEach-Object {
+	try
+	{
+		Set-ItemProperty -Name "DisablePromptToUpdateHelp" -Path "HKLM:\SOFTWARE\$($_)\Microsoft\PowerShell" -Value 1 -Force
+	} 
+	catch
+	{
+		# Ignore for cases when tests are running in non-elevated more or registry key does not exist or not accessible
+	}
+}
+
 # Invoke existing test files that use Invoke-ScriptAnalyzer
 . $directory\InvokeScriptAnalyzer.tests.ps1
 . $directory\RuleSuppression.tests.ps1