modified variable test cases to use parameterized test cases

Author: Razmo99

test/PowerShellEditorServices.Test/Refactoring/RefactorVariableTests.cs

@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-using System;
 using System.IO;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Logging.Abstractions;
@@ -13,6 +12,7 @@
 using Microsoft.PowerShell.EditorServices.Handlers;
 using Xunit;
 using PowerShellEditorServices.Test.Shared.Refactoring.Variables;
+using static PowerShellEditorServices.Test.Refactoring.RefactorUtilities;
 using Microsoft.PowerShell.EditorServices.Refactoring;
 
 namespace PowerShellEditorServices.Test.Refactoring
@@ -31,33 +31,7 @@ public async Task InitializeAsync()
         public async Task DisposeAsync() => await Task.Run(psesHost.StopAsync);
         private ScriptFile GetTestScript(string fileName) => workspace.GetFile(TestUtilities.GetSharedPath(Path.Combine("Refactoring", "Variables", fileName)));
 
-        internal static string GetModifiedScript(string OriginalScript, ModifiedFileResponse Modification)
-        {
-            Modification.Changes.Sort((a, b) =>
-            {
-                if (b.StartLine == a.StartLine)
-                {
-                    return b.EndColumn - a.EndColumn;
-                }
-                return b.StartLine - a.StartLine;
-
-            });
-            string[] Lines = OriginalScript.Split(
-                            new string[] { Environment.NewLine },
-                            StringSplitOptions.None);
-
-            foreach (TextChange change in Modification.Changes)
-            {
-                string TargetLine = Lines[change.StartLine];
-                string begin = TargetLine.Substring(0, change.StartColumn);
-                string end = TargetLine.Substring(change.EndColumn);
-                Lines[change.StartLine] = begin + change.NewText + end;
-            }
-
-            return string.Join(Environment.NewLine, Lines);
-        }
-
-        internal static string TestRenaming(ScriptFile scriptFile, RenameSymbolParams request)
+        internal static string TestRenaming(ScriptFile scriptFile, RenameSymbolParamsSerialized request)
         {
 
             IterativeVariableRename iterative = new(request.RenameTo,
@@ -71,223 +45,40 @@ internal static string TestRenaming(ScriptFile scriptFile, RenameSymbolParams re
             };
             return GetModifiedScript(scriptFile.Contents, changes);
         }
-
-        [Fact]
-        public void RefactorVariableSingle()
-        {
-            RenameSymbolParams request = RenameVariableData.SimpleVariableAssignment;
-            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 RefactorVariableNestedScopeFunction()
-        {
-            RenameSymbolParams request = RenameVariableData.VariableNestedScopeFunction;
-            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 RefactorVariableInPipeline()
-        {
-            RenameSymbolParams request = RenameVariableData.VariableInPipeline;
-            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 RefactorVariableInScriptBlock()
-        {
-            RenameSymbolParams request = RenameVariableData.VariableInScriptblock;
-            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 RefactorVariableInScriptBlockScoped()
-        {
-            RenameSymbolParams request = RenameVariableData.VariablewWithinHastableExpression;
-            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 VariableNestedFunctionScriptblock()
-        {
-            RenameSymbolParams request = RenameVariableData.VariableNestedFunctionScriptblock;
-            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 VariableWithinCommandAstScriptBlock()
-        {
-            RenameSymbolParams request = RenameVariableData.VariableWithinCommandAstScriptBlock;
-            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 VariableWithinForeachObject()
-        {
-            RenameSymbolParams request = RenameVariableData.VariableWithinForeachObject;
-            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 VariableusedInWhileLoop()
-        {
-            RenameSymbolParams request = RenameVariableData.VariableusedInWhileLoop;
-            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 VariableInParam()
-        {
-            RenameSymbolParams request = RenameVariableData.VariableInParam;
-            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 VariableCommandParameter()
-        {
-            RenameSymbolParams request = RenameVariableData.VariableCommandParameter;
-            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 VariableCommandParameterReverse()
-        {
-            RenameSymbolParams request = RenameVariableData.VariableCommandParameterReverse;
-            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 VariableScriptWithParamBlock()
-        {
-            RenameSymbolParams request = RenameVariableData.VariableScriptWithParamBlock;
-            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 VariableNonParam()
-        {
-            RenameSymbolParams request = RenameVariableData.VariableNonParam;
-            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 VariableParameterCommandWithSameName()
-        {
-            RenameSymbolParams request = RenameVariableData.VariableParameterCommandWithSameName;
-            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 VarableCommandParameterSplattedFromCommandAst()
-        {
-            RenameSymbolParams request = RenameVariableData.VariableCommandParameterSplattedFromCommandAst;
-            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 VarableCommandParameterSplattedFromSplat()
+        public class VariableRenameTestData : TheoryData<RenameSymbolParamsSerialized>
         {
-            RenameSymbolParams request = RenameVariableData.VariableCommandParameterSplattedFromSplat;
-            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);
+            public VariableRenameTestData()
+            {
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.SimpleVariableAssignment));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableRedefinition));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableNestedScopeFunction));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableInLoop));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableInPipeline));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableInScriptblock));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableInScriptblockScoped));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariablewWithinHastableExpression));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableNestedFunctionScriptblock));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableWithinCommandAstScriptBlock));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableWithinForeachObject));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableusedInWhileLoop));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableInParam));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableCommandParameter));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableCommandParameterReverse));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableScriptWithParamBlock));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableNonParam));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableParameterCommandWithSameName));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableCommandParameterSplattedFromCommandAst));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableCommandParameterSplattedFromSplat));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableInForeachDuplicateAssignment));
+                Add(new RenameSymbolParamsSerialized(RenameVariableData.VariableInForloopDuplicateAssignment));
+            }
         }
-        [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()
+        [Theory]
+        [ClassData(typeof(VariableRenameTestData))]
+        public void Rename(RenameSymbolParamsSerialized s)
         {
-            RenameSymbolParams request = RenameVariableData.VariableInForloopDuplicateAssignment;
+            RenameSymbolParamsSerialized request = s;
             ScriptFile scriptFile = GetTestScript(request.FileName);
             ScriptFile expectedContent = GetTestScript(request.FileName.Substring(0, request.FileName.Length - 4) + "Renamed.ps1");
 
@@ -296,4 +87,5 @@ public void VariableInForloopDuplicateAssignment()
             Assert.Equal(expectedContent.Contents, modifiedcontent);
         }
     }
+
 }