Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Complete checks api #723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Mar 4, 2020
Merged

Complete checks api #723

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
10cc79f
add more properties to GHCheckRun
XiongKezhi Feb 28, 2020
05e8148
format code
XiongKezhi Feb 28, 2020
73179c1
Fixed typo in JavaDoc of getApp
XiongKezhi Feb 29, 2020
2242174
add Output in GHCheckRun
XiongKezhi Feb 29, 2020
e96067e
Merge remote-tracking branch 'origin/complete-checks-api' into comple…
XiongKezhi Feb 29, 2020
5a8f8c3
parse completedAt and startedAt into Date in getters
XiongKezhi Feb 29, 2020
57f9475
Delete empty line in JavaDoc
XiongKezhi Feb 29, 2020
f9006af
Merge branch 'master' into complete-checks-api
bitwiseman Feb 29, 2020
10b01ca
using Date for timestamps and add more JavaDoc
XiongKezhi Mar 1, 2020
3754175
Change timestamps property back to String
XiongKezhi Mar 1, 2020
16faaae
Add GHCheckSuite
XiongKezhi Mar 1, 2020
f8a8ee9
Format code
XiongKezhi Mar 1, 2020
f54bfd3
Fixed JavaDoc warning reported by maven site
XiongKezhi Mar 1, 2020
ce7cfc0
Merge branch 'master' into complete-checks-api
XiongKezhi Mar 3, 2020
768f607
Add Output and more tests
XiongKezhi Mar 3, 2020
d0b23c7
Merge branch 'master' into complete-checks-api
bitwiseman Mar 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
170 changes: 167 additions & 3 deletions 170 src/main/java/org/kohsuke/github/GHCheckRun.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

import java.io.IOException;
import java.net.URL;
import java.util.Date;

/**
* Represents a check run.
*
* @see <a href="https://developer.github.com/v3/checks/runs/">documentation</a>
*/

@SuppressFBWarnings(value = { "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD", "URF_UNREAD_FIELD" },
justification = "JSON API")
public class GHCheckRun extends GHObject {
Expand All @@ -21,7 +21,16 @@ public class GHCheckRun extends GHObject {
private String conclusion;
private String name;
private String headSha;
private String nodeId;
private String externalId;
private String startedAt;
private String completedAt;
Comment on lines +26 to +27
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These can be Date instances I think and Jackson will handle the conversion.

Copy link
Contributor Author

@XiongKezhi XiongKezhi Mar 1, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just saw the GHObject uses String for such timestamps at first and convert them into Date in getters. And I think if we want to get rid of setters, we may have to do it in this way, or we will get error messages from spot-bugs like may expose internal representation.

private URL htmlUrl;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the htmlUrl and getHtmlUrl() can be inherited from GHObject. Please confirm.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can inherit the url and getUrl, but the getHtmlUrl() is abstract in GHObject, so I have to overwrite it.

private URL detailsUrl;
private Output output;
private GHApp app;
private GHPullRequest[] pullRequests;
private GHCheckSuite checkSuite;

GHCheckRun wrap(GHRepository owner) {
this.owner = owner;
Expand All @@ -41,14 +50,30 @@ GHPullRequest[] wrap() {
return pullRequests;
}

/**
* Gets status of the check run. It can be one of "queue", "in_progress", or "completed"
*
* @return Status of the check run
*/
public String getStatus() {
return status;
}

/**
* Gets conclusion of a completed check run. It can be one of "success", "failure", "neutral", "cancelled",
* "time_out", or "action_required".
*
* @return Status of the check run
*/
public String getConclusion() {
return conclusion;
}

/**
* Gets the custom name of this check run.
*
* @return Name of the check run
*/
public String getName() {
return name;
}
Expand All @@ -62,6 +87,11 @@ public String getHeadSha() {
return headSha;
}

/**
* Gets the pull requests participated in this check run.
*
* @return Pull requests of this check run
*/
GHPullRequest[] getPullRequests() throws IOException {
if (pullRequests != null && pullRequests.length != 0) {
for (GHPullRequest singlePull : pullRequests) {
Expand All @@ -72,11 +102,145 @@ GHPullRequest[] getPullRequests() throws IOException {
}

/**
* @deprecated This object has no HTML URL.
* Gets the HTML URL: https://github.com/[owner]/[repo-name]/runs/[check-run-id], usually an GitHub Action page of
* the check run.
*
* @return HTML URL
*/
@Override
public URL getHtmlUrl() {
return null;
return htmlUrl;
}

/**
* Gets the global node id to access most objects in GitHub.
*
* @see <a href="https://developer.github.com/v4/guides/using-global-node-ids/">documentation</a>
* @return Global node id
*/
public String getNodeId() {
return nodeId;
}

/**
* Gets a reference for the check run on the integrator's system.
*
* @return Reference id
*/
public String getExternalId() {
return externalId;
}

/**
* Gets the details URL from which to find full details of the check run on the integrator's site.
*
* @return Details URL
*/
public URL getDetailsUrl() {
return detailsUrl;
}

/**
* Gets the start time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
*
* @return Timestamp of the start time
*/
public Date getStartedAt() {
return GitHubClient.parseDate(startedAt);
}

/**
* Gets the completed time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
*
* @return Timestamp of the completed time
*/
public Date getCompletedAt() {
return GitHubClient.parseDate(completedAt);
}

/**
* Gets the GitHub app this check run belongs to, included in response.
*
* @return GitHub App
*/
public GHApp getApp() {
return app;
}

/**
* Gets the check suite this check run belongs to
*
* @return Check suite
*/
public GHCheckSuite getCheckSuite() {
return checkSuite;
}

/**
* Gets an output for a check run.
*
* @return Output of a check run
*/
public Output getOutput() {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need the javadoc for this.

return output;
}

/**
* Represents an output in a check run to include summary and other results.
*
* @see <a href="https://developer.github.com/v3/checks/runs/#output-object">documentation</a>
*/
public static class Output {
private String title;
private String summary;
private String text;
private int annotationsCount;
private URL annotationsUrl;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have a CheckRunAnnotations yet? If not we'll need that added eventually as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's where I'm confused. The response (or event payload) from GitHub does not include annotation objects, but they are needed when users are making requests. So does our implementation have to make sure it supports both usages?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most probably it should support. Would be beneficial for users in the longer term

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It isn't required for this PR, I'm just noting it for later.


/**
* Gets the title of check run.
*
* @return title of check run
*/
public String getTitle() {
return title;
}

/**
* Gets the summary of the check run, note that it supports Markdown.
*
* @return summary of check run
*/
public String getSummary() {
return summary;
}

/**
* Gets the details of the check run, note that it supports Markdown.
*
* @return Details of the check run
*/
public String getText() {
return text;
}

/**
* Gets the annotation count of a check run.
*
* @return annotation count of a check run
*/
public int getAnnotationsCount() {
return annotationsCount;
}

/**
* Gets the URL of annotations.
*
* @return URL of annotations
*/
public URL getAnnotationsUrl() {
return annotationsUrl;
}
}

}
Loading
Morty Proxy This is a proxified and sanitized view of the page, visit original site.