Add error handling for interactive #requires (#6469)

rjmholt · daxian-dbw · commit 63c0d8d783b8 · 2018-04-25T18:04:04.000-07:00
diff --git a/src/System.Management.Automation/engine/AutomationEngine.cs b/src/System.Management.Automation/engine/AutomationEngine.cs
@@ -62,19 +62,19 @@ internal string Expand(string s)
         /// Compile a piece of text into a parse tree for later execution.
         /// </summary>
         /// <param name="script">The text to parse</param>
-        /// <param name="interactiveCommand"></param>
+        /// <param name="addToHistory">true iff the scriptblock will be added to history</param>
         /// <returns>The parse text as a parsetree node.</returns>
-        internal ScriptBlock ParseScriptBlock(string script, bool interactiveCommand)
+        internal ScriptBlock ParseScriptBlock(string script, bool addToHistory)
         {
-            return ParseScriptBlock(script, null, interactiveCommand);
+            return ParseScriptBlock(script, null, addToHistory);
         }
 
-        internal ScriptBlock ParseScriptBlock(string script, string fileName, bool interactiveCommand)
+        internal ScriptBlock ParseScriptBlock(string script, string fileName, bool addToHistory)
         {
             ParseError[] errors;
             var ast = EngineParser.Parse(fileName, script, null, out errors, ParseMode.Default);
 
-            if (interactiveCommand)
+            if (addToHistory)
             {
                 EngineParser.SetPreviousFirstLastToken(Context);
             }
diff --git a/src/System.Management.Automation/engine/parser/tokenizer.cs b/src/System.Management.Automation/engine/parser/tokenizer.cs
@@ -492,6 +492,7 @@ internal class TokenizerState
         internal string Script;
         internal int TokenStart;
         internal int CurrentIndex;
+        internal Token FirstToken;
         internal Token LastToken;
         internal BitArray SkippedCharOffsets;
         internal List<Token> TokenList;
@@ -687,6 +688,7 @@ internal TokenizerState StartNestedScan(UnscannedSubExprToken nestedText)
                 NestedTokensAdjustment = _nestedTokensAdjustment,
                 Script = _script,
                 TokenStart = _tokenStart,
+                FirstToken = FirstToken,
                 LastToken = LastToken,
                 SkippedCharOffsets = _skippedCharOffsets,
                 TokenList = TokenList,
@@ -708,6 +710,7 @@ internal void FinishNestedScan(TokenizerState ts)
             _nestedTokensAdjustment = ts.NestedTokensAdjustment;
             _script = ts.Script;
             _tokenStart = ts.TokenStart;
+            FirstToken = ts.FirstToken;
             LastToken = ts.LastToken;
             _skippedCharOffsets = ts.SkippedCharOffsets;
             TokenList = ts.TokenList;
diff --git a/test/powershell/Language/Parser/Parser.Tests.ps1 b/test/powershell/Language/Parser/Parser.Tests.ps1
@@ -931,4 +931,39 @@ foo``u{2195}abc
         $err = { ExecuteCommand "Function foo { [CmdletBinding()] param() DynamicParam {} " } | Should -Throw -ErrorId "IncompleteParseException" -PassThru
         $err.Exception.InnerException.ErrorRecord.FullyQualifiedErrorId | Should -BeExactly "MissingEndCurlyBrace"
     }
+
+    Context "#requires nested scan tokenizer tests" {
+        BeforeAll {
+            $settings = [System.Management.Automation.PSInvocationSettings]::new()
+            $settings.AddToHistory = $true
+
+            $ps = [powershell]::Create()
+        }
+
+        AfterAll {
+            $ps.Dispose()
+        }
+
+        AfterEach {
+            $ps.Commands.Clear()
+        }
+
+        $testCases = @(
+            @{ script = "#requires"; firstToken = $null; lastToken = $null },
+            @{ script = "#requires -Version 5.0`n10"; firstToken = "10"; lastToken = "10" },
+            @{ script = "Write-Host 'Hello'`n#requires -Version 5.0`n7"; firstToken = "Write-Host"; lastToken = "7" },
+            @{ script = "Write-Host 'Hello'`n#requires -Version 5.0"; firstToken = "Write-Host"; lastToken = "Hello"}
+        )
+
+        It "Correctly resets the first and last tokens in the tokenizer after nested scan in script" -TestCases $testCases {
+            param($script, $firstToken, $lastToken)
+
+            $ps.AddScript($script)
+            $ps.AddScript("(`$^,`$`$)")
+            $tokens = $ps.Invoke(@(), $settings)
+
+            $tokens[0] | Should -BeExactly $firstToken
+            $tokens[1] | Should -BeExactly $lastToken
+        }
+    }
 }
diff --git a/test/powershell/Language/Scripting/Requires.Tests.ps1 b/test/powershell/Language/Scripting/Requires.Tests.ps1
@@ -27,4 +27,21 @@ Describe "Requires tests" -Tags "CI" {
         }
     }
 
-}
+    Context "Interactive requires" {
+
+        BeforeAll {
+            $ps = [powershell]::Create()
+        }
+
+        AfterAll {
+            $ps.Dispose()
+        }
+
+        It "Successfully does nothing when given '#requires' interactively" {
+            $settings = [System.Management.Automation.PSInvocationSettings]::new()
+            $settings.AddToHistory = $true
+
+            { $ps.AddScript("#requires").Invoke(@(), $settings) } | Should -Not -Throw
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -62,19 +62,19 @@ internal string Expand(string s)`
`62`	`62`	`/// Compile a piece of text into a parse tree for later execution.`
`63`	`63`	`/// </summary>`
`64`	`64`	`/// <param name="script">The text to parse</param>`
`65`		`- /// <param name="interactiveCommand"></param>`
	`65`	`+ /// <param name="addToHistory">true iff the scriptblock will be added to history</param>`
`66`	`66`	`/// <returns>The parse text as a parsetree node.</returns>`
`67`		`- internal ScriptBlock ParseScriptBlock(string script, bool interactiveCommand)`
	`67`	`+ internal ScriptBlock ParseScriptBlock(string script, bool addToHistory)`
`68`	`68`	`{`
`69`		`- return ParseScriptBlock(script, null, interactiveCommand);`
	`69`	`+ return ParseScriptBlock(script, null, addToHistory);`
`70`	`70`	`}`
`71`	`71`
`72`		`- internal ScriptBlock ParseScriptBlock(string script, string fileName, bool interactiveCommand)`
	`72`	`+ internal ScriptBlock ParseScriptBlock(string script, string fileName, bool addToHistory)`
`73`	`73`	`{`
`74`	`74`	`ParseError[] errors;`
`75`	`75`	`var ast = EngineParser.Parse(fileName, script, null, out errors, ParseMode.Default);`
`76`	`76`
`77`		`- if (interactiveCommand)`
	`77`	`+ if (addToHistory)`
`78`	`78`	`{`
`79`	`79`	`EngineParser.SetPreviousFirstLastToken(Context);`
`80`	`80`	`}`