Merge pull request #1642 from github/refactor/sync-submodules-vs-command

Factor sync submodules into VS command

Author: jcansdale

src/GitHub.App/ViewModels/GitHubPane/PullRequestDetailViewModel.cs

@@ -7,8 +7,8 @@
 using System.Reactive.Linq;
 using System.Reactive.Threading.Tasks;
 using System.Threading.Tasks;
-using System.Globalization;
 using GitHub.App;
+using GitHub.Commands;
 using GitHub.Extensions;
 using GitHub.Factories;
 using GitHub.Helpers;
@@ -36,7 +36,7 @@ public sealed class PullRequestDetailViewModel : PanePageViewModelBase, IPullReq
         readonly IPullRequestSessionManager sessionManager;
         readonly IUsageTracker usageTracker;
         readonly ITeamExplorerContext teamExplorerContext;
-        readonly IStatusBarNotificationService statusBarNotificationService;
+        readonly ISyncSubmodulesCommand syncSubmodulesCommand;
         IModelService modelService;
         IPullRequestModel model;
         string sourceBranchDisplayName;
@@ -71,22 +71,22 @@ public PullRequestDetailViewModel(
             IModelServiceFactory modelServiceFactory,
             IUsageTracker usageTracker,
             ITeamExplorerContext teamExplorerContext,
-            IStatusBarNotificationService statusBarNotificationService,
-            IPullRequestFilesViewModel files)
+            IPullRequestFilesViewModel files,
+            ISyncSubmodulesCommand syncSubmodulesCommand)
         {
             Guard.ArgumentNotNull(pullRequestsService, nameof(pullRequestsService));
             Guard.ArgumentNotNull(sessionManager, nameof(sessionManager));
             Guard.ArgumentNotNull(modelServiceFactory, nameof(modelServiceFactory));
             Guard.ArgumentNotNull(usageTracker, nameof(usageTracker));
             Guard.ArgumentNotNull(teamExplorerContext, nameof(teamExplorerContext));
-            Guard.ArgumentNotNull(statusBarNotificationService, nameof(statusBarNotificationService));
+            Guard.ArgumentNotNull(syncSubmodulesCommand, nameof(syncSubmodulesCommand));
 
             this.pullRequestsService = pullRequestsService;
             this.sessionManager = sessionManager;
             this.modelServiceFactory = modelServiceFactory;
             this.usageTracker = usageTracker;
             this.teamExplorerContext = teamExplorerContext;
-            this.statusBarNotificationService = statusBarNotificationService;
+            this.syncSubmodulesCommand = syncSubmodulesCommand;
             Files = files;
 
             Checkout = ReactiveCommand.CreateAsyncObservable(
@@ -606,21 +606,17 @@ async Task DoSyncSubmodules(object unused)
                 IsBusy = true;
                 usageTracker.IncrementCounter(x => x.NumberOfSyncSubmodules).Forget();
 
-                var writer = new StringWriter(CultureInfo.CurrentCulture);
-                var complete = await pullRequestsService.SyncSubmodules(LocalRepository, line =>
-                {
-                    writer.WriteLine(line);
-                    statusBarNotificationService.ShowMessage(line);
-                });
+                var result = await syncSubmodulesCommand.SyncSubmodules();
+                var complete = result.Item1;
+                var summary = result.Item2;
                 if (!complete)
                 {
-                    throw new ApplicationException(writer.ToString());
+                    throw new ApplicationException(summary);
                 }
             }
             finally
             {
                 IsBusy = false;
-                statusBarNotificationService.ShowMessage(string.Empty);
             }
         }
 

src/GitHub.Exports/Commands/ISyncSubmodulesCommand.cs

@@ -0,0 +1,18 @@
+using System;
+using System.Threading.Tasks;
+
+namespace GitHub.Commands
+{
+    /// <summary>
+    /// Sync submodules in local repository.
+    /// </summary>
+    public interface ISyncSubmodulesCommand : IVsCommand
+    {
+        /// <summary>
+        /// Sync submodules in local repository.
+        /// </summary>
+        /// <returns>Tuple with bool that is true if command completed successfully and string with
+        /// output from sync submodules Git command.</returns>
+        Task<Tuple<bool, string>> SyncSubmodules();
+    }
+}

src/GitHub.Exports/GitHub.Exports.csproj

@@ -148,6 +148,7 @@
     <Compile Include="Commands\IOpenLinkCommand.cs" />
     <Compile Include="Commands\ICreateGistCommand.cs" />
     <Compile Include="Commands\IShowCurrentPullRequestCommand.cs" />
+    <Compile Include="Commands\ISyncSubmodulesCommand.cs" />
     <Compile Include="Commands\IShowGitHubPaneCommand.cs" />
     <Compile Include="Commands\IOpenPullRequestsCommand.cs" />
     <Compile Include="Commands\IAddConnectionCommand.cs" />

src/GitHub.Exports/Settings/PkgCmdID.cs

@@ -10,6 +10,7 @@ public static class PkgCmdIDList
         public const int showGitHubPaneCommand = 0x200;
         public const int openPullRequestsCommand = 0x201;
         public const int showCurrentPullRequestCommand = 0x202;
+        public const int syncSubmodulesCommand = 0x203;
         public const int backCommand = 0x300;
         public const int forwardCommand = 0x301;
         public const int refreshCommand = 0x302;

src/GitHub.VisualStudio/Commands/SyncSubmodulesCommand.cs

@@ -0,0 +1,100 @@
+using System;
+using System.Threading.Tasks;
+using System.ComponentModel.Composition;
+using GitHub.Logging;
+using GitHub.Commands;
+using GitHub.Services;
+using GitHub.Services.Vssdk.Commands;
+using Serilog;
+using System.IO;
+using System.Globalization;
+using System.Linq;
+
+namespace GitHub.VisualStudio.Commands
+{
+    /// <summary>
+    /// Command to sync submodules in local repository.
+    /// </summary>
+    [Export(typeof(ISyncSubmodulesCommand))]
+    public class SyncSubmodulesCommand : VsCommand, ISyncSubmodulesCommand
+    {
+        static readonly ILogger log = LogManager.ForContext<SyncSubmodulesCommand>();
+
+        readonly Lazy<IPullRequestService> lazyPullRequestService;
+        readonly Lazy<IStatusBarNotificationService> lazyStatusBarNotificationService;
+        readonly Lazy<IVSGitExt> lazyVSGitExt;
+
+        [ImportingConstructor]
+        protected SyncSubmodulesCommand(
+            Lazy<IPullRequestService> pullRequestService,
+            Lazy<IStatusBarNotificationService> statusBarNotificationService,
+            Lazy<IVSGitExt> gitExt)
+            : base(CommandSet, CommandId)
+        {
+            lazyPullRequestService = pullRequestService;
+            lazyStatusBarNotificationService = statusBarNotificationService;
+            lazyVSGitExt = gitExt;
+        }
+
+        /// <summary>
+        /// Gets the GUID of the group the command belongs to.
+        /// </summary>
+        public static readonly Guid CommandSet = Guids.guidGitHubCmdSet;
+
+        /// <summary>
+        /// Gets the numeric identifier of the command.
+        /// </summary>
+        public const int CommandId = PkgCmdIDList.syncSubmodulesCommand;
+
+        /// <summary>
+        /// Syncs submodules.
+        /// </summary>
+        public override async Task Execute()
+        {
+            try
+            {
+                var complete = await SyncSubmodules();
+            }
+            catch (Exception ex)
+            {
+                log.Error(ex, "Error syncing submodules");
+                lazyStatusBarNotificationService.Value.ShowMessage("Error syncing submodules");
+            }
+        }
+
+        /// <summary>
+        /// Sync submodules in local repository.
+        /// </summary>
+        /// <returns>Tuple with bool that is true if command completed successfully and string with
+        /// output from sync submodules Git command.</returns>
+        public async Task<Tuple<bool, string>> SyncSubmodules()
+        {
+            var pullRequestService = lazyPullRequestService.Value;
+            var statusBarNotificationService = lazyStatusBarNotificationService.Value;
+            var gitExt = lazyVSGitExt.Value;
+
+            var repository = gitExt.ActiveRepositories.FirstOrDefault();
+            if (repository == null)
+            {
+                statusBarNotificationService.ShowMessage("No local Git repository");
+                return new Tuple<bool, string>(true, "No local Git repository");
+            }
+
+            var writer = new StringWriter(CultureInfo.CurrentCulture);
+            var complete = await pullRequestService.SyncSubmodules(repository, line =>
+            {
+                writer.WriteLine(line);
+                statusBarNotificationService.ShowMessage(line);
+            });
+
+            if (!complete)
+            {
+                statusBarNotificationService.ShowMessage("Failed to sync submodules." + Environment.NewLine + writer);
+                return new Tuple<bool, string>(false, writer.ToString());
+            }
+
+            statusBarNotificationService.ShowMessage(string.Empty);
+            return new Tuple<bool, string>(true, writer.ToString());
+        }
+    }
+}

src/GitHub.VisualStudio/GitHub.VisualStudio.csproj

@@ -319,6 +319,7 @@
     <Compile Include="Commands\LinkCommandBase.cs" />
     <Compile Include="Commands\CopyLinkCommand.cs" />
     <Compile Include="Commands\OpenLinkCommand.cs" />
+    <Compile Include="Commands\SyncSubmodulesCommand.cs" />
     <Compile Include="Commands\ShowCurrentPullRequestCommand.cs" />
     <Compile Include="Commands\ShowGitHubPaneCommand.cs" />
     <Compile Include="Commands\OpenPullRequestsCommand.cs" />

src/GitHub.VisualStudio/GitHub.VisualStudio.vsct

@@ -102,6 +102,16 @@
         </Strings>
       </Button>
 
+      <Button guid="guidGitHubCmdSet" id="syncSubmodulesCommand" type="Button">
+        <Icon guid="guidImages" id="logo" />
+        <CommandFlag>IconIsMoniker</CommandFlag>
+        <Strings>
+          <ButtonText>Sync Submodules</ButtonText>
+          <CanonicalName>.GitHub.SyncSubmodules</CanonicalName>
+          <LocCanonicalName>.GitHub.SyncSubmodules</LocCanonicalName>
+        </Strings>
+      </Button>
+
       <!--- Toolbar buttons -->
       <Button guid="guidGitHubToolbarCmdSet" id="backCommand" type="Button">
         <Icon guid="guidImages" id="arrow_left" />
@@ -321,6 +331,7 @@
       <IDSymbol name="addConnectionCommand" value="0x110"/>
       <IDSymbol name="showGitHubPaneCommand" value="0x200"/>
       <IDSymbol name="showCurrentPullRequestCommand" value="0x202"/>
+      <IDSymbol name="syncSubmodulesCommand" value="0x0203" />
     </GuidSymbol>
 
     <!-- This is the Manage Connections menu -->

src/GitHub.VisualStudio/GitHubPackage.cs

@@ -39,7 +39,7 @@ protected override async Task InitializeAsync(CancellationToken cancellationToke
         {
             LogVersionInformation();
             await base.InitializeAsync(cancellationToken, progress);
-            
+
             await InitializeLoggingAsync();
             await GetServiceAsync(typeof(IUsageTracker));
 
@@ -85,7 +85,8 @@ async Task InitializeMenus()
                 exports.GetExportedValue<IOpenLinkCommand>(),
                 exports.GetExportedValue<IOpenPullRequestsCommand>(),
                 exports.GetExportedValue<IShowCurrentPullRequestCommand>(),
-                exports.GetExportedValue<IShowGitHubPaneCommand>()
+                exports.GetExportedValue<IShowGitHubPaneCommand>(),
+                exports.GetExportedValue<ISyncSubmodulesCommand>()
             };
 
             await JoinableTaskFactory.SwitchToMainThreadAsync();

test/UnitTests/GitHub.App/ViewModels/GitHubPane/PullRequestDetailViewModelTests.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.ComponentModel;
 using System.IO;
 using System.Linq;
 using System.Reactive;
@@ -9,6 +8,7 @@
 using GitHub.Factories;
 using GitHub.Models;
 using GitHub.Primitives;
+using GitHub.Commands;
 using GitHub.Services;
 using GitHub.ViewModels.GitHubPane;
 using LibGit2Sharp;
@@ -577,8 +577,8 @@ static Tuple<PullRequestDetailViewModel, IPullRequestService> CreateTargetAndSer
                 Substitute.For<IModelServiceFactory>(),
                 Substitute.For<IUsageTracker>(),
                 Substitute.For<ITeamExplorerContext>(),
-                Substitute.For<IStatusBarNotificationService>(),
-                Substitute.For<IPullRequestFilesViewModel>());
+                Substitute.For<IPullRequestFilesViewModel>(),
+                Substitute.For<ISyncSubmodulesCommand>());
             vm.InitializeAsync(repository, Substitute.For<IConnection>(), "owner", "repo", 1).Wait();
 
             return Tuple.Create(vm, pullRequestService);