Merge pull request #307 from yansklyarenko/feature/GH-211-return-thread-object

Author: pascalberger

src/Cake.AzureDevOps.Tests/ExceptionAssertExtensions.cs

@@ -10,7 +10,21 @@
     public static class ExceptionAssertExtensions
     {
         /// <summary>
-        /// Checks if an execption is of type <see cref="ArgumentNullException"/>.
+        /// Checks if an exception is of type <typeparamref name="T"/>.
+        /// </summary>
+        /// <typeparam name="T">The <see cref="ArgumentException"/> or one of its descendants.</typeparam>
+        /// <param name="exception">Exception to check.</param>
+        /// <param name="expectedExceptionType">The expected type of the exception.</param>
+        /// <param name="parameterName">Expected name of the parameter which has caused the exception.</param>
+        public static void IsArgumentException<T>(this T exception, Type expectedExceptionType, string parameterName)
+            where T : ArgumentException
+        {
+            Assert.IsType(expectedExceptionType, exception);
+            Assert.Equal(parameterName, exception.ParamName);
+        }
+
+        /// <summary>
+        /// Checks if an exception is of type <see cref="ArgumentNullException"/>.
         /// </summary>
         /// <param name="exception">Exception to check.</param>
         /// <param name="parameterName">Expected name of the parameter which has caused the exception.</param>
@@ -21,7 +35,7 @@ public static void IsArgumentNullException(this Exception exception, string para
         }
 
         /// <summary>
-        /// Checks if an execption is of type <see cref="ArgumentOutOfRangeException"/>.
+        /// Checks if an exception is of type <see cref="ArgumentOutOfRangeException"/>.
         /// </summary>
         /// <param name="exception">Exception to check.</param>
         /// <param name="parameterName">Expected name of the parameter which has caused the exception.</param>
@@ -32,7 +46,7 @@ public static void IsArgumentOutOfRangeException(this Exception exception, strin
         }
 
         /// <summary>
-        /// Checks if an execption is of type <see cref="ArgumentException"/>.
+        /// Checks if an exception is of type <see cref="ArgumentException"/>.
         /// </summary>
         /// <param name="exception">Exception to check.</param>
         /// <param name="parameterName">Expected name of the parameter which has caused the exception.</param>
@@ -43,7 +57,7 @@ public static void IsArgumentException(this Exception exception, string paramete
         }
 
         /// <summary>
-        /// Checks if an execption is of type <see cref="InvalidOperationException"/>.
+        /// Checks if an exception is of type <see cref="InvalidOperationException"/>.
         /// </summary>
         /// <param name="exception">Exception to check.</param>
         public static void IsInvalidOperationException(this Exception exception)
@@ -70,7 +84,7 @@ public static void IsAzureDevOpsPullRequestNotFoundException(this Exception exce
         }
 
         /// <summary>
-        /// Checks if an exception is of type <see cref="AzureDevOpsException"/>
+        /// Checks if an exception is of type <see cref="AzureDevOpsException"/>.
         /// </summary>
         /// <param name="exception">Exception to check.</param>
         public static void IsAzureDevOpsException(this Exception exception)
@@ -79,7 +93,7 @@ public static void IsAzureDevOpsException(this Exception exception)
         }
 
         /// <summary>
-        /// Checks if an exception is of type <see cref="AzureDevOpsBranchNotFoundException"/>
+        /// Checks if an exception is of type <see cref="AzureDevOpsBranchNotFoundException"/>.
         /// </summary>
         /// <param name="exception">Exception to check.</param>
         /// <param name="message">Exception message which should be checked.</param>

src/Cake.AzureDevOps.Tests/Repos/PullRequest/AzureDevOpsPullRequestTests.cs

@@ -1,5 +1,6 @@
 namespace Cake.AzureDevOps.Tests.Repos.PullRequest
 {
+    using System;
     using System.Collections.Generic;
     using System.Linq;
     using Cake.AzureDevOps.Repos.PullRequest;
@@ -767,97 +768,115 @@ public void Should_Return_Valid_Comment_Threads()
 
         public sealed class TheCreateCommentMethod
         {
-            [Fact]
-            public void Should_Throw_If_Comment_Is_Null()
+            [Theory]
+            [InlineData((string)null, typeof(ArgumentNullException))]
+            [InlineData("", typeof(ArgumentOutOfRangeException))]
+            [InlineData(" ", typeof(ArgumentOutOfRangeException))]
+            public void Should_Throw_If_Comment_Is_Null_Or_Empty_Or_Whitespace(string comment, Type expectedExceptionType)
             {
                 // Given
                 var fixture = new PullRequestFixture(BasePullRequestFixture.ValidAzureDevOpsServerUrl, 100);
                 var pullRequest = new AzureDevOpsPullRequest(fixture.Log, fixture.Settings, fixture.GitClientFactory);
 
                 // When
-                var result = Record.Exception(() => pullRequest.CreateComment(null));
+                var result = Record.Exception(() => pullRequest.CreateComment(comment)) as ArgumentException;
 
                 // Then
-                result.IsArgumentNullException("comment");
+                result.ShouldNotBeNull();
+                result.IsArgumentException(expectedExceptionType, "comment");
             }
 
             [Fact]
-            public void Should_Throw_If_Comment_Is_Empty()
+            public void Should_Return_Null_If_Null_Is_Returned_From_Git_Client()
             {
                 // Given
-                var fixture = new PullRequestFixture(BasePullRequestFixture.ValidAzureDevOpsServerUrl, 100);
+                var fixture = new PullRequestFixture(BasePullRequestFixture.ValidAzureDevOpsServerUrl, 100)
+                {
+                    GitClientFactory = new FakeNullForMethodsGitClientFactory(),
+                };
                 var pullRequest = new AzureDevOpsPullRequest(fixture.Log, fixture.Settings, fixture.GitClientFactory);
 
                 // When
-                var result = Record.Exception(() => pullRequest.CreateComment(string.Empty));
+                var thread = pullRequest.CreateComment("Foo");
 
                 // Then
-                result.IsArgumentOutOfRangeException("comment");
+                thread.ShouldBeNull();
             }
 
             [Fact]
-            public void Should_Throw_If_Comment_Is_Whitespace()
+            public void Should_Create_Valid_Thread_With_One_Comment()
             {
                 // Given
                 var fixture = new PullRequestFixture(BasePullRequestFixture.ValidAzureDevOpsServerUrl, 100);
                 var pullRequest = new AzureDevOpsPullRequest(fixture.Log, fixture.Settings, fixture.GitClientFactory);
 
                 // When
-                var result = Record.Exception(() => pullRequest.CreateComment(" "));
+                var thread = pullRequest.CreateComment("Valid");
 
                 // Then
-                result.IsArgumentOutOfRangeException("comment");
+                thread.ShouldNotBeNull();
+                thread.Status.ShouldBe(AzureDevOpsCommentThreadStatus.Active);
+                thread.Comments.ShouldNotBeNull();
+                thread.Comments.Count().ShouldBe(1);
+
+                var comment = thread.Comments.First();
+                comment.CommentType.ShouldBe(AzureDevOpsCommentType.System);
+                comment.IsDeleted.ShouldBeFalse();
+                comment.Content.ShouldBe("Valid");
             }
+        }
 
+        public sealed class TheCreateCommentThreadMethod
+        {
             [Fact]
-            public void Should_Not_Throw_If_Null_Is_Returned()
+            public void Should_Throw_If_Input_Thread_Is_Null()
             {
                 // Given
-                var fixture = new PullRequestFixture(BasePullRequestFixture.ValidAzureDevOpsServerUrl, 100)
-                {
-                    GitClientFactory = new FakeNullForMethodsGitClientFactory(),
-                };
+                var fixture = new PullRequestFixture(BasePullRequestFixture.ValidAzureDevOpsServerUrl, 100);
                 var pullRequest = new AzureDevOpsPullRequest(fixture.Log, fixture.Settings, fixture.GitClientFactory);
 
                 // When
-                pullRequest.CreateComment("Foo");
+                var result = Record.Exception(() => pullRequest.CreateCommentThread(null));
 
                 // Then
-                // ?? Nothing to validate here since the method returns void
+                result.IsArgumentNullException("thread");
             }
-        }
 
-        public sealed class TheCreateCommentThreadMethod
-        {
             [Fact]
-            public void Should_Throw_If_Input_Thread_Is_Null()
+            public void Should_Return_Null_If_Pull_Request_Is_Invalid()
             {
                 // Given
-                var fixture = new PullRequestFixture(BasePullRequestFixture.ValidAzureDevOpsServerUrl, 100);
+                var fixture = new PullRequestFixture(BasePullRequestFixture.ValidAzureDevOpsServerUrl, 100)
+                {
+                    GitClientFactory = new FakeNullGitClientFactory(),
+                };
+                fixture.Settings.ThrowExceptionIfPullRequestCouldNotBeFound = false;
+
                 var pullRequest = new AzureDevOpsPullRequest(fixture.Log, fixture.Settings, fixture.GitClientFactory);
 
                 // When
-                var result = Record.Exception(() => pullRequest.CreateCommentThread(null));
+                var outThread = pullRequest.CreateCommentThread(new AzureDevOpsPullRequestCommentThread());
 
                 // Then
-                result.IsArgumentNullException("thread");
+                outThread.ShouldBeNull();
             }
 
             [Fact]
-            public void Should_Not_Throw_If_Null_Is_Returned()
+            public void Should_Return_Null_If_Null_Is_Returned_From_Git_Client()
             {
                 // Given
                 var fixture = new PullRequestFixture(BasePullRequestFixture.ValidAzureDevOpsServerUrl, 100)
                 {
                     GitClientFactory = new FakeNullForMethodsGitClientFactory(),
                 };
+
                 var pullRequest = new AzureDevOpsPullRequest(fixture.Log, fixture.Settings, fixture.GitClientFactory);
 
                 // When
-                pullRequest.CreateCommentThread(new AzureDevOpsPullRequestCommentThread());
+                var outThread = pullRequest.CreateCommentThread(new AzureDevOpsPullRequestCommentThread());
 
                 // Then
-                // ?? Nothing to validate here since the method returns void
+                outThread.ShouldBeNull();
             }
 
             [Fact]
@@ -866,12 +885,15 @@ public void Should_Create_Valid_Comment_Thread()
                 // Given
                 var fixture = new PullRequestFixture(BasePullRequestFixture.ValidAzureDevOpsUrl, 200);
                 var pullRequest = new AzureDevOpsPullRequest(fixture.Log, fixture.Settings, fixture.GitClientFactory);
+                var inThread = new AzureDevOpsPullRequestCommentThread { Id = 300, Status = AzureDevOpsCommentThreadStatus.Pending, FilePath = "/index.html" };
 
                 // When
-                pullRequest.CreateCommentThread(new AzureDevOpsPullRequestCommentThread { Id = 300, Status = AzureDevOpsCommentThreadStatus.Pending, FilePath = "/index.html" });
+                var outThread = pullRequest.CreateCommentThread(inThread);
 
                 // Then
-                // ?? Nothing to validate here since the method returns void
+                outThread.Id.ShouldBe(inThread.Id);
+                outThread.Status.ShouldBe(inThread.Status);
+                outThread.FilePath.ShouldBeEquivalentTo(inThread.FilePath);
             }
         }
 

src/Cake.AzureDevOps/Repos/PullRequest/AzureDevOpsPullRequest.cs

@@ -577,7 +577,8 @@ public void ActivateCommentThread(int threadId)
         /// Creates a new comment thread with a single comment in the pull request.
         /// </summary>
         /// <param name="comment">Comment which should be added.</param>
-        public void CreateComment(string comment)
+        /// <returns>A newly created comment thread, or null if it can't be created.</returns>
+        public AzureDevOpsPullRequestCommentThread CreateComment(string comment)
         {
             comment.NotNullOrWhiteSpace(nameof(comment));
 
@@ -595,33 +596,41 @@ public void CreateComment(string comment)
                 },
             };
 
-            this.CreateCommentThread(thread);
+            return this.CreateCommentThread(thread);
         }
 
         /// <summary>
         /// Creates a new comment thread in the pull request.
         /// </summary>
         /// <param name="thread">The instance of the thread.</param>
-        public void CreateCommentThread(AzureDevOpsPullRequestCommentThread thread)
+        /// <returns>A newly created comment thread, or null if it can't be created.</returns>
+        public AzureDevOpsPullRequestCommentThread CreateCommentThread(AzureDevOpsPullRequestCommentThread thread)
         {
             thread.NotNull(nameof(thread));
 
+            AzureDevOpsPullRequestCommentThread resultingThread = null;
             if (!this.ValidatePullRequest())
             {
-                return;
+                return resultingThread;
             }
 
             using (var gitClient = this.gitClientFactory.CreateGitClient(this.CollectionUrl, this.credentials))
             {
-                gitClient
-                    .CreateThreadAsync(
+                var newThread = gitClient.CreateThreadAsync(
                         thread.InnerThread,
                         this.RepositoryId,
                         this.PullRequestId)
                     .ConfigureAwait(false)
                     .GetAwaiter()
                     .GetResult();
+
+                if (newThread != null)
+                {
+                    resultingThread = new AzureDevOpsPullRequestCommentThread(newThread);
+                }
             }
+
+            return resultingThread;
         }
 
         /// <summary>