Add test for dot-sourced find function definition

daviwil · Kayla Davis · commit f1a7882a511e · 2015-08-10T15:55:17.000-07:00
diff --git a/src/PowerShellEditorServices/Language/LanguageService.cs b/src/PowerShellEditorServices/Language/LanguageService.cs
@@ -120,7 +120,10 @@ public CompletionDetails GetCompletionDetailsInFile(
                         result => result.CompletionText.Equals(entryName));
                 return completionResult;
             }
-            else { return null; }
+            else
+            {
+                return null;
+            }
         }
 
         /// <summary>
@@ -146,6 +149,7 @@ public SymbolReference FindSymbolAtLocation(
             {
                 symbolReference.FilePath = file.FilePath;
             }
+
             return symbolReference;
         }
 
@@ -205,36 +209,34 @@ public GetDefinitionResult GetDefinitionOfSymbol(
             SymbolReference foundSymbol,
             ScriptFile[] referencedFiles)
         {
-            if (foundSymbol != null)
+            Validate.IsNotNull("foundSymbol", foundSymbol);
+
+            // look through the referenced files until definition is found
+            // or there are no more file to look through
+            SymbolReference foundDefinition = null;
+            for (int i = 0; i < referencedFiles.Length; i++)
             {
-                // look through the referenced files until definition is found
-                // or there are no more file to look through
-                int index = 0;
-                SymbolReference foundDefinition = null;
-                while (foundDefinition == null && index < referencedFiles.Length)
-                {
-                    foundDefinition =
-                        AstOperations.FindDefinitionOfSymbol(
-                            referencedFiles[index].ScriptAst,
-                            foundSymbol);
-                    if (foundDefinition != null)
-                    {
-                        foundDefinition.FilePath = referencedFiles[index].FilePath;
-                    }
-                    index++;
-                }
+                foundDefinition =
+                    AstOperations.FindDefinitionOfSymbol(
+                        referencedFiles[i].ScriptAst,
+                        foundSymbol);
 
-                // if definition is not found in referenced files 
-                // look for it in the builtin commands
-                if (foundDefinition == null)
+                if (foundDefinition != null)
                 {
-                    CommandInfo cmdInfo = GetCommandInfo(foundSymbol.SymbolName);
-                    foundDefinition = FindDeclarationForBuiltinCommand(cmdInfo, foundSymbol);
+                    foundDefinition.FilePath = referencedFiles[i].FilePath;
+                    break;
                 }
+            }
 
-                return new GetDefinitionResult(foundDefinition);
+            // if definition is not found in referenced files 
+            // look for it in the builtin commands
+            if (foundDefinition == null)
+            {
+                CommandInfo cmdInfo = GetCommandInfo(foundSymbol.SymbolName);
+                foundDefinition = FindDeclarationForBuiltinCommand(cmdInfo, foundSymbol);
             }
-            else { return null; }
+
+            return new GetDefinitionResult(foundDefinition);
         }
 
         /// <summary>
@@ -254,6 +256,7 @@ public FindOccurrencesResult FindOccurrencesInFile(
                     file.ScriptAst,
                     lineNumber,
                     columnNumber);
+
             if (foundSymbol != null)
             {
                 IEnumerable<SymbolReference> symbolOccurrences =
@@ -268,7 +271,10 @@ public FindOccurrencesResult FindOccurrencesInFile(
                         FoundOccurrences = symbolOccurrences
                     };
             }
-            else { return null; }
+            else
+            {
+                return null;
+            }
         }
 
         /// <summary>
@@ -300,9 +306,15 @@ public ParameterSetSignatures FindParameterSetsInFile(
 
                     return new ParameterSetSignatures(commandInfoSet, foundSymbol);
                 }
-                else { return null; }
+                else
+                {
+                    return null;
+                }
+            }
+            else
+            {
+                return null;
             }
-            else { return null; }
         }
         
         #endregion
@@ -354,8 +366,10 @@ private ScriptFile[] GetBuiltinCommandScriptFiles(PSModuleInfo moduleInfo)
                         }
                     }
                 }
+
                 return scriptFiles.ToArray();
             }
+
             return new List<ScriptFile>().ToArray();
         }
 
@@ -383,6 +397,7 @@ private SymbolReference FindDeclarationForBuiltinCommand(CommandInfo cmdInfo, Sy
                     index++;
                 }
             }
+
             return foundDefinition;
         }
     }
diff --git a/src/PowerShellEditorServices/Session/Workspace.cs b/src/PowerShellEditorServices/Session/Workspace.cs
@@ -144,9 +144,9 @@ private void RecursivelyFindReferences(
                         scriptFile.FilePath,
                         filename);
 
-                if (referencedScriptFiles.ContainsKey(resolvedScriptPath))
+                if (!referencedScriptFiles.ContainsKey(resolvedScriptPath))
                 {
-                    if (TryGetFile(resolvedScriptPath, out newFile))
+                    if (!TryGetFile(resolvedScriptPath, out newFile))
                     {
                         newFile = OpenFile(resolvedScriptPath);
                         referencedScriptFiles.Add(resolvedScriptPath, newFile);
diff --git a/test/PowerShellEditorServices.Test.Host/ScenarioTests.cs b/test/PowerShellEditorServices.Test.Host/ScenarioTests.cs
@@ -216,7 +216,7 @@ public void FindsNoReferencesOfEmptyLine()
                     Arguments = new FileLocationRequestArgs
                     {
                         File = "TestFiles\\FindReferences.ps1",
-                        Line = 9,
+                        Line = 10,
                         Offset = 1,
                     }
                 });
@@ -256,7 +256,7 @@ public void FindsReferencesOnCommand()
                     Arguments = new FileLocationRequestArgs
                     {
                         File = "TestFiles\\FindReferences.ps1",
-                        Line = 10,
+                        Line = 9,
                         Offset = 2,
                     }
                 });
@@ -297,7 +297,7 @@ public void FindsNoDefinitionOfBuiltinCommand()
                     Arguments = new FileLocationRequestArgs
                     {
                         File = "TestFiles\\FindReferences.ps1",
-                        Line = 12,
+                        Line = 11,
                         Offset = 10,
                     }
                 });
@@ -315,7 +315,7 @@ public void FindsDefintionOfVariable()
                     Arguments = new FileLocationRequestArgs
                     {
                         File = "TestFiles\\FindReferences.ps1",
-                        Line = 10,
+                        Line = 9,
                         Offset = 14,
                     }
                 });
@@ -358,7 +358,7 @@ public void GetsParameterHintsOnCommand()
                     Arguments = new SignatureHelpRequestArgs
                     {
                         File = "TestFiles\\FindReferences.ps1",
-                        Line = 14,
+                        Line = 13,
                         Offset = 15,
                     }
                 });
diff --git a/test/PowerShellEditorServices.Test.Host/TestFiles/FindReferences.ps1 b/test/PowerShellEditorServices.Test.Host/TestFiles/FindReferences.ps1
@@ -6,7 +6,6 @@ function My-Function ($myInput)
 $things = 4
 
 $things
-. simpleps.ps1
 My-Function $things
 
 Write-Output "Hi";
diff --git a/test/PowerShellEditorServices.Test.Shared/Definition/FindsFunctionDefinitionInDotSourceReference.cs b/test/PowerShellEditorServices.Test.Shared/Definition/FindsFunctionDefinitionInDotSourceReference.cs
@@ -0,0 +1,20 @@
+﻿//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using Microsoft.PowerShell.EditorServices.Session;
+
+namespace Microsoft.PowerShell.EditorServices.Test.Shared.Definition
+{
+    public class FindsFunctionDefinitionInDotSourceReference
+    {
+        public static readonly ScriptRegion SourceDetails =
+            new ScriptRegion
+            {
+                File = @"References\FileWithReferences.ps1",
+                StartLineNumber = 3,
+                StartColumnNumber = 6
+            };
+    }
+}
diff --git a/test/PowerShellEditorServices.Test.Shared/PowerShellEditorServices.Test.Shared.csproj b/test/PowerShellEditorServices.Test.Shared/PowerShellEditorServices.Test.Shared.csproj
@@ -42,6 +42,7 @@
     <Compile Include="Completion\CompleteCommandFromModule.cs" />
     <Compile Include="Completion\CompleteCommandInFile.cs" />
     <Compile Include="Completion\CompleteVariableInFile.cs" />
+    <Compile Include="Definition\FindsFunctionDefinitionInDotSourceReference.cs" />
     <Compile Include="Definition\FindsFunctionDefinition.cs" />
     <Compile Include="Definition\FindsVariableDefinition.cs" />
     <Compile Include="Occurrences\FindOccurrencesOnParameter.cs" />
@@ -69,6 +70,7 @@
     </None>
   </ItemGroup>
   <ItemGroup>
+    <None Include="References\FileWithReferences.ps1" />
     <None Include="References\SimpleFile.ps1">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
diff --git a/test/PowerShellEditorServices.Test.Shared/References/FileWithReferences.ps1 b/test/PowerShellEditorServices.Test.Shared/References/FileWithReferences.ps1
@@ -0,0 +1,3 @@
+﻿. .\SimpleFile.ps1
+
+My-Function "test"
diff --git a/test/PowerShellEditorServices.Test/Language/LanguageServiceTests.cs b/test/PowerShellEditorServices.Test/Language/LanguageServiceTests.cs
@@ -117,6 +117,23 @@ public void LanguageServiceFindsFunctionDefinition()
             Assert.Equal("My-Function", definition.SymbolName);
         }
 
+        [Fact]
+        public void LanguageServiceFindsFunctionDefinitionInDotSourceReference()
+        {
+            GetDefinitionResult definitionResult =
+                this.GetDefinition(
+                    FindsFunctionDefinitionInDotSourceReference.SourceDetails);
+
+            SymbolReference definition = definitionResult.FoundDefinition;
+            Assert.True(
+                definitionResult.FoundDefinition.FilePath.EndsWith(
+                    FindsFunctionDefinition.SourceDetails.File),
+                "Unexpected reference file: " + definitionResult.FoundDefinition.FilePath);
+            Assert.Equal(1, definition.ScriptRegion.StartLineNumber);
+            Assert.Equal(10, definition.ScriptRegion.StartColumnNumber);
+            Assert.Equal("My-Function", definition.SymbolName);
+        }
+
         [Fact]
         public void LanguageServiceFindsVariableDefinition()
         {
@@ -164,7 +181,13 @@ private ScriptFile GetScriptFile(ScriptRegion scriptRegion)
                     baseSharedScriptPath, 
                     scriptRegion.File);
 
-            return this.workspace.OpenFile(resolvedPath);
+            ScriptFile scriptFile = null;
+            if (!this.workspace.TryGetFile(resolvedPath, out scriptFile))
+            {
+                scriptFile = this.workspace.OpenFile(resolvedPath);
+            }
+
+            return scriptFile;
         }
 
         private CompletionResults GetCompletionResults(ScriptRegion scriptRegion)

Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,10 @@ public CompletionDetails GetCompletionDetailsInFile(`
`120`	`120`	`result => result.CompletionText.Equals(entryName));`
`121`	`121`	`return completionResult;`
`122`	`122`	`}`
`123`		`- else { return null; }`
	`123`	`+ else`
	`124`	`+ {`
	`125`	`+ return null;`
	`126`	`+ }`
`124`	`127`	`}`
`125`	`128`
`126`	`129`	`/// <summary>`
`@@ -146,6 +149,7 @@ public SymbolReference FindSymbolAtLocation(`
`146`	`149`	`{`
`147`	`150`	`symbolReference.FilePath = file.FilePath;`
`148`	`151`	`}`
	`152`	`+`
`149`	`153`	`return symbolReference;`
`150`	`154`	`}`
`151`	`155`
`@@ -205,36 +209,34 @@ public GetDefinitionResult GetDefinitionOfSymbol(`
`205`	`209`	`SymbolReference foundSymbol,`
`206`	`210`	`ScriptFile[] referencedFiles)`
`207`	`211`	`{`
`208`		`- if (foundSymbol != null)`
	`212`	`+ Validate.IsNotNull("foundSymbol", foundSymbol);`
	`213`	`+`
	`214`	`+ // look through the referenced files until definition is found`
	`215`	`+ // or there are no more file to look through`
	`216`	`+ SymbolReference foundDefinition = null;`
	`217`	`+ for (int i = 0; i < referencedFiles.Length; i++)`
`209`	`218`	`{`
`210`		`- // look through the referenced files until definition is found`
`211`		`- // or there are no more file to look through`
`212`		`- int index = 0;`
`213`		`- SymbolReference foundDefinition = null;`
`214`		`- while (foundDefinition == null && index < referencedFiles.Length)`
`215`		`- {`
`216`		`- foundDefinition =`
`217`		`- AstOperations.FindDefinitionOfSymbol(`
`218`		`- referencedFiles[index].ScriptAst,`
`219`		`- foundSymbol);`
`220`		`- if (foundDefinition != null)`
`221`		`- {`
`222`		`- foundDefinition.FilePath = referencedFiles[index].FilePath;`
`223`		`- }`
`224`		`- index++;`
`225`		`- }`
	`219`	`+ foundDefinition =`
	`220`	`+ AstOperations.FindDefinitionOfSymbol(`
	`221`	`+ referencedFiles[i].ScriptAst,`
	`222`	`+ foundSymbol);`
`226`	`223`
`227`		`- // if definition is not found in referenced files`
`228`		`- // look for it in the builtin commands`
`229`		`- if (foundDefinition == null)`
	`224`	`+ if (foundDefinition != null)`
`230`	`225`	`{`
`231`		`- CommandInfo cmdInfo = GetCommandInfo(foundSymbol.SymbolName);`
`232`		`- foundDefinition = FindDeclarationForBuiltinCommand(cmdInfo, foundSymbol);`
	`226`	`+ foundDefinition.FilePath = referencedFiles[i].FilePath;`
	`227`	`+ break;`
`233`	`228`	`}`
	`229`	`+ }`
`234`	`230`
`235`		`- return new GetDefinitionResult(foundDefinition);`
	`231`	`+ // if definition is not found in referenced files`
	`232`	`+ // look for it in the builtin commands`
	`233`	`+ if (foundDefinition == null)`
	`234`	`+ {`
	`235`	`+ CommandInfo cmdInfo = GetCommandInfo(foundSymbol.SymbolName);`
	`236`	`+ foundDefinition = FindDeclarationForBuiltinCommand(cmdInfo, foundSymbol);`
`236`	`237`	`}`
`237`		`- else { return null; }`
	`238`	`+`
	`239`	`+ return new GetDefinitionResult(foundDefinition);`
`238`	`240`	`}`
`239`	`241`
`240`	`242`	`/// <summary>`
`@@ -254,6 +256,7 @@ public FindOccurrencesResult FindOccurrencesInFile(`
`254`	`256`	`file.ScriptAst,`
`255`	`257`	`lineNumber,`
`256`	`258`	`columnNumber);`
	`259`	`+`
`257`	`260`	`if (foundSymbol != null)`
`258`	`261`	`{`
`259`	`262`	`IEnumerable<SymbolReference> symbolOccurrences =`
`@@ -268,7 +271,10 @@ public FindOccurrencesResult FindOccurrencesInFile(`
`268`	`271`	`FoundOccurrences = symbolOccurrences`
`269`	`272`	`};`
`270`	`273`	`}`
`271`		`- else { return null; }`
	`274`	`+ else`
	`275`	`+ {`
	`276`	`+ return null;`
	`277`	`+ }`
`272`	`278`	`}`
`273`	`279`
`274`	`280`	`/// <summary>`
`@@ -300,9 +306,15 @@ public ParameterSetSignatures FindParameterSetsInFile(`
`300`	`306`
`301`	`307`	`return new ParameterSetSignatures(commandInfoSet, foundSymbol);`
`302`	`308`	`}`
`303`		`- else { return null; }`
	`309`	`+ else`
	`310`	`+ {`
	`311`	`+ return null;`
	`312`	`+ }`
	`313`	`+ }`
	`314`	`+ else`
	`315`	`+ {`
	`316`	`+ return null;`
`304`	`317`	`}`
`305`		`- else { return null; }`
`306`	`318`	`}`
`307`	`319`
`308`	`320`	`#endregion`
`@@ -354,8 +366,10 @@ private ScriptFile[] GetBuiltinCommandScriptFiles(PSModuleInfo moduleInfo)`
`354`	`366`	`}`
`355`	`367`	`}`
`356`	`368`	`}`
	`369`	`+`
`357`	`370`	`return scriptFiles.ToArray();`
`358`	`371`	`}`
	`372`	`+`
`359`	`373`	`return new List<ScriptFile>().ToArray();`
`360`	`374`	`}`
`361`	`375`
`@@ -383,6 +397,7 @@ private SymbolReference FindDeclarationForBuiltinCommand(CommandInfo cmdInfo, Sy`
`383`	`397`	`index++;`
`384`	`398`	`}`
`385`	`399`	`}`
	`400`	`+`
`386`	`401`	`return foundDefinition;`
`387`	`402`	`}`
`388`	`403`	`}`
Original file line number	Diff line number	Diff line change
`@@ -144,9 +144,9 @@ private void RecursivelyFindReferences(`
`144`	`144`	`scriptFile.FilePath,`
`145`	`145`	`filename);`
`146`	`146`
`147`		`- if (referencedScriptFiles.ContainsKey(resolvedScriptPath))`
	`147`	`+ if (!referencedScriptFiles.ContainsKey(resolvedScriptPath))`
`148`	`148`	`{`
`149`		`- if (TryGetFile(resolvedScriptPath, out newFile))`
	`149`	`+ if (!TryGetFile(resolvedScriptPath, out newFile))`
`150`	`150`	`{`
`151`	`151`	`newFile = OpenFile(resolvedScriptPath);`
`152`	`152`	`referencedScriptFiles.Add(resolvedScriptPath, newFile);`
Original file line number	Diff line number	Diff line change
`@@ -216,7 +216,7 @@ public void FindsNoReferencesOfEmptyLine()`
`216`	`216`	`Arguments = new FileLocationRequestArgs`
`217`	`217`	`{`
`218`	`218`	`File = "TestFiles\\FindReferences.ps1",`
`219`		`- Line = 9,`
	`219`	`+ Line = 10,`
`220`	`220`	`Offset = 1,`
`221`	`221`	`}`
`222`	`222`	`});`
`@@ -256,7 +256,7 @@ public void FindsReferencesOnCommand()`
`256`	`256`	`Arguments = new FileLocationRequestArgs`
`257`	`257`	`{`
`258`	`258`	`File = "TestFiles\\FindReferences.ps1",`
`259`		`- Line = 10,`
	`259`	`+ Line = 9,`
`260`	`260`	`Offset = 2,`
`261`	`261`	`}`
`262`	`262`	`});`
`@@ -297,7 +297,7 @@ public void FindsNoDefinitionOfBuiltinCommand()`
`297`	`297`	`Arguments = new FileLocationRequestArgs`
`298`	`298`	`{`
`299`	`299`	`File = "TestFiles\\FindReferences.ps1",`
`300`		`- Line = 12,`
	`300`	`+ Line = 11,`
`301`	`301`	`Offset = 10,`
`302`	`302`	`}`
`303`	`303`	`});`
`@@ -315,7 +315,7 @@ public void FindsDefintionOfVariable()`
`315`	`315`	`Arguments = new FileLocationRequestArgs`
`316`	`316`	`{`
`317`	`317`	`File = "TestFiles\\FindReferences.ps1",`
`318`		`- Line = 10,`
	`318`	`+ Line = 9,`
`319`	`319`	`Offset = 14,`
`320`	`320`	`}`
`321`	`321`	`});`
`@@ -358,7 +358,7 @@ public void GetsParameterHintsOnCommand()`
`358`	`358`	`Arguments = new SignatureHelpRequestArgs`
`359`	`359`	`{`
`360`	`360`	`File = "TestFiles\\FindReferences.ps1",`
`361`		`- Line = 14,`
	`361`	`+ Line = 13,`
`362`	`362`	`Offset = 15,`
`363`	`363`	`}`
`364`	`364`	`});`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+. .\SimpleFile.ps1`
	`2`	`+`
	`3`	`+My-Function "test"`