From 73fad75d046e9bbafff81ff3316f2b43063a140b Mon Sep 17 00:00:00 2001 From: mindless Date: Tue, 27 Jan 2009 18:43:20 +0000 Subject: [PATCH] [FIXED HUDSON-291] Add new ItemListener.onScheduled(Queue.Task) interface method and invoke this from Queue.add(). Hudson registers a listener to write what triggered each build into the console output. BuildableItem.scheduleBuild() now takes triggeredBy parameter, ParameterizedProjectTask stores triggeredBy value for scheduled tasks, and Trigger has scheduleBuild convenience methods to use its descriptor's displayName as the triggeredBy value. git-svn-id: https://hudson.dev.java.net/svn/hudson/trunk/hudson/main@14823 71c3de6d-444a-0410-be80-ed276b4c234a --- .../main/java/hudson/matrix/MatrixBuild.java | 2 +- .../hudson/matrix/MatrixConfiguration.java | 7 +- .../main/java/hudson/maven/MavenBuild.java | 2 +- .../hudson/maven/MavenModuleSetBuild.java | 4 +- .../java/hudson/model/AbstractProject.java | 75 ++++++++++++------- .../main/java/hudson/model/BuildableItem.java | 8 +- core/src/main/java/hudson/model/Hudson.java | 8 +- .../model/ParameterizedProjectTask.java | 35 ++++++--- .../model/ParametersDefinitionProperty.java | 14 +++- core/src/main/java/hudson/model/Queue.java | 8 +- .../hudson/model/listeners/ItemListener.java | 15 +++- .../main/java/hudson/tasks/BuildTrigger.java | 2 +- .../main/java/hudson/triggers/SCMTrigger.java | 2 +- .../java/hudson/triggers/TimerTrigger.java | 2 +- .../main/java/hudson/triggers/Trigger.java | 17 +++++ .../java/hudson/triggers/TriggerListener.java | 53 +++++++++++++ 16 files changed, 194 insertions(+), 60 deletions(-) create mode 100644 core/src/main/java/hudson/triggers/TriggerListener.java diff --git a/core/src/main/java/hudson/matrix/MatrixBuild.java b/core/src/main/java/hudson/matrix/MatrixBuild.java index 72388075a1..a207411d02 100644 --- a/core/src/main/java/hudson/matrix/MatrixBuild.java +++ b/core/src/main/java/hudson/matrix/MatrixBuild.java @@ -151,7 +151,7 @@ public class MatrixBuild extends AbstractBuild { if (parameters != null) { c.scheduleBuild(parameters); } else { - c.scheduleBuild(); + c.scheduleBuild("Matrix"); } } diff --git a/core/src/main/java/hudson/matrix/MatrixConfiguration.java b/core/src/main/java/hudson/matrix/MatrixConfiguration.java index b4856aa42a..7373b03409 100644 --- a/core/src/main/java/hudson/matrix/MatrixConfiguration.java +++ b/core/src/main/java/hudson/matrix/MatrixConfiguration.java @@ -259,9 +259,8 @@ public class MatrixConfiguration extends Project */ public static boolean useShortWorkspaceName = Boolean.getBoolean(MatrixConfiguration.class.getName()+".useShortWorkspaceName"); - public boolean scheduleBuild(ParametersAction parameters) { + public boolean scheduleBuild(ParametersAction parameters) { return Hudson.getInstance().getQueue().add( - new ParameterizedProjectTask(this, parameters.getParameters()), getQuietPeriod()); - } - + new ParameterizedProjectTask(this, parameters.getParameters(), "Matrix"), getQuietPeriod()); + } } diff --git a/core/src/main/java/hudson/maven/MavenBuild.java b/core/src/main/java/hudson/maven/MavenBuild.java index cbea863e11..5428490a63 100644 --- a/core/src/main/java/hudson/maven/MavenBuild.java +++ b/core/src/main/java/hudson/maven/MavenBuild.java @@ -554,7 +554,7 @@ public class MavenBuild extends AbstractBuild { if(trigger) { listener.getLogger().println(Messages.MavenBuild_Triggering(down.getName())); downstreams.add(down); - down.scheduleBuild(); + down.scheduleBuild("Maven"); } } } diff --git a/core/src/main/java/hudson/maven/MavenModuleSetBuild.java b/core/src/main/java/hudson/maven/MavenModuleSetBuild.java index 9198589b0d..1c13c2e80b 100644 --- a/core/src/main/java/hudson/maven/MavenModuleSetBuild.java +++ b/core/src/main/java/hudson/maven/MavenModuleSetBuild.java @@ -286,7 +286,7 @@ public final class MavenModuleSetBuild extends AbstractBuild,R extends A /** * Schedules a build of this project. * + * @param triggeredBy + * String describing how build was triggered. * @return * true if the project is actually added to the queue. * false if the queue contained it and therefore the add() * was noop */ - public boolean scheduleBuild() { - return scheduleBuild(getQuietPeriod()); + public boolean scheduleBuild(String triggeredBy) { + return scheduleBuild(getQuietPeriod(), triggeredBy); } - public boolean scheduleBuild(int quietPeriod) { + public boolean scheduleBuild(int quietPeriod, String triggeredBy) { if (isDisabled()) return false; - if (isParameterized()) - return Hudson.getInstance().getQueue().add( - new ParameterizedProjectTask(this, getDefaultParametersValues()), quietPeriod); - else - return Hudson.getInstance().getQueue().add(this, quietPeriod); + return Hudson.getInstance().getQueue().add( + new ParameterizedProjectTask(this, getDefaultParametersValues(), triggeredBy), + quietPeriod); + } + + /** + * @deprecated + * As of 1.279. Use {@link #scheduleBuild(String)} instead. + */ + @Deprecated + public boolean scheduleBuild() { + return scheduleBuild(getQuietPeriod(), null); + } + + /** + * @deprecated + * As of 1.279. Use {@link #scheduleBuild(int, String)} instead. + */ + @Deprecated + public boolean scheduleBuild(int quietPeriod) { + return scheduleBuild(quietPeriod, null); } private List getDefaultParametersValues() { ParametersDefinitionProperty paramDefProp = getProperty(ParametersDefinitionProperty.class); ArrayList defValues = new ArrayList(); - /* - * This check is made ONLY if someone will call this method even if isParametrized() is false. - */ + // In case isParameterized() is false. if(paramDefProp == null) return defValues; @@ -441,7 +457,7 @@ public abstract class AbstractProject

,R extends A * Schedules a build of this project, and returns a {@link Future} object * to wait for the completion of the build. */ - public Future scheduleBuild2(int quietPeriod) { + public Future scheduleBuild2(int quietPeriod, String triggeredBy) { R lastBuild = getLastBuild(); final int n; if(lastBuild!=null) n = lastBuild.getNumber(); @@ -460,11 +476,20 @@ public abstract class AbstractProject

,R extends A { r.register(); } }; - scheduleBuild(quietPeriod); + scheduleBuild(quietPeriod, triggeredBy); return f; } + /** + * @deprecated + * As of 1.279. Use {@link #scheduleBuild2(int, String)} instead. + */ + @Deprecated + public Future scheduleBuild2(int quietPeriod) { + return scheduleBuild2(quietPeriod, null); + } + /** * Schedules a polling of this project. */ @@ -962,22 +987,20 @@ public abstract class AbstractProject

,R extends A String delay = req.getParameter("delay"); if (delay!=null) { - if (!isDisabled()) { - try { - // TODO: more unit handling - if(delay.endsWith("sec")) delay=delay.substring(0,delay.length()-3); - if(delay.endsWith("secs")) delay=delay.substring(0,delay.length()-4); - Hudson.getInstance().getQueue().add(this, Integer.parseInt(delay)); - } catch (NumberFormatException e) { - throw new ServletException("Invalid delay parameter value: "+delay); - } - } - } else { - scheduleBuild(); + // TODO: more unit handling + if(delay.endsWith("sec")) delay=delay.substring(0,delay.length()-3); + if(delay.endsWith("secs")) delay=delay.substring(0,delay.length()-4); + } + try { + User user = User.current(); + scheduleBuild(delay != null ? Integer.parseInt(delay) : getQuietPeriod(), + "User " + (user != null ? user.getId() : "anonymous")); + } catch (NumberFormatException e) { + throw new ServletException("Invalid delay parameter value: "+delay); } rsp.forwardToPreviousPage(req); } - + /** * Supports build trigger with parameters via an HTTP GET or POST. * Currently only String parameters are supported. diff --git a/core/src/main/java/hudson/model/BuildableItem.java b/core/src/main/java/hudson/model/BuildableItem.java index e99c7eb2f1..055f7c9d4c 100644 --- a/core/src/main/java/hudson/model/BuildableItem.java +++ b/core/src/main/java/hudson/model/BuildableItem.java @@ -12,6 +12,10 @@ import hudson.model.Queue.Task; * @author Kohsuke Kawaguchi */ public interface BuildableItem extends Item, Task { - boolean scheduleBuild(); - boolean scheduleBuild(int quietPeriod); + boolean scheduleBuild(String triggeredBy); + boolean scheduleBuild(int quietPeriod, String triggeredBy); + /** @deprecated since 1.279 */ + @Deprecated boolean scheduleBuild(); + /** @deprecated since 1.279 */ + @Deprecated boolean scheduleBuild(int quietPeriod); } diff --git a/core/src/main/java/hudson/model/Hudson.java b/core/src/main/java/hudson/model/Hudson.java index 61e0296230..0c5bebe042 100644 --- a/core/src/main/java/hudson/model/Hudson.java +++ b/core/src/main/java/hudson/model/Hudson.java @@ -63,6 +63,7 @@ import hudson.tasks.Mailer; import hudson.tasks.Publisher; import hudson.triggers.Trigger; import hudson.triggers.TriggerDescriptor; +import hudson.triggers.TriggerListener; import hudson.triggers.Triggers; import hudson.util.CaseInsensitiveComparator; import hudson.util.ClockDifference; @@ -308,7 +309,7 @@ public final class Hudson extends AbstractModelObject implements ItemGroup itemListeners = new CopyOnWriteList(); @@ -485,6 +486,7 @@ public final class Hudson extends AbstractModelObject implements ItemGroup project; private final List parameters; + private final String triggeredBy; private static long COUNTER = System.currentTimeMillis(); @@ -27,28 +28,40 @@ public class ParameterizedProjectTask extends QueueTaskFilter { */ private final String key = Long.toString(COUNTER++); - public ParameterizedProjectTask(AbstractProject project, List parameters) { + public ParameterizedProjectTask(AbstractProject project, List parameters, String triggeredBy) { super(project); this.project = project; this.parameters = parameters; + this.triggeredBy = triggeredBy; } - + + /** @deprecated since 1.279 */ + @Deprecated + public ParameterizedProjectTask(AbstractProject project, List parameters) { + this(project, parameters, null); + } + public AbstractProject getProject() { - return project; - } + return project; + } - public List getParameters() { - return parameters; - } + public List getParameters() { + return parameters; + } - @Override + public String getTriggeredBy() { + return triggeredBy; + } + + @Override public Executable createExecutable() throws IOException { AbstractBuild build = project.createExecutable(); - build.addAction(new ParametersAction(parameters, build)); + if (project.isParameterized()) + build.addAction(new ParametersAction(parameters, build)); return build; } - + /** * Cancels a scheduled build. */ @@ -64,6 +77,7 @@ public class ParameterizedProjectTask extends QueueTaskFilter { public int hashCode() { final int prime = 31; int result = 1; + // triggeredBy is NOT included so different triggers won't schedule duplicate builds result = prime * result + ((parameters == null) ? 0 : parameters.hashCode()); result = prime * result + ((project == null) ? 0 : project.hashCode()); @@ -79,6 +93,7 @@ public class ParameterizedProjectTask extends QueueTaskFilter { if (getClass() != obj.getClass()) return false; ParameterizedProjectTask other = (ParameterizedProjectTask) obj; + // triggeredBy is NOT checked so different triggers won't schedule duplicate builds if (parameters == null) { if (other.parameters != null) return false; diff --git a/core/src/main/java/hudson/model/ParametersDefinitionProperty.java b/core/src/main/java/hudson/model/ParametersDefinitionProperty.java index bc42879e22..fe5ed4eb71 100644 --- a/core/src/main/java/hudson/model/ParametersDefinitionProperty.java +++ b/core/src/main/java/hudson/model/ParametersDefinitionProperty.java @@ -74,8 +74,7 @@ public class ParametersDefinitionProperty extends JobProperty parameters) { + User user = User.current(); + return Hudson.getInstance().getQueue().add( + new ParameterizedProjectTask(owner, parameters, + "User " + (user != null ? user.getId() : "anonymous")), + 0); + } + /** * Gets the {@link ParameterDefinition} of the given name, if any. */ diff --git a/core/src/main/java/hudson/model/Queue.java b/core/src/main/java/hudson/model/Queue.java index fa1ea1b5f0..fc336b73d9 100644 --- a/core/src/main/java/hudson/model/Queue.java +++ b/core/src/main/java/hudson/model/Queue.java @@ -4,6 +4,7 @@ import hudson.BulkChange; import hudson.Util; import hudson.XmlFile; import hudson.model.Node.Mode; +import hudson.model.listeners.ItemListener; import hudson.triggers.SafeTimerTask; import hudson.triggers.Trigger; import hudson.util.OneShotEvent; @@ -169,7 +170,7 @@ public class Queue extends ResourceController implements Saveable { while ((line = in.readLine()) != null) { AbstractProject j = Hudson.getInstance().getItemByFullName(line, AbstractProject.class); if (j != null) - j.scheduleBuild(); + j.scheduleBuild("Loading saved queue"); } in.close(); // discard the queue file now that we are done @@ -302,6 +303,11 @@ public class Queue extends ResourceController implements Saveable { } scheduleMaintenance(); // let an executor know that a new item is in the queue. + // let listeners know that a new item is in the queue. + for (ItemListener l : Hudson.getInstance().getJobListeners()) { + l.onScheduled(p); + } + return true; } diff --git a/core/src/main/java/hudson/model/listeners/ItemListener.java b/core/src/main/java/hudson/model/listeners/ItemListener.java index 4b3eded747..556b4047e0 100644 --- a/core/src/main/java/hudson/model/listeners/ItemListener.java +++ b/core/src/main/java/hudson/model/listeners/ItemListener.java @@ -3,7 +3,7 @@ package hudson.model.listeners; import hudson.ExtensionPoint; import hudson.model.Hudson; import hudson.model.Item; -import hudson.model.Job; +import hudson.model.Queue; /** * Receives notifications about CRUD operations of {@link Item}. @@ -19,8 +19,7 @@ public class ItemListener implements ExtensionPoint { } /** - * Called after all the jobs are loaded from disk into {@link Hudson} - * object. + * Called after all the jobs are loaded from disk into {@link Hudson} object. */ public void onLoaded() { } @@ -47,6 +46,16 @@ public class ItemListener implements ExtensionPoint { public void onRenamed(Item item, String oldName, String newName) { } + /** + * Called when a {@link Queue.Task} is scheduled in the queue. + * + * @param task + * The pending task. + * @since 1.279 + */ + public void onScheduled(Queue.Task task) { + } + /** * Registers this instance to Hudson and start getting notifications. */ diff --git a/core/src/main/java/hudson/tasks/BuildTrigger.java b/core/src/main/java/hudson/tasks/BuildTrigger.java index 9b7662bd8e..bb1af3d74b 100644 --- a/core/src/main/java/hudson/tasks/BuildTrigger.java +++ b/core/src/main/java/hudson/tasks/BuildTrigger.java @@ -141,7 +141,7 @@ public class BuildTrigger extends Publisher implements DependecyDeclarer, Matrix // this is not completely accurate, as a new build might be triggered // between these calls String name = p.getName()+" #"+p.getNextBuildNumber(); - if(p.scheduleBuild()) { + if(p.scheduleBuild("Upstream project " + build.getProject().getDisplayName())) { logger.println(Messages.BuildTrigger_Triggering(name)); } else { logger.println(Messages.BuildTrigger_InQueue(name)); diff --git a/core/src/main/java/hudson/triggers/SCMTrigger.java b/core/src/main/java/hudson/triggers/SCMTrigger.java index 814cec73d9..575c464a47 100644 --- a/core/src/main/java/hudson/triggers/SCMTrigger.java +++ b/core/src/main/java/hudson/triggers/SCMTrigger.java @@ -412,7 +412,7 @@ public class SCMTrigger extends Trigger { if(foundChanges) { String name = " #"+job.asProject().getNextBuildNumber(); - if(job.scheduleBuild()) { + if(scheduleBuild(job)) { LOGGER.info("SCM changes detected in "+ job.getName()+". Triggering "+name); } else { LOGGER.info("SCM changes detected in "+ job.getName()+". Job is already in the queue"); diff --git a/core/src/main/java/hudson/triggers/TimerTrigger.java b/core/src/main/java/hudson/triggers/TimerTrigger.java index 61fba873c8..f8bc6b6039 100644 --- a/core/src/main/java/hudson/triggers/TimerTrigger.java +++ b/core/src/main/java/hudson/triggers/TimerTrigger.java @@ -29,7 +29,7 @@ public class TimerTrigger extends Trigger { } public void run() { - job.scheduleBuild(0); + scheduleBuild(job, 0); } public TriggerDescriptor getDescriptor() { diff --git a/core/src/main/java/hudson/triggers/Trigger.java b/core/src/main/java/hudson/triggers/Trigger.java index 5595b255fa..34ebacae27 100644 --- a/core/src/main/java/hudson/triggers/Trigger.java +++ b/core/src/main/java/hudson/triggers/Trigger.java @@ -8,6 +8,7 @@ import hudson.slaves.ComputerRetentionWork; import hudson.model.AbstractProject; import hudson.model.Action; import hudson.model.Build; +import hudson.model.BuildableItem; import hudson.model.ComputerSet; import hudson.model.Describable; import hudson.model.FingerprintCleanupThread; @@ -228,4 +229,20 @@ public abstract class Trigger implements Describable> } }, 1000*10); } + + /** + * Schedule build for given item. + * @since 1.279 + */ + protected boolean scheduleBuild(BuildableItem job) { + return job.scheduleBuild(getDescriptor().getDisplayName()); + } + + /** + * Schedule build for given item. + * @since 1.279 + */ + protected boolean scheduleBuild(BuildableItem job, int quietPeriod) { + return job.scheduleBuild(quietPeriod, getDescriptor().getDisplayName()); + } } diff --git a/core/src/main/java/hudson/triggers/TriggerListener.java b/core/src/main/java/hudson/triggers/TriggerListener.java new file mode 100644 index 0000000000..2786ff2ced --- /dev/null +++ b/core/src/main/java/hudson/triggers/TriggerListener.java @@ -0,0 +1,53 @@ +package hudson.triggers; + +import hudson.model.Job; +import hudson.model.Queue.Task; +import hudson.model.ParameterizedProjectTask; +import hudson.model.Run; +import hudson.model.TaskListener; +import hudson.model.listeners.ItemListener; +import hudson.model.listeners.RunListener; + +import java.util.HashMap; + +/** + * Use ItemListener and RunListener interfaces to record how each build + * was triggered in the job console output. + * @author Alan Harder + */ +public class TriggerListener extends ItemListener { + + private HashMap triggerMap = new HashMap(); + + /** + * Listen for scheduled builds and remember how they were triggered, + * so that info can be recorded when build actually starts. + */ + @Override + public void onScheduled(Task task) { + if (task instanceof ParameterizedProjectTask) { + Job job = ((ParameterizedProjectTask)task).getProject(); + synchronized (this) { + if (!triggerMap.containsKey(job)) + triggerMap.put(job, ((ParameterizedProjectTask)task).getTriggeredBy()); + } + } + } + + @Override + public void register() { + super.register(); + new RunListener(Run.class) { + @Override + public void onStarted(Run r, TaskListener listener) { + String triggeredBy; + synchronized (TriggerListener.this) { + triggeredBy = triggerMap.remove(r.getParent()); + } + if (triggeredBy != null) { + listener.getLogger().println("Build triggered by " + triggeredBy); + } + } + }.register(); + } +}