added tests and logic for duplicate assignment cases for; foreach and for loops

Author: Razmo99

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

@@ -174,11 +174,25 @@ internal static Ast GetAstParentScope(Ast node)
         {
             Ast parent = node;
             // Walk backwards up the tree looking for a ScriptBLock of a FunctionDefinition
-            parent = Utilities.GetAstParentOfType(parent, typeof(ScriptBlockAst), typeof(FunctionDefinitionAst));
+            parent = Utilities.GetAstParentOfType(parent, typeof(ScriptBlockAst), typeof(FunctionDefinitionAst), typeof(ForEachStatementAst),typeof(ForStatementAst));
             if (parent is ScriptBlockAst && parent.Parent != null && parent.Parent is FunctionDefinitionAst)
             {
                 parent = parent.Parent;
             }
+            // Check if the parent of the VariableExpressionAst is a ForEachStatementAst then check if the variable names match
+            // if so this is probably a variable defined within a foreach loop
+            else if(parent is ForEachStatementAst ForEachStmnt && node is VariableExpressionAst VarExp &&
+                     ForEachStmnt.Variable.VariablePath.UserPath == VarExp.VariablePath.UserPath) {
+                parent = ForEachStmnt;
+            }
+            // Check if the parent of the VariableExpressionAst is a ForStatementAst then check if the variable names match
+            // if so this is probably a variable defined within a foreach loop
+            else if(parent is ForStatementAst ForStmnt && node is VariableExpressionAst ForVarExp &&
+                    ForStmnt.Initializer is AssignmentStatementAst AssignStmnt && AssignStmnt.Left is VariableExpressionAst VarExpStmnt &&
+                    VarExpStmnt.VariablePath.UserPath == ForVarExp.VariablePath.UserPath){
+                parent = ForStmnt;
+            }
+
             return parent;
         }
 

test/PowerShellEditorServices.Test.Shared/Refactoring/Variables/RefactorVariablesData.cs

@@ -149,5 +149,26 @@ internal static class RenameVariableData
             Line = 16,
             RenameTo = "Renamed"
         };
+        public static readonly RenameSymbolParams VariableInForeachDuplicateAssignment = new()
+        {
+            FileName = "VariableInForeachDuplicateAssignment.ps1",
+            Column = 18,
+            Line = 6,
+            RenameTo = "Renamed"
+        };
+        public static readonly RenameSymbolParams VariableInForloopDuplicateAssignment = new()
+        {
+            FileName = "VariableInForloopDuplicateAssignment.ps1",
+            Column = 14,
+            Line = 7,
+            RenameTo = "Renamed"
+        };
+        public static readonly RenameSymbolParams VariableInWhileDuplicateAssignment = new()
+        {
+            FileName = "VariableInWhileDuplicateAssignment.ps1",
+            Column = 13,
+            Line = 7,
+            RenameTo = "Renamed"
+        };
     }
 }

test/PowerShellEditorServices.Test.Shared/Refactoring/Variables/VariableInForeachDuplicateAssignment.ps1

@@ -0,0 +1,13 @@
+$a = 1..5
+$b = 6..10
+function test {
+    process {
+        foreach ($testvar in $a) {
+            $testvar
+        }
+
+        foreach ($testvar in $b) {
+            $testvar
+        }
+    }
+}

test/PowerShellEditorServices.Test.Shared/Refactoring/Variables/VariableInForeachDuplicateAssignmentRenamed.ps1

@@ -0,0 +1,13 @@
+$a = 1..5
+$b = 6..10
+function test {
+    process {
+        foreach ($Renamed in $a) {
+            $Renamed
+        }
+
+        foreach ($testvar in $b) {
+            $testvar
+        }
+    }
+}

test/PowerShellEditorServices.Test.Shared/Refactoring/Variables/VariableInForloopDuplicateAssignment.ps1

@@ -0,0 +1,14 @@
+$a = 1..5
+$b = 6..10
+function test {
+    process {
+
+        for ($i = 0; $i -lt $a.Count; $i++) {
+            $i
+        }
+
+        for ($i = 0; $i -lt $a.Count; $i++) {
+            $i
+        }
+    }
+}

test/PowerShellEditorServices.Test.Shared/Refactoring/Variables/VariableInForloopDuplicateAssignmentRenamed.ps1

@@ -0,0 +1,14 @@
+$a = 1..5
+$b = 6..10
+function test {
+    process {
+
+        for ($Renamed = 0; $Renamed -lt $a.Count; $Renamed++) {
+            $Renamed
+        }
+
+        for ($i = 0; $i -lt $a.Count; $i++) {
+            $i
+        }
+    }
+}

test/PowerShellEditorServices.Test/Refactoring/RefactorVariableTests.cs

@@ -271,6 +271,28 @@ public void VarableCommandParameterSplattedFromSplat()
 
             string modifiedcontent = TestRenaming(scriptFile, request);
 
+            Assert.Equal(expectedContent.Contents, modifiedcontent);
+        }
+        [Fact]
+        public void VariableInForeachDuplicateAssignment()
+        {
+            RenameSymbolParams request = RenameVariableData.VariableInForeachDuplicateAssignment;
+            ScriptFile scriptFile = GetTestScript(request.FileName);
+            ScriptFile expectedContent = GetTestScript(request.FileName.Substring(0, request.FileName.Length - 4) + "Renamed.ps1");
+
+            string modifiedcontent = TestRenaming(scriptFile, request);
+
+            Assert.Equal(expectedContent.Contents, modifiedcontent);
+        }
+        [Fact]
+        public void VariableInForloopDuplicateAssignment()
+        {
+            RenameSymbolParams request = RenameVariableData.VariableInForloopDuplicateAssignment;
+            ScriptFile scriptFile = GetTestScript(request.FileName);
+            ScriptFile expectedContent = GetTestScript(request.FileName.Substring(0, request.FileName.Length - 4) + "Renamed.ps1");
+
+            string modifiedcontent = TestRenaming(scriptFile, request);
+
             Assert.Equal(expectedContent.Contents, modifiedcontent);
         }
     }