New Method and tests to check if a script ast contains dot sourcing

Author: Razmo99

src/PowerShellEditorServices/Services/PowerShell/Refactoring/Utilities.cs

@@ -106,6 +106,16 @@ public static FunctionDefinitionAst GetFunctionDefByCommandAst(string OldName, i
             return CorrectDefinition;
         }
 
+        public static bool AssertContainsDotSourced(Ast ScriptAst){
+            Ast dotsourced = ScriptAst.Find(ast =>{
+                return ast is CommandAst commandAst && commandAst.InvocationOperator == TokenKind.Dot;
+            },true);
+            if (dotsourced != null)
+            {
+                return true;
+            }
+            return false;
+        }
         public static Ast GetAst(int StartLineNumber, int StartColumnNumber, Ast Ast)
         {
             Ast token = null;

test/PowerShellEditorServices.Test.Shared/Refactoring/Utilities/TestDotSourcingFalse.ps1

@@ -0,0 +1,21 @@
+function New-User {
+    param (
+        [string]$Username,
+        [string]$password
+    )
+    write-host $username + $password
+
+    $splat= @{
+        Username = "JohnDeer"
+        Password = "SomePassword"
+    }
+    New-User @splat
+}
+
+$UserDetailsSplat= @{
+    Username = "JohnDoe"
+    Password = "SomePassword"
+}
+New-User @UserDetailsSplat
+
+New-User -Username "JohnDoe" -Password "SomePassword"

test/PowerShellEditorServices.Test.Shared/Refactoring/Utilities/TestDotSourcingTrue.ps1

@@ -0,0 +1,7 @@
+$sb = { $var = 30 }
+$shouldDotSource = Get-Random -Minimum 0 -Maximum 2
+if ($shouldDotSource) {
+    . $sb
+} else {
+    & $sb
+}

test/PowerShellEditorServices.Test/Refactoring/RefactorUtilitiesTests.cs

@@ -43,131 +43,133 @@ public void Dispose()
         [Fact]
         public void GetVariableExpressionAst()
         {
-            RenameSymbolParams request = new(){
-                Column=11,
-                Line=15,
-                RenameTo="Renamed",
-                FileName="TestDetection.ps1"
+            RenameSymbolParams request = new()
+            {
+                Column = 11,
+                Line = 15,
+                RenameTo = "Renamed",
+                FileName = "TestDetection.ps1"
             };
             ScriptFile scriptFile = GetTestScript(request.FileName);
 
-            Ast symbol = Utilities.GetAst(request.Line,request.Column,scriptFile.ScriptAst);
-            Assert.Equal(15,symbol.Extent.StartLineNumber);
-            Assert.Equal(1,symbol.Extent.StartColumnNumber);
+            Ast symbol = Utilities.GetAst(request.Line, request.Column, scriptFile.ScriptAst);
+            Assert.Equal(15, symbol.Extent.StartLineNumber);
+            Assert.Equal(1, symbol.Extent.StartColumnNumber);
 
         }
         [Fact]
         public void GetVariableExpressionStartAst()
         {
-            RenameSymbolParams request = new(){
-                Column=1,
-                Line=15,
-                RenameTo="Renamed",
-                FileName="TestDetection.ps1"
+            RenameSymbolParams request = new()
+            {
+                Column = 1,
+                Line = 15,
+                RenameTo = "Renamed",
+                FileName = "TestDetection.ps1"
             };
             ScriptFile scriptFile = GetTestScript(request.FileName);
 
-            Ast symbol = Utilities.GetAst(request.Line,request.Column,scriptFile.ScriptAst);
-            Assert.Equal(15,symbol.Extent.StartLineNumber);
-            Assert.Equal(1,symbol.Extent.StartColumnNumber);
+            Ast symbol = Utilities.GetAst(request.Line, request.Column, scriptFile.ScriptAst);
+            Assert.Equal(15, symbol.Extent.StartLineNumber);
+            Assert.Equal(1, symbol.Extent.StartColumnNumber);
 
         }
         [Fact]
         public void GetVariableWithinParameterAst()
         {
-            RenameSymbolParams request = new(){
-                Column=21,
-                Line=3,
-                RenameTo="Renamed",
-                FileName="TestDetection.ps1"
+            RenameSymbolParams request = new()
+            {
+                Column = 21,
+                Line = 3,
+                RenameTo = "Renamed",
+                FileName = "TestDetection.ps1"
             };
             ScriptFile scriptFile = GetTestScript(request.FileName);
 
-            Ast symbol = Utilities.GetAst(request.Line,request.Column,scriptFile.ScriptAst);
-            Assert.Equal(3,symbol.Extent.StartLineNumber);
-            Assert.Equal(17,symbol.Extent.StartColumnNumber);
+            Ast symbol = Utilities.GetAst(request.Line, request.Column, scriptFile.ScriptAst);
+            Assert.Equal(3, symbol.Extent.StartLineNumber);
+            Assert.Equal(17, symbol.Extent.StartColumnNumber);
 
         }
         [Fact]
         public void GetHashTableKey()
         {
-            RenameSymbolParams request = new(){
-                Column=9,
-                Line=16,
-                RenameTo="Renamed",
-                FileName="TestDetection.ps1"
+            RenameSymbolParams request = new()
+            {
+                Column = 9,
+                Line = 16,
+                RenameTo = "Renamed",
+                FileName = "TestDetection.ps1"
             };
             ScriptFile scriptFile = GetTestScript(request.FileName);
 
-            Ast symbol = Utilities.GetAst(request.Line,request.Column,scriptFile.ScriptAst);
-            Assert.Equal(16,symbol.Extent.StartLineNumber);
-            Assert.Equal(5,symbol.Extent.StartColumnNumber);
+            Ast symbol = Utilities.GetAst(request.Line, request.Column, scriptFile.ScriptAst);
+            Assert.Equal(16, symbol.Extent.StartLineNumber);
+            Assert.Equal(5, symbol.Extent.StartColumnNumber);
 
         }
         [Fact]
         public void GetVariableWithinCommandAst()
         {
-            RenameSymbolParams request = new(){
-                Column=29,
-                Line=6,
-                RenameTo="Renamed",
-                FileName="TestDetection.ps1"
+            RenameSymbolParams request = new()
+            {
+                Column = 29,
+                Line = 6,
+                RenameTo = "Renamed",
+                FileName = "TestDetection.ps1"
             };
             ScriptFile scriptFile = GetTestScript(request.FileName);
 
-            Ast symbol = Utilities.GetAst(request.Line,request.Column,scriptFile.ScriptAst);
-            Assert.Equal(6,symbol.Extent.StartLineNumber);
-            Assert.Equal(28,symbol.Extent.StartColumnNumber);
+            Ast symbol = Utilities.GetAst(request.Line, request.Column, scriptFile.ScriptAst);
+            Assert.Equal(6, symbol.Extent.StartLineNumber);
+            Assert.Equal(28, symbol.Extent.StartColumnNumber);
 
         }
         [Fact]
         public void GetCommandParameterAst()
         {
-            RenameSymbolParams request = new(){
-                Column=12,
-                Line=21,
-                RenameTo="Renamed",
-                FileName="TestDetection.ps1"
-            };
-            ScriptFile scriptFile = GetTestScript(request.FileName);
-
-            Ast symbol = Utilities.GetAst(request.Line,request.Column,scriptFile.ScriptAst);
-            Assert.Equal(21,symbol.Extent.StartLineNumber);
-            Assert.Equal(10,symbol.Extent.StartColumnNumber);
-
-        }
-        [Fact]
-        public void GetFunctionDefinitionAst()
-        {
-            RenameSymbolParams request = new(){
-                Column=12,
-                Line=1,
-                RenameTo="Renamed",
-                FileName="TestDetection.ps1"
+            RenameSymbolParams request = new()
+            {
+                Column = 12,
+                Line = 21,
+                RenameTo = "Renamed",
+                FileName = "TestDetection.ps1"
             };
             ScriptFile scriptFile = GetTestScript(request.FileName);
 
-            Ast symbol = Utilities.GetAst(request.Line,request.Column,scriptFile.ScriptAst);
-            Assert.Equal(1,symbol.Extent.StartLineNumber);
-            Assert.Equal(1,symbol.Extent.StartColumnNumber);
+            Ast symbol = Utilities.GetAst(request.Line, request.Column, scriptFile.ScriptAst);
+            Assert.Equal(21, symbol.Extent.StartLineNumber);
+            Assert.Equal(10, symbol.Extent.StartColumnNumber);
 
         }
         [Fact]
         public void GetFunctionDefinitionAst()
         {
             RenameSymbolParams request = new()
             {
-                Column = 16,
+                Column = 12,
                 Line = 1,
                 RenameTo = "Renamed",
                 FileName = "TestDetection.ps1"
             };
             ScriptFile scriptFile = GetTestScript(request.FileName);
 
             Ast symbol = Utilities.GetAst(request.Line, request.Column, scriptFile.ScriptAst);
-            Assert.IsType<FunctionDefinitionAst>(symbol);
             Assert.Equal(1, symbol.Extent.StartLineNumber);
             Assert.Equal(1, symbol.Extent.StartColumnNumber);
+
+        }
+        [Fact]
+        public void AssertContainsDotSourcingTrue()
+        {
+            ScriptFile scriptFile = GetTestScript("TestDotSourcingTrue.ps1");
+            Assert.True(Utilities.AssertContainsDotSourced(scriptFile.ScriptAst));
+        }
+        [Fact]
+        public void AssertContainsDotSourcingFalse()
+        {
+            ScriptFile scriptFile = GetTestScript("TestDotSourcingFalse.ps1");
+            Assert.False(Utilities.AssertContainsDotSourced(scriptFile.ScriptAst));
         }
     }
 }