mirror of
https://github.com/zoriya/octokit.net.git
synced 2026-06-08 20:45:51 +00:00
Implement Check Suites API (#1846)
* Check run request models * Check Run response models * Check run clients * Check run ApiUrls and AcceptHeaders * Pack it all together for now * Add missing accept headers to connection calls * Standardize class definitions * Standardize function names * Merge ICheckRunAnnotationsClient into ICheckRunsClient * Properly organize clients * Cleanup CheckRun response model * Fix slug check run urls * Add checks installation permission * Use StringEnums where appropriate * Cleanup check run output models * Flesh out CheckSuite model * Delete CheckRunsList * Remove a sealed, fix some line endings * Adding check suite models * Skeleton check suite client implementation * Add check suite ApiUrls * Flesh out check suites client * Add parameterless CheckRun constructor * Add DebuggerDisplay to checks models * Add observable checks interfaces * Add return values to POST and PATCH check clients * Fix some check suite client return values * Skeleton reactive checks implementation * Implement observable checks clients * Remove rogue tabs * Add CheckSuiteEventPayload * Add CheckRunEventPayload * Add DebuggerDisplay attributes to checks API payloads * Properly nullables check suite/run conclusion * Add CheckSuiteEventTests * Fix checks client accessor naming issues * Add missing Text field to CheckRunOutput * Marks CheckRunUpdate's conclusion as nullable * Fix reactive checks client naming * Today I learned DateTimeOffset is a struct Makes CheckRunUpdate's DateTimeOffsets nullable * Modify check clients to put slug version before repo id version * Add nullable to CheckRun.CompletedAt * Implement parameterless ICheckRunsClient.GetAllForReference and GetAllForCheckSuite * Add missing RequestParameters base to CheckSuiteRequest * Implement checks API GetAll methods * Bring parity to Reactive checks clients * fix project settings to get GitHubApp helper working again * remove un-needed InstallationId setting - provide helper method to find installation based on owner * fix up request object ctors based on required/optional parameters * fix up request object ctors based on required/optional parameters * add some initial integration tests for CheckSuites and CheckRuns including some helper methods * Add test for Request CheckSuite Fix Request CheckSuite to use correct Uri Fix Request CheckSuite return type as it doesnt return an object Fix CheckSuiteTriggerRequest ctor to make required fields mandatory * simplify Get CheckSuite test to not require as much data setup * Add test for CheckSuite GetAllForReference * Add test for CheckSuite UpdatePreferences * rename response models * rename CheckSuitesList to CheckSuitesResponse and use as response to the GetAll calls * Fix tests * Fix observable * fix model convention tests * remove CheckRuns so we can focus only on CheckSuites for now * naming things is hard * oh so many unit tests for CheckSuites methods * make client mockable * Fix issue with .Max() when no results returned * fix request parameter names * add Xml doc comments * Add XmlDoc comments to request/common model objects * rename class to match usage * tidy ups * xmldoc for observable clients * fix method order * add observable unit tests and get them passing * Add Observable unit tests and get them passing * add observable integration tests * tidy up ApiUrl method name * whitespace/using tidy ups * Ensure CheckSuiteEventPayload class is handled in deserializer and add to activity test * add response model XmlDoc comments * missed one xmldoc * add xmldoc to NewCheckSuite request and remove HeadBranch property as it doesnt exist anymore * add some extra check suites integration tests
This commit is contained in:
Ryan Gribble
@@ -0,0 +1,271 @@
|
||||
using System;
|
||||
using System.Reactive.Threading.Tasks;
|
||||
using Octokit.Reactive.Internal;
|
||||
|
||||
namespace Octokit.Reactive
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Check Suites API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/checks/suites/">Check Suites API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public class ObservableCheckSuitesClient : IObservableCheckSuitesClient
|
||||
{
|
||||
readonly ICheckSuitesClient _client;
|
||||
readonly IConnection _connection;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new GitHub Check Suites API client.
|
||||
/// </summary>
|
||||
/// <param name="client">An <see cref="IGitHubClient" /> used to make the requests</param>
|
||||
public ObservableCheckSuitesClient(IGitHubClient client)
|
||||
{
|
||||
Ensure.ArgumentNotNull(client, nameof(client));
|
||||
|
||||
_client = client.Check.Suite;
|
||||
_connection = client.Connection;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a single Check Suite by Id
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/checks/suites/#get-a-single-check-suite">Check Suites API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <param name="checkSuiteId">The Id of the check suite</param>
|
||||
public IObservable<CheckSuite> Get(string owner, string name, long checkSuiteId)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
|
||||
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
|
||||
|
||||
return _client.Get(owner, name, checkSuiteId).ToObservable();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a single Check Suite by Id
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/checks/suites/#get-a-single-check-suite">Check Suites API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="repositoryId">The Id of the repository</param>
|
||||
/// <param name="checkSuiteId">The Id of the check suite</param>
|
||||
public IObservable<CheckSuite> Get(long repositoryId, long checkSuiteId)
|
||||
{
|
||||
return _client.Get(repositoryId, checkSuiteId).ToObservable();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Lists Check Suites for a commit reference (SHA, branch name or tag name)
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref">Check Suites API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <param name="reference">The reference (SHA, branch name or tag name) to list check suites for</param>
|
||||
public IObservable<CheckSuitesResponse> GetAllForReference(string owner, string name, string reference)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
|
||||
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
|
||||
Ensure.ArgumentNotNullOrEmptyString(reference, nameof(reference));
|
||||
|
||||
return GetAllForReference(owner, name, reference, new CheckSuiteRequest(), ApiOptions.None);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Lists Check Suites for a commit reference (SHA, branch name or tag name)
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref">Check Suites API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="repositoryId">The Id of the repository</param>
|
||||
/// <param name="reference">The reference (SHA, branch name or tag name) to list check suites for</param>
|
||||
public IObservable<CheckSuitesResponse> GetAllForReference(long repositoryId, string reference)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(reference, nameof(reference));
|
||||
|
||||
return GetAllForReference(repositoryId, reference, new CheckSuiteRequest(), ApiOptions.None);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Lists Check Suites for a commit reference (SHA, branch name or tag name)
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref">Check Suites API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <param name="reference">The reference (SHA, branch name or tag name) to list check suites for</param>
|
||||
/// <param name="request">Details to filter the request, such as by App Id or Check Name</param>
|
||||
public IObservable<CheckSuitesResponse> GetAllForReference(string owner, string name, string reference, CheckSuiteRequest request)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
|
||||
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
|
||||
Ensure.ArgumentNotNullOrEmptyString(reference, nameof(reference));
|
||||
Ensure.ArgumentNotNull(request, nameof(request));
|
||||
|
||||
return GetAllForReference(owner, name, reference, request, ApiOptions.None);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Lists Check Suites for a commit reference (SHA, branch name or tag name)
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref">Check Suites API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="repositoryId">The Id of the repository</param>
|
||||
/// <param name="reference">The reference (SHA, branch name or tag name) to list check suites for</param>
|
||||
/// <param name="request">Details to filter the request, such as by App Id or Check Name</param>
|
||||
public IObservable<CheckSuitesResponse> GetAllForReference(long repositoryId, string reference, CheckSuiteRequest request)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(reference, nameof(reference));
|
||||
Ensure.ArgumentNotNull(request, nameof(request));
|
||||
|
||||
return GetAllForReference(repositoryId, reference, request, ApiOptions.None);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Lists Check Suites for a commit reference (SHA, branch name or tag name)
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref">Check Suites API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <param name="reference">The reference (SHA, branch name or tag name) to list check suites for</param>
|
||||
/// <param name="request">Details to filter the request, such as by App Id or Check Name</param>
|
||||
/// <param name="options">Options to change the API response</param>
|
||||
public IObservable<CheckSuitesResponse> GetAllForReference(string owner, string name, string reference, CheckSuiteRequest request, ApiOptions options)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
|
||||
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
|
||||
Ensure.ArgumentNotNullOrEmptyString(reference, nameof(reference));
|
||||
Ensure.ArgumentNotNull(request, nameof(request));
|
||||
Ensure.ArgumentNotNull(options, nameof(options));
|
||||
|
||||
return _connection.GetAndFlattenAllPages<CheckSuitesResponse>(ApiUrls.CheckSuitesForReference(owner, name, reference), request.ToParametersDictionary(), AcceptHeaders.ChecksApiPreview, options);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Lists Check Suites for a commit reference (SHA, branch name or tag name)
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref">Check Suites API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="repositoryId">The Id of the repository</param>
|
||||
/// <param name="reference">The reference (SHA, branch name or tag name) to list check suites for</param>
|
||||
/// <param name="request">Details to filter the request, such as by App Id or Check Name</param>
|
||||
/// <param name="options">Options to change the API response</param>
|
||||
public IObservable<CheckSuitesResponse> GetAllForReference(long repositoryId, string reference, CheckSuiteRequest request, ApiOptions options)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(reference, nameof(reference));
|
||||
Ensure.ArgumentNotNull(request, nameof(request));
|
||||
Ensure.ArgumentNotNull(options, nameof(options));
|
||||
|
||||
return _connection.GetAndFlattenAllPages<CheckSuitesResponse>(ApiUrls.CheckSuitesForReference(repositoryId, reference), request.ToParametersDictionary(), AcceptHeaders.ChecksApiPreview, options);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Updates Check Suites prefrences on a repository, such as disabling automatic creation when code is pushed
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository">Check Suites API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <param name="preferences">The check suite preferences</param>
|
||||
public IObservable<CheckSuitePreferencesResponse> UpdatePreferences(string owner, string name, CheckSuitePreferences preferences)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
|
||||
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
|
||||
Ensure.ArgumentNotNull(preferences, nameof(preferences));
|
||||
|
||||
return _client.UpdatePreferences(owner, name, preferences).ToObservable();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Updates Check Suites prefrences on a repository, such as disabling automatic creation when code is pushed
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository">Check Suites API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="repositoryId">The Id of the repository</param>
|
||||
/// <param name="preferences">The check suite preferences</param>
|
||||
public IObservable<CheckSuitePreferencesResponse> UpdatePreferences(long repositoryId, CheckSuitePreferences preferences)
|
||||
{
|
||||
Ensure.ArgumentNotNull(preferences, nameof(preferences));
|
||||
|
||||
return _client.UpdatePreferences(repositoryId, preferences).ToObservable();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates a new Check Suite
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/checks/suites/#create-a-check-suite">Check Suites API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <param name="newCheckSuite">Details of the Check Suite to create</param>
|
||||
public IObservable<CheckSuite> Create(string owner, string name, NewCheckSuite newCheckSuite)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
|
||||
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
|
||||
Ensure.ArgumentNotNull(newCheckSuite, nameof(newCheckSuite));
|
||||
|
||||
return _client.Create(owner, name, newCheckSuite).ToObservable();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates a new Check Suite
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/checks/suites/#create-a-check-suite">Check Suites API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="repositoryId">The Id of the repository</param>
|
||||
/// <param name="newCheckSuite">Details of the Check Suite to create</param>
|
||||
public IObservable<CheckSuite> Create(long repositoryId, NewCheckSuite newCheckSuite)
|
||||
{
|
||||
Ensure.ArgumentNotNull(newCheckSuite, nameof(newCheckSuite));
|
||||
|
||||
return _client.Create(repositoryId, newCheckSuite).ToObservable();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Triggers GitHub to create a new check suite, without pushing new code to a repository
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/checks/suites/#request-check-suites">Check Suites API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <param name="request">Details of the Check Suite request</param>
|
||||
public IObservable<bool> Request(string owner, string name, CheckSuiteTriggerRequest request)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
|
||||
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
|
||||
Ensure.ArgumentNotNull(request, nameof(request));
|
||||
|
||||
return _client.Request(owner, name, request).ToObservable();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Triggers GitHub to create a new check suite, without pushing new code to a repository
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/checks/suites/#request-check-suites">Check Suites API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="repositoryId">The Id of the repository</param>
|
||||
/// <param name="request">Details of the Check Suite request</param>
|
||||
|
||||
public IObservable<bool> Request(long repositoryId, CheckSuiteTriggerRequest request)
|
||||
{
|
||||
Ensure.ArgumentNotNull(request, nameof(request));
|
||||
|
||||
return _client.Request(repositoryId, request).ToObservable();
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user