Added validation of client workspace name (via pattern from global configuration)

Signed-off-by: Oleg Nenashev <nenashev@synopsys.com>

Author: oleg-nenashev

src/main/java/hudson/plugins/perforce/PerforceSCM.java

@@ -1747,6 +1747,8 @@ private String getConcurrentClientName(FilePath workspace, String p4Client) {
 
     @Extension
     public static final class PerforceSCMDescriptor extends SCMDescriptor<PerforceSCM> {
+        private String p4ClientPattern;
+        
         public PerforceSCMDescriptor() {
             super(PerforceSCM.class, PerforceRepositoryBrowser.class);
             load();
@@ -1807,6 +1809,34 @@ public List<PerforceToolInstallation> getP4Tools() {
             PerforceToolInstallation[] p4ToolInstallations = Hudson.getInstance().getDescriptorByType(PerforceToolInstallation.DescriptorImpl.class).getInstallations();
             return Arrays.asList(p4ToolInstallations);
         }
+        
+        public String getP4ClientPattern() {
+            if (p4ClientPattern == null) {
+                return ".*";
+            } else {
+                return p4ClientPattern;
+            }
+        }
+
+        
+        @Override
+        public boolean configure(StaplerRequest req, JSONObject json) throws FormException {
+            p4ClientPattern = Util.fixEmpty(req.getParameter("p4.clientPattern").trim());
+            save();
+            return true;
+        }
+        
+        public FormValidation doValidateNamePattern(StaplerRequest req) {
+            String namePattern = Util.fixEmptyAndTrim(req.getParameter("value"));
+            if (namePattern != null) {
+                try {
+                    Pattern.compile(namePattern);
+                } catch (PatternSyntaxException exception) {
+                    return FormValidation.error("Pattern format error: "+exception.getMessage());
+                }
+            }
+            return FormValidation.ok();
+        }
 
         public String isValidProjectPath(String path) {
             if (!path.startsWith("//")) {
@@ -1878,19 +1908,26 @@ public FormValidation doValidatePerforceLogin(StaplerRequest req) {
          * Checks to see if the specified workspace is valid.
          */
         public FormValidation doValidateP4Client(StaplerRequest req) {
-            Depot depot = getDepotFromRequest(req);
-            if (depot == null) {
-                return FormValidation.error(
-                        "Unable to check workspace against depot");
-            }
-            String workspace = Util.fixEmptyAndTrim(req.getParameter("client"));
+            String workspace = Util.fixEmptyAndTrim(req.getParameter("client"));          
             if (workspace == null) {
                 return FormValidation.error("You must enter a workspaces name");
             }
             try {
+                // Check P4 client pattern first, because workspace check fails on valid client names with variables
+                if (!workspace.matches(getP4ClientPattern())) {
+                    return FormValidation.error("Client name doesn't meet global pattern: "+getP4ClientPattern());
+                }
+                
+                // Then, check depot 
+                Depot depot = getDepotFromRequest(req);
+                if (depot == null) {
+                    return FormValidation.error(
+                            "Unable to check workspace against depot");
+                }
+                
+                // Then, check workspace
                 Workspace p4Workspace =
                     depot.getWorkspaces().getWorkspace(workspace, "");
-
                 if (p4Workspace.getAccess() == null ||
                         p4Workspace.getAccess().equals(""))
                     return FormValidation.warning("Workspace does not exist. " +

src/main/resources/hudson/plugins/perforce/PerforceSCM/global.jelly

@@ -0,0 +1,37 @@
+<?xml version='1.0' encoding='UTF-8' ?> 
+<!--
+  - The MIT License
+  -
+  - Copyright (c) 2013, Oleg Nenashev <nenashev@synopsys.com>, Synopsys Inc.
+  -
+  - OriginalFile: manage-project-roles.jelly
+  - Thomas Maurel & Romain Seguy, Manufacture Française des Pneumatiques Michelin,
+  - 
+  -
+  - 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:st="jelly:stapler" xmlns:d="jelly:define"
+         xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
+  <f:section title="Perforce SCM">
+    <f:entry title="P4 Client name pattern"  help="/plugin/perforce/help/clientNamePattern.html">
+      <f:textbox name="p4.clientPattern" value="${descriptor.p4ClientPattern}"
+                 checkUrl="'${rootURL}/scm/PerforceSCM/validateNamePattern?value='+escape(this.value)"/>
+    </f:entry>
+  </f:section>
+</j:jelly>

src/main/webapp/help/clientNamePattern.html

@@ -0,0 +1,13 @@
+<div>
+  <p>
+    Regular expression to check P4 client naming policies.
+  </p>
+  <p>
+    Examples:
+	<ul>
+		<li>.* - All patterns</li>
+		<li>Jenkins_.* - Workspace should start from Jenkins_ prefix</li>
+		<li>\$\{JOB_NAME}_\$\{NODE_NAME\}_[\S]* - require two variables and non-space charecters then</li>
+	</ul>
+  </p>
+</div>