-
Notifications
You must be signed in to change notification settings - Fork 42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Jenkins pipeline support in ircbot-plugin - an ircNotify() step #21
Merged
Merged
Changes from 6 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
82b410f
pom.xml : update git tag to HEAD like in instant-messaging-plugin
jimklimov 3206794
pom.xml : require at least JDK v8
jimklimov 369a79c
pom.xml : add workflow-step-api
jimklimov 8713e7a
Add IrcNotifyStep.java for basic pipeline step support
jimklimov afe83ea
IrcNotifyStep.java : Add a constructor with no args (to notify defaul…
jimklimov 6b10c77
Add support for pipeline step `ircNotify customMessage:"something"` a…
jimklimov 12be117
IrcNotifyStep.java : make targets an optional argument, so parameter-…
jimklimov 8acddc5
Copy IrcPublisher jelly configs for IrcNotifyStep too
jimklimov 4eca3a3
README.md : ircNofity in pipeline
jimklimov ad43503
pom.xml : CI builds: build against instant-messaging.plugin 1.36-SNAP…
jimklimov a02360a
IrcNotifyStep.java : use a fixed serialVersionUID
jimklimov 4852295
Merge remote-tracking branch 'upstream/master' into pipeline-support
jimklimov d345757
pom.xml : update instant-messaging-plugin reference to recent officia…
jimklimov 54f8dbf
IrcNotifyStep.java : fix checkstyle warnings (import order)
jimklimov 7b1fecf
IrcNotifyStep.java : fix package this is part of (copy-paste error fr…
jimklimov ab18341
IrcNotifyStep.java : use a fixed serialVersionUID in IrcNotifyStepExe…
jimklimov fda499b
IRCColorizer.java : fix javadoc-test complaints
jimklimov a4d0b58
IrcPublisher.java : fix javadoc-test complaints
jimklimov 5722a26
PircListener.java : fix javadoc-test complaints
jimklimov File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,230 @@ | ||
package hudson.plugins.jabber.im.steps; | ||
|
||
/* Snatched one-for-one from Jabber plugin implem by akomakom : | ||
* https://github.com/jenkinsci/jabber-plugin/pull/18/files#diff-c197962302397baf3a4cc36463dce5ea | ||
* and renamed some tokens for IRC plugin symbols. | ||
* Most of the implementation depends on the instmsg plugin changes in PR: | ||
* https://github.com/jenkinsci/instant-messaging-plugin/pull/16 | ||
*/ | ||
|
||
import com.google.common.collect.ImmutableSet; | ||
|
||
import hudson.Extension; | ||
import hudson.FilePath; | ||
import hudson.Launcher; | ||
import hudson.model.Run; | ||
import hudson.model.TaskListener; | ||
import hudson.plugins.im.IMMessageTarget; | ||
import hudson.plugins.im.IMConnection; | ||
import hudson.plugins.im.MatrixJobMultiplier; | ||
import hudson.plugins.im.NotificationStrategy; | ||
import hudson.plugins.im.build_notify.BuildToChatNotifier; | ||
import hudson.plugins.im.build_notify.DefaultBuildToChatNotifier; | ||
import hudson.plugins.ircbot.v2.IRCConnectionProvider; | ||
import hudson.plugins.ircbot.v2.IRCMessageTargetConverter; | ||
import hudson.plugins.ircbot.IrcPublisher; | ||
import hudson.util.ListBoxModel; | ||
|
||
import java.util.Arrays; | ||
import java.util.List; | ||
import java.util.Set; | ||
|
||
import javax.annotation.Nonnull; | ||
|
||
import org.apache.commons.lang.StringUtils; | ||
|
||
import org.jenkinsci.plugins.workflow.steps.Step; | ||
import org.jenkinsci.plugins.workflow.steps.StepContext; | ||
import org.jenkinsci.plugins.workflow.steps.StepDescriptor; | ||
import org.jenkinsci.plugins.workflow.steps.StepExecution; | ||
import org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution; | ||
|
||
import org.kohsuke.stapler.DataBoundConstructor; | ||
import org.kohsuke.stapler.DataBoundSetter; | ||
|
||
/** | ||
* Pipeline step | ||
*/ | ||
public class IrcNotifyStep extends Step { | ||
|
||
private final static char TARGET_SEPARATOR_CHAR = ' '; | ||
private final static IRCMessageTargetConverter CONVERTER = new IRCMessageTargetConverter(); | ||
|
||
private final String targets; | ||
private boolean notifySuspects; | ||
private boolean notifyCulprits; | ||
private boolean notifyFixers; | ||
private boolean notifyUpstreamCommitters; | ||
private String notificationStrategy = NotificationStrategy.ALL.getDisplayName(); | ||
private BuildToChatNotifier buildToChatNotifier = new DefaultBuildToChatNotifier(); | ||
private MatrixJobMultiplier matrixNotifier = MatrixJobMultiplier.ONLY_PARENT; | ||
|
||
// Instead of build status messages, send an arbitrary message to specified | ||
// or default (global config) targets with the pipeline step (and ignoring | ||
// the strategy and filtering rules options above) | ||
private String customMessage; | ||
|
||
@Override | ||
public StepExecution start(StepContext context) throws Exception { | ||
return new IrcNotifyStepExecution(this, context); | ||
} | ||
|
||
@DataBoundConstructor | ||
public IrcNotifyStep(String targets) { | ||
this.targets = targets; | ||
} | ||
|
||
public IrcNotifyStep() { | ||
this.targets = ""; // Notify all channels subscribed via global config | ||
} | ||
|
||
public String getTargets() { | ||
return targets; | ||
} | ||
|
||
public boolean isNotifySuspects() { | ||
return notifySuspects; | ||
} | ||
|
||
@DataBoundSetter | ||
public void setNotifySuspects(boolean notifySuspects) { | ||
this.notifySuspects = notifySuspects; | ||
} | ||
|
||
public boolean isNotifyCulprits() { | ||
return notifyCulprits; | ||
} | ||
|
||
@DataBoundSetter | ||
public void setNotifyCulprits(boolean notifyCulprits) { | ||
this.notifyCulprits = notifyCulprits; | ||
} | ||
|
||
public boolean isNotifyFixers() { | ||
return notifyFixers; | ||
} | ||
|
||
@DataBoundSetter | ||
public void setNotifyFixers(boolean notifyFixers) { | ||
this.notifyFixers = notifyFixers; | ||
} | ||
|
||
public boolean isNotifyUpstreamCommitters() { | ||
return notifyUpstreamCommitters; | ||
} | ||
|
||
@DataBoundSetter | ||
public void setNotifyUpstreamCommitters(boolean notifyUpstreamCommitters) { | ||
this.notifyUpstreamCommitters = notifyUpstreamCommitters; | ||
} | ||
|
||
public BuildToChatNotifier getBuildToChatNotifier() { | ||
return buildToChatNotifier; | ||
} | ||
|
||
@DataBoundSetter | ||
public void setBuildToChatNotifier(BuildToChatNotifier buildToChatNotifier) { | ||
this.buildToChatNotifier = buildToChatNotifier; | ||
} | ||
|
||
public MatrixJobMultiplier getMatrixNotifier() { | ||
return matrixNotifier; | ||
} | ||
|
||
@DataBoundSetter | ||
public void setMatrixNotifier(MatrixJobMultiplier matrixNotifier) { | ||
this.matrixNotifier = matrixNotifier; | ||
} | ||
|
||
public String getNotificationStrategy() { | ||
return notificationStrategy; | ||
} | ||
|
||
@DataBoundSetter | ||
public void setNotificationStrategy(String notificationStrategy) { | ||
this.notificationStrategy = notificationStrategy; | ||
} | ||
|
||
public String getCustomMessage() { | ||
return customMessage; | ||
} | ||
|
||
@DataBoundSetter | ||
public void setCustomMessage(String customMessage) { | ||
this.customMessage = customMessage; | ||
} | ||
|
||
private static class IrcNotifyStepExecution extends SynchronousNonBlockingStepExecution<Void> { | ||
private transient final IrcNotifyStep step; | ||
|
||
public IrcNotifyStepExecution(@Nonnull IrcNotifyStep step, @Nonnull StepContext context) { | ||
super(context); | ||
this.step = step; | ||
} | ||
|
||
@Override | ||
protected Void run() throws Exception { | ||
|
||
List<String> targets = Arrays.asList(StringUtils.split(step.targets, TARGET_SEPARATOR_CHAR)); | ||
|
||
// getContext().get(TaskListener.class).getLogger().println("IrcNotifyStep: sending message with strategy " + step.notificationStrategy); | ||
|
||
|
||
|
||
IrcPublisher publisher = new IrcPublisher( | ||
CONVERTER.allFromString(targets), | ||
step.notificationStrategy, | ||
false, | ||
step.notifySuspects, | ||
step.notifyCulprits, | ||
step.notifyFixers, | ||
step.notifyUpstreamCommitters, | ||
step.buildToChatNotifier, | ||
step.matrixNotifier | ||
); | ||
if (step.customMessage == null || step.customMessage.isEmpty()) { | ||
publisher.perform( | ||
getContext().get(Run.class), | ||
getContext().get(FilePath.class), | ||
getContext().get(Launcher.class), | ||
getContext().get(TaskListener.class)); | ||
} else { | ||
IMConnection imConnection = //publisher.getIMConnection(); | ||
IRCConnectionProvider.getInstance().currentConnection(); | ||
for (IMMessageTarget target : CONVERTER.allFromString(targets)) { | ||
imConnection.send(target, step.customMessage); | ||
} | ||
} | ||
|
||
return null; | ||
} | ||
} | ||
|
||
|
||
@Extension(optional=true) | ||
public static final class DescriptorImpl extends StepDescriptor { | ||
|
||
@Override | ||
public Set<? extends Class<?>> getRequiredContext() { | ||
return ImmutableSet.of(FilePath.class, Run.class, Launcher.class, TaskListener.class); | ||
} | ||
|
||
@Override | ||
public String getFunctionName() { | ||
return "ircNotify"; | ||
} | ||
|
||
@Override | ||
public String getDisplayName() { | ||
return "IRC Notification"; | ||
} | ||
|
||
public ListBoxModel doFillNotificationStrategyItems() { | ||
ListBoxModel items = new ListBoxModel(); | ||
for (NotificationStrategy strategy : NotificationStrategy.values()) { | ||
items.add(strategy.getDisplayName(), strategy.getDisplayName()); | ||
} | ||
return items; | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: As subsequent co-evolution of ircbot and instant-messaging plugins, maybe makes sense to evict this feature there, similarly to
extraMessage
done in @akomakom's branch.