GitTools#492 feat: renaming label Name using RenameFrom in Configuration

davidzwa · Jun 10, 2023 · 971a1fb · 971a1fb
1 parent c0d8b8e
commit 971a1fb
Show file tree

Hide file tree

Showing 9 changed files with 58 additions and 22 deletions.
diff --git a/src/GitReleaseManager.Core.Tests/Commands/LabelCommandTests.cs b/src/GitReleaseManager.Core.Tests/Commands/LabelCommandTests.cs
@@ -32,13 +32,13 @@ public async Task Should_Execute_Command()
                 RepositoryName = "repository",
             };
 
-            _vcsService.CreateLabelsAsync(options.RepositoryOwner, options.RepositoryName)
+            _vcsService.CreateOrUpdateLabelsAsync(options.RepositoryOwner, options.RepositoryName)
                 .Returns(Task.CompletedTask);
 
             var result = await _command.Execute(options).ConfigureAwait(false);
             result.ShouldBe(0);
 
-            await _vcsService.Received(1).CreateLabelsAsync(options.RepositoryOwner, options.RepositoryName).ConfigureAwait(false);
+            await _vcsService.Received(1).CreateOrUpdateLabelsAsync(options.RepositoryOwner, options.RepositoryName).ConfigureAwait(false);
             _logger.Received(1).Information(Arg.Any<string>());
         }
     }

diff --git a/src/GitReleaseManager.Core.Tests/VcsServiceTests.cs b/src/GitReleaseManager.Core.Tests/VcsServiceTests.cs
@@ -211,7 +211,7 @@ public async Task Should_Create_Labels()
             _vcsProvider.CreateLabelAsync(OWNER, REPOSITORY, Arg.Any<Label>())
                 .Returns(Task.CompletedTask);
 
-            await _vcsService.CreateLabelsAsync(OWNER, REPOSITORY).ConfigureAwait(false);
+            await _vcsService.CreateOrUpdateLabelsAsync(OWNER, REPOSITORY).ConfigureAwait(false);
 
             await _vcsProvider.Received(1).GetLabelsAsync(OWNER, REPOSITORY).ConfigureAwait(false);
             await _vcsProvider.Received(labels.Count).DeleteLabelAsync(OWNER, REPOSITORY, Arg.Any<string>()).ConfigureAwait(false);
@@ -227,7 +227,7 @@ public async Task Should_Log_An_Warning_When_Labels_Not_Configured()
         {
             _configuration.Labels.Clear();
 
-            await _vcsService.CreateLabelsAsync(OWNER, REPOSITORY).ConfigureAwait(false);
+            await _vcsService.CreateOrUpdateLabelsAsync(OWNER, REPOSITORY).ConfigureAwait(false);
 
             _logger.Received(1).Warning(Arg.Any<string>());
         }

diff --git a/src/GitReleaseManager.Core/Commands/LabelCommand.cs b/src/GitReleaseManager.Core/Commands/LabelCommand.cs
@@ -18,7 +18,7 @@ public LabelCommand(IVcsService vcsService, ILogger logger)
         public async Task<int> Execute(LabelSubOptions options)
         {
             _logger.Information("Creating standard labels");
-            await _vcsService.CreateLabelsAsync(options.RepositoryOwner, options.RepositoryName).ConfigureAwait(false);
+            await _vcsService.CreateOrUpdateLabelsAsync(options.RepositoryOwner, options.RepositoryName).ConfigureAwait(false);
 
             return 0;
         }

diff --git a/src/GitReleaseManager.Core/Configuration/LabelConfig.cs b/src/GitReleaseManager.Core/Configuration/LabelConfig.cs
@@ -4,13 +4,12 @@ namespace GitReleaseManager.Core.Configuration
 {
     public class LabelConfig
     {
-        [YamlMember(Alias = "name")]
-        public string Name { get; set; }
+        [YamlMember(Alias = "name")] public string Name { get; set; }
 
-        [YamlMember(Alias = "description")]
-        public string Description { get; set; }
+        [YamlMember(Alias = "description")] public string Description { get; set; }
 
-        [YamlMember(Alias = "color")]
-        public string Color { get; set; }
+        [YamlMember(Alias = "color")] public string Color { get; set; }
+
+        [YamlMember(Alias = "renameFrom")] public string RenameFrom { get; set; }
     }
 }
diff --git a/src/GitReleaseManager.Core/IVcsService.cs b/src/GitReleaseManager.Core/IVcsService.cs
@@ -24,6 +24,6 @@ public interface IVcsService
 
         Task PublishReleaseAsync(string owner, string repository, string tagName);
 
-        Task CreateLabelsAsync(string owner, string repository);
+        Task CreateOrUpdateLabelsAsync(string owner, string repository);
     }
 }
diff --git a/src/GitReleaseManager.Core/Provider/GitHubProvider.cs b/src/GitReleaseManager.Core/Provider/GitHubProvider.cs
@@ -152,6 +152,16 @@ public Task CreateLabelAsync(string owner, string repository, Label label)
             });
         }
 
+        public Task UpdateLabelAsync(string owner, string repository, string originalName, Label label)
+        {
+            return ExecuteAsync(async () =>
+            {
+                var updatedLabel = _mapper.Map<LabelUpdate>(label);
+
+                await _gitHubClient.Issue.Labels.Update(owner, repository, originalName, updatedLabel);
+            });
+        }
+
         public Task DeleteLabelAsync(string owner, string repository, string labelName)
         {
             return ExecuteAsync(async () =>

diff --git a/src/GitReleaseManager.Core/Provider/IVcsProvider.cs b/src/GitReleaseManager.Core/Provider/IVcsProvider.cs
@@ -21,6 +21,8 @@ public interface IVcsProvider
         Task<IEnumerable<IssueComment>> GetIssueCommentsAsync(string owner, string repository, int issueNumber);
 
         Task CreateLabelAsync(string owner, string repository, Label label);
+
+        Task UpdateLabelAsync(string owner, string repository, string existingLabelName,Label label);
 
         Task DeleteLabelAsync(string owner, string repository, string labelName);
 

diff --git a/src/GitReleaseManager.Core/VcsService.cs b/src/GitReleaseManager.Core/VcsService.cs
@@ -290,33 +290,58 @@ public async Task PublishReleaseAsync(string owner, string repository, string ta
             }
         }
 
-        public async Task CreateLabelsAsync(string owner, string repository)
+        public async Task CreateOrUpdateLabelsAsync(string owner, string repository)
         {
             if (_configuration.Labels.Any())
             {
                 var newLabels = new List<Label>();
+                var updatedLabels = new List<Tuple<string, Label>>();
 
+                _logger.Verbose("Grabbing all existing labels on '{Owner}/{Repository}'", owner, repository);
+                var existingLabels = await _vcsProvider.GetLabelsAsync(owner, repository).ConfigureAwait(false);
+
+                IEnumerable<Label> existingLabelsEnumerable = existingLabels as Label[] ?? existingLabels.ToArray();
                 foreach (var label in _configuration.Labels)
                 {
-                    newLabels.Add(new Label
+                    var newLabel = new Label
                     {
                         Name = label.Name,
                         Color = label.Color,
                         Description = label.Description,
-                    });
-                }
+                    };
 
-                _logger.Verbose("Grabbing all existing labels on '{Owner}/{Repository}'", owner, repository);
-                var labels = await _vcsProvider.GetLabelsAsync(owner, repository).ConfigureAwait(false);
+                    // Labels that don't exist yet will be created, otherwise they will be updated given RenameFrom matches an existing label
+                    if (!string.IsNullOrEmpty(label.RenameFrom) &&
+                        existingLabelsEnumerable.Any(el => el.Name == label.RenameFrom))
+                    {
+                        updatedLabels.Add(new Tuple<string, Label>(label.RenameFrom, newLabel));
+                    }
+                    else
+                    {
+                        newLabels.Add(newLabel);
+                    }
+                }
 
+                // Process labels to delete
+                var deletedLabels = existingLabelsEnumerable.Where(el => updatedLabels.All(n => n.Item1 != el.Name))
+                    .ToList();
                 _logger.Verbose("Removing existing labels");
-                _logger.Debug("{@Labels}", labels);
-                var deleteLabelsTasks = labels.Select(label => _vcsProvider.DeleteLabelAsync(owner, repository, label.Name));
+                _logger.Debug("{@Labels}", deletedLabels);
+                var deleteLabelsTasks =
+                    deletedLabels.Select(label => _vcsProvider.DeleteLabelAsync(owner, repository, label.Name));
                 await Task.WhenAll(deleteLabelsTasks).ConfigureAwait(false);
 
+                // Update labels which have a RenameFrom that can be found in the existing labels
+                _logger.Verbose("Updating existing labels");
+                _logger.Debug("{@Labels}", updatedLabels);
+                var updateLabelsTasks = updatedLabels.Select(label =>
+                    _vcsProvider.UpdateLabelAsync(owner, repository, label.Item1, label.Item2));
+                await Task.WhenAll(updateLabelsTasks).ConfigureAwait(false);
+
                 _logger.Verbose("Creating new standard labels");
                 _logger.Debug("{@Labels}", newLabels);
-                var createLabelsTasks = newLabels.Select(label => _vcsProvider.CreateLabelAsync(owner, repository, label));
+                var createLabelsTasks =
+                    newLabels.Select(label => _vcsProvider.CreateLabelAsync(owner, repository, label));
                 await Task.WhenAll(createLabelsTasks).ConfigureAwait(false);
             }
             else

diff --git a/src/GitReleaseManager.Tests/VcsServiceMock.cs b/src/GitReleaseManager.Tests/VcsServiceMock.cs
@@ -70,7 +70,7 @@ public Task PublishReleaseAsync(string owner, string repository, string tagName)
             throw new System.NotImplementedException();
         }
 
-        public Task CreateLabelsAsync(string owner, string repository)
+        public Task CreateOrUpdateLabelsAsync(string owner, string repository)
         {
             throw new System.NotImplementedException();
         }