package com.tapadoo.slacknotifier;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
import jetbrains.buildServer.issueTracker.Issue;
import jetbrains.buildServer.serverSide.*;
import jetbrains.buildServer.serverSide.settings.ProjectSettingsManager;
import jetbrains.buildServer.users.SUser;
import jetbrains.buildServer.users.UserSet;
import jetbrains.buildServer.vcs.SVcsModification;
import jetbrains.buildServer.vcs.SelectPrevBuildPolicy;
import org.joda.time.Duration;
import org.joda.time.format.PeriodFormatter;
import org.joda.time.format.PeriodFormatterBuilder;
import java.io.BufferedOutputStream;
import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Collection;
import java.util.Date;
import java.util.List;
/**
* Created by jasonconnery on 02/03/2014.
*/
public class SlackServerAdapter extends BuildServerAdapter {
private final SBuildServer buildServer;
private final SlackConfigProcessor slackConfig;
private final ProjectSettingsManager projectSettingsManager;
private final ProjectManager projectManager ;
private Gson gson ;
public SlackServerAdapter(SBuildServer sBuildServer, ProjectManager projectManager, ProjectSettingsManager projectSettingsManager , SlackConfigProcessor configProcessor) {
this.projectManager = projectManager ;
this.projectSettingsManager = projectSettingsManager ;
this.buildServer = sBuildServer ;
this.slackConfig = configProcessor ;
}
public void init()
{
buildServer.addListener(this);
}
private Gson getGson()
{
if( gson == null )
{
gson = new GsonBuilder().create() ;
}
return gson ;
}
@Override
public void buildStarted(SRunningBuild build) {
super.buildStarted(build);
if( !build.isPersonal() && slackConfig.postStarted() )
{
postStartedBuild(build);
}
}
@Override
public void buildFinished(SRunningBuild build) {
super.buildFinished(build);
String postToSlack = build.getParametersProvider().get("system.POST_TO_SLACK");
if(postToSlack != null && (postToSlack.equals("false") || postToSlack.equals("0") )) {
return ;
}
if( !build.isPersonal() && build.getBuildStatus().isSuccessful() && slackConfig.postSuccessful() )
{
processSuccessfulBuild(build);
}
else if ( !build.isPersonal() && build.getBuildStatus().isFailed() && slackConfig.postFailed() )
{
postFailureBuild(build);
}
else
{
//TODO - modify in future if we care about other states
}
}
private void postStartedBuild(SRunningBuild build )
{
//Could put other into here. Agents maybe?
String message = String.format("Project '%s' build started." , build.getFullName());
postToSlack(build, message, true);
}
private void postFailureBuild(SRunningBuild build )
{
String message = "";
PeriodFormatter durationFormatter = new PeriodFormatterBuilder()
.printZeroRarelyFirst()
.appendHours()
.appendSuffix(" hour", " hours")
.appendSeparator(" ")
.printZeroRarelyLast()
.appendMinutes()
.appendSuffix(" minute", " minutes")
.appendSeparator(" and ")
.appendSeconds()
.appendSuffix(" second", " seconds")
.toFormatter();
Duration buildDuration = new Duration(1000*build.getDuration());
message = String.format("Project '%s' build failed! ( %s )" , build.getFullName() , durationFormatter.print(buildDuration.toPeriod()));
postToSlack(build, message, false);
}
private void processSuccessfulBuild(SRunningBuild build) {
String message = "";
PeriodFormatter durationFormatter = new PeriodFormatterBuilder()
.printZeroRarelyFirst()
.appendHours()
.appendSuffix(" hour", " hours")
.appendSeparator(" ")
.printZeroRarelyLast()
.appendMinutes()
.appendSuffix(" minute", " minutes")
.appendSeparator(" and ")
.appendSeconds()
.appendSuffix(" second", " seconds")
.toFormatter();
Duration buildDuration = new Duration(1000*build.getDuration());
message = String.format("Project '%s' built successfully in %s." , build.getFullName() , durationFormatter.print(buildDuration.toPeriod()));
postToSlack(build, message, true);
}
/**
* Post a payload to slack with a message and good/bad color. Committer summary is automatically added as an attachment
* @param build the build the message is relating to
* @param message main message to include, 'Build X completed...' etc
* @param goodColor true for 'good' builds, false for danger.
*/
private void postToSlack(SRunningBuild build, String message, boolean goodColor) {
try{
URL url = new URL(slackConfig.getPostUrl());
SlackProjectSettings projectSettings = (SlackProjectSettings) projectSettingsManager.getSettings(build.getProjectId(),"slackSettings");
if( ! projectSettings.isEnabled() )
{
return ;
}
String iconUrl = projectSettings.getLogoUrl();
if(iconUrl == null || iconUrl.length() < 1 )
{
iconUrl = slackConfig.getLogoUrl() ;
}
String configuredChannel = build.getParametersProvider().get("system.SLACK_CHANNEL");
String channel = this.slackConfig.getDefaultChannel();
if( configuredChannel != null && configuredChannel.length() > 0 )
{
channel = configuredChannel ;
}
else if( projectSettings != null && projectSettings.getChannel() != null && projectSettings.getChannel().length() > 0 )
{
channel = projectSettings.getChannel() ;
}
UserSet<SUser> committers = build.getCommitters(SelectPrevBuildPolicy.SINCE_LAST_BUILD);
StringBuilder committersString = new StringBuilder();
for( SUser committer : committers.getUsers() )
{
if( committer != null)
{
String committerName = committer.getName() ;
if( committerName == null || committerName.equals("") )
{
committerName = committer.getUsername() ;
}
if( committerName != null && !committerName.equals(""))
{
committersString.append(committerName);
committersString.append(",");
}
}
}
if( committersString.length() > 0 )
{
committersString.deleteCharAt(committersString.length()-1); //remove the last ,
}
String committersMsg = committersString.toString();
JsonObject payloadObj = new JsonObject();
payloadObj.addProperty("channel" , channel);
payloadObj.addProperty("username" , "TeamCity");
payloadObj.addProperty("text", message);
payloadObj.addProperty("icon_url",iconUrl);
JsonArray attachmentsObj = new JsonArray();
JsonObject attachment = new JsonObject() ;
attachmentsObj.add(attachment);
JsonArray fields = new JsonArray();
//Attach the build number
JsonObject buildField = new JsonObject() ;
buildField.addProperty("title" , "Build");
buildField.addProperty("short" , true);
buildField.addProperty("value" , build.getBuildNumber());
fields.add(buildField);
StringBuilder fallbackMessage = new StringBuilder();
if( committersMsg.length() > 0 )
{
JsonObject field = new JsonObject() ;
field.addProperty("title","Changes By");
field.addProperty("value",committersMsg);
field.addProperty("short", true);
fields.add(field);
fallbackMessage.append("Changes by ");
fallbackMessage.append(committersMsg);
fallbackMessage.append(" ");
}
BuildStatistics testStats = build.getBuildStatistics(BuildStatisticsOptions.ALL_TESTS_NO_DETAILS);
if ( testStats != null && testStats.getAllTestRunCount() > 0 ) {
int failureCount = testStats.getFailedTestCount();
int successCount = testStats.getPassedTestCount();
JsonObject field = new JsonObject();
field.addProperty("title" , "Tests");
field.addProperty("value", String.format("%d passed, %d failed.", successCount, failureCount));
field.addProperty("short", true);
fields.add(field);
}
//Do we have any issues?
if( build.isHasRelatedIssues() )
{
//We do!
Collection<Issue> issues = build.getRelatedIssues();
StringBuilder issueIds = new StringBuilder();
StringBuilder clickableIssueIds = new StringBuilder();
for( Issue issue : issues )
{
issueIds.append(',');
issueIds.append(issue.getId());
clickableIssueIds.append(',');
clickableIssueIds.append('<');
clickableIssueIds.append(issue.getUrl());
clickableIssueIds.append('|');
clickableIssueIds.append(issue.getId());
clickableIssueIds.append('>');
}
if( issueIds.length() > 0 )
{
issueIds.deleteCharAt(0); //delete first ','
}
if( clickableIssueIds.length() > 0 )
{
clickableIssueIds.deleteCharAt(0); //delete first ','
}
JsonObject field = new JsonObject() ;
field.addProperty("title", "Related Issues");
field.addProperty("value",clickableIssueIds.toString());
field.addProperty("short", true);
fields.add(field);
fallbackMessage.append("Related Issues ");
fallbackMessage.append(issueIds.toString());
}
attachment.addProperty("color", (goodColor ? "good" : "danger"));
attachment.add("fields",fields);
JsonObject commitAttachment = createCommitAttachment(build);
if(commitAttachment != null) {
attachmentsObj.add(commitAttachment);
}
if( attachmentsObj.size() > 0 ) {
payloadObj.add("attachments", attachmentsObj);
}
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setDoOutput(true);
BufferedOutputStream bos = new BufferedOutputStream(conn.getOutputStream());
String payloadJson = getGson().toJson(payloadObj);
String bodyContents = "payload=" + payloadJson ;
bos.write(bodyContents.getBytes("utf8"));
bos.flush();
bos.close();
int serverResponseCode = conn.getResponseCode() ;
conn.disconnect();
conn = null ;
url = null ;
}
catch ( MalformedURLException ex )
{
} catch (IOException e) {
e.printStackTrace();
}
}
private JsonObject createCommitAttachment(SRunningBuild build) {
String ignoreCommitMessage = build.getParametersProvider().get("system.SLACK_IGNORE_COMMIT_MESSAGE");
if (ignoreCommitMessage != null && ignoreCommitMessage.equalsIgnoreCase("true")) return null;
List<SVcsModification> changes = build.getChanges(SelectPrevBuildPolicy.SINCE_LAST_SUCCESSFULLY_FINISHED_BUILD, true);
StringBuilder commitMessage = new StringBuilder();
/*
* If this field starts to feel too long in slack, we should only use the first item in the array, which would be the latest change
*
*/
for ( int i = 0 ; i < changes.size() ; i++ ){
SVcsModification modification = changes.get(i);
String desc = modification.getDescription();
commitMessage.append("‣ ");
commitMessage.append(desc);
if( i < changes.size() - 1 ) {
commitMessage.append("\n");
}
}
if (changes.size() < 1) {
return null;
}
String commitMessageString = commitMessage.toString();
JsonObject attachment = new JsonObject();
attachment.addProperty("title", "Commit Messages");
attachment.addProperty("fallback" , commitMessageString);
attachment.addProperty("text" , commitMessageString);
attachment.addProperty("color" , "#2FA8B9");
Branch branch = build.getBranch();
if (branch != null) {
attachment.addProperty("footer" , String.format("Built from %s", branch.getDisplayName()) );
Date finishDate = build.getFinishDate();
if (finishDate != null ) {
long finishTime = finishDate.getTime()/1000;
attachment.addProperty("ts" , finishTime);
}
}
return attachment;
}
}
