[FIXED JENKINS-18436]

Fire the "jenkins:apply" event from the apply button and listen to that to write back edits to <TEXTAREA>
jenkinsci · Jun 20, 2013 · 2ffece9 · olivergondza · Jun 28, 2013 · ssogabe
1 parent aff73d4
commit 2ffece9
Show file tree

Hide file tree

Showing 6 changed files with 59 additions and 1 deletion.
diff --git a/changelog.html b/changelog.html
@@ -64,7 +64,9 @@
   <li class=bug>
     Fixed "Comparison method violates its general contract" error in BuildTrigger.execute
     (<a href="https://issues.jenkins-ci.org/browse/JENKINS-17247">issue 17247</a>)
-</ul>
+  <li class=bug>
+    Edited description wasn't reflected when pressing the "Apply" button.
+    (<a href="https://issues.jenkins-ci.org/browse/JENKINS-18436">issue 18436</a>) </ul>
 </div><!--=TRUNK-END=-->
 
 <!-- these changes are controlled by the release process. DO NOT MODIFY -->

diff --git a/core/src/main/resources/lib/form/apply.jelly b/core/src/main/resources/lib/form/apply.jelly
@@ -28,6 +28,10 @@ THE SOFTWARE.
   <s:documentation>
     "Apply" button that submits the form but without a page transition.
     See hudson.util.FormApply for the server-side code.
+
+    When this button is pressed, the FORM element fires the "jenkins:apply" event
+    that allows interested parties to write back whatever states back into the INPUT
+    elements.
   </s:documentation>
   <st:adjunct includes="lib.form.apply.apply"/>
   <input type="hidden" name="core:apply" value="" />

diff --git a/core/src/main/resources/lib/form/apply/apply.js b/core/src/main/resources/lib/form/apply/apply.js
@@ -54,6 +54,7 @@ Behaviour.specify("INPUT.apply-button", 'apply', 0, function (e) {
 
             f.target = target.id;
             f.elements['core:apply'].value = "true";
+            Event.fire(f,"jenkins:apply"); // give everyone a chance to write back to DOM
             try {
                 buildFormTree(f);
                 f.submit();

diff --git a/core/src/main/resources/lib/form/textarea/textarea.js b/core/src/main/resources/lib/form/textarea/textarea.js
@@ -13,6 +13,11 @@ Behaviour.specify("TEXTAREA.codemirror", 'textarea', 0, function(e) {
         var scroller = codemirror.getScrollerElement();
         scroller.setAttribute("style","border:1px solid black;");
         scroller.style.height = h+"px";
+
+        // the form needs to be populated before the "Apply" button
+        e.up('form').on("jenkins:apply",function() {
+            e.value = codemirror.getValue()
+        })
     });
 
 Behaviour.specify("DIV.textarea-preview-container", 'textarea', 100, function (e) {

diff --git a/test/src/test/groovy/lib/form/ApplyButtonTest.groovy b/test/src/test/groovy/lib/form/ApplyButtonTest.groovy
@@ -0,0 +1,35 @@
+package lib.form
+
+import org.junit.Rule
+import org.junit.Test
+import org.jvnet.hudson.test.Bug
+import org.jvnet.hudson.test.JenkinsRule
+
+/**
+ *
+ *
+ * @author Kohsuke Kawaguchi
+ */
+class ApplyButtonTest {
+    @Rule public JenkinsRule j = new JenkinsRule();
+
+    /**
+     * Editing code mirror should still gets reflected when you click apply.
+     */
+    @Test @Bug(18436)
+    public void editDescription() {
+        def p = j.createFreeStyleProject()
+        def b = j.assertBuildStatusSuccess(p.scheduleBuild2(0))
+
+        def config = j.createWebClient().getPage(b, "configure")
+        def form = config.getFormByName("config")
+        // HtmlUnit doesn't have JSON, so we need to emulate one
+        config.executeJavaScript(getClass().getResource("JSON.js").text)
+        // it's hard to emulate the keytyping, so we just set the value into codemirror and test if this gets
+        // reflected back into TEXTAREA
+        config.executeJavaScript("document.getElementsByTagName('TEXTAREA')[0].codemirrorObject.setLine(0,'foobar')")
+        j.getButtonByCaption(form,"Apply").click()
+
+        assert "foobar"==b.description
+    }
+}
diff --git a/test/src/test/resources/lib/form/JSON.js b/test/src/test/resources/lib/form/JSON.js
@@ -0,0 +1,11 @@
+// htmlunit doesn't have JSON, so emulate it
+if (typeof JSON=="undefined") {
+    var JSON = {
+        parse : function (str) {
+            return String.evalJSON(str);
+        },
+        stringify : function (obj) {
+            return Object.toJSON(obj);
+       }
+    };
+}