com.uber.jenkins.phabricator.conduit

Class DifferentialClient

java.lang.Object

com.uber.jenkins.phabricator.conduit.DifferentialClient

public class DifferentialClient
extends java.lang.Object

DifferentialClient handles all interaction with conduit/arc for differentials

Constructor Summary

Constructors

Constructor and Description
DifferentialClient(java.lang.String diffID, ConduitAPIClient conduit)

Method Summary

Modifier and Type	Method and Description
protected net.sf.json.JSONObject	callConduit(java.lang.String methodName, net.sf.json.JSONObject params)
net.sf.json.JSONObject	fetchDiff() Fetch a differential from Conduit
java.lang.String	getCommitMessage(java.lang.String revisionID) Fetch the commit message for the revision.
net.sf.json.JSONObject	postComment(java.lang.String revisionID, java.lang.String message) Post a comment on the differential
net.sf.json.JSONObject	postComment(java.lang.String revisionID, java.lang.String message, boolean silent, java.lang.String action) Posts a comment to a differential
net.sf.json.JSONObject	sendHarbormasterMessage(java.lang.String phid, HarbormasterClient.MessageType messageType, UnitResults unitResults, java.util.Map<java.lang.String,java.lang.String> coverage, LintResults lintResults) Sets a sendHarbormasterMessage build status
net.sf.json.JSONObject	sendHarbormasterUri(java.lang.String phid, java.lang.String buildUri) Uploads a uri as an 'artifact' for Harbormaster to display

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DifferentialClient

public DifferentialClient(java.lang.String diffID,
                          ConduitAPIClient conduit)

Method Detail

postComment

public net.sf.json.JSONObject postComment(java.lang.String revisionID,
                                          java.lang.String message,
                                          boolean silent,
                                          java.lang.String action)
                                   throws java.io.IOException,
                                          ConduitAPIException

Posts a comment to a differential

Parameters:

revisionID - the revision ID (e.g. "D1234" without the "D")

message - the content of the comment

silent - whether or not to trigger an email

action - phabricator comment action, e.g. 'resign', 'reject', 'none'

Returns:

the Conduit API response

Throws:

java.io.IOException - if there is a network error talking to Conduit

ConduitAPIException - if any error is experienced talking to Conduit

fetchDiff

public net.sf.json.JSONObject fetchDiff()
                                 throws java.io.IOException,
                                        ConduitAPIException

Fetch a differential from Conduit

Returns:

the Conduit API response

Throws:

java.io.IOException - if there is a network error talking to Conduit

ConduitAPIException - if any error is experienced talking to Conduit

sendHarbormasterMessage

public net.sf.json.JSONObject sendHarbormasterMessage(java.lang.String phid,
                                                      HarbormasterClient.MessageType messageType,
                                                      UnitResults unitResults,
                                                      java.util.Map<java.lang.String,java.lang.String> coverage,
                                                      LintResults lintResults)
                                               throws ConduitAPIException,
                                                      java.io.IOException

Sets a sendHarbormasterMessage build status

Parameters:

phid - Phabricator object ID

messageType - type of message to send; either 'pass', 'fail' or 'work'

unitResults - the results from the unit tests

coverage - the results from the coverage provider

Returns:

the Conduit API response

Throws:

java.io.IOException - if there is a network error talking to Conduit

ConduitAPIException - if any error is experienced talking to Conduit

sendHarbormasterUri

public net.sf.json.JSONObject sendHarbormasterUri(java.lang.String phid,
                                                  java.lang.String buildUri)
                                           throws ConduitAPIException,
                                                  java.io.IOException

Uploads a uri as an 'artifact' for Harbormaster to display

Parameters:

phid - Phabricator object ID

buildUri - Uri to display, presumably the jenkins builds

Returns:

the Conduit API response

Throws:

java.io.IOException - if there is a network error talking to Conduit

ConduitAPIException - if any error is experienced talking to Conduit

postComment

public net.sf.json.JSONObject postComment(java.lang.String revisionID,
                                          java.lang.String message)
                                   throws ConduitAPIException,
                                          java.io.IOException

Post a comment on the differential

Parameters:

revisionID - the revision ID (e.g. "D1234" without the "D")

message - the string message to post

Returns:

the Conduit API response

Throws:

java.io.IOException - if there is a network error talking to Conduit

ConduitAPIException - if any error is experienced talking to Conduit

getCommitMessage

public java.lang.String getCommitMessage(java.lang.String revisionID)
                                  throws ConduitAPIException,
                                         java.io.IOException

Fetch the commit message for the revision. This isn't available on the diff, so it requires a separate query.

Parameters:

revisionID - The ID of the revision, e.g. for "D123" this would be "123"

Returns:

A \n-separated string of the commit message

Throws:

ConduitAPIException

java.io.IOException

callConduit

protected net.sf.json.JSONObject callConduit(java.lang.String methodName,
                                             net.sf.json.JSONObject params)
                                      throws ConduitAPIException,
                                             java.io.IOException

Throws:

ConduitAPIException

java.io.IOException