Split code and add tests

Author: laurentkempe

src/GitHub.InlineReviews/GitHub.InlineReviews.csproj

@@ -88,6 +88,8 @@
     <Compile Include="Models\InlineCommentThreadModel.cs" />
     <Compile Include="Models\PullRequestSessionLiveFile.cs" />
     <Compile Include="Models\PullRequestSessionFile.cs" />
+    <Compile Include="Services\IPullRequestFilterService.cs" />
+    <Compile Include="Services\PullRequestFilterService.cs" />
     <Compile Include="Services\PullRequestStatusBarManager.cs" />
     <Compile Include="Tags\MouseEnterAndLeaveEventRouter.cs" />
     <Compile Include="Peek\InlineCommentPeekableItemSource.cs" />

src/GitHub.InlineReviews/PullRequestFilterProvider.cs

@@ -1,7 +1,7 @@
 using System.Collections.Generic;
 using System.ComponentModel.Composition;
-using System.IO;
 using System.Threading.Tasks;
+using GitHub.InlineReviews.Services;
 using GitHub.Services;
 using GitHub.VisualStudio;
 using Microsoft.Internal.VisualStudio.PlatformUI;
@@ -20,46 +20,34 @@ public static class PullRequestFilterPackageGuids
     public class PullRequestFilterProvider : HierarchyTreeFilterProvider
     {
         private readonly IVsHierarchyItemCollectionProvider hierarchyCollectionProvider;
-        private readonly IGitHubServiceProvider githubServiceProvider;
+        readonly IGitHubServiceProvider githubServiceProvider;
+        readonly IPullRequestFilterService pullRequestFilterService;
 
         [ImportingConstructor]
-        public PullRequestFilterProvider(IVsHierarchyItemCollectionProvider hierarchyCollectionProvider, IGitHubServiceProvider githubServiceProvider)
+        public PullRequestFilterProvider(IVsHierarchyItemCollectionProvider hierarchyCollectionProvider, IGitHubServiceProvider githubServiceProvider, IPullRequestFilterService pullRequestFilterService)
         {
             this.hierarchyCollectionProvider = hierarchyCollectionProvider;
             this.githubServiceProvider = githubServiceProvider;
+            this.pullRequestFilterService = pullRequestFilterService;
         }
 
         protected override HierarchyTreeFilter CreateFilter()
         {
-            return new PullRequestFilter(hierarchyCollectionProvider, githubServiceProvider);
+            return new PullRequestFilter(hierarchyCollectionProvider, githubServiceProvider, pullRequestFilterService);
         }
 
         private sealed class PullRequestFilter : HierarchyTreeFilter
         {
             private readonly IVsHierarchyItemCollectionProvider hierarchyCollectionProvider;
-            private readonly IGitHubServiceProvider githubServiceProvider;
-            private IPullRequestSessionManager sessionManager;
+            readonly IGitHubServiceProvider githubServiceProvider;
+            readonly IPullRequestFilterService pullRequestFilterService;
             private HashSet<string> pullRequestSessionFiles;
 
-            public PullRequestFilter(IVsHierarchyItemCollectionProvider hierarchyCollectionProvider, IGitHubServiceProvider githubServiceProvider)
+            public PullRequestFilter(IVsHierarchyItemCollectionProvider hierarchyCollectionProvider, IGitHubServiceProvider githubServiceProvider, IPullRequestFilterService pullRequestFilterService)
             {
                 this.hierarchyCollectionProvider = hierarchyCollectionProvider;
                 this.githubServiceProvider = githubServiceProvider;
-            }
-
-            IPullRequestSessionManager SessionManager
-            {
-                get
-                {
-                    // Lazily load the pull request session manager to prevent all of our assemblies
-                    // being loaded on VS startup.
-                    if (sessionManager == null)
-                    {
-                        sessionManager = githubServiceProvider.GetService<IPullRequestSessionManager>();
-                    }
-
-                    return sessionManager;
-                }
+                this.pullRequestFilterService = pullRequestFilterService;
             }
 
             // Gets the items to be included from this filter provider.
@@ -75,25 +63,12 @@ protected override async Task<IReadOnlyObservableSet> GetIncludedItemsAsync(IEnu
                 string _;
                 vsSolution.GetSolutionInfo(out solutionDirectory, out _, out _);
 
-                this.pullRequestSessionFiles = new HashSet<string>();
-                if (SessionManager.CurrentSession != null)
-                {
-                    var requestSessionFiles = await SessionManager.CurrentSession.GetAllFiles();
-                    requestSessionFiles.ForEach(file => this.pullRequestSessionFiles.Add(BuildAbsolutePath(solutionDirectory, file.RelativePath)));
-                }
-
-                return await hierarchyCollectionProvider.GetFilteredHierarchyItemsAsync(sourceItems, ShouldIncludeInFilter, CancellationToken);
-            }
+                pullRequestSessionFiles = await pullRequestFilterService.GetPullRequestSessionFiles(solutionDirectory);
 
-            // Returns true if filters hierarchy item name for given filter; otherwise, false</returns>
-            private bool ShouldIncludeInFilter(IVsHierarchyItem hierarchyItem)
-            {
-                return hierarchyItem?.CanonicalName != null && pullRequestSessionFiles.Contains(hierarchyItem.CanonicalName.ToUpperInvariant());
-            }
-
-            private static string BuildAbsolutePath(string solutionDirectory, string fileRelativePath)
-            {
-                return Path.Combine(solutionDirectory, fileRelativePath.Replace("/", @"\")).ToUpperInvariant();
+                return
+                    await hierarchyCollectionProvider.GetFilteredHierarchyItemsAsync(sourceItems,
+                        hierarchyItem => PullRequestFilterService.ShouldIncludeInFilter(pullRequestSessionFiles, hierarchyItem),
+                        CancellationToken);
             }
         }
     }

src/GitHub.InlineReviews/Services/IPullRequestFilterService.cs

@@ -0,0 +1,10 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace GitHub.InlineReviews.Services
+{
+    public interface IPullRequestFilterService
+    {
+        Task<HashSet<string>> GetPullRequestSessionFiles(string solutionDirectory);
+    }
+}

src/GitHub.InlineReviews/Services/PullRequestFilterService.cs

@@ -0,0 +1,61 @@
+using System.Collections.Generic;
+using System.ComponentModel.Composition;
+using System.IO;
+using System.Threading.Tasks;
+using GitHub.Services;
+using Microsoft.VisualStudio.Shell;
+
+namespace GitHub.InlineReviews.Services
+{
+    [Export(typeof(IPullRequestFilterService))]
+    public class PullRequestFilterService : IPullRequestFilterService
+    {
+        readonly IGitHubServiceProvider githubServiceProvider;
+        private IPullRequestSessionManager sessionManager;
+
+        [ImportingConstructor]
+        public PullRequestFilterService(IGitHubServiceProvider githubServiceProvider)
+        {
+            this.githubServiceProvider = githubServiceProvider;
+        }
+
+        IPullRequestSessionManager SessionManager
+        {
+            get
+            {
+                // Lazily load the pull request session manager to prevent all of our assemblies
+                // being loaded on VS startup.
+                if (sessionManager == null)
+                {
+                    sessionManager = githubServiceProvider.GetService<IPullRequestSessionManager>();
+                }
+
+                return sessionManager;
+            }
+        }
+
+        public async Task<HashSet<string>> GetPullRequestSessionFiles(string solutionDirectory)
+        {
+            var pullRequestSessionFiles = new HashSet<string>();
+
+            if (SessionManager.CurrentSession != null)
+            {
+                var requestSessionFiles = await SessionManager.CurrentSession.GetAllFiles();
+                requestSessionFiles.ForEach(file => pullRequestSessionFiles.Add(BuildAbsolutePath(solutionDirectory, file.RelativePath)));
+            }
+
+            return pullRequestSessionFiles;
+        }
+
+        // Returns true if filters hierarchy item name for given filter; otherwise, false</returns>
+        public static bool ShouldIncludeInFilter(HashSet<string> hashSet, IVsHierarchyItem hierarchyItem)
+        {
+            return hierarchyItem?.CanonicalName != null && hashSet.Contains(hierarchyItem.CanonicalName.ToUpperInvariant());
+        }
+
+        private static string BuildAbsolutePath(string solutionDirectory, string fileRelativePath)
+        {
+            return Path.Combine(solutionDirectory, fileRelativePath.Replace("/", @"\")).ToUpperInvariant();
+        }
+    }
+}

test/GitHub.InlineReviews.UnitTests/Services/PullRequestFilterServiceTests.cs

@@ -0,0 +1,63 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using GitHub.InlineReviews.Services;
+using GitHub.Models;
+using GitHub.Services;
+using NSubstitute;
+using NUnit.Framework;
+
+namespace GitHub.InlineReviews.UnitTests.Services
+{
+    public class PullRequestFilterServiceTests
+    {
+        [Test]
+        public async Task GetPullRequestSessionFiles()
+        {
+            var gitHubServiceProvider = CreateGitHubServiceProvider(new List<IPullRequestSessionFile>());
+
+            var pullRequestFilterService = new PullRequestFilterService(gitHubServiceProvider);
+
+            var pullRequestSessionFiles = await pullRequestFilterService.GetPullRequestSessionFiles(@"c:\MySolution");
+
+            Assert.That(pullRequestSessionFiles, Is.Empty);
+        }
+
+        [Test]
+        public async Task GetPullRequestSessionFiles2()
+        {
+            var pullRequestSessionFilesStub = new List<IPullRequestSessionFile>();
+            var pullRequestSessionFile = Substitute.For<IPullRequestSessionFile>();
+            pullRequestSessionFile.RelativePath.Returns("test");
+            pullRequestSessionFilesStub.Add(pullRequestSessionFile);
+
+            var gitHubServiceProvider = CreateGitHubServiceProvider(pullRequestSessionFilesStub);
+
+            var pullRequestFilterService = new PullRequestFilterService(gitHubServiceProvider);
+
+            var pullRequestSessionFiles = await pullRequestFilterService.GetPullRequestSessionFiles(@"c:\MySolution");
+
+            Assert.That(pullRequestSessionFiles, Is.Empty);
+        }
+
+        IGitHubServiceProvider CreateGitHubServiceProvider(List<IPullRequestSessionFile> pullRequestSessionFilesStub)
+        {
+            var gitHubServiceProvider = Substitute.For<IGitHubServiceProvider>();
+            gitHubServiceProvider.GetService<IPullRequestSessionManager>().Returns(_ => CreatePullRequestSessionManager(pullRequestSessionFilesStub));
+            return gitHubServiceProvider;
+        }
+
+        IPullRequestSessionManager CreatePullRequestSessionManager(List<IPullRequestSessionFile> pullRequestSessionFiles)
+        {
+            var pullRequestSessionManager = Substitute.For<IPullRequestSessionManager>();
+            pullRequestSessionManager.CurrentSession.Returns(_ => CreateCurrentSession(pullRequestSessionFiles));
+            return pullRequestSessionManager;
+        }
+
+        IPullRequestSession CreateCurrentSession(List<IPullRequestSessionFile> pullRequestSessionFilesStub)
+        {
+            var pullRequestSession = Substitute.For<IPullRequestSession>();
+            pullRequestSession.GetAllFiles().Returns(_ => pullRequestSessionFilesStub);
+            return pullRequestSession;
+        }
+    }
+}