Merge branch 'master' into JENKINS-23729

res0nance · web-flow · commit 8fd8e2feeff6 · 2020-12-27T15:19:45.000+08:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,8 @@
+  
+version: 2
+updates:
+- package-ecosystem: maven
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -0,0 +1,3 @@
+_extends: .github
+name-template: v$NEXT_MINOR_VERSION 🌈
+tag-template: validating-string-parameter-$NEXT_MINOR_VERSION
diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
@@ -0,0 +1,16 @@
+# Automates creation of Release Drafts using Release Drafter
+# More Info: https://github.com/jenkinsci/.github/blob/master/.github/release-drafter.adoc
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,58 @@
+# Version History
+
+### Future releases can be found [here](https://github.com/jenkinsci/validating-string-parameter-plugin/releases)
+
+## Version 2.4 (20-Apr-2018)
+
+- Fixes Pipeline compatibility
+
+## Version 2.3 (04-Feb-2015)
+
+-   Fixed links to regex pattern documentation
+-   Use codemirror for the description field
+
+## Version 2.2 (13-Sep-2011)
+
+-   [JENKINS-10139](http://issues.jenkins-ci.org/browse/JENKINS-10139)
+    Fix for regex containing back slashes
+
+## Version 2.1 (27-Feb-2011)
+
+-   If an invalid value is passed to the build, the build will be
+    aborted and an error message will display in console indicating the
+    parameter and failing value
+
+## Version 2.0 (19-Feb-2011)
+
+-   Migrated code to jenkins and performed release
+
+## Version 1.4 (13-Oct-2010)
+
+-   [JENKINS-7794](http://issues.jenkins-ci.org/browse/JENKINS-6158)
+    validation check doesn't work if Jenkins is hosted with a context
+    root
+
+## Version 1.3 (22-May-2010)
+
+-   [JENKINS-6158](http://issues.jenkins-ci.org/browse/JENKINS-6158)
+    Build will fail if invalid parameter is passed
+-   [JENKINS-6160](http://issues.jenkins-ci.org/browse/JENKINS-6160)
+    Jenkins will record regex used to validate the build parameter as
+    part of build configuration and display as tooltip on the parameter
+    page.
+
+## Version 1.2 (29-Aug-2009)
+
+-   Used the javascript function encodeURIComponent to properly handle
+    characters within the user entered values for regex and validation
+    error message. (Issue
+    [4334](http://wiki.jenkins-ci.org/pages/editpage.action?pageId=38928603))
+
+## Version 1.1 (28-Aug-2009)
+
+-   Supported the release plugins as well as any other plugin that uses
+    build parameters
+
+## Version 1.0 (24-Aug-2009)
+
+-   Initial Version
diff --git a/README.md b/README.md
@@ -0,0 +1,35 @@
+# Validating String Parameter Plugin
+
+[![Jenkins](https://ci.jenkins.io/job/Plugins/job/validating-string-parameter-plugin/job/master/badge/icon)](https://ci.jenkins.io/job/Plugins/job/validating-string-parameter-plugin/job/master/)
+[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/validating-string-parameter.svg)](https://plugins.jenkins.io/validating-string-parameter)
+[![GitHub release](https://img.shields.io/github/release/jenkinsci/validating-string-parameter-plugin.svg?label=changelog)](https://github.com/jenkinsci/validating-string-parameter-plugin/releases/latest)
+
+The validating string parameter plugin contributes a new parameter type
+to Jenkins that supports regular expression validation of the user's
+entered parameter.
+
+# Usage
+
+This plugin is used wherever build parameter selection is available,
+most commonly in the job configuration page by enabling parameterized
+builds (this parameter type will also be available as release parameters
+using the [release
+plugin](https://plugins.jenkins.io/release/)).
+
+Configure the parameter by entering a name, regular expression to
+validate the entered value and optionally a default value, an error
+message shown when the user entered value fails the regular expression
+check and a parameter description.  
+![](docs/images/configure.PNG)
+
+When a build is requested, the user will be prompted with the parameters
+to enter. Users enter the parameter as normal, but will now be prompted
+with an error message if the entered value does not meet the regular
+expression.
+
+![](docs/images/build-error.PNG) 
+
+Once the entered value meets the configured regular expression, the
+error message is no longer displayed.
+
+![](docs/images/build-success.PNG)
diff --git a/README.txt b/README.txt
diff --git a/docs/images/build-error.PNG b/docs/images/build-error.PNG
diff --git a/docs/images/build-success.PNG b/docs/images/build-success.PNG
diff --git a/docs/images/configure.PNG b/docs/images/configure.PNG
diff --git a/pom.xml b/pom.xml
@@ -4,13 +4,13 @@
     <parent>
         <groupId>org.jenkins-ci.plugins</groupId>
         <artifactId>plugin</artifactId>
-        <version>3.5</version>
+        <version>4.15</version>
     </parent>
     <artifactId>validating-string-parameter</artifactId>
     <packaging>hpi</packaging>
     <name>Validating String Parameter Plugin</name>
     <version>2.6-SNAPSHOT</version>
-    <url>http://wiki.jenkins-ci.org/display/JENKINS/Validating+String+Parameter+Plugin</url>
+    <url>https://github.com/jenkinsci/validating-string-parameter-plugin</url>
 
     <properties>
         <java.level>8</java.level>
diff --git a/src/main/java/hudson/plugins/validating_string_parameter/ValidatingStringParameterDefinition.java b/src/main/java/hudson/plugins/validating_string_parameter/ValidatingStringParameterDefinition.java
@@ -23,12 +23,15 @@
  */
 package hudson.plugins.validating_string_parameter;
 
+import hudson.AbortException;
 import hudson.Extension;
+import hudson.cli.CLICommand;
 import hudson.model.Failure;
 import hudson.model.ParameterDefinition;
 import hudson.model.ParameterValue;
 import hudson.util.FormValidation;
 
+import java.io.IOException;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.regex.Pattern;
@@ -163,4 +166,16 @@ public ParameterValue createValue(StaplerRequest req) {
             return new ValidatingStringParameterValue(getName(), value[0], regex, getDescription());
         }
     }
+
+    @Override
+    public ParameterValue createValue(CLICommand command, String value) throws IOException, InterruptedException {
+        if (value == null || value.length() == 0) {
+            return getDefaultParameterValue();
+        } else {
+            if (!Pattern.matches(regex, value)) {
+                throw new AbortException("Invalid value for parameter [" + getName() + "] specified: " + value);
+            }
+            return new ValidatingStringParameterValue(getName(), value, regex, getDescription());
+        }
+    }
 }
diff --git a/src/main/resources/hudson/plugins/validating_string_parameter/ValidatingStringParameterDefinition/index.jelly b/src/main/resources/hudson/plugins/validating_string_parameter/ValidatingStringParameterDefinition/index.jelly
@@ -1,38 +1,38 @@
-<!--
-The MIT License
-
-Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi, Tom Huybrechts
-
-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.
--->
-<?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"
-	xmlns:i="jelly:fmt" xmlns:p="/lib/hudson/project">
-	
-	<j:set var="escapeEntryTitleAndDescription" value="false"/>
-	
-	<f:entry title="${h.xmlEscape(it.name)}" description="${it.formattedDescription}">
-		<div name="parameter" description="${it.formattedDescription}">
-			<input type="hidden" name="name" value="${it.name}" />
-			<f:textbox name="value" value="${it.defaultValue}"
-				checkUrl="'descriptorByName/hudson.plugins.validating_string_parameter.ValidatingStringParameterDefinition/validate?regex='+encodeURIComponent('${h.jsStringEscape(it.regex)}')+'&amp;failedValidationMessage='+encodeURIComponent('${h.jsStringEscape(it.failedValidationMessage)}')+'&amp;value='+encodeURIComponent(this.value)"/>
-		</div>
-	</f:entry>
-</j:jelly>
+<!--
+The MIT License
+
+Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi, Tom Huybrechts
+
+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.
+-->
+<?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"
+	xmlns:i="jelly:fmt" xmlns:p="/lib/hudson/project">
+	
+	<j:set var="escapeEntryTitleAndDescription" value="false"/>
+	
+	<f:entry title="${h.xmlEscape(it.name)}" description="${it.formattedDescription}">
+		<div name="parameter" description="${it.formattedDescription}">
+			<input type="hidden" name="name" value="${it.name}" />
+			<f:textbox name="value" value="${it.defaultValue}"
+				checkUrl="'${rootURL}/descriptorByName/hudson.plugins.validating_string_parameter.ValidatingStringParameterDefinition/validate?regex='+encodeURIComponent('${h.jsStringEscape(it.regex)}')+'&amp;failedValidationMessage='+encodeURIComponent('${h.jsStringEscape(it.failedValidationMessage)}')+'&amp;value='+encodeURIComponent(this.value)"/>
+		</div>
+	</f:entry>
+</j:jelly>
diff --git a/src/test/java/hudson/plugins/validating_string_parameter/ValidatingStringParameterDefinitionTest.java b/src/test/java/hudson/plugins/validating_string_parameter/ValidatingStringParameterDefinitionTest.java
@@ -1,29 +1,48 @@
-package hudson.plugins.validating_string_parameter;
-
-import hudson.Functions;
-import org.junit.Test;
-
-import static org.junit.Assert.assertEquals;
-
-public class ValidatingStringParameterDefinitionTest {
-    @Test
-    public void testSimpleConfiguration() throws Exception {
-        ValidatingStringParameterDefinition d = new ValidatingStringParameterDefinition("DUMMY", "foo", ".+", "Your parameter does not match the regular expression!", "Some parameter");
-        assertEquals("DUMMY", d.getName());
-        assertEquals("foo", d.getDefaultValue());
-        assertEquals(".+", d.getRegex());
-        assertEquals("Your parameter does not match the regular expression!", d.getFailedValidationMessage());
-        assertEquals("Some parameter", d.getDescription());
-    }
-
-    @Test
-    public void testJavaScriptEncode() throws Exception {
-        ValidatingStringParameterDefinition d = new ValidatingStringParameterDefinition("DUMMY", "foo", "\".+", "Your parameter does not match the regular expression!", "Some parameter");
-        assertEquals("DUMMY", d.getName());
-        assertEquals("foo", d.getDefaultValue());
-        assertEquals("\".+", d.getRegex());
-        assertEquals("\\\".+", Functions.jsStringEscape(d.getRegex()));
-        assertEquals("Your parameter does not match the regular expression!", d.getFailedValidationMessage());
-        assertEquals("Some parameter", d.getDescription());
-    }
+package hudson.plugins.validating_string_parameter;
+
+import hudson.Functions;
+import hudson.cli.CLICommand;
+import hudson.cli.ConsoleCommand;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+
+import java.io.IOException;
+
+import static org.junit.Assert.assertEquals;
+
+public class ValidatingStringParameterDefinitionTest {
+
+    @Rule
+    public JenkinsRule r = new JenkinsRule();
+
+    @Test
+    public void testSimpleConfiguration() throws Exception {
+        ValidatingStringParameterDefinition d = new ValidatingStringParameterDefinition("DUMMY", "foo", ".+", "Your parameter does not match the regular expression!", "Some parameter");
+        assertEquals("DUMMY", d.getName());
+        assertEquals("foo", d.getDefaultValue());
+        assertEquals(".+", d.getRegex());
+        assertEquals("Your parameter does not match the regular expression!", d.getFailedValidationMessage());
+        assertEquals("Some parameter", d.getDescription());
+    }
+
+    @Test
+    public void testJavaScriptEncode() throws Exception {
+        ValidatingStringParameterDefinition d = new ValidatingStringParameterDefinition("DUMMY", "foo", "\".+", "Your parameter does not match the regular expression!", "Some parameter");
+        assertEquals("DUMMY", d.getName());
+        assertEquals("foo", d.getDefaultValue());
+        assertEquals("\".+", d.getRegex());
+        assertEquals("\\\".+", Functions.jsStringEscape(d.getRegex()));
+        assertEquals("Your parameter does not match the regular expression!", d.getFailedValidationMessage());
+        assertEquals("Some parameter", d.getDescription());
+    }
+
+    @Test
+    public void testCLICommand() throws IOException, InterruptedException {
+        ValidatingStringParameterDefinition d = new ValidatingStringParameterDefinition("DUMMY", "foo", "\".+", "Your parameter does not match the regular expression!", "Some parameter");
+        CLICommand cliCommand = new ConsoleCommand();
+        assertEquals(d.getDefaultParameterValue(),d.createValue(cliCommand, null));
+        assertEquals(new ValidatingStringParameterValue("DUMMY", "\"hello"), d.createValue(cliCommand, "\"hello"));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+_extends: .github`
	`2`	`+name-template: v$NEXT_MINOR_VERSION 🌈`
	`3`	`+tag-template: validating-string-parameter-$NEXT_MINOR_VERSION`