Skip to content

Commit

Permalink
Merge pull request #76 from cburroughs/uri-artifact
Browse files Browse the repository at this point in the history
tell harbormaster how to link back to jenkins results
  • Loading branch information
ascandella committed Aug 17, 2015
2 parents 3b38f5c + 50a3c9a commit 5fa407e
Show file tree
Hide file tree
Showing 5 changed files with 221 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import com.uber.jenkins.phabricator.tasks.NonDifferentialBuildTask;
import com.uber.jenkins.phabricator.tasks.PostCommentTask;
import com.uber.jenkins.phabricator.tasks.SendHarbormasterResultTask;
import com.uber.jenkins.phabricator.tasks.SendHarbormasterUriTask;
import com.uber.jenkins.phabricator.tasks.Task;
import com.uber.jenkins.phabricator.uberalls.UberallsClient;
import com.uber.jenkins.phabricator.utils.CommonUtils;
Expand Down Expand Up @@ -140,7 +141,8 @@ public final boolean perform(final AbstractBuild<?, ?> build, final Launcher lau
Result buildResult = build.getResult();
boolean harbormasterSuccess = buildResult.isBetterOrEqualTo(Result.SUCCESS);

CommentBuilder commenter = new CommentBuilder(logger, buildResult, coverage, environment.get("BUILD_URL"));
final String buildUrl = environment.get("BUILD_URL");
CommentBuilder commenter = new CommentBuilder(logger, buildResult, coverage, buildUrl);

// First add in info about the change in coverage, if applicable
if (commenter.hasCoverageAvailable()) {
Expand All @@ -158,10 +160,14 @@ public final boolean perform(final AbstractBuild<?, ?> build, final Launcher lau

String commentAction = "none";
if (runHarbormaster) {
logger.info("harbormaster", "Sending build result to Harbormaster with PHID '" + phid + "', success: " + harbormasterSuccess);
logger.info("harbormaster", "Sending Harbormaster BUILD_URL via PHID: " + phid);
Task.Result sendUriResult = new SendHarbormasterUriTask(logger, diffClient, phid, buildUrl).run();
if (sendUriResult != Task.Result.SUCCESS) {
logger.info(CONDUIT_TAG, "Unable to send BUILD_URL to Harbormaster");
}

logger.info("harbormaster", "Sending build result to Harbormaster with PHID '" + phid + "', success: " + harbormasterSuccess);
Task.Result result = new SendHarbormasterResultTask(logger, diffClient, phid, harbormasterSuccess).run();

if (result != Task.Result.SUCCESS) {
logger.info(CONDUIT_TAG, "Unable to post to harbormaster");
return false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,22 @@ public ConduitAPIClient(String conduitURL, String conduitToken) {
* @throws ConduitAPIException If there was an error calling conduit
*/
public JSONObject perform(String action, Map<String, String> data) throws IOException, ConduitAPIException {
JSONObject params = new JSONObject();
params.putAll(data);
return perform(action, params);
}

/**
* Call the conduit API of Phabricator
* @param action Name of the API call
* @param params The data to send to Harbormaster
* @return The result as a JSONObject
* @throws IOException If there was a problem reading the response
* @throws ConduitAPIException If there was an error calling conduit
*/
public JSONObject perform(String action, JSONObject params) throws IOException, ConduitAPIException {
CloseableHttpClient client = HttpClientBuilder.create().build();
HttpUriRequest request = createRequest(action, data);
HttpUriRequest request = createRequest(action, params);

HttpResponse response;
try {
Expand Down Expand Up @@ -93,6 +107,20 @@ public JSONObject perform(String action, Map<String, String> data) throws IOExce
* @throws ConduitAPIException when the conduit URL is misconfigured
*/
public HttpUriRequest createRequest(String action, Map<String, String> data) throws UnsupportedEncodingException, ConduitAPIException {
JSONObject params = new JSONObject();
params.putAll(data);
return createRequest(action, params);
}

/**
* Post a URL-encoded "params" key with a JSON-encoded body as per the Conduit API
* @param action The name of the Conduit method
* @param params The data to be sent to the Conduit method
* @return The request to perform
* @throws UnsupportedEncodingException when the POST data can't be encoded
* @throws ConduitAPIException when the conduit URL is misconfigured
*/
public HttpUriRequest createRequest(String action, JSONObject params) throws UnsupportedEncodingException, ConduitAPIException {
HttpPost post;
try {
post = new HttpPost(
Expand All @@ -104,9 +132,6 @@ public HttpUriRequest createRequest(String action, Map<String, String> data) thr
throw new ConduitAPIException(e.getMessage());
}

JSONObject params = new JSONObject();
params.putAll(data);

JSONObject conduitParams = new JSONObject();
conduitParams.put(API_TOKEN_KEY, conduitToken);
params.put(CONDUIT_METADATA_KEY, conduitParams);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,27 @@ public JSONObject sendHarbormasterMessage(String phid, boolean pass) throws Cond
return this.callConduit("harbormaster.sendmessage", params);
}

/**
* Uploads a uri as an 'artifact' for Harbormaster to display
* @param phid Phabricator object ID
* @param buildUri Uri to display, presumably the jenkins builds
* @return the Conduit API response
* @throws IOException if there is a network error talking to Conduit
* @throws ConduitAPIException if any error is experienced talking to Conduit
*/
public JSONObject sendHarbormasterUri(String phid, String buildUri) throws ConduitAPIException, IOException {
Map params = new HashMap<String, String>();
params.put("buildTargetPHID", phid);
params.put("artifactKey", "jenkins.uri");
params.put("artifactType", "uri");
JSONObject artifactData = new JSONObject();
artifactData = artifactData.element("uri", buildUri)
.element("name", "Jenkins")
.element("ui.external", true);
params.put("artifactData", artifactData);
return this.callConduit("harbormaster.createartifact", params);
}

/**
* Post a comment on the differential
* @param revisionID the revision ID (e.g. "D1234" without the "D")
Expand All @@ -121,4 +142,8 @@ public JSONObject postComment(String revisionID, String message) throws ConduitA
protected JSONObject callConduit(String methodName, Map<String, String> params) throws ConduitAPIException, IOException {
return conduit.perform(methodName, params);
}

protected JSONObject callConduit(String methodName, JSONObject params) throws ConduitAPIException, IOException {
return conduit.perform(methodName, params);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package com.uber.jenkins.phabricator.tasks;

import com.uber.jenkins.phabricator.conduit.ConduitAPIClient;
import com.uber.jenkins.phabricator.conduit.ConduitAPIException;
import com.uber.jenkins.phabricator.conduit.DifferentialClient;
import com.uber.jenkins.phabricator.utils.Logger;
import net.sf.json.JSONNull;
import net.sf.json.JSONObject;

import java.io.IOException;

public class SendHarbormasterUriTask extends Task {

private final DifferentialClient diffClient;
private final String phid;
private final String buildUri;

public SendHarbormasterUriTask(Logger logger, DifferentialClient diffClient, String phid, String buildUri) {
super(logger);
this.diffClient = diffClient;
this.phid = phid;
this.buildUri = buildUri;
}

@Override
protected String getTag() {
return "send-harbormaster-uri";
}

@Override
protected void setup() {
// Do nothing
}

@Override
protected void execute() {
try {
JSONObject result = diffClient.sendHarbormasterUri(phid, buildUri);
if (result.containsKey("error_info") && !(result.get("error_info") instanceof JSONNull)) {
info(String.format("Error from Harbormaster: %s", result.getString("error_info")));
this.result = Result.FAILURE;
} else {
this.result = Result.SUCCESS;
}
} catch (ConduitAPIException e) {
e.printStackTrace();
this.result = Result.FAILURE;
} catch (IOException e) {
e.printStackTrace();
this.result = Result.FAILURE;
}
}

@Override
protected void tearDown() {
// Do nothing
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package com.uber.jenkins.phabricator.tasks;

import com.uber.jenkins.phabricator.conduit.ConduitAPIException;
import com.uber.jenkins.phabricator.conduit.DifferentialClient;
import com.uber.jenkins.phabricator.utils.TestUtils;
import net.sf.json.JSONObject;
import org.junit.Before;
import org.junit.Test;

import java.io.IOException;

import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

public class SendHarbormasterUriTaskTest {
private final String buildUrl = "http://jenkins.example.com/foo/123";
private final JSONObject validResponse = new JSONObject();
private DifferentialClient diffClient;

@Before
public void setUp() {
diffClient = mock(DifferentialClient.class);
}

@Test
public void testUrlHappyPath() throws IOException, ConduitAPIException {
when(diffClient.sendHarbormasterUri(TestUtils.TEST_PHID, buildUrl)).thenReturn(validResponse);

assertEquals(Task.Result.SUCCESS, getResult());
}

@Test
public void testErrorInfoResponse() throws IOException, ConduitAPIException {
JSONObject errorResponse = new JSONObject();
errorResponse.put("error_info", "i'm having a bad day");
when(diffClient.sendHarbormasterUri(TestUtils.TEST_PHID, buildUrl)).thenReturn(errorResponse);

assertEquals(Task.Result.FAILURE, getResult());
}

@Test
public void testConduitAPIFailure() throws IOException, ConduitAPIException {
when(diffClient.sendHarbormasterUri(TestUtils.TEST_PHID, buildUrl)).thenThrow(ConduitAPIException.class);

assertEquals(Task.Result.FAILURE, getResult());
}

@Test
public void testIOExceptionFailure() throws IOException, ConduitAPIException {
when(diffClient.sendHarbormasterUri(TestUtils.TEST_PHID, buildUrl)).thenThrow(IOException.class);

assertEquals(Task.Result.FAILURE, getResult());
}

private Task.Result getResult() {
return new SendHarbormasterUriTask(
TestUtils.getDefaultLogger(),
diffClient,
TestUtils.TEST_PHID,
buildUrl
).run();
}
}

0 comments on commit 5fa407e

Please sign in to comment.