From d876679f131e52b84688586206fc35abbd2de1e7 Mon Sep 17 00:00:00 2001
From: Nicolas De Loof <nicolas.deloof@gmail.com>
Date: Thu, 22 Aug 2013 15:17:35 +0200
Subject: [PATCH] provide alternate error message for pattern-based naming
 strategy

---
 .../jenkins/model/ProjectNamingStrategy.java  | 21 ++++++++++++++++---
 .../config.groovy                             |  5 +++++
 .../config.properties                         |  1 +
 .../help-description.html                     |  4 ++++
 4 files changed, 28 insertions(+), 3 deletions(-)
 create mode 100644 core/src/main/resources/jenkins/model/ProjectNamingStrategy/PatternProjectNamingStrategy/help-description.html

diff --git a/core/src/main/java/jenkins/model/ProjectNamingStrategy.java b/core/src/main/java/jenkins/model/ProjectNamingStrategy.java
index b37343dc74..8b9862c9d5 100644
--- a/core/src/main/java/jenkins/model/ProjectNamingStrategy.java
+++ b/core/src/main/java/jenkins/model/ProjectNamingStrategy.java
@@ -30,6 +30,7 @@ import hudson.Util;
 import hudson.model.Describable;
 import hudson.model.Descriptor;
 import hudson.model.Failure;
+import jenkins.model.Messages;
 import hudson.util.FormValidation;
 import java.io.IOException;
 
@@ -132,19 +133,29 @@ public abstract class ProjectNamingStrategy implements Describable<ProjectNaming
          */
         private final String namePattern;
 
+        private final String description;
+
         private boolean forceExistingJobs;
 
-        @DataBoundConstructor
+        @Deprecated
         public PatternProjectNamingStrategy(String namePattern, boolean forceExistingJobs) {
+            this(namePattern, null, forceExistingJobs);
+        }
+
+        @DataBoundConstructor
+        public PatternProjectNamingStrategy(String namePattern, String description, boolean forceExistingJobs) {
             this.namePattern = namePattern;
+            this.description = description;
             this.forceExistingJobs = forceExistingJobs;
         }
 
         @Override
-        public void checkName(String name) throws Failure {
+        public void checkName(String name) {
             if (StringUtils.isNotBlank(namePattern) && StringUtils.isNotBlank(name)) {
                 if (!Pattern.matches(namePattern, name)) {
-                    throw new Failure(jenkins.model.Messages._Hudson_JobNameConventionNotApplyed(name, namePattern).toString());
+                    throw new Failure(StringUtils.isEmpty(description) ?
+                        Messages.Hudson_JobNameConventionNotApplyed(name, namePattern) :
+                        description);
                 }
             }
         }
@@ -153,6 +164,10 @@ public abstract class ProjectNamingStrategy implements Describable<ProjectNaming
             return namePattern;
         }
 
+        public String getDescription() {
+            return description;
+        }
+
         public boolean isForceExistingJobs() {
             return forceExistingJobs;
         }
diff --git a/core/src/main/resources/jenkins/model/ProjectNamingStrategy/PatternProjectNamingStrategy/config.groovy b/core/src/main/resources/jenkins/model/ProjectNamingStrategy/PatternProjectNamingStrategy/config.groovy
index 0204cd0433..3bfaa168b2 100644
--- a/core/src/main/resources/jenkins/model/ProjectNamingStrategy/PatternProjectNamingStrategy/config.groovy
+++ b/core/src/main/resources/jenkins/model/ProjectNamingStrategy/PatternProjectNamingStrategy/config.groovy
@@ -6,6 +6,11 @@ def f=namespace(lib.FormTagLib)
 f.entry(title:_("namePattern"), field:"namePattern") {
     f.textbox(value:h.defaulted(instance?.namePattern, descriptor.DEFAULT_PATTERN),class:"fixed-width")
 }
+
+f.entry(title:_("description"), field:"description") {
+    f.textbox()
+}
+
 f.entry(title:_("forceExistingJobs"), field:"forceExistingJobs") {
     f.checkbox(name:"forceExistingJobs")
 }
diff --git a/core/src/main/resources/jenkins/model/ProjectNamingStrategy/PatternProjectNamingStrategy/config.properties b/core/src/main/resources/jenkins/model/ProjectNamingStrategy/PatternProjectNamingStrategy/config.properties
index 9efe256849..76da287c26 100644
--- a/core/src/main/resources/jenkins/model/ProjectNamingStrategy/PatternProjectNamingStrategy/config.properties
+++ b/core/src/main/resources/jenkins/model/ProjectNamingStrategy/PatternProjectNamingStrategy/config.properties
@@ -21,6 +21,7 @@
 # THE SOFTWARE.
 
 namePattern = Name Pattern
+description = Description
 forceExistingJobs = force existing
 
 
diff --git a/core/src/main/resources/jenkins/model/ProjectNamingStrategy/PatternProjectNamingStrategy/help-description.html b/core/src/main/resources/jenkins/model/ProjectNamingStrategy/PatternProjectNamingStrategy/help-description.html
new file mode 100644
index 0000000000..48c0a7eac4
--- /dev/null
+++ b/core/src/main/resources/jenkins/model/ProjectNamingStrategy/PatternProjectNamingStrategy/help-description.html
@@ -0,0 +1,4 @@
+<p>
+    Provide a human-readable description to explain naming constraints.
+    Will be used as error message when job name does not match pattern
+</p>
\ No newline at end of file
-- 
GitLab