(GH-879) Add characterisation tests for Workspace.EnumeratePSFiles

glennsarti · glennsarti · commit 103214fcee07 · 2019-03-17T20:48:17.000+08:00
Previosly there were no tests for the Workspace.EnumeratePSFiles method.  This
commit adds tests for EnumeratePSFiles method using a set of static fixture
test files.

Note that the behaviour of EnumeratePSFiles changes depending on the .Net
Framework edition
diff --git a/test/PowerShellEditorServices.Test/Fixtures/Workspace/nested/donotfind.ps1 b/test/PowerShellEditorServices.Test/Fixtures/Workspace/nested/donotfind.ps1
@@ -0,0 +1 @@
+# donotfind.ps1
diff --git a/test/PowerShellEditorServices.Test/Fixtures/Workspace/nested/donotfind.txt b/test/PowerShellEditorServices.Test/Fixtures/Workspace/nested/donotfind.txt
@@ -0,0 +1 @@
+donotfind.txt
diff --git a/test/PowerShellEditorServices.Test/Fixtures/Workspace/nested/nestedmodule.psd1 b/test/PowerShellEditorServices.Test/Fixtures/Workspace/nested/nestedmodule.psd1
@@ -0,0 +1 @@
+# nestedmodule.psd1
diff --git a/test/PowerShellEditorServices.Test/Fixtures/Workspace/nested/nestedmodule.psm1 b/test/PowerShellEditorServices.Test/Fixtures/Workspace/nested/nestedmodule.psm1
@@ -0,0 +1 @@
+# nestedmodule.psm1
diff --git a/test/PowerShellEditorServices.Test/Fixtures/Workspace/other/other.cdxml b/test/PowerShellEditorServices.Test/Fixtures/Workspace/other/other.cdxml
@@ -0,0 +1 @@
+<!-- other.cdxml -->
diff --git a/test/PowerShellEditorServices.Test/Fixtures/Workspace/other/other.ps1xml b/test/PowerShellEditorServices.Test/Fixtures/Workspace/other/other.ps1xml
@@ -0,0 +1 @@
+<!-- other.ps1xml -->
diff --git a/test/PowerShellEditorServices.Test/Fixtures/Workspace/other/other.psrc b/test/PowerShellEditorServices.Test/Fixtures/Workspace/other/other.psrc
@@ -0,0 +1 @@
+# other.psrc
diff --git a/test/PowerShellEditorServices.Test/Fixtures/Workspace/other/other.pssc b/test/PowerShellEditorServices.Test/Fixtures/Workspace/other/other.pssc
@@ -0,0 +1 @@
+# other.pssc
diff --git a/test/PowerShellEditorServices.Test/Fixtures/Workspace/rootfile.ps1 b/test/PowerShellEditorServices.Test/Fixtures/Workspace/rootfile.ps1
@@ -0,0 +1 @@
+# rootfile.ps1
diff --git a/test/PowerShellEditorServices.Test/PowerShellEditorServices.Test.csproj b/test/PowerShellEditorServices.Test/PowerShellEditorServices.Test.csproj
@@ -27,6 +27,11 @@
   <ItemGroup>
     <Service Include="{82a7f48d-3b50-4b1e-b82e-3ada8210c358}" />
   </ItemGroup>
+  <ItemGroup>
+    <None Include="Fixtures\**">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
   <PropertyGroup Condition=" '$(TargetFramework)' == 'netcoreapp2.1' ">
     <DefineConstants>$(DefineConstants);CoreCLR</DefineConstants>
   </PropertyGroup>
diff --git a/test/PowerShellEditorServices.Test/Session/WorkspaceTests.cs b/test/PowerShellEditorServices.Test/Session/WorkspaceTests.cs
@@ -18,6 +18,7 @@ public class WorkspaceTests
         private static readonly Version PowerShellVersion = new Version("5.0");
 
         [Fact]
+        [Trait("Category", "Workspace")]
         public void CanResolveWorkspaceRelativePath()
         {
             string workspacePath = TestUtilities.NormalizePath("c:/Test/Workspace/");
@@ -41,6 +42,43 @@ public void CanResolveWorkspaceRelativePath()
         }
 
         [Fact]
+        [Trait("Category", "Workspace")]
+        public void CanRecurseDirectoryTree()
+        {
+            Workspace workspace = new Workspace(PowerShellVersion, Logging.NullLogger);
+            workspace.WorkspacePath = TestUtilities.NormalizePath("Fixtures/Workspace");
+
+            IEnumerable<string> result = workspace.EnumeratePSFiles();
+            List<string> fileList = new List<string>();
+            foreach (string file in result) { fileList.Add(file); }
+            // TODO: Is order important? or just collected in depth-first order?
+            // TODO: For now assume order is not important and sort the array so we can use deterministic asserts
+            fileList.Sort();
+
+            if (RuntimeInformation.FrameworkDescription.StartsWith(".NET Core"))
+            {
+                // .Net Core doesn't appear to use the same three letter pattern matching rule although the docs
+                // suggest it should be find the '.ps1xml' files because we search for the pattern '*.ps1'
+                // ref https://docs.microsoft.com/en-us/dotnet/api/system.io.directory.getfiles?view=netcore-2.1#System_IO_Directory_GetFiles_System_String_System_String_System_IO_EnumerationOptions_
+                Assert.Equal(4, fileList.Count);
+                Assert.Equal(Path.Combine(workspace.WorkspacePath,"nested", "donotfind.ps1"), fileList[0]);
+                Assert.Equal(Path.Combine(workspace.WorkspacePath,"nested", "nestedmodule.psd1"), fileList[1]);
+                Assert.Equal(Path.Combine(workspace.WorkspacePath,"nested", "nestedmodule.psm1"), fileList[2]);
+                Assert.Equal(Path.Combine(workspace.WorkspacePath,"rootfile.ps1"), fileList[3]);
+            }
+            else
+            {
+                Assert.Equal(5, fileList.Count);
+                Assert.Equal(Path.Combine(workspace.WorkspacePath,"nested", "donotfind.ps1"), fileList[0]);
+                Assert.Equal(Path.Combine(workspace.WorkspacePath,"nested", "nestedmodule.psd1"), fileList[1]);
+                Assert.Equal(Path.Combine(workspace.WorkspacePath,"nested", "nestedmodule.psm1"), fileList[2]);
+                Assert.Equal(Path.Combine(workspace.WorkspacePath,"other", "other.ps1xml"), fileList[3]);
+                Assert.Equal(Path.Combine(workspace.WorkspacePath,"rootfile.ps1"), fileList[4]);
+            }
+        }
+
+        [Fact]
+        [Trait("Category", "Workspace")]
         public void CanDetermineIsPathInMemory()
         {
             string tempDir = Path.GetTempPath();
@@ -78,6 +116,7 @@ public void CanDetermineIsPathInMemory()
         }
 
         [Theory()]
+        [Trait("Category", "Workspace")]
         [MemberData(nameof(PathsToResolve), parameters: 2)]
         public void CorrectlyResolvesPaths(string givenPath, string expectedPath)
         {
