(GH-72) Don't create release when not required (#183)

(GH-72) Don't create release when not required

Author: AdmiringWorm

Source/GitReleaseManager.Tests/ReleaseNotesBuilderTests.cs

@@ -18,10 +18,20 @@ namespace GitReleaseManager.Tests
     [TestFixture]
     public class ReleaseNotesBuilderTests
     {
+        public TestContext TestContext { get; set; }
+
+        [OneTimeSetUp]
+        public void Configure()
+        {
+            Logger.WriteError = s => TestContext.WriteLine($"Error: {s}");
+            Logger.WriteInfo = s => TestContext.WriteLine($"Info: {s}");
+            Logger.WriteWarning = s => TestContext.WriteLine($"Warning: {s}");
+        }
+
         [Test]
         public void NoCommitsNoIssues()
         {
-            AcceptTest(0);
+            Assert.Throws<AggregateException>(() => AcceptTest(0));
         }
 
         [Test]
@@ -33,7 +43,7 @@ public void NoCommitsSomeIssues()
         [Test]
         public void SomeCommitsNoIssues()
         {
-            AcceptTest(5);
+            Assert.Throws<AggregateException>(() => AcceptTest(5));
         }
 
         [Test]
@@ -45,7 +55,7 @@ public void SomeCommitsSomeIssues()
         [Test]
         public void SingularCommitsNoIssues()
         {
-            AcceptTest(1);
+            Assert.Throws<AggregateException>(() => AcceptTest(1));
         }
 
         [Test]

Source/GitReleaseManager/ReleaseNotesBuilder.cs

@@ -46,6 +46,13 @@ public async Task<string> BuildReleaseNotes()
             var previousMilestone = GetPreviousMilestone();
             var numberOfCommits = await _vcsProvider.GetNumberOfCommitsBetween(previousMilestone, _targetMilestone, _user, _repository).ConfigureAwait(false);
 
+            if (issues.Count == 0)
+            {
+                var logMessage = string.Format("No closed issues have been found for milestone {0}, or all assigned issues are meant to be excluded from release notes, aborting creation of release.", _milestoneTitle);
+                Logger.WriteError(logMessage);
+                throw new Exception(logMessage);
+            }
+
             if (issues.Count > 0)
             {
                 var issuesText = string.Format(issues.Count == 1 ? "{0} issue" : "{0} issues", issues.Count);
@@ -109,18 +116,19 @@ private string GetLabel(string label, Func<LabelAlias, string> func)
             return alias != null ? func(alias) : null;
         }
 
-        private void CheckForValidLabels(Issue issue)
+        private bool CheckForValidLabels(Issue issue)
         {
-            var count = 0;
+            var includedIssuesCount = 0;
+            var excludedIssuesCount = 0;
 
             foreach (var issueLabel in issue.Labels)
             {
-                count += _configuration.IssueLabelsInclude.Count(issueToInclude => issueLabel.Name.ToUpperInvariant() == issueToInclude.ToUpperInvariant());
+                includedIssuesCount += _configuration.IssueLabelsInclude.Count(issueToInclude => issueLabel.Name.ToUpperInvariant() == issueToInclude.ToUpperInvariant());
 
-                count += _configuration.IssueLabelsExclude.Count(issueToExclude => issueLabel.Name.ToUpperInvariant() == issueToExclude.ToUpperInvariant());
+                excludedIssuesCount += _configuration.IssueLabelsExclude.Count(issueToExclude => issueLabel.Name.ToUpperInvariant() == issueToExclude.ToUpperInvariant());
             }
 
-            if (count != 1)
+            if (includedIssuesCount + excludedIssuesCount != 1)
             {
                 var allIssueLabels = _configuration.IssueLabelsInclude.Union(_configuration.IssueLabelsExclude).ToList();
                 var allIssuesExceptLast = allIssueLabels.Take(allIssueLabels.Count - 1);
@@ -131,6 +139,13 @@ private void CheckForValidLabels(Issue issue)
                 var message = string.Format(CultureInfo.InvariantCulture, "Bad Issue {0} expected to find a single label with either {1} or {2}.", issue.HtmlUrl, allIssuesExceptLastString, lastLabel);
                 throw new InvalidOperationException(message);
             }
+
+            if (includedIssuesCount > 0)
+            {
+                return true;
+            }
+
+            return false;
         }
 
         private void AddIssues(StringBuilder stringBuilder, List<Issue> issues)
@@ -181,9 +196,24 @@ private async Task LoadMilestones()
         private async Task<List<Issue>> GetIssues(Milestone milestone)
         {
             var issues = await _vcsProvider.GetIssuesAsync(milestone).ConfigureAwait(false);
+
+            var hasIncludedIssues = false;
+
             foreach (var issue in issues)
             {
-                CheckForValidLabels(issue);
+                if (CheckForValidLabels(issue))
+                {
+                    hasIncludedIssues = true;
+                }
+            }
+
+            // If there are no issues assigned to the milestone that have a label that is part
+            // of the labels to include array, then that is essentially the same as having no
+            // closed issues assigned to the milestone.  In this scenario, we want to raise an
+            // error, so return an emtpy issues list.
+            if (!hasIncludedIssues)
+            {
+                return new List<Issue>();
             }
 
             return issues;