reworked applicable utilities tests to be parameterized

Author: Razmo99

test/PowerShellEditorServices.Test.Shared/Refactoring/Utilities/RefactorUtilitiesData.cs

@@ -0,0 +1,60 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+using Microsoft.PowerShell.EditorServices.Handlers;
+
+namespace PowerShellEditorServices.Test.Shared.Refactoring.Utilities
+{
+    internal static class RenameUtilitiesData
+    {
+
+        public static readonly RenameSymbolParams GetVariableExpressionAst = new()
+        {
+            Column = 11,
+            Line = 15,
+            RenameTo = "Renamed",
+            FileName = "TestDetection.ps1"
+        };
+        public static readonly RenameSymbolParams GetVariableExpressionStartAst = new()
+        {
+            Column = 1,
+            Line = 15,
+            RenameTo = "Renamed",
+            FileName = "TestDetection.ps1"
+        };
+        public static readonly RenameSymbolParams GetVariableWithinParameterAst = new()
+        {
+            Column = 21,
+            Line = 3,
+            RenameTo = "Renamed",
+            FileName = "TestDetection.ps1"
+        };
+        public static readonly RenameSymbolParams GetHashTableKey = new()
+        {
+            Column = 9,
+            Line = 16,
+            RenameTo = "Renamed",
+            FileName = "TestDetection.ps1"
+        };
+        public static readonly RenameSymbolParams GetVariableWithinCommandAst = new()
+        {
+            Column = 29,
+            Line = 6,
+            RenameTo = "Renamed",
+            FileName = "TestDetection.ps1"
+        };
+        public static readonly RenameSymbolParams GetCommandParameterAst = new()
+        {
+            Column = 12,
+            Line = 21,
+            RenameTo = "Renamed",
+            FileName = "TestDetection.ps1"
+        };
+        public static readonly RenameSymbolParams GetFunctionDefinitionAst = new()
+        {
+            Column = 12,
+            Line = 1,
+            RenameTo = "Renamed",
+            FileName = "TestDetection.ps1"
+        };
+    }
+}

test/PowerShellEditorServices.Test/Refactoring/RefactorUtilitiesTests.cs

@@ -12,10 +12,9 @@
 using Microsoft.PowerShell.EditorServices.Handlers;
 using Xunit;
 using System.Management.Automation.Language;
+using static PowerShellEditorServices.Test.Refactoring.RefactorUtilities;
 using Microsoft.PowerShell.EditorServices.Refactoring;
-using System.Management.Automation.Language;
-using System.Collections.Generic;
-using System.Linq;
+using PowerShellEditorServices.Test.Shared.Refactoring.Utilities;
 
 namespace PowerShellEditorServices.Test.Refactoring
 {
@@ -34,140 +33,48 @@ 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", "Utilities", fileName)));
 
-        [Fact]
-        public void GetVariableExpressionAst()
-        {
-            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);
 
-        }
-        [Fact]
-        public void GetVariableExpressionStartAst()
+        public class GetAstShouldDetectTestData : TheoryData<RenameSymbolParamsSerialized, int, int>
         {
-            RenameSymbolParams request = new()
+            public GetAstShouldDetectTestData()
             {
-                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);
-
+                Add(new RenameSymbolParamsSerialized(RenameUtilitiesData.GetVariableExpressionAst), 15, 1);
+                Add(new RenameSymbolParamsSerialized(RenameUtilitiesData.GetVariableExpressionStartAst), 15, 1);
+                Add(new RenameSymbolParamsSerialized(RenameUtilitiesData.GetVariableWithinParameterAst), 3, 17);
+                Add(new RenameSymbolParamsSerialized(RenameUtilitiesData.GetHashTableKey), 16, 5);
+                Add(new RenameSymbolParamsSerialized(RenameUtilitiesData.GetVariableWithinCommandAst), 6, 28);
+                Add(new RenameSymbolParamsSerialized(RenameUtilitiesData.GetCommandParameterAst), 21, 10);
+                Add(new RenameSymbolParamsSerialized(RenameUtilitiesData.GetFunctionDefinitionAst), 1, 1);
+            }
         }
-        [Fact]
-        public void GetVariableWithinParameterAst()
-        {
-            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);
-
-        }
-        [Fact]
-        public void GetHashTableKey()
-        {
-            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);
 
-        }
-        [Fact]
-        public void GetVariableWithinCommandAst()
+        [Theory]
+        [ClassData(typeof(GetAstShouldDetectTestData))]
+        public void GetAstShouldDetect(RenameSymbolParamsSerialized s, int l, int c)
         {
-            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);
-
+            ScriptFile scriptFile = GetTestScript(s.FileName);
+            Ast symbol = Utilities.GetAst(s.Line, s.Column, scriptFile.ScriptAst);
+            // Assert the Line and Column is what is expected
+            Assert.Equal(l, symbol.Extent.StartLineNumber);
+            Assert.Equal(c, 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()
+        public void GetVariableUnderFunctionDef()
         {
             RenameSymbolParams request = new()
             {
-                Column = 12,
-                Line = 1,
+                Column = 5,
+                Line = 2,
                 RenameTo = "Renamed",
-                FileName = "TestDetection.ps1"
+                FileName = "TestDetectionUnderFunctionDef.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);
-
-        }
-        [Fact]
-        public void GetVariableUnderFunctionDef()
-        {
-            RenameSymbolParams request = new(){
-                Column=5,
-                Line=2,
-                RenameTo="Renamed",
-                FileName="TestDetectionUnderFunctionDef.ps1"
-            };
-            ScriptFile scriptFile = GetTestScript(request.FileName);
-
-            Ast symbol = Utilities.GetAst(request.Line,request.Column,scriptFile.ScriptAst);
             Assert.IsType<VariableExpressionAst>(symbol);
-            Assert.Equal(2,symbol.Extent.StartLineNumber);
-            Assert.Equal(5,symbol.Extent.StartColumnNumber);
+            Assert.Equal(2, symbol.Extent.StartLineNumber);
+            Assert.Equal(5, symbol.Extent.StartColumnNumber);
 
         }
         [Fact]