[FIXED JENKINS-10006] Parameterized publishing

jenkinsci · Jul 8, 2011 · b1c16d5 · b1c16d5
1 parent ac9f8a2
commit b1c16d5
Show file tree

Hide file tree

Showing 21 changed files with 446 additions and 15 deletions.
diff --git a/src/main/java/jenkins/plugins/publish_over_ftp/BapFtpParamPublish.java b/src/main/java/jenkins/plugins/publish_over_ftp/BapFtpParamPublish.java
@@ -0,0 +1,74 @@
+/*
+ * The MIT License
+ *
+ * Copyright (C) 2010-2011 by Anthony Robinson
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package jenkins.plugins.publish_over_ftp;
+
+import hudson.Extension;
+import hudson.model.Describable;
+import hudson.model.Descriptor;
+import hudson.model.Hudson;
+import jenkins.plugins.publish_over.ParamPublish;
+import org.apache.commons.lang.builder.EqualsBuilder;
+import org.apache.commons.lang.builder.HashCodeBuilder;
+import org.apache.commons.lang.builder.ToStringBuilder;
+import org.apache.commons.lang.builder.ToStringStyle;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+public class BapFtpParamPublish extends ParamPublish implements Describable<BapFtpParamPublish> {
+
+    @DataBoundConstructor
+    public BapFtpParamPublish(final String parameterName) {
+        super(parameterName);
+    }
+
+    public BapFtpParamPublishDescriptor getDescriptor() {
+        return Hudson.getInstance().getDescriptorByType(BapFtpParamPublishDescriptor.class);
+    }
+
+    public boolean equals(final Object that) {
+        if (this == that) return true;
+        if (that == null || getClass() != that.getClass()) return false;
+
+        return addToEquals(new EqualsBuilder(), (BapFtpParamPublish) that).isEquals();
+    }
+
+    public int hashCode() {
+        return addToHashCode(new HashCodeBuilder()).toHashCode();
+    }
+
+    public String toString() {
+        return addToToString(new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE)).toString();
+    }
+
+    @Extension
+    public static class BapFtpParamPublishDescriptor extends Descriptor<BapFtpParamPublish> {
+
+        @Override
+        public String getDisplayName() {
+            return Messages.paramPublish_descriptor_displayName();
+        }
+
+    }
+
+}
diff --git a/src/main/java/jenkins/plugins/publish_over_ftp/BapFtpPromotionPublisherPlugin.java b/src/main/java/jenkins/plugins/publish_over_ftp/BapFtpPromotionPublisherPlugin.java
@@ -51,8 +51,10 @@ public class BapFtpPromotionPublisherPlugin extends Notifier {
 
     @DataBoundConstructor
     public BapFtpPromotionPublisherPlugin(final ArrayList<BapFtpPublisher> publishers, final boolean continueOnError,
-                                          final boolean failOnError, final boolean alwaysPublishFromMaster, final String masterNodeName) {
-        this.delegate = new BapFtpPublisherPlugin(publishers, continueOnError, failOnError, alwaysPublishFromMaster, masterNodeName);
+                                          final boolean failOnError, final boolean alwaysPublishFromMaster, final String masterNodeName,
+                                          final BapFtpParamPublish paramPublish) {
+        this.delegate = new BapFtpPublisherPlugin(publishers, continueOnError, failOnError, alwaysPublishFromMaster, masterNodeName,
+                                                  paramPublish);
     }
 
     public BapFtpPublisherPlugin getDelegate() {

diff --git a/src/main/java/jenkins/plugins/publish_over_ftp/BapFtpPublisher.java b/src/main/java/jenkins/plugins/publish_over_ftp/BapFtpPublisher.java
@@ -46,14 +46,19 @@ public class BapFtpPublisher extends BapPublisher<BapFtpTransfer> implements Des
 
     @DataBoundConstructor
     public BapFtpPublisher(final String configName, final boolean verbose, final ArrayList<BapFtpTransfer> transfers,
-                           final boolean useWorkspaceInPromotion, final boolean usePromotionTimestamp, final BapFtpRetry retry) {
-        super(configName, verbose, transfers, useWorkspaceInPromotion, usePromotionTimestamp, retry);
+                           final boolean useWorkspaceInPromotion, final boolean usePromotionTimestamp, final BapFtpRetry retry,
+                           final BapFtpPublisherLabel label) {
+        super(configName, verbose, transfers, useWorkspaceInPromotion, usePromotionTimestamp, retry, label);
     }
 
     public BapFtpRetry getRetry() {
         return (BapFtpRetry) super.getRetry();
     }
 
+    public BapFtpPublisherLabel getLabel() {
+        return (BapFtpPublisherLabel) super.getLabel();
+    }
+
     public BapFtpPublisherDescriptor getDescriptor() {
         return Hudson.getInstance().getDescriptorByType(BapFtpPublisherDescriptor.class);
     }

diff --git a/src/main/java/jenkins/plugins/publish_over_ftp/BapFtpPublisherLabel.java b/src/main/java/jenkins/plugins/publish_over_ftp/BapFtpPublisherLabel.java
@@ -0,0 +1,74 @@
+/*
+ * The MIT License
+ *
+ * Copyright (C) 2010-2011 by Anthony Robinson
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package jenkins.plugins.publish_over_ftp;
+
+import hudson.Extension;
+import hudson.model.Describable;
+import hudson.model.Descriptor;
+import hudson.model.Hudson;
+import jenkins.plugins.publish_over.PublisherLabel;
+import org.apache.commons.lang.builder.EqualsBuilder;
+import org.apache.commons.lang.builder.HashCodeBuilder;
+import org.apache.commons.lang.builder.ToStringBuilder;
+import org.apache.commons.lang.builder.ToStringStyle;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+public class BapFtpPublisherLabel extends PublisherLabel implements Describable<BapFtpPublisherLabel> {
+
+    @DataBoundConstructor
+    public BapFtpPublisherLabel(final String label) {
+        super(label);
+    }
+
+    public BapFtpPublisherLabelDescriptor getDescriptor() {
+        return Hudson.getInstance().getDescriptorByType(BapFtpPublisherLabelDescriptor.class);
+    }
+
+    public boolean equals(final Object that) {
+        if (this == that) return true;
+        if (that == null || getClass() != that.getClass()) return false;
+
+        return addToEquals(new EqualsBuilder(), (BapFtpPublisherLabel) that).isEquals();
+    }
+
+    public int hashCode() {
+        return addToHashCode(new HashCodeBuilder()).toHashCode();
+    }
+
+    public String toString() {
+        return addToToString(new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE)).toString();
+    }
+
+    @Extension
+    public static class BapFtpPublisherLabelDescriptor extends Descriptor<BapFtpPublisherLabel> {
+
+        @Override
+        public String getDisplayName() {
+            return Messages.publisherLabel_descriptor_displayName();
+        }
+
+    }
+
+}
diff --git a/src/main/java/jenkins/plugins/publish_over_ftp/BapFtpPublisherPlugin.java b/src/main/java/jenkins/plugins/publish_over_ftp/BapFtpPublisherPlugin.java
@@ -44,8 +44,14 @@ public class BapFtpPublisherPlugin extends BPPlugin<BapFtpPublisher, BapFtpClien
 
     @DataBoundConstructor
     public BapFtpPublisherPlugin(final ArrayList<BapFtpPublisher> publishers, final boolean continueOnError, final boolean failOnError,
-                                 final boolean alwaysPublishFromMaster, final String masterNodeName) {
-        super(Messages.console_message_prefix(), publishers, continueOnError, failOnError, alwaysPublishFromMaster, masterNodeName);
+                                 final boolean alwaysPublishFromMaster, final String masterNodeName,
+                                 final BapFtpParamPublish paramPublish) {
+        super(Messages.console_message_prefix(), publishers, continueOnError, failOnError, alwaysPublishFromMaster, masterNodeName,
+                paramPublish);
+    }
+
+    public BapFtpParamPublish getParamPublish() {
+        return (BapFtpParamPublish) getDelegate().getParamPublish();
     }
 
     public boolean equals(final Object that) {

diff --git a/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpParamPublish/config.jelly b/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpParamPublish/config.jelly
@@ -0,0 +1,33 @@
+<?jelly escape-by-default='true'?>
+
+<!--
+  ~ The MIT License
+  ~
+  ~ Copyright (C) 2010-2011 by Anthony Robinson
+  ~
+  ~ Permission is hereby granted, free of charge, to any person obtaining a copy
+  ~ of this software and associated documentation files (the "Software"), to deal
+  ~ in the Software without restriction, including without limitation the rights
+  ~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  ~ copies of the Software, and to permit persons to whom the Software is
+  ~ furnished to do so, subject to the following conditions:
+  ~
+  ~ The above copyright notice and this permission notice shall be included in
+  ~ all copies or substantial portions of the Software.
+  ~
+  ~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  ~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  ~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  ~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  ~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  ~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+  ~ THE SOFTWARE.
+  -->
+
+<j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form">
+
+    <f:entry title="${%parameterName.title}" field="parameterName">
+        <f:textbox/>
+    </f:entry>
+
+</j:jelly>
diff --git a/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpParamPublish/config.properties b/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpParamPublish/config.properties
@@ -0,0 +1,25 @@
+#
+# The MIT License
+#
+# Copyright (C) 2010-2011 by Anthony Robinson
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+
+parameterName.title=Parameter name
diff --git a/...ain/resources/jenkins/plugins/publish_over_ftp/BapFtpParamPublish/help-parameterName.html b/...ain/resources/jenkins/plugins/publish_over_ftp/BapFtpParamPublish/help-parameterName.html
@@ -0,0 +1,27 @@
+<!--
+  ~ The MIT License
+  ~
+  ~ Copyright (C) 2010-2011 by Anthony Robinson
+  ~
+  ~ Permission is hereby granted, free of charge, to any person obtaining a copy
+  ~ of this software and associated documentation files (the "Software"), to deal
+  ~ in the Software without restriction, including without limitation the rights
+  ~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  ~ copies of the Software, and to permit persons to whom the Software is
+  ~ furnished to do so, subject to the following conditions:
+  ~
+  ~ The above copyright notice and this permission notice shall be included in
+  ~ all copies or substantial portions of the Software.
+  ~
+  ~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  ~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  ~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  ~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  ~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  ~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+  ~ THE SOFTWARE.
+  -->
+
+<div>
+    The name of the parameter or environment variable that will contain the expression for matching the labels.
+</div>
diff --git a/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpPublisher/config.jelly b/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpPublisher/config.jelly
@@ -56,6 +56,7 @@
             <poj:checkbox title="${%verbose.title}"/>
         </f:entry>
         <f:optionalProperty title="${%retry.title}" field="retry"/>
+        <f:optionalProperty title="${%label.title}" field="label"/>
     </f:advanced>
 
     <f:entry title="${%transfers.section}">

diff --git a/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpPublisher/config.properties b/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpPublisher/config.properties
@@ -31,3 +31,4 @@ transfers.dragAndDropLabel=Transfer Set
 addTransfer.value=Add Transfer Set
 deleteTransfer.value=Delete Transfer Set
 retry.title=Retry
+label.title=Label
diff --git a/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpPublisher/help-label.html b/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpPublisher/help-label.html
@@ -0,0 +1,29 @@
+<!--
+  ~ The MIT License
+  ~
+  ~ Copyright (C) 2010-2011 by Anthony Robinson
+  ~
+  ~ Permission is hereby granted, free of charge, to any person obtaining a copy
+  ~ of this software and associated documentation files (the "Software"), to deal
+  ~ in the Software without restriction, including without limitation the rights
+  ~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  ~ copies of the Software, and to permit persons to whom the Software is
+  ~ furnished to do so, subject to the following conditions:
+  ~
+  ~ The above copyright notice and this permission notice shall be included in
+  ~ all copies or substantial portions of the Software.
+  ~
+  ~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  ~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  ~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  ~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  ~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  ~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+  ~ THE SOFTWARE.
+  -->
+
+<div>
+    <p>Set the label for this Server instance - for use with Parameterized publishing</p>
+
+    <p>Expand the help for Parameterized publishing for more details</p>
+</div>
diff --git a/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpPublisherLabel/config.jelly b/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpPublisherLabel/config.jelly
@@ -0,0 +1,33 @@
+<?jelly escape-by-default='true'?>
+
+<!--
+  ~ The MIT License
+  ~
+  ~ Copyright (C) 2010-2011 by Anthony Robinson
+  ~
+  ~ Permission is hereby granted, free of charge, to any person obtaining a copy
+  ~ of this software and associated documentation files (the "Software"), to deal
+  ~ in the Software without restriction, including without limitation the rights
+  ~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  ~ copies of the Software, and to permit persons to whom the Software is
+  ~ furnished to do so, subject to the following conditions:
+  ~
+  ~ The above copyright notice and this permission notice shall be included in
+  ~ all copies or substantial portions of the Software.
+  ~
+  ~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  ~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  ~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  ~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  ~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  ~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+  ~ THE SOFTWARE.
+  -->
+
+<j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form">
+
+    <f:entry title="${%label.title}" field="label">
+        <f:textbox/>
+    </f:entry>
+
+</j:jelly>
diff --git a/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpPublisherLabel/config.properties b/src/main/resources/jenkins/plugins/publish_over_ftp/BapFtpPublisherLabel/config.properties
@@ -0,0 +1,25 @@
+#
+# The MIT License
+#
+# Copyright (C) 2010-2011 by Anthony Robinson
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+
+label.title=Label