Add test for dot-sourced find function definition

Author: daviwil

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;
         }
     }

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);

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,
                     }
                 });

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";

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
+            };
+    }
+}

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>

test/PowerShellEditorServices.Test.Shared/References/FileWithReferences.ps1

@@ -0,0 +1,3 @@
+. .\SimpleFile.ps1
+
+My-Function "test"

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)