Finds all dot sourced files in a ScriptFile

Author: Kayla Davis

src/PowerShellEditorServices/Language/AstOperations.cs

@@ -4,6 +4,7 @@
 //
 
 using System.Collections.Generic;
+using System.Linq;
 using System.Management.Automation;
 using System.Management.Automation.Language;
 using System.Management.Automation.Runspaces;
@@ -135,5 +136,18 @@ static public SymbolReference FindDefinitionOfSymbol(Ast scriptAst, SymbolRefere
 
             return declarationVisitor.FoundDeclartion;
         }
+
+        /// <summary>
+        /// Finds all files dot sourced in a script
+        /// </summary>
+        /// <param name="scriptAst">The abstract syntax tree of the given script</param>
+        /// <returns></returns>
+        static public string[] FindDotSourcedIncludes(Ast scriptAst)
+        {
+            FindDotSourcedVisitor dotSourcedVisitor = new FindDotSourcedVisitor();
+            scriptAst.Visit(dotSourcedVisitor);
+
+            return dotSourcedVisitor.DotSourcedFiles.ToArray();
+        }
     }
 }

src/PowerShellEditorServices/Language/FindDotSourcedVisitor.cs

@@ -0,0 +1,45 @@
+//
+// 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;
+using System.Collections.Generic;
+using System.IO;
+using System.Management.Automation.Language;
+
+namespace Microsoft.PowerShell.EditorServices.Language
+{
+    /// <summary>
+    /// The vistor used to find the dont sourced files in an AST
+    /// </summary>
+    internal class FindDotSourcedVisitor : AstVisitor
+    {
+       /// <summary>
+       /// A hash set of the dot sourced files (because we don't want duplicates)
+       /// </summary>
+        public HashSet<string> DotSourcedFiles { get; private set; }
+
+        public FindDotSourcedVisitor()
+        {
+            this.DotSourcedFiles = new HashSet<string>();
+        }
+
+        /// <summary>
+        /// Checks to see if the command invocation is a dot
+        /// in order to find a dot sourced file
+        /// </summary>
+        /// <param name="commandAst">A CommandAst object in the script's AST</param>
+        /// <returns>A descion to stop searching if the right commandAst was found, 
+        /// or a decision to continue if it wasn't found</returns>
+        public override AstVisitAction VisitCommand(CommandAst commandAst)
+        {
+            if (commandAst.InvocationOperator.Equals(TokenKind.Dot))
+            {
+                string fileName = commandAst.CommandElements[0].Extent.Text;
+                DotSourcedFiles.Add(fileName);
+            }
+            return base.VisitCommand(commandAst);
+        }
+    }
+}

src/PowerShellEditorServices/PowerShellEditorServices.csproj

@@ -72,6 +72,7 @@
     <Compile Include="Language\CompletionResults.cs" />
     <Compile Include="Language\FindCommandVisitor.cs" />
     <Compile Include="Language\FindDeclartionVisitor.cs" />
+    <Compile Include="Language\FindDotSourcedVisitor.cs" />
     <Compile Include="Language\FindOccurrencesResult.cs" />
     <Compile Include="Language\FindReferencesResult.cs" />
     <Compile Include="Language\FindReferencesVisitor.cs" />

src/PowerShellEditorServices/Session/ScriptFile.cs

@@ -3,6 +3,7 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
 
+using Microsoft.PowerShell.EditorServices.Language;
 using Microsoft.PowerShell.EditorServices.Utility;
 using System;
 using System.Collections.Generic;
@@ -78,6 +79,15 @@ public Token[] ScriptTokens
             get { return this.scriptTokens; }
         }
 
+        /// <summary>
+        /// Gets the array of filepaths dot sourced in this ScriptFile 
+        /// </summary>
+        public string[] ReferencedFiles
+        {
+            get;
+            private set;
+        }
+
         #endregion
 
         #region Constructors
@@ -224,6 +234,16 @@ private void ReadFile(TextReader textReader)
 
             // Parse the contents to get syntax tree and errors
             this.ParseFileContents();
+            this.FindDotSourcedFiles();
+        }
+
+        /// <summary>
+        /// Finds the dot sourced files in this ScriptFile
+        /// </summary>
+        private void FindDotSourcedFiles()
+        {
+            ReferencedFiles = 
+                AstOperations.FindDotSourcedIncludes(this.ScriptAst);
         }
 
         /// <summary>

test/PowerShellEditorServices.Test/Session/FileChangeTests.cs renamed to test/PowerShellEditorServices.Test/Session/ScriptFileTests.cs

@@ -123,6 +123,25 @@ public void CanApplyMultiLineDelete()
                 });
         }
 
+        [Fact]
+        public void FindsDotSourcedFiles()
+        {
+            string exampleScriptContents =
+                @". .\athing.ps1"+"\r\n"+
+                @". .\somefile.ps1"+"\r\n" +
+                @". .\somefile.ps1"+"\r\n" +
+                @"Do-Stuff $uri"+"\r\n" +
+                @". simpleps.ps1";
+
+            using (StringReader stringReader = new StringReader(exampleScriptContents))
+            {
+                ScriptFile scriptFile = new ScriptFile("DotSourceTestFile.ps1", stringReader);
+                Assert.Equal(3, scriptFile.ReferencedFiles.Length);
+                System.Console.Write("a" + scriptFile.ReferencedFiles[0]);
+                Assert.Equal(@".\athing.ps1", scriptFile.ReferencedFiles[0]);
+            }
+        }
+
         private void AssertFileChange(
             string initialString,
             string expectedString,