Merge pull request #8 from ikedam/feature/JENKINS-20226_DataBoundCons…

…tructor [FIXED JENKINS-20226] Supports @DataBoundConstructor.
jenkinsci · Oct 29, 2013 · 9043e7a · 9043e7a · oleg-nenashev · Oct 29, 2013
2 parents e779665 + 93ad8a7
commit 9043e7a
Show file tree

Hide file tree

Showing 3 changed files with 69 additions and 22 deletions.
diff --git a/src/main/java/hudson/tasks/Mailer.java b/src/main/java/hudson/tasks/Mailer.java
@@ -40,12 +40,14 @@
 import hudson.tasks.i18n.Messages;
 import hudson.util.FormValidation;
 import hudson.util.Secret;
+import hudson.util.XStream2;
 
 import jenkins.model.JenkinsLocationConfiguration;
 import org.apache.commons.lang.StringUtils;
 import org.apache.tools.ant.types.selectors.SelectorUtils;
 import org.kohsuke.accmod.Restricted;
 import org.kohsuke.accmod.restrictions.NoExternalUse;
+import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.QueryParameter;
 import org.kohsuke.stapler.StaplerRequest;
 import org.kohsuke.stapler.export.Exported;
@@ -101,11 +103,35 @@ public class Mailer extends Notifier {
      */
     public boolean dontNotifyEveryUnstableBuild;
 
+    public boolean isNotifyEveryUnstableBuild() {
+        return !dontNotifyEveryUnstableBuild;
+    }
+
     /**
      * If true, individuals will receive e-mails regarding who broke the build.
      */
     public boolean sendToIndividuals;
 
+    /**
+     * Default Constructor.
+     * 
+     * This is left for backward compatibility.
+     */
+    @Deprecated
+    public Mailer() {}
+
+    /**
+     * @param recipients
+     * @param notifyEveryUnstableBuild inverted for historical reasons.
+     * @param sendToIndividuals
+     */
+    @DataBoundConstructor
+    public Mailer(String recipients, boolean notifyEveryUnstableBuild, boolean sendToIndividuals) {
+        this.recipients = recipients;
+        this.dontNotifyEveryUnstableBuild = !notifyEveryUnstableBuild;
+        this.sendToIndividuals = sendToIndividuals;
+    }
+
     @Override
     public boolean perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener) throws IOException, InterruptedException {
         if(debug)
@@ -185,6 +211,8 @@ public static final class DescriptorImpl extends BuildStepDescriptor<Publisher>
          * @deprecated as of 1.4
          *      Maintained in {@link JenkinsLocationConfiguration} but left here
          *      for compatibility just in case, so as not to lose this information.
+         *      This is loaded to {@link JenkinsLocationConfiguration} via the XML file
+         *      marshaled with {@link XStream2}.
          */
         private String hudsonUrl;
 
@@ -432,10 +460,8 @@ public void setSmtpAuth(String userName, String password) {
         }
 
         @Override
-        public Publisher newInstance(StaplerRequest req, JSONObject formData) {
-            Mailer m = new Mailer();
-            req.bindParameters(m,"mailer_");
-            m.dontNotifyEveryUnstableBuild = req.getParameter("mailer_notifyEveryUnstableBuild")==null;
+        public Publisher newInstance(StaplerRequest req, JSONObject formData) throws FormException {
+            Mailer m = (Mailer)super.newInstance(req, formData);
 
             if(hudsonUrl==null) {
                 // if Hudson URL is not configured yet, infer some default

diff --git a/src/main/resources/hudson/tasks/Mailer/config.jelly b/src/main/resources/hudson/tasks/Mailer/config.jelly
@@ -24,15 +24,13 @@ THE SOFTWARE.
 
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
-  <f:entry title="${%Recipients}" description="${%description}">
-    <f:textbox name="mailer_recipients" value="${instance.recipients}"/>
+  <f:entry field="recipients" title="${%Recipients}" description="${%description}">
+    <f:textbox />
   </f:entry>
-  <f:entry title="">
-    <f:checkbox name="mailer_notifyEveryUnstableBuild" checked="${h.defaultToTrue(!instance.dontNotifyEveryUnstableBuild)}"
-            title="${%Send e-mail for every unstable build}"/>
+  <f:entry field="notifyEveryUnstableBuild" title="">
+    <f:checkbox title="${%Send e-mail for every unstable build}" default="true" />
   </f:entry>
-  <f:entry title="" help="/help/tasks/mailer/sendToindividuals.html">
-    <f:checkbox name="mailer_sendToIndividuals" checked="${instance.sendToIndividuals}"
-        title="${%Send separate e-mails to individuals who broke the build}"/>
+  <f:entry field="sendToIndividuals" title="" help="/help/tasks/mailer/sendToindividuals.html">
+    <f:checkbox title="${%Send separate e-mails to individuals who broke the build}" />
   </f:entry>
 </j:jelly>
diff --git a/src/test/java/hudson/tasks/MailerTest.java b/src/test/java/hudson/tasks/MailerTest.java
@@ -34,6 +34,8 @@
 import javax.mail.Address;
 import javax.mail.internet.InternetAddress;
 
+import jenkins.model.JenkinsLocationConfiguration;
+
 import com.gargoylesoftware.htmlunit.html.HtmlPage;
 import com.gargoylesoftware.htmlunit.html.HtmlInput;
 
@@ -53,8 +55,7 @@ public void testSenderAddress() throws Exception {
         // create a project to simulate a build failure
         FreeStyleProject project = createFreeStyleProject();
         project.getBuildersList().add(new FailureBuilder());
-        Mailer m = new Mailer();
-        m.recipients = recipient;
+        Mailer m = new Mailer(recipient, false, false);
         project.getPublishersList().add(m);
 
         project.scheduleBuild2(0).get();
@@ -67,16 +68,10 @@ public void testSenderAddress() throws Exception {
 
     @Email("http://www.nabble.com/email-recipients-disappear-from-freestyle-job-config-on-save-to25479293.html")
     public void testConfigRoundtrip() throws Exception {
-        Mailer m = new Mailer();
-        m.recipients = "kk@kohsuke.org";
-        m.dontNotifyEveryUnstableBuild = true;
-        m.sendToIndividuals = true;
+        Mailer m = new Mailer("kk@kohsuke.org", false, true);
         verifyRoundtrip(m);
 
-        m = new Mailer();
-        m.recipients = "";
-        m.dontNotifyEveryUnstableBuild = false;
-        m.sendToIndividuals = false;
+        m = new Mailer("", true, false);
         verifyRoundtrip(m);
     }
 
@@ -117,4 +112,32 @@ public void testGlobalConfigRoundtrip() throws Exception {
         assertNull("expected null, got: " + d.getSmtpAuthUserName(), d.getSmtpAuthUserName());
         assertNull("expected null, got: " + d.getSmtpAuthPassword(), d.getSmtpAuthPassword());
     }
+
+    /**
+     * Simulates {@link JenkinsLocationConfiguration} is not configured.
+     */
+    private static class CleanJenkinsLocationConfiguration extends JenkinsLocationConfiguration {
+        @Override
+        public synchronized void load() {
+            getConfigFile().delete();
+            super.load();
+        }
+    };
+
+    /**
+     * Test {@link JenkinsLocationConfiguration} can load hudsonUrl.
+     */
+    public void testHudsonUrlCompatibility() throws Exception {
+        // not configured.
+        assertNull(new CleanJenkinsLocationConfiguration().getUrl());
+
+        Mailer m = new Mailer("", true, false);
+        FreeStyleProject p = createFreeStyleProject();
+        p.getPublishersList().add(m);
+        WebClient wc = new WebClient();
+        submit(wc.getPage(p,"configure").getFormByName("config"));
+
+        // configured via the marshaled XML file of Mailer
+        assertEquals(wc.getContextPath(), new CleanJenkinsLocationConfiguration().getUrl());
+    }
 }