Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #13 from ninian/master
JENKINS-7824: Add 'assigned by' field and optional emails
- Loading branch information
Showing
19 changed files
with
419 additions
and
28 deletions.
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
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,61 @@ | ||
| package hudson.plugins.claim; | ||
|
|
||
| import hudson.Extension; | ||
| import jenkins.model.GlobalConfiguration; | ||
| import net.sf.json.JSONObject; | ||
|
|
||
| import org.kohsuke.stapler.StaplerRequest; | ||
|
|
||
| @Extension | ||
| public class ClaimConfig extends GlobalConfiguration { | ||
|
|
||
| public ClaimConfig() { | ||
| load(); | ||
| } | ||
|
|
||
| /** | ||
| * Whether we want to send emails to the assignee when items are claimed/assigned | ||
| */ | ||
| private boolean sendEmails; | ||
|
|
||
|
|
||
| /** | ||
| * This human readable name is used in the configuration screen. | ||
| */ | ||
| public String getDisplayName() { | ||
| return "Claim"; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean configure(StaplerRequest req, JSONObject formData) throws FormException { | ||
| // To persist global configuration information, | ||
| // set that to properties and call save(). | ||
| sendEmails = formData.getBoolean("sendEmails"); | ||
| save(); | ||
| return super.configure(req,formData); | ||
| } | ||
|
|
||
| /** | ||
| * This method returns true if the global configuration says we should send mails on build claims | ||
| * @return true if configuration is that we send emails for claims, false otherwise | ||
| */ | ||
| public boolean getSendEmails() { | ||
| return sendEmails; | ||
| } | ||
|
|
||
| /** | ||
| * Set whether we should send emails | ||
| * @param val the setting to use | ||
| */ | ||
| public void setSendEmails(boolean val) { | ||
| sendEmails = val; | ||
| } | ||
|
|
||
| /** | ||
| * get the current claim configuration | ||
| * @return the global claim configuration | ||
| */ | ||
| public static ClaimConfig get() { | ||
| return GlobalConfiguration.all().get(ClaimConfig.class); | ||
| } | ||
| } |
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,124 @@ | ||
| package hudson.plugins.claim; | ||
|
|
||
| import hudson.model.User; | ||
| import hudson.tasks.Mailer; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.UnsupportedEncodingException; | ||
| import java.util.Date; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
|
|
||
| import javax.mail.Address; | ||
| import javax.mail.Message.RecipientType; | ||
| import javax.mail.MessagingException; | ||
| import javax.mail.Transport; | ||
| import javax.mail.internet.AddressException; | ||
| import javax.mail.internet.InternetAddress; | ||
| import javax.mail.internet.MimeMessage; | ||
|
|
||
| import jenkins.model.JenkinsLocationConfiguration; | ||
| /** | ||
| * Email utility class to allow sending of emails using the setup of the mailer plug-in to do so. | ||
| * If the mailer plug-in is not installed, then no emails are sent | ||
| * | ||
| * | ||
| */ | ||
| public class ClaimEmailer { | ||
|
|
||
| private static final Logger LOGGER = Logger.getLogger("claim-plugin"); | ||
|
|
||
| private static final boolean mailerLoaded = isMailerLoaded(); | ||
|
|
||
| private static boolean isMailerLoaded () { | ||
| boolean ret = true; | ||
| try { | ||
| new Mailer.DescriptorImpl(); | ||
| } catch (Throwable e) { | ||
| LOGGER.warning("Mailer plugin is not installed. Mailer plugin must be installed if you want to send emails"); | ||
| ret = false; | ||
| } | ||
| return ret; | ||
| } | ||
|
|
||
| /** | ||
| * Send an email to the assignee indicating that the given build has been assigned | ||
| * @param assignee the user assigned the failed build | ||
| * @param assignedBy the user assigning the build | ||
| * @param build the build/action which has been assigned | ||
| * @param reason the reason given for the assignment | ||
| * @param URL the URL the user can view for the assigned build | ||
| * @throws MessagingException if there has been some problem with sending the email | ||
| * @throws IOException if there is an IO problem when sending the mail | ||
| * @throws InterruptedException if the send operation is interrupted | ||
| */ | ||
| public static void sendEmailIfConfigured (User assignee, String assignedBy, String build, String reason, String URL) throws MessagingException, IOException, InterruptedException { | ||
|
|
||
| ClaimConfig config = ClaimConfig.get(); | ||
| if (config.getSendEmails() && mailerLoaded) { | ||
| MimeMessage msg = createMessage(assignee, assignedBy, build, reason, URL); | ||
| Transport.send(msg); | ||
| } | ||
| } | ||
|
|
||
| private static MimeMessage createMessage(User assignee, String assignedBy, String build, String reason, String URL) | ||
| throws MessagingException, IOException, InterruptedException { | ||
| MimeMessage msg = null; | ||
| // create Session | ||
| final Mailer.DescriptorImpl mailDescriptor = new Mailer.DescriptorImpl(); | ||
| msg = createMimeMessage(mailDescriptor); | ||
|
|
||
| msg.setSentDate(new Date()); | ||
| msg.setSubject(Messages.ClaimEmailer_Subject(build),mailDescriptor.getCharset()); | ||
| //TODO configurable formatting, through email-ext plugin | ||
| final String text = Messages.ClaimEmailer_Text(build, assignedBy) + | ||
| System.getProperty("line.separator") + Messages.ClaimEmailer_Reason(reason) + | ||
| System.getProperty("line.separator") + System.getProperty("line.separator") + | ||
| Messages.ClaimEmailer_Details(JenkinsLocationConfiguration.get().getUrl() + URL); | ||
|
|
||
| msg.setText(text, mailDescriptor.getCharset()); | ||
| msg.setRecipient(RecipientType.TO, getUserEmail(assignee,mailDescriptor)); | ||
|
|
||
| return msg; | ||
| } | ||
|
|
||
| /** | ||
| * Creates MimeMessage using the mailer plugin for jenkins. | ||
| * | ||
| * @param mailDescriptor a reference to the mailer plugin from which we can get mailing parameters | ||
| * @return mimemessage a message which can be emailed | ||
| * @throws MessagingException | ||
| * @throws UnsupportedEncodingException | ||
| * @throws AddressException | ||
| * | ||
| */ | ||
| private static MimeMessage createMimeMessage(final Mailer.DescriptorImpl mailDescriptor) throws AddressException, UnsupportedEncodingException, MessagingException { | ||
| MimeMessage ret = new MimeMessage(mailDescriptor.createSession()); | ||
| ret.setFrom(Mailer.StringToAddress(JenkinsLocationConfiguration.get().getAdminAddress(), mailDescriptor.getCharset())); | ||
| return ret; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the email address of a given user. | ||
| * | ||
| * @param user the user | ||
| * @param mailDescriptor the descriptor allowing us to access mail config | ||
| * @return email address for this user, null if none can be derived | ||
| */ | ||
| private static Address getUserEmail(User user, Mailer.DescriptorImpl mailDescriptor) { | ||
| if (user != null) { | ||
| try { | ||
| final Mailer.UserProperty mailProperty = user | ||
| .getProperty(Mailer.UserProperty.class); | ||
| if (mailProperty != null && mailProperty.getAddress() != null) { | ||
| return new InternetAddress(mailProperty.getAddress()); | ||
| } | ||
| return new InternetAddress(user.getId() + mailDescriptor.getDefaultSuffix()); | ||
| } catch (AddressException e) { | ||
| LOGGER.log(Level.WARNING, "Cannot get email address for user " + user.getId(), e); | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| } |
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
Oops, something went wrong.