mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-06 07:16:09 +00:00
ff9521ce3d
* First Iteration Need to finish tests and docs * Mostly Complete * Fixing tests and adding review comments * Added tests for reactive client * Moved Reviews inside fo the Pull request client for better organization and began initial intigration testing * Fixing bad recursive function breaking tests * test fixes * Add paging support to review comments call * Fixing recursive function * Addressing comments from PR * fixing CI break * Typo build break * Fixing Convention Tests * Adding correct nameof() usage in Ensure * Small consitancy changes * Trigger build * Address PR Comments * Fixup test naming * Fix sub client ordering and incorrect URL * Tidy up comments and remove StringEnum wrapper from Request models as it is only for Response models * Rename GetReview to Get * tweak debugger display * Rework integration tests - implement the easy Get/GetAll ones first... * Implement integration tests for Create method. Move helpers to create PR/review into SetupHelper class Fixed up review status enum to contain correct values Tests for Approve/RequestChanges currently failing as a user cant approve/request changes on their own PR * Implement secondary account settings for integration tests and a new [DualAccountTest] attribute for discovery when configured Change integration test to create PR from the 2nd account, so the main test account is able to perform review actions on the PR * Add integration tests for Delete, Dismiss and Submit methods Fixed up API client implementation for delete (was looking for incorrect 201 http status) Removed unnecessary await/async calls from client implementations that dont need to do anything with the result * Attempting to add comments as part of a review revealed that we cant use the existing PullRequestReviewCommentCreate class as the API throws a validation error due to the CommitId field These newer review APIs need a DraftPullRequestReviewComment (that doesnt have a commitId) instead * add second test account user/password to configure-integration-tests script
465 lines
17 KiB
C#
465 lines
17 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Threading.Tasks;
|
|
using NSubstitute;
|
|
using Octokit;
|
|
using Octokit.Tests;
|
|
using Xunit;
|
|
|
|
public class PullRequestReviewsClientTests
|
|
{
|
|
public class TheCtor
|
|
{
|
|
[Fact]
|
|
public void EnsuresNonNullArguments()
|
|
{
|
|
Assert.Throws<ArgumentNullException>(() => new PullRequestReviewCommentsClient(null));
|
|
}
|
|
|
|
[Fact]
|
|
public void PullRequestReviewCreateEnsuresArgumentsValue()
|
|
{
|
|
string body = "body";
|
|
string path = "path";
|
|
PullRequestReviewEvent evt = PullRequestReviewEvent.Approve;
|
|
int position = 1;
|
|
|
|
var comment = new DraftPullRequestReviewComment(body, path, position);
|
|
|
|
var review = new PullRequestReviewCreate()
|
|
{
|
|
Body = body,
|
|
Event = evt
|
|
};
|
|
|
|
review.Comments.Add(comment);
|
|
|
|
|
|
Assert.Equal(body, review.Body);
|
|
Assert.Equal(evt, review.Event);
|
|
Assert.NotEmpty(review.Comments);
|
|
}
|
|
}
|
|
|
|
public class TheGetAllMethod
|
|
{
|
|
[Fact]
|
|
public async Task RequestsCorrectUrl()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
await client.GetAll("owner", "name", 7);
|
|
|
|
connection.Received().GetAll<PullRequestReview>(Arg.Is<Uri>(u => u.ToString() == "repos/owner/name/pulls/7/reviews"), null, Args.ApiOptions);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task RequestsCorrectUrlWithRepositoryId()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
await client.GetAll(1, 7);
|
|
|
|
connection.Received().GetAll<PullRequestReview>(
|
|
Arg.Is<Uri>(u => u.ToString() == "repositories/1/pulls/7/reviews"), Args.ApiOptions);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task RequestsCorrectUrlWithApiOptions()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
var options = new ApiOptions
|
|
{
|
|
StartPage = 1,
|
|
PageCount = 1,
|
|
PageSize = 1
|
|
};
|
|
|
|
await client.GetAll("owner", "name", 7, options);
|
|
|
|
connection.Received().GetAll<PullRequestReview>(
|
|
Arg.Is<Uri>(u => u.ToString() == "repos/owner/name/pulls/7/reviews"), null, options);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task RequestsCorrectUrlWithApiOptionsWithRepositoryId()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
var options = new ApiOptions
|
|
{
|
|
StartPage = 1,
|
|
PageCount = 1,
|
|
PageSize = 1
|
|
};
|
|
|
|
await client.GetAll(1, 7, options);
|
|
|
|
connection.Received().GetAll<PullRequestReview>(
|
|
Arg.Is<Uri>(u => u.ToString() == "repositories/1/pulls/7/reviews"), options);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task EnsuresNotNullArguments()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetAll(null, "name", 1));
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetAll("owner", null, 1));
|
|
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetAll(null, "name", 1, ApiOptions.None));
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetAll("owner", null, 1, ApiOptions.None));
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetAll("owner", "name", 1, null));
|
|
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetAll(1, 1, null));
|
|
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.GetAll("", "name", 1));
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.GetAll("owner", "", 1));
|
|
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.GetAll("", "name", 1, ApiOptions.None));
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.GetAll("owner", "", 1, ApiOptions.None));
|
|
}
|
|
}
|
|
|
|
public class TheGetMethod
|
|
{
|
|
[Fact]
|
|
public void RequestsCorrectUrl()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
client.Get("owner", "name", 53, 2);
|
|
|
|
connection.Received().Get<PullRequestReview>(
|
|
Arg.Is<Uri>(u => u.ToString() == "repos/owner/name/pulls/53/reviews/2"));
|
|
}
|
|
|
|
[Fact]
|
|
public void RequestsCorrectUrlWithRepositoryId()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
client.Get(1, 53, 2);
|
|
|
|
connection.Received().Get<PullRequestReview>(Arg.Is<Uri>(u => u.ToString() == "repositories/1/pulls/53/reviews/2"));
|
|
}
|
|
|
|
[Fact]
|
|
public async Task EnsuresNonNullArguments()
|
|
{
|
|
var client = new PullRequestReviewsClient(Substitute.For<IApiConnection>());
|
|
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.Get(null, "name", 1, 1));
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.Get("owner", null, 1, 1));
|
|
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.Get("", "name", 1, 1));
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.Get("owner", "", 1, 1));
|
|
}
|
|
}
|
|
|
|
public class TheCreateMethod
|
|
{
|
|
[Fact]
|
|
public void PostsToCorrectUrl()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
var comment = new DraftPullRequestReviewComment("Comment content", "file.css", 7);
|
|
|
|
var review = new PullRequestReviewCreate()
|
|
{
|
|
CommitId = "commit",
|
|
Body = "body",
|
|
Event = PullRequestReviewEvent.Approve
|
|
};
|
|
review.Comments.Add(comment);
|
|
|
|
client.Create("fakeOwner", "fakeRepoName", 13, review);
|
|
|
|
connection.Received().Post<PullRequestReview>(Arg.Is<Uri>(u => u.ToString() == "repos/fakeOwner/fakeRepoName/pulls/13/reviews"),
|
|
review, null, null);
|
|
}
|
|
|
|
[Fact]
|
|
public void PostsToCorrectUrlWithRepositoryId()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
var comment = new DraftPullRequestReviewComment("Comment content", "file.css", 7);
|
|
|
|
var review = new PullRequestReviewCreate()
|
|
{
|
|
CommitId = "commit",
|
|
Body = "body",
|
|
Event = PullRequestReviewEvent.Approve
|
|
};
|
|
review.Comments.Add(comment);
|
|
|
|
client.Create(1, 13, review);
|
|
|
|
connection.Received().Post<PullRequestReview>(Arg.Is<Uri>(u => u.ToString() == "repositories/1/pulls/13/reviews"),
|
|
review, null, null);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task EnsuresNonNullArguments()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
string body = "Comment content";
|
|
string path = "file.css";
|
|
int position = 7;
|
|
|
|
var comment = new DraftPullRequestReviewComment(body, path, position);
|
|
|
|
var review = new PullRequestReviewCreate()
|
|
{
|
|
CommitId = "commit",
|
|
Body = "body",
|
|
Event = PullRequestReviewEvent.Approve
|
|
};
|
|
|
|
review.Comments.Add(comment);
|
|
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.Create(null, "fakeRepoName", 1, review));
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.Create("fakeOwner", null, 1, review));
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.Create("fakeOwner", "fakeRepoName", 1, null));
|
|
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.Create("", "fakeRepoName", 1, review));
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.Create("fakeOwner", "", 1, review));
|
|
}
|
|
}
|
|
|
|
public class TheDeleteMethod
|
|
{
|
|
[Fact]
|
|
public async Task PostsToCorrectUrl()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
await client.Delete("owner", "name", 13, 13);
|
|
|
|
connection.Received().Delete(Arg.Is<Uri>(u => u.ToString() == "repos/owner/name/pulls/13/reviews/13"));
|
|
}
|
|
|
|
[Fact]
|
|
public async Task PostsToCorrectUrlWithRepositoryId()
|
|
{
|
|
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
await client.Delete(1, 13, 13);
|
|
|
|
connection.Received().Delete(Arg.Is<Uri>(u => u.ToString() == "repositories/1/pulls/13/reviews/13"));
|
|
}
|
|
|
|
[Fact]
|
|
public async Task EnsuresNonNullArguments()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.Delete(null, "name", 1, 1));
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.Delete("owner", null, 1, 1));
|
|
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.Delete("", "name", 1, 1));
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.Delete("owner", "", 1, 1));
|
|
}
|
|
}
|
|
|
|
public class TheDismissMethod
|
|
{
|
|
[Fact]
|
|
public async Task PostsToCorrectUrl()
|
|
{
|
|
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
var dismissMessage = new PullRequestReviewDismiss()
|
|
{
|
|
Message = "test message"
|
|
};
|
|
await client.Dismiss("owner", "name", 13, 13, dismissMessage);
|
|
|
|
connection.Received().Put<PullRequestReview>(Arg.Is<Uri>(u => u.ToString() == "repos/owner/name/pulls/13/reviews/13/dismissals"), dismissMessage);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task PostsToCorrectUrlWithRepositoryId()
|
|
{
|
|
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
var dismissMessage = new PullRequestReviewDismiss()
|
|
{
|
|
Message = "test message"
|
|
};
|
|
await client.Dismiss(1, 13, 13, dismissMessage);
|
|
|
|
connection.Received().Put<PullRequestReview>(Arg.Is<Uri>(u => u.ToString() == "repositories/1/pulls/13/reviews/13/dismissals"), dismissMessage);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task EnsuresNonNullArguments()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
var dismissMessage = new PullRequestReviewDismiss()
|
|
{
|
|
Message = "test message"
|
|
};
|
|
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.Dismiss(null, "name", 1, 1, dismissMessage));
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.Dismiss("owner", null, 1, 1, dismissMessage));
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.Dismiss("owner", "name", 1, 1, null));
|
|
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.Dismiss("", "name", 1, 1, dismissMessage));
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.Dismiss("owner", "", 1, 1, dismissMessage));
|
|
}
|
|
}
|
|
|
|
public class TheGetAllCommentsMethod
|
|
{
|
|
[Fact]
|
|
public async Task RequestsCorrectUrl()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
await client.GetAllComments("owner", "name", 13, 13);
|
|
|
|
connection.Received().GetAll<PullRequestReviewComment>(Arg.Is<Uri>(u => u.ToString() == "repos/owner/name/pulls/13/reviews/13/comments"), null, Args.ApiOptions);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task RequestsCorrectUrlWithRepositoryId()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
await client.GetAllComments(1, 13, 13);
|
|
|
|
connection.Received().GetAll<PullRequestReviewComment>(Arg.Is<Uri>(u => u.ToString() == "repositories/1/pulls/13/reviews/13/comments"), null, Args.ApiOptions);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task RequestsCorrectUrlWithApiOptions()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
var options = new ApiOptions
|
|
{
|
|
StartPage = 1,
|
|
PageCount = 1,
|
|
PageSize = 1
|
|
};
|
|
|
|
await client.GetAllComments("owner", "name", 13, 13, options);
|
|
|
|
connection.Received().GetAll<PullRequestReviewComment>(Arg.Is<Uri>(u => u.ToString() == "repos/owner/name/pulls/13/reviews/13/comments"), null, options);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task RequestsCorrectUrlWithApiOptionsWithRepositoryId()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
var options = new ApiOptions
|
|
{
|
|
StartPage = 1,
|
|
PageCount = 1,
|
|
PageSize = 1
|
|
};
|
|
|
|
await client.GetAllComments(1, 13, 13, options);
|
|
|
|
connection.Received().GetAll<PullRequestReviewComment>(Arg.Is<Uri>(u => u.ToString() == "repositories/1/pulls/13/reviews/13/comments"), null, Args.ApiOptions);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task EnsuresNonNullArguments()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetAllComments(null, "name", 1, 1));
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetAllComments("owner", null, 1, 1));
|
|
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.GetAllComments("", "name", 1, 1));
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.GetAllComments("owner", "", 1, 1));
|
|
}
|
|
}
|
|
|
|
public class TheSubmitMethod
|
|
{
|
|
[Fact]
|
|
public async Task PostsToCorrectUrl()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
var submitMessage = new PullRequestReviewSubmit()
|
|
{
|
|
Body = "string",
|
|
Event = PullRequestReviewEvent.Approve
|
|
};
|
|
await client.Submit("owner", "name", 13, 13, submitMessage);
|
|
|
|
connection.Received().Post<PullRequestReview>(Arg.Is<Uri>(u => u.ToString() == "repos/owner/name/pulls/13/reviews/13/events"), submitMessage, null, null);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task PostsToCorrectUrlWithRepositoryId()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
var submitMessage = new PullRequestReviewSubmit()
|
|
{
|
|
Body = "string",
|
|
Event = PullRequestReviewEvent.Approve
|
|
};
|
|
await client.Submit(1, 13, 13, submitMessage);
|
|
|
|
connection.Received().Post<PullRequestReview>(Arg.Is<Uri>(u => u.ToString() == "repositories/1/pulls/13/reviews/13/events"), submitMessage, null, null);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task EnsuresNonNullArguments()
|
|
{
|
|
var connection = Substitute.For<IApiConnection>();
|
|
var client = new PullRequestReviewsClient(connection);
|
|
|
|
var submitMessage = new PullRequestReviewSubmit()
|
|
{
|
|
Body = "string",
|
|
Event = PullRequestReviewEvent.Approve
|
|
};
|
|
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.Submit(null, "name", 1, 1, submitMessage));
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.Submit("owner", null, 1, 1, submitMessage));
|
|
await Assert.ThrowsAsync<ArgumentNullException>(() => client.Submit("owner", "name", 1, 1, null));
|
|
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.Submit("", "name", 1, 1, submitMessage));
|
|
await Assert.ThrowsAsync<ArgumentException>(() => client.Submit("owner", "", 1, 1, submitMessage));
|
|
}
|
|
}
|
|
}
|