mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-05 23:06:10 +00:00
9c80b00e6f
* bugfix - PUT should have a payload for Mark as Read (#1579) * bugfix - PUT should have a payload for Mark as Read * also fix the Observable client test * add integration tests for MarkRead methods * Fixup MarkReadForRepository methods to specify a body in the PUT request * Fix unit tests for regular and observable client * helps if the new files are included in the test project :) * Cloning ApiInfo object should work when some fields are null (#1580) * Adjust ApiInfo.Clone() to work even if some elements (eg ETag) are null * Remove c# 6 language feature and do it the old school way * Add a test for cloning ApiInfo when some fields are null * The 3 lists can never be null anyway so remove some un-needed statements * Add test for null RateLimit * Remove Rx-Main dependency from samples This resolves #1592 - LINQPad doesn't understand how to restore this unlisted package and it's not actually needed in the samples. * Adding RemovedFromProject and other missing EventInfoState types. (#1591) * Adding missing review types to event info. * Fixing whitespace. * Reword `BaseRefChanged` comment * Adding missing event types. * Change response models 'Url' properties from `Uri` to `string` (#1585) * Add convention test to ensure 'Url' properties are of type string Closes #1582 * Change 'Url' properties from Uri to string Global Find/Replace FTW! * fix compilation errors in the integration tests project * Extend 'Url' properties type check to request models * Stick to convention tests naming convention * Remove unused using directives in models Changing from `Uri` to `string` means the `using System;` directive was not needed anymore in some files * Update exception message wording * empty commit to trigger a new build - hopefully Travis passes * add convention test to ensure request models have Uri 'Url' properties * make request models 'Url' properties Uri fix typo in convention test name * revert some request models 'Url' properties as `string` see https://github.com/octokit/octokit.net/pull/1585#issuecomment-297186728 * Change test so that all model types must have 'Url' properties of type string - Filter test input to only get types which have 'Url' properties - Merge response and request model types tests into one - Unparameterize the exception since we only check for the string type now * Fix string.Format tokens If this PR doesn't get rebased, it'll be my wall of shame FOREVER! * and then it's even more embarrassing when the commit message says rebased but you really meant squashed * Remove exclusion of `Release` from request models
477 lines
21 KiB
C#
477 lines
21 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Threading.Tasks;
|
|
using NSubstitute;
|
|
using Octokit.Reactive;
|
|
using Xunit;
|
|
|
|
namespace Octokit.Tests.Reactive
|
|
{
|
|
public class ObservableNotificationsClientTests
|
|
{
|
|
public class TheCtor
|
|
{
|
|
[Fact]
|
|
public void EnsuresNonNullArguments()
|
|
{
|
|
Assert.Throws<ArgumentNullException>(
|
|
() => new ObservableNotificationsClient(null));
|
|
}
|
|
}
|
|
|
|
public class TheGetAllForCurrentMethod
|
|
{
|
|
[Fact]
|
|
public void RequestsCorrectUrl()
|
|
{
|
|
var endpoint = new Uri("notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
client.GetAllForCurrent();
|
|
|
|
connection.Received().Get<List<Notification>>(endpoint, Args.EmptyDictionary, null);
|
|
}
|
|
|
|
[Fact]
|
|
public void RequestsCorrectUrlApiOptions()
|
|
{
|
|
var endpoint = new Uri("notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
var options = new ApiOptions
|
|
{
|
|
PageCount = 1,
|
|
StartPage = 1,
|
|
PageSize = 1
|
|
};
|
|
|
|
client.GetAllForCurrent(options);
|
|
|
|
connection.Received().Get<List<Notification>>(endpoint, Arg.Is<Dictionary<string, string>>(d => d.Count == 2), null);
|
|
}
|
|
|
|
[Fact]
|
|
public void RequestsCorrectUrlNotificationRequest()
|
|
{
|
|
var endpoint = new Uri("notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
var notificationsRequest = new NotificationsRequest { All = true };
|
|
|
|
client.GetAllForCurrent(notificationsRequest);
|
|
|
|
connection.Received().Get<List<Notification>>(endpoint, Arg.Is<IDictionary<string, string>>(d => d.Count == 2
|
|
&& d["all"] == "true" && d["participating"] == "false"), null);
|
|
}
|
|
|
|
[Fact]
|
|
public void RequestsCorrectUrlNotificationRequestWithApiOptions()
|
|
{
|
|
var endpoint = new Uri("notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
var notificationsRequest = new NotificationsRequest { All = true };
|
|
|
|
var options = new ApiOptions
|
|
{
|
|
PageCount = 1,
|
|
StartPage = 1,
|
|
PageSize = 1
|
|
};
|
|
|
|
client.GetAllForCurrent(notificationsRequest, options);
|
|
|
|
connection.Received().Get<List<Notification>>(endpoint, Arg.Is<IDictionary<string, string>>(d => d.Count == 4
|
|
&& d["all"] == "true" && d["participating"] == "false"
|
|
&& d["page"] == "1" && d["per_page"] == "1"), null);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task EnsuresNonNullArguments()
|
|
{
|
|
var client = new ObservableNotificationsClient(Substitute.For<IGitHubClient>());
|
|
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForCurrent((ApiOptions)null));
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForCurrent((NotificationsRequest)null));
|
|
}
|
|
}
|
|
|
|
public class TheGetAllForRepository
|
|
{
|
|
[Fact]
|
|
public void RequestsCorrectUrl()
|
|
{
|
|
var endpoint = new Uri("repos/banana/split/notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
client.GetAllForRepository("banana", "split");
|
|
|
|
connection.Received().Get<List<Notification>>(endpoint, Args.EmptyDictionary, null);
|
|
}
|
|
|
|
[Fact]
|
|
public void RequestsCorrectUrlWithRepositoryId()
|
|
{
|
|
var endpoint = new Uri("repositories/1/notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
client.GetAllForRepository(1);
|
|
|
|
connection.Received().Get<List<Notification>>(endpoint, Args.EmptyDictionary, null);
|
|
}
|
|
|
|
[Fact]
|
|
public void RequestsCorrectUrlWithApiOptions()
|
|
{
|
|
var endpoint = new Uri("repos/banana/split/notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
var options = new ApiOptions
|
|
{
|
|
PageCount = 1,
|
|
StartPage = 1,
|
|
PageSize = 1
|
|
};
|
|
|
|
client.GetAllForRepository("banana", "split", options);
|
|
|
|
connection.Received().Get<List<Notification>>(endpoint, Arg.Is<Dictionary<string, string>>(d => d.Count == 2), null);
|
|
}
|
|
|
|
[Fact]
|
|
public void RequestsCorrectUrlWithApiOptionsWithRepositoryId()
|
|
{
|
|
var endpoint = new Uri("repositories/1/notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
var options = new ApiOptions
|
|
{
|
|
PageCount = 1,
|
|
StartPage = 1,
|
|
PageSize = 1
|
|
};
|
|
|
|
client.GetAllForRepository(1, options);
|
|
|
|
connection.Received().Get<List<Notification>>(endpoint, Arg.Is<Dictionary<string, string>>(d => d.Count == 2), null);
|
|
}
|
|
|
|
[Fact]
|
|
public void RequestsCorrectUrlNotificationRequest()
|
|
{
|
|
var endpoint = new Uri("repos/banana/split/notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
var notificationsRequest = new NotificationsRequest { All = true };
|
|
|
|
client.GetAllForRepository("banana", "split", notificationsRequest);
|
|
|
|
connection.Received().Get<List<Notification>>(endpoint, Arg.Is<Dictionary<string, string>>(
|
|
d => d.Count == 2 && d["all"] == "true" && d["participating"] == "false"),
|
|
null);
|
|
}
|
|
|
|
[Fact]
|
|
public void RequestsCorrectUrlNotificationRequestWithRepositoryId()
|
|
{
|
|
var endpoint = new Uri("repositories/1/notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
var notificationsRequest = new NotificationsRequest { All = true };
|
|
|
|
client.GetAllForRepository(1, notificationsRequest);
|
|
|
|
connection.Received().Get<List<Notification>>(endpoint, Arg.Is<Dictionary<string, string>>(
|
|
d => d.Count == 2 && d["all"] == "true" && d["participating"] == "false"),
|
|
null);
|
|
}
|
|
|
|
[Fact]
|
|
public void RequestsCorrectUrlNotificationRequestWithApiOptions()
|
|
{
|
|
var endpoint = new Uri("repos/banana/split/notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
var notificationsRequest = new NotificationsRequest { All = true };
|
|
|
|
var options = new ApiOptions
|
|
{
|
|
PageCount = 1,
|
|
StartPage = 1,
|
|
PageSize = 1
|
|
};
|
|
|
|
client.GetAllForRepository("banana", "split", notificationsRequest, options);
|
|
|
|
connection.Received().Get<List<Notification>>(endpoint, Arg.Is<Dictionary<string, string>>(
|
|
d => d.Count == 4 && d["all"] == "true" && d["participating"] == "false"
|
|
&& d["page"] == "1" && d["per_page"] == "1"),
|
|
null);
|
|
}
|
|
|
|
[Fact]
|
|
public void RequestsCorrectUrlNotificationRequestWithApiOptionsWithRepositoryId()
|
|
{
|
|
var endpoint = new Uri("repositories/1/notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
var notificationsRequest = new NotificationsRequest { All = true };
|
|
|
|
var options = new ApiOptions
|
|
{
|
|
PageCount = 1,
|
|
StartPage = 1,
|
|
PageSize = 1
|
|
};
|
|
|
|
client.GetAllForRepository(1, notificationsRequest, options);
|
|
|
|
connection.Received().Get<List<Notification>>(endpoint, Arg.Is<Dictionary<string, string>>(
|
|
d => d.Count == 4 && d["all"] == "true" && d["participating"] == "false"
|
|
&& d["page"] == "1" && d["per_page"] == "1"),
|
|
null);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task EnsuresNonNullArguments()
|
|
{
|
|
var client = new ObservableNotificationsClient(Substitute.For<IGitHubClient>());
|
|
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository(null, "name"));
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository("owner", null));
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository(null, "name", ApiOptions.None));
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository("owner", null, ApiOptions.None));
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository("owner", "name", (ApiOptions)null));
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository(null, "name", new NotificationsRequest()));
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository("owner", null, new NotificationsRequest()));
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository("owner", "name", (NotificationsRequest)null));
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository(null, "name", new NotificationsRequest(), ApiOptions.None));
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository("owner", null, new NotificationsRequest(), ApiOptions.None));
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository("owner", "name", null, ApiOptions.None));
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository("owner", "name", new NotificationsRequest(), null));
|
|
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository(1, (ApiOptions)null));
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository(1, (NotificationsRequest)null));
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository(1, null, ApiOptions.None));
|
|
Assert.Throws<ArgumentNullException>(() => client.GetAllForRepository(1, new NotificationsRequest(), null));
|
|
|
|
Assert.Throws<ArgumentException>(() => client.GetAllForRepository("", "name"));
|
|
Assert.Throws<ArgumentException>(() => client.GetAllForRepository("owner", ""));
|
|
Assert.Throws<ArgumentException>(() => client.GetAllForRepository("", "name", ApiOptions.None));
|
|
Assert.Throws<ArgumentException>(() => client.GetAllForRepository("owner", "", ApiOptions.None));
|
|
Assert.Throws<ArgumentException>(() => client.GetAllForRepository("", "name", new NotificationsRequest()));
|
|
Assert.Throws<ArgumentException>(() => client.GetAllForRepository("owner", "", new NotificationsRequest()));
|
|
Assert.Throws<ArgumentException>(() => client.GetAllForRepository("", "name", new NotificationsRequest(), ApiOptions.None));
|
|
Assert.Throws<ArgumentException>(() => client.GetAllForRepository("owner", "", new NotificationsRequest(), ApiOptions.None));
|
|
}
|
|
}
|
|
|
|
public class TheMarkAsRead
|
|
{
|
|
[Fact]
|
|
public void RequestsCorrectUrl()
|
|
{
|
|
var endpoint = new Uri("notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
client.MarkAsRead();
|
|
|
|
connection.Received().Put<object>(endpoint, Args.Object);
|
|
}
|
|
}
|
|
|
|
public class TheMarkAsReadForRepository
|
|
{
|
|
[Fact]
|
|
public void RequestsCorrectUrl()
|
|
{
|
|
var endpoint = new Uri("repos/banana/split/notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
client.MarkAsReadForRepository("banana", "split");
|
|
|
|
connection.Received().Put<object>(endpoint, Args.Object);
|
|
}
|
|
|
|
[Fact]
|
|
public void RequestsCorrectUrlWithRepositoryId()
|
|
{
|
|
var endpoint = new Uri("repositories/1/notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
client.MarkAsReadForRepository(1);
|
|
|
|
connection.Received().Put<object>(endpoint, Args.Object);
|
|
}
|
|
|
|
[Fact]
|
|
public void RequestsCorrectUrlParameterized()
|
|
{
|
|
var endpoint = new Uri("repos/banana/split/notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
var markAsReadRequest = new MarkAsReadRequest();
|
|
|
|
client.MarkAsReadForRepository("banana", "split", markAsReadRequest);
|
|
|
|
connection.Received().Put<object>(endpoint, markAsReadRequest);
|
|
}
|
|
|
|
[Fact]
|
|
public void RequestsCorrectUrlParameterizedWithRepositoryId()
|
|
{
|
|
var endpoint = new Uri("repositories/1/notifications", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
var markAsReadRequest = new MarkAsReadRequest();
|
|
|
|
client.MarkAsReadForRepository(1, markAsReadRequest);
|
|
|
|
connection.Received().Put<object>(endpoint, markAsReadRequest);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task EnsuresNonNullArguments()
|
|
{
|
|
var client = new ObservableNotificationsClient(Substitute.For<IGitHubClient>());
|
|
|
|
Assert.Throws<ArgumentNullException>(() => client.MarkAsReadForRepository(null, "name"));
|
|
Assert.Throws<ArgumentNullException>(() => client.MarkAsReadForRepository("owner", null));
|
|
Assert.Throws<ArgumentNullException>(() => client.MarkAsReadForRepository(null, "name", new MarkAsReadRequest()));
|
|
Assert.Throws<ArgumentNullException>(() => client.MarkAsReadForRepository("owner", null, new MarkAsReadRequest()));
|
|
Assert.Throws<ArgumentNullException>(() => client.MarkAsReadForRepository("owner", "name", null));
|
|
|
|
Assert.Throws<ArgumentNullException>(() => client.MarkAsReadForRepository(1, null));
|
|
|
|
Assert.Throws<ArgumentException>(() => client.MarkAsReadForRepository("", "name"));
|
|
Assert.Throws<ArgumentException>(() => client.MarkAsReadForRepository("owner", ""));
|
|
Assert.Throws<ArgumentException>(() => client.MarkAsReadForRepository("", "name", new MarkAsReadRequest()));
|
|
Assert.Throws<ArgumentException>(() => client.MarkAsReadForRepository("owner", "", new MarkAsReadRequest()));
|
|
}
|
|
}
|
|
|
|
public class TheGetNotification
|
|
{
|
|
[Fact]
|
|
public void RequestsCorrectUrl()
|
|
{
|
|
var endpoint = new Uri("notifications/threads/1", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
client.Get(1);
|
|
|
|
connection.Received().Get<Notification>(endpoint, null, null);
|
|
}
|
|
}
|
|
|
|
public class TheMarkNotificationAsRead
|
|
{
|
|
[Fact]
|
|
public void RequestsCorrectUrl()
|
|
{
|
|
var endpoint = new Uri("notifications/threads/1", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
client.MarkAsRead(1);
|
|
|
|
connection.Received().Patch(endpoint);
|
|
}
|
|
}
|
|
|
|
public class TheGetThreadSubscription
|
|
{
|
|
[Fact]
|
|
public void RequestsCorrectUrl()
|
|
{
|
|
var endpoint = new Uri("notifications/threads/1/subscription", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
client.GetThreadSubscription(1);
|
|
|
|
connection.Received().Get<ThreadSubscription>(endpoint, null, null);
|
|
}
|
|
}
|
|
|
|
public class TheSetThreadSubscription
|
|
{
|
|
[Fact]
|
|
public void RequestsCorrectUrl()
|
|
{
|
|
var endpoint = new Uri("notifications/threads/1/subscription", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
var data = new NewThreadSubscription();
|
|
|
|
client.SetThreadSubscription(1, data);
|
|
|
|
connection.Received().Put<ThreadSubscription>(endpoint, data);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task EnsuresNonNullArguments()
|
|
{
|
|
var client = new ObservableNotificationsClient(Substitute.For<IGitHubClient>());
|
|
|
|
Assert.Throws<ArgumentNullException>(() => client.SetThreadSubscription(1, null));
|
|
}
|
|
}
|
|
|
|
public class TheDeleteThreadSubscription
|
|
{
|
|
[Fact]
|
|
public void RequestsCorrectUrl()
|
|
{
|
|
var endpoint = new Uri("notifications/threads/1/subscription", UriKind.Relative);
|
|
var connection = Substitute.For<IConnection>();
|
|
var gitHubClient = new GitHubClient(connection);
|
|
var client = new ObservableNotificationsClient(gitHubClient);
|
|
|
|
client.DeleteThreadSubscription(1);
|
|
|
|
connection.Received().Delete(endpoint);
|
|
}
|
|
}
|
|
}
|
|
}
|