Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Fix JENKINS-20170
Added help.html files for all the triggers and cleaned up trigger
descriptors.
  • Loading branch information
slide committed Oct 23, 2013
1 parent 92177e6 commit d288c1e
Show file tree
Hide file tree
Showing 62 changed files with 244 additions and 332 deletions.
18 changes: 8 additions & 10 deletions src/main/java/hudson/plugins/emailext/ExtendedEmailPublisher.java
@@ -1,7 +1,6 @@
package hudson.plugins.emailext;

import hudson.EnvVars;
import hudson.Extension;
import hudson.Launcher;
import hudson.matrix.MatrixAggregatable;
import hudson.matrix.MatrixAggregator;
Expand All @@ -13,13 +12,11 @@
import hudson.model.AbstractProject;
import hudson.model.Cause;
import hudson.model.Cause.UserCause;
import hudson.model.Hudson;
import hudson.model.User;
import hudson.plugins.emailext.plugins.ContentBuilder;
import hudson.plugins.emailext.plugins.CssInliner;
import hudson.plugins.emailext.plugins.EmailTrigger;
import hudson.scm.ChangeLogSet.Entry;
import hudson.tasks.BuildStepDescriptor;
import hudson.tasks.BuildStepMonitor;
import hudson.tasks.MailMessageIdAction;
import hudson.tasks.Notifier;
Expand Down Expand Up @@ -183,6 +180,7 @@ public ExtendedEmailPublisher() {

/**
* Get the list of configured email triggers for this project.
* @return
*/
public List<EmailTrigger> getConfiguredTriggers() {
if (configuredTriggers == null) {
Expand All @@ -192,8 +190,7 @@ public List<EmailTrigger> getConfiguredTriggers() {
}

public MatrixTriggerMode getMatrixTriggerMode() {
if (matrixTriggerMode ==null) return MatrixTriggerMode.BOTH;
return matrixTriggerMode;
return matrixTriggerMode == null ? MatrixTriggerMode.BOTH : matrixTriggerMode;
}

public void setMatrixTriggerMode(MatrixTriggerMode matrixTriggerMode) {
Expand Down Expand Up @@ -254,6 +251,7 @@ private boolean _perform(AbstractBuild<?, ?> build, BuildListener listener, bool
for (String triggerName : triggered.keySet()) {
replacedTriggers.addAll(triggered.get(triggerName).getDescriptor().getTriggerReplaceList());
}

for (String triggerName : replacedTriggers) {
triggered.remove(triggerName);
listener.getLogger().println("Trigger " + triggerName + " was overridden by another trigger and will not send an email.");
Expand Down Expand Up @@ -360,7 +358,7 @@ private boolean executePresendScript(AbstractBuild<?, ?> build, BuildListener li
boolean cancel = false;
presendScript = new ContentBuilder().transformText(presendScript, this, build, listener);
if (StringUtils.isNotBlank(presendScript)) {
listener.getLogger().println("Executing pre-send script");
debug(listener.getLogger(), "Executing pre-send script");
ClassLoader cl = Jenkins.getInstance().getPluginManager().uberClassLoader;
ScriptSandbox sandbox = null;
CompilerConfiguration cc = new CompilerConfiguration();
Expand Down Expand Up @@ -542,7 +540,7 @@ private MimeMessage createMail(EmailType type, AbstractBuild<?, ?> build, BuildL
debug(listener.getLogger(), "Emergency reroute turned on");
recipientAddresses.clear();
addAddressesFromRecipientList(recipientAddresses, ccAddresses, emergencyReroute, env, listener);
listener.getLogger().println("Emergency reroute is set to: " + emergencyReroute);
debug(listener.getLogger(), "Emergency reroute is set to: " + emergencyReroute);
}

// remove the excluded recipients
Expand All @@ -554,7 +552,7 @@ private MimeMessage createMail(EmailType type, AbstractBuild<?, ?> build, BuildL
}
recipientAddresses.removeAll(excludedRecipients);
ccAddresses.removeAll(excludedRecipients);

msg.setRecipients(Message.RecipientType.TO, recipientAddresses.toArray(new InternetAddress[recipientAddresses.size()]));
if(ccAddresses.size() > 0) {
msg.setRecipients(Message.RecipientType.CC, ccAddresses.toArray(new InternetAddress[ccAddresses.size()]));
Expand Down Expand Up @@ -626,7 +624,7 @@ private void addUserTriggeringTheBuild(AbstractBuild<?, ?> build, Set<InternetAd
EnvVars env, BuildListener listener) {
User user = getByUserIdCause(build);
if (user == null) {
user = getByLegacyUserCause(build);
user = getByLegacyUserCause(build);
}

if (user != null) {
Expand Down Expand Up @@ -669,7 +667,7 @@ private User getByLegacyUserCause(AbstractBuild<?, ?> build) {
String name = (String) authenticationName.get(userCause);
return User.get(name, false);
}
} catch(Exception e) {
} catch (Exception e) {
LOGGER.info(e.getMessage());
}
return null;
Expand Down
Expand Up @@ -7,13 +7,8 @@
import hudson.plugins.emailext.plugins.EmailTrigger;
import hudson.plugins.emailext.plugins.EmailTriggerDescriptor;

import java.io.IOException;
import javax.servlet.ServletException;
import jenkins.model.Jenkins;
import org.kohsuke.stapler.DataBoundConstructor;

import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;

public class AbortedTrigger extends EmailTrigger {

Expand Down Expand Up @@ -43,11 +38,6 @@ public static final class DescriptorImpl extends EmailTriggerDescriptor {
public String getDisplayName() {
return TRIGGER_NAME;
}

@Override
public void doHelp(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
rsp.getWriter().println(Messages.AbortedTrigger_HelpText());
}

@Override
public boolean getDefaultSendToDevs() {
Expand Down
@@ -0,0 +1,58 @@
/*
* To change this license header, choose License Headers in Project Properties.
* To change this template file, choose Tools | Templates
* and open the template in the editor.
*/

package hudson.plugins.emailext.plugins.trigger;

import hudson.Extension;
import hudson.model.AbstractBuild;
import hudson.model.TaskListener;
import hudson.plugins.emailext.plugins.EmailTrigger;
import hudson.plugins.emailext.plugins.EmailTriggerDescriptor;
import org.kohsuke.stapler.DataBoundConstructor;

/**
*
* @author acearl
*/
public class AlwaysTrigger extends EmailTrigger {

public static final String TRIGGER_NAME = "Always";

public static AlwaysTrigger createDefault() {
return new AlwaysTrigger(true, true, true, true, "", "$PROJECT_DEFAULT_REPLYTO", "$PROJECT_DEFAULT_SUBJECT", "$PROJECT_DEFAULT_CONTENT", "", 0, "project");
}

@DataBoundConstructor
public AlwaysTrigger(boolean sendToList, boolean sendToDevs, boolean sendToRequestor, boolean sendToCulprits, String recipientList,
String replyTo, String subject, String body, String attachmentsPattern, int attachBuildLog, String contentType) {
super(sendToList, sendToDevs, sendToRequestor, sendToCulprits, recipientList, replyTo, subject, body, attachmentsPattern, attachBuildLog, contentType);
}

@Override
public boolean trigger(AbstractBuild<?, ?> build, TaskListener listener) {
return true;
}

@Extension
public static final class DescriptorImpl extends EmailTriggerDescriptor {

@Override
public String getDisplayName() {
return TRIGGER_NAME;
}

@Override
public boolean getDefaultSendToDevs() {
return true;
}

@Override
public boolean getDefaultSendToList() {
return true;
}
}
}

Expand Up @@ -6,12 +6,7 @@
import hudson.model.TaskListener;
import hudson.plugins.emailext.plugins.EmailTrigger;
import hudson.plugins.emailext.plugins.EmailTriggerDescriptor;
import java.io.IOException;
import javax.servlet.ServletException;
import jenkins.model.Jenkins;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;

public class BuildingTrigger extends EmailTrigger {

Expand Down Expand Up @@ -46,11 +41,6 @@ public String getDisplayName() {
return TRIGGER_NAME;
}

@Override
public void doHelp(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
rsp.getWriter().println(Messages.BuildingTrigger_HelpText());
}

@Override
public boolean getDefaultSendToDevs() {
return true;
Expand Down
Expand Up @@ -7,13 +7,8 @@
import hudson.plugins.emailext.plugins.EmailTrigger;
import hudson.plugins.emailext.plugins.EmailTriggerDescriptor;

import java.io.IOException;
import javax.servlet.ServletException;
import jenkins.model.Jenkins;
import org.kohsuke.stapler.DataBoundConstructor;

import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;

public class FailureTrigger extends EmailTrigger {

Expand Down Expand Up @@ -42,11 +37,6 @@ public String getDisplayName() {
return TRIGGER_NAME;
}

@Override
public void doHelp(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
rsp.getWriter().println(Messages.FailureTrigger_HelpText());
}

@Override
public boolean getDefaultSendToDevs() {
return true;
Expand Down
@@ -1,13 +1,8 @@
package hudson.plugins.emailext.plugins.trigger;

import hudson.Extension;
import hudson.plugins.emailext.plugins.EmailTriggerDescriptor;

import java.io.IOException;
import javax.servlet.ServletException;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;

public class FirstFailureTrigger extends NthFailureTrigger {

Expand All @@ -26,12 +21,6 @@ public static final class DescriptorImpl extends NthFailureTrigger.DescriptorImp
public String getDisplayName() {
return TRIGGER_NAME;
}

@Override
public void doHelp(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
rsp.getWriter().println("An email will be sent when the build status changes from \"Success\" "
+ "to \"Failure\"");
}
}

/**
Expand Down
Expand Up @@ -7,12 +7,8 @@
import hudson.plugins.emailext.plugins.EmailTrigger;
import hudson.plugins.emailext.plugins.EmailTriggerDescriptor;

import java.io.IOException;
import javax.servlet.ServletException;
import org.kohsuke.stapler.DataBoundConstructor;

import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;

public class FixedTrigger extends EmailTrigger {

Expand Down Expand Up @@ -51,11 +47,6 @@ public String getDisplayName() {
return TRIGGER_NAME;
}

@Override
public void doHelp(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
rsp.getWriter().println(Messages.FixedTrigger_HelpText());
}

@Override
public boolean getDefaultSendToDevs() {
return true;
Expand Down
Expand Up @@ -7,13 +7,7 @@
import hudson.plugins.emailext.plugins.EmailTrigger;
import hudson.plugins.emailext.plugins.EmailTriggerDescriptor;

import java.io.IOException;

import javax.servlet.ServletException;

import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;

public class FixedUnhealthyTrigger extends EmailTrigger {

Expand Down Expand Up @@ -67,11 +61,6 @@ public String getDisplayName() {
return TRIGGER_NAME;
}

@Override
public void doHelp(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
rsp.getWriter().println(Messages.FixedTrigger_HelpText());
}

@Override
public boolean getDefaultSendToDevs() {
return true;
Expand Down
Expand Up @@ -6,13 +6,8 @@
import hudson.plugins.emailext.plugins.EmailTrigger;
import hudson.plugins.emailext.plugins.EmailTriggerDescriptor;

import java.io.IOException;
import javax.servlet.ServletException;
import org.kohsuke.stapler.DataBoundConstructor;

import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;

public class ImprovementTrigger extends EmailTrigger {

public static final String TRIGGER_NAME = "Improvement";
Expand Down Expand Up @@ -54,11 +49,6 @@ public DescriptorImpl() {
public String getDisplayName() {
return TRIGGER_NAME;
}

@Override
public void doHelp(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
rsp.getWriter().println(Messages.ImprovementTrigger_HelpText());
}

@Override
public boolean getDefaultSendToDevs() {
Expand Down
Expand Up @@ -7,13 +7,8 @@
import hudson.plugins.emailext.plugins.EmailTrigger;
import hudson.plugins.emailext.plugins.EmailTriggerDescriptor;

import java.io.IOException;
import javax.servlet.ServletException;
import org.kohsuke.stapler.DataBoundConstructor;

import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;

public class NotBuiltTrigger extends EmailTrigger {

public static final String TRIGGER_NAME = "Not Built";
Expand Down Expand Up @@ -42,11 +37,6 @@ public static final class DescriptorImpl extends EmailTriggerDescriptor {
public String getDisplayName() {
return TRIGGER_NAME;
}

@Override
public void doHelp(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
rsp.getWriter().println(Messages.NotBuiltTrigger_HelpText());
}

@Override
public boolean getDefaultSendToDevs() {
Expand Down
Expand Up @@ -3,14 +3,7 @@
import hudson.Extension;
import hudson.plugins.emailext.plugins.EmailTriggerDescriptor;


import java.io.IOException;

import javax.servlet.ServletException;

import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;

public class PreBuildScriptTrigger extends AbstractScriptTrigger {

Expand All @@ -34,10 +27,5 @@ public static final class DescriptorImpl extends EmailTriggerDescriptor {
public String getDisplayName() {
return TRIGGER_NAME;
}

@Override
public void doHelp(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
rsp.getWriter().println(Messages.PreBuildScriptTrigger_HelpText());
}
}
}

0 comments on commit d288c1e

Please sign in to comment.