From 4fe1df86864a328e12e69b5426020fe3ff108ec5 Mon Sep 17 00:00:00 2001 From: Kohsuke Kawaguchi Date: Fri, 1 Apr 2011 09:51:52 -0700 Subject: [PATCH 1/3] Node now supports ReconfigurableDescribable --- core/src/main/java/hudson/model/Computer.java | 2 +- core/src/main/java/hudson/model/Node.java | 9 ++++++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/core/src/main/java/hudson/model/Computer.java b/core/src/main/java/hudson/model/Computer.java index e37f696f3e..59bf7f476f 100644 --- a/core/src/main/java/hudson/model/Computer.java +++ b/core/src/main/java/hudson/model/Computer.java @@ -1029,7 +1029,7 @@ public /*transient*/ abstract class Computer extends Actionable implements Acces final Hudson app = Hudson.getInstance(); - Node result = getNode().getDescriptor().newInstance(req, req.getSubmittedForm()); + Node result = getNode().reconfigure(req, req.getSubmittedForm()); // replace the old Node object by the new one synchronized (app) { diff --git a/core/src/main/java/hudson/model/Node.java b/core/src/main/java/hudson/model/Node.java index a0546893f8..c79d336907 100644 --- a/core/src/main/java/hudson/model/Node.java +++ b/core/src/main/java/hudson/model/Node.java @@ -30,6 +30,7 @@ import hudson.ExtensionPoint; import hudson.FilePath; import hudson.FileSystemProvisioner; import hudson.Launcher; +import hudson.model.Descriptor.FormException; import hudson.model.Queue.Task; import hudson.model.labels.LabelAtom; import hudson.model.queue.CauseOfBlockage; @@ -56,7 +57,9 @@ import java.util.Set; import java.util.List; import java.util.logging.Logger; +import net.sf.json.JSONObject; import org.kohsuke.stapler.Stapler; +import org.kohsuke.stapler.StaplerRequest; import org.kohsuke.stapler.export.ExportedBean; import org.kohsuke.stapler.export.Exported; @@ -71,7 +74,7 @@ import org.kohsuke.stapler.export.Exported; * @see NodeDescriptor */ @ExportedBean -public abstract class Node extends AbstractModelObject implements Describable, ExtensionPoint, AccessControlled { +public abstract class Node extends AbstractModelObject implements ReconfigurableDescribable, ExtensionPoint, AccessControlled { private static final Logger LOGGER = Logger.getLogger(Node.class.getName()); @@ -362,6 +365,10 @@ public abstract class Node extends AbstractModelObject implements Describable Date: Fri, 1 Apr 2011 14:22:41 -0700 Subject: [PATCH 2/3] added a convenience method --- .../java/org/jvnet/hudson/test/HudsonTestCase.java | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/test/src/main/java/org/jvnet/hudson/test/HudsonTestCase.java b/test/src/main/java/org/jvnet/hudson/test/HudsonTestCase.java index 338b647ef0..0e540ec85e 100644 --- a/test/src/main/java/org/jvnet/hudson/test/HudsonTestCase.java +++ b/test/src/main/java/org/jvnet/hudson/test/HudsonTestCase.java @@ -846,6 +846,16 @@ public abstract class HudsonTestCase extends TestCase implements RootAction { return (C)computerConnectorTester.connector; } + protected User configRoundtrip(User u) throws Exception { + submit(createWebClient().goTo(u.getUrl()+"/configure").getFormByName("config")); + return u; + } + + protected N configRoundtrip(N node) throws Exception { + submit(createWebClient().goTo("/computer/"+node.getNodeName()+"/configure").getFormByName("config")); + return (N)hudson.getNode(node.getNodeName()); + } + protected V configRoundtrip(V view) throws Exception { submit(createWebClient().getPage(view, "configure").getFormByName("viewConfig")); return view; From ad343a68075e64ee91bf66d84a8dea727f60bf84 Mon Sep 17 00:00:00 2001 From: Kohsuke Kawaguchi Date: Fri, 1 Apr 2011 14:25:46 -0700 Subject: [PATCH 3/3] added a mechanism for creating invisible node properties --- core/pom.xml | 2 +- core/src/main/java/hudson/model/Node.java | 30 ++++++- .../main/java/hudson/slaves/NodeProperty.java | 10 ++- .../java/hudson/slaves/NodePropertyTest.java | 81 +++++++++++++++++++ .../PropertyImpl/config.jelly | 5 ++ 5 files changed, 124 insertions(+), 4 deletions(-) create mode 100644 test/src/test/java/hudson/slaves/NodePropertyTest.java create mode 100644 test/src/test/resources/hudson/slaves/NodePropertyTest/PropertyImpl/config.jelly diff --git a/core/pom.xml b/core/pom.xml index 7159ba984c..53e0d2bbcd 100644 --- a/core/pom.xml +++ b/core/pom.xml @@ -382,7 +382,7 @@ THE SOFTWARE. org.kohsuke.stapler stapler-jelly - 1.155 + 1.161 commons-jelly diff --git a/core/src/main/java/hudson/model/Node.java b/core/src/main/java/hudson/model/Node.java index c79d336907..4d75381c96 100644 --- a/core/src/main/java/hudson/model/Node.java +++ b/core/src/main/java/hudson/model/Node.java @@ -51,6 +51,7 @@ import hudson.util.TagCloud; import hudson.util.TagCloud.WeightFunction; import java.io.IOException; +import java.lang.reflect.Type; import java.util.Collections; import java.util.HashSet; import java.util.Set; @@ -58,6 +59,7 @@ import java.util.List; import java.util.logging.Logger; import net.sf.json.JSONObject; +import org.kohsuke.stapler.BindInterceptor; import org.kohsuke.stapler.Stapler; import org.kohsuke.stapler.StaplerRequest; import org.kohsuke.stapler.export.ExportedBean; @@ -365,8 +367,32 @@ public abstract class Node extends AbstractModelObject implements Reconfigurable return getACL().hasPermission(permission); } - public Node reconfigure(StaplerRequest req, JSONObject form) throws FormException { - return form==null ? null : getDescriptor().newInstance(req, form); + public Node reconfigure(final StaplerRequest req, JSONObject form) throws FormException { + if (form==null) return null; + + final JSONObject jsonForProperties = form.optJSONObject("nodeProperties"); + BindInterceptor old = req.setBindListener(new BindInterceptor() { + @Override + public Object onConvert(Type targetType, Class targetTypeErasure, Object jsonSource) { + if (jsonForProperties!=jsonSource) return DEFAULT; + + try { + DescribableList, NodePropertyDescriptor> tmp = new DescribableList, NodePropertyDescriptor>(Saveable.NOOP,getNodeProperties().toList()); + tmp.rebuild(req, jsonForProperties, NodeProperty.all()); + return tmp.toList(); + } catch (FormException e) { + throw new IllegalArgumentException(e); + } catch (IOException e) { + throw new IllegalArgumentException(e); + } + } + }); + + try { + return getDescriptor().newInstance(req, form); + } finally { + req.setBindListener(old); + } } public abstract NodeDescriptor getDescriptor(); diff --git a/core/src/main/java/hudson/slaves/NodeProperty.java b/core/src/main/java/hudson/slaves/NodeProperty.java index 1319238887..59322ea832 100644 --- a/core/src/main/java/hudson/slaves/NodeProperty.java +++ b/core/src/main/java/hudson/slaves/NodeProperty.java @@ -26,6 +26,8 @@ package hudson.slaves; import hudson.ExtensionPoint; import hudson.Launcher; import hudson.DescriptorExtensionList; +import hudson.model.Descriptor.FormException; +import hudson.model.ReconfigurableDescribable; import hudson.model.queue.CauseOfBlockage; import hudson.scm.SCM; import hudson.model.AbstractBuild; @@ -35,6 +37,8 @@ import hudson.model.Environment; import hudson.model.Hudson; import hudson.model.Node; import hudson.model.Queue.Task; +import net.sf.json.JSONObject; +import org.kohsuke.stapler.StaplerRequest; import java.io.IOException; import java.util.List; @@ -63,7 +67,7 @@ import java.util.List; * * @since 1.286 */ -public abstract class NodeProperty implements Describable>, ExtensionPoint { +public abstract class NodeProperty implements ReconfigurableDescribable>, ExtensionPoint { protected transient N node; @@ -109,6 +113,10 @@ public abstract class NodeProperty implements Describable reconfigure(StaplerRequest req, JSONObject form) throws FormException { + return form==null ? null : getDescriptor().newInstance(req, form); + } + /** * Lists up all the registered {@link NodeDescriptor}s in the system. */ diff --git a/test/src/test/java/hudson/slaves/NodePropertyTest.java b/test/src/test/java/hudson/slaves/NodePropertyTest.java new file mode 100644 index 0000000000..b8be591998 --- /dev/null +++ b/test/src/test/java/hudson/slaves/NodePropertyTest.java @@ -0,0 +1,81 @@ +package hudson.slaves; + +import com.gargoylesoftware.htmlunit.html.HtmlForm; +import com.gargoylesoftware.htmlunit.html.HtmlLabel; +import hudson.model.Descriptor.FormException; +import hudson.model.Slave; +import net.sf.json.JSONObject; +import org.jvnet.hudson.test.HudsonTestCase; +import org.jvnet.hudson.test.TestExtension; +import org.kohsuke.stapler.DataBoundConstructor; +import org.kohsuke.stapler.StaplerRequest; + +/** + * @author Kohsuke Kawaguchi + */ +public class NodePropertyTest extends HudsonTestCase { + public void testInvisibleProperty() throws Exception { + DumbSlave s = createSlave(); + InvisibleProperty before = new InvisibleProperty(); + s.getNodeProperties().add(before); + assertFalse(before.reconfigured); + + + DumbSlave s2 = configRoundtrip(s); + assertNotSame(s,s2); + InvisibleProperty after = s2.getNodeProperties().get(InvisibleProperty.class); + + assertSame(before,after); + assertTrue(after.reconfigured); + } + + public static class InvisibleProperty extends NodeProperty { + boolean reconfigured = false; + @Override + public NodeProperty reconfigure(StaplerRequest req, JSONObject form) throws FormException { + reconfigured = true; + return this; + } + + @TestExtension + public static class DescriptorImpl extends NodePropertyDescriptor { + @Override + public String getDisplayName() { + return null; + } + } + } + + public void testBasicConfigRoundtrip() throws Exception { + DumbSlave s = createSlave(); + HtmlForm f = createWebClient().goTo("/computer/" + s.getNodeName() + "/configure").getFormByName("config"); + ((HtmlLabel)f.selectSingleNode(".//LABEL[text()='Some Property']")).click(); + submit(f); + PropertyImpl p = hudson.getNode(s.getNodeName()).getNodeProperties().get(PropertyImpl.class); + assertEquals("Duke",p.name); + + p.name = "Kohsuke"; + configRoundtrip(s); + + PropertyImpl p2 = hudson.getNode(s.getNodeName()).getNodeProperties().get(PropertyImpl.class); + assertNotSame(p,p2); + assertEqualDataBoundBeans(p,p2); + } + + public static class PropertyImpl extends NodeProperty { + public String name; + + @DataBoundConstructor + public PropertyImpl(String name) { + this.name = name; + } + + @TestExtension("testBasicConfigRoundtrip") + public static class DescriptorImpl extends NodePropertyDescriptor { + @Override + public String getDisplayName() { + return "Some Property"; + } + } + } +} diff --git a/test/src/test/resources/hudson/slaves/NodePropertyTest/PropertyImpl/config.jelly b/test/src/test/resources/hudson/slaves/NodePropertyTest/PropertyImpl/config.jelly new file mode 100644 index 0000000000..4bcbab93c4 --- /dev/null +++ b/test/src/test/resources/hudson/slaves/NodePropertyTest/PropertyImpl/config.jelly @@ -0,0 +1,5 @@ + + + + +