Integrate Folder Properties in P4Plugin. (#242)

skumar7322 · web-flow · commit fb70a9a8b121 · 2025-06-23T17:16:20.000+05:30
Resolve the folder properties used in P4Plugin for FreeStyle, Pipeline and MultiBranch project configuration.
diff --git a/pom.xml b/pom.xml
@@ -75,6 +75,12 @@
       <version>2024.2.2695691</version>
     </dependency>
 
+    <dependency>
+      <groupId>com.mig82</groupId>
+      <artifactId>folder-properties</artifactId>
+      <version>57.vde5161ec7a_b_a_</version>
+    </dependency>
+
     <dependency>
       <groupId>commons-io</groupId>
       <artifactId>commons-io</artifactId>
diff --git a/src/main/java/org/jenkinsci/plugins/p4/PerforceScm.java b/src/main/java/org/jenkinsci/plugins/p4/PerforceScm.java
@@ -1,6 +1,7 @@
 package org.jenkinsci.plugins.p4;
 
 import com.cloudbees.plugins.credentials.CredentialsProvider;
+import com.mig82.folders.properties.PropertiesLoader;
 import com.perforce.p4java.exception.P4JavaException;
 import hudson.AbortException;
 import hudson.EnvVars;
@@ -432,6 +433,10 @@ private PollingResult pollWorkspace(EnvVars envVars, TaskListener listener, File
 		ws.setRootPath(null);
 		ws.setExpand(envVars);
 
+		EnvVars folderPropertiesVars = PropertiesLoader.loadFolderProperties(lastRun.getParent());
+		if (!folderPropertiesVars.isEmpty()) {
+			folderPropertiesVars.forEach(ws::addEnv);
+		}
 		// Set EXPANDED client
 		String client = ws.getFullName();
 		listener.getLogger().println("P4: Polling on: " + nodeName + " with:" + client);
@@ -519,7 +524,7 @@ private List<P4Ref> lookForChanges(FilePath buildWorkspace, Workspace ws, Run<?,
 					}
 				}
 			}
-			
+
 			// no previous build, return null.
 			listener.getLogger().println("P4: Polling: No changes in previous build(s).");
 			return null;
@@ -589,6 +594,10 @@ public void checkout(Run<?, ?> run, Launcher launcher, FilePath buildWorkspace,
 
 		// Get workspace used for the Task
 		Workspace ws = task.setEnvironment(run, workspace, buildWorkspace);
+		EnvVars folderPropertiesVars = PropertiesLoader.loadFolderProperties(run.getParent());
+		if (!folderPropertiesVars.isEmpty()) {
+			folderPropertiesVars.forEach(ws::addEnv);
+		}
 
 		// Add review to environment, if defined
 		if (review != null) {
@@ -727,7 +736,7 @@ private void setStreamEnvVariables(Run<?, ?> run, Workspace ws) {
 			streamName = ((StreamWorkspaceImpl) ws).getStreamName();
 		}
 		if (StringUtils.isNotBlank(streamName) || StringUtils.isNotBlank(streamAtChange)) {
-			run.addAction(new P4StreamEnvironmentContributionAction(streamName,streamAtChange));
+			run.addAction(new P4StreamEnvironmentContributionAction(streamName, streamAtChange));
 		}
 	}
 
diff --git a/src/main/java/org/jenkinsci/plugins/p4/browsers/SwarmBrowser.java b/src/main/java/org/jenkinsci/plugins/p4/browsers/SwarmBrowser.java
@@ -65,7 +65,7 @@ public String getDisplayName() {
 			return "Swarm browser";
 		}
 
-		public FormValidation doCheck(@QueryParameter final String value) throws IOException, ServletException {
+		public FormValidation doCheckUrl(@QueryParameter final String value) throws IOException, ServletException {
 
 			String url = Util.fixEmpty(value);
 			if (url == null) {
diff --git a/src/main/java/org/jenkinsci/plugins/p4/build/P4EnvironmentContributor.java b/src/main/java/org/jenkinsci/plugins/p4/build/P4EnvironmentContributor.java
@@ -1,5 +1,6 @@
 package org.jenkinsci.plugins.p4.build;
 
+import com.mig82.folders.properties.PropertiesLoader;
 import hudson.EnvVars;
 import hudson.Extension;
 import hudson.model.Descriptor;
@@ -34,6 +35,10 @@ public void buildEnvironmentFor(Run run, EnvVars env, TaskListener listener) thr
 		TagAction tagAction = TagAction.getLastAction(run);
 		buildEnvironment(tagAction, env);
 		injectSwarmEnvVars(run, env);
+		EnvVars folderPropertiesVars = PropertiesLoader.loadFolderProperties(run.getParent());
+		if (!folderPropertiesVars.isEmpty()) {
+			env.putAll(folderPropertiesVars);
+		}
 	}
 
 	public static void buildEnvironment(TagAction tagAction, Map<String, String> map) {
@@ -135,7 +140,7 @@ private static void injectSwarmEnvVars(Run run, EnvVars env) {
 			}
 			Map<String, String> swarmParameters = ((P4SCMHead) head).getSwarmParams();
 
-			if(swarmParameters == null || swarmParameters.isEmpty()) {
+			if (swarmParameters == null || swarmParameters.isEmpty()) {
 				continue;
 			}
 			String swarmBranch = swarmParameters.get(ReviewProp.SWARM_BRANCH.toString());
diff --git a/src/main/java/org/jenkinsci/plugins/p4/scm/AbstractP4ScmSource.java b/src/main/java/org/jenkinsci/plugins/p4/scm/AbstractP4ScmSource.java
@@ -36,6 +36,7 @@
 import org.jenkinsci.plugins.p4.populate.Populate;
 import org.jenkinsci.plugins.p4.review.ReviewProp;
 import org.jenkinsci.plugins.p4.scm.events.P4BranchScanner;
+import org.jenkinsci.plugins.p4.utils.FolderPropertiesUtil;
 import org.jenkinsci.plugins.p4.workspace.Workspace;
 import org.jenkinsci.plugins.workflow.job.WorkflowJob;
 import org.jenkinsci.plugins.workflow.job.WorkflowRun;
@@ -182,6 +183,18 @@ protected void retrieve(@CheckForNull SCMSourceCriteria criteria, @NonNull SCMHe
 		}
 	}
 
+	public boolean pathContainsFolderPropertyVar(List<String> paths) {
+		if (paths == null || paths.isEmpty()) {
+			return false;
+		}
+		for (String path : paths) {
+			if (path.contains(FolderPropertiesUtil.PROP_EXPANSION_PATTERN)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
 	private List<P4SCMHead> getP4SCMHeads(SCMHeadObserver observer, TaskListener listener) throws Exception {
 		List<P4SCMHead> heads = new ArrayList<>();
 		Set<SCMHead> includedHead = observer.getIncludes();
diff --git a/src/main/java/org/jenkinsci/plugins/p4/scm/BranchesScmSource.java b/src/main/java/org/jenkinsci/plugins/p4/scm/BranchesScmSource.java
@@ -9,6 +9,7 @@
 import org.jenkinsci.plugins.p4.browsers.P4Browser;
 import org.jenkinsci.plugins.p4.client.ConnectionHelper;
 import org.jenkinsci.plugins.p4.client.ViewMapHelper;
+import org.jenkinsci.plugins.p4.utils.FolderPropertiesUtil;
 import org.jenkinsci.plugins.p4.workspace.ManualWorkspaceImpl;
 import org.jenkinsci.plugins.p4.workspace.Workspace;
 import org.jenkinsci.plugins.p4.workspace.WorkspaceSpec;
@@ -88,6 +89,10 @@ public List<P4SCMHead> getHeads(@NonNull TaskListener listener) throws Exception
 
 		Pattern excludesPattern = Pattern.compile(getExcludes());
 		List<String> paths = getIncludePaths();
+		if (pathContainsFolderPropertyVar(paths)) {
+			paths = FolderPropertiesUtil.processFolderPropertiesIn(paths, getOwner());
+		}
+
 		List<P4SCMHead> list = new ArrayList<>();
 
 		try (ConnectionHelper p4 = new ConnectionHelper(getOwner(), getCredential(), listener)) {
diff --git a/src/main/java/org/jenkinsci/plugins/p4/scm/StreamsScmSource.java b/src/main/java/org/jenkinsci/plugins/p4/scm/StreamsScmSource.java
@@ -7,6 +7,7 @@
 import org.jenkinsci.Symbol;
 import org.jenkinsci.plugins.p4.browsers.P4Browser;
 import org.jenkinsci.plugins.p4.client.ConnectionHelper;
+import org.jenkinsci.plugins.p4.utils.FolderPropertiesUtil;
 import org.jenkinsci.plugins.p4.workspace.StreamWorkspaceImpl;
 import org.jenkinsci.plugins.p4.workspace.Workspace;
 import org.kohsuke.stapler.DataBoundConstructor;
@@ -47,8 +48,11 @@ public List<P4SCMHead> getTags(@NonNull TaskListener listener) throws Exception
 	@Override
 	public List<P4SCMHead> getHeads(@NonNull TaskListener listener) throws Exception {
 		List<String> paths = getIncludePaths();
-		HashSet<P4SCMHead> list = new HashSet<P4SCMHead>();
 
+		if (pathContainsFolderPropertyVar(paths)) {
+			paths = FolderPropertiesUtil.processFolderPropertiesIn(paths, getOwner());
+		}
+		HashSet<P4SCMHead> list = new HashSet<>();
 		try (ConnectionHelper p4 = new ConnectionHelper(getOwner(), credential, listener)) {
 
 			Pattern excludesPattern = Pattern.compile(getExcludes());
diff --git a/src/main/java/org/jenkinsci/plugins/p4/tasks/AbstractTask.java b/src/main/java/org/jenkinsci/plugins/p4/tasks/AbstractTask.java
@@ -99,7 +99,6 @@ public static Workspace setup(Run<?, ?> run, Workspace wsType, FilePath buildWor
 		envVars.put("NODE_NAME", envVars.get("NODE_NAME", nodeName));
 		String executor = ExecutorHelper.getExecutorID(buildWorkspace, listener);
 		envVars.put("EXECUTOR_NUMBER", envVars.get("EXECUTOR_NUMBER", executor));
-
 		ws.setExpand(envVars);
 
 		// Set workspace root (check for parallel execution)
diff --git a/src/main/java/org/jenkinsci/plugins/p4/utils/FolderPropertiesUtil.java b/src/main/java/org/jenkinsci/plugins/p4/utils/FolderPropertiesUtil.java
@@ -0,0 +1,69 @@
+package org.jenkinsci.plugins.p4.utils;
+
+import com.cloudbees.hudson.plugins.folder.AbstractFolder;
+import com.cloudbees.hudson.plugins.folder.AbstractFolderProperty;
+import com.cloudbees.hudson.plugins.folder.AbstractFolderPropertyDescriptor;
+import com.mig82.folders.properties.FolderProperties;
+import hudson.model.ItemGroup;
+import hudson.util.DescribableList;
+import jenkins.scm.api.SCMSourceOwner;
+import org.jenkinsci.plugins.p4.workspace.Expand;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.stream.Collectors;
+
+public final class FolderPropertiesUtil {
+	public static final String PROP_EXPANSION_PATTERN = "${";
+
+	private FolderPropertiesUtil() {
+	}
+
+	public static List<String> processFolderPropertiesIn(List<String> paths, SCMSourceOwner owner) {
+		if (paths == null || paths.isEmpty()) {
+			return new ArrayList<>();
+		}
+		Map<String, String> folderProperties = getFolderPropertiesFrom(owner);
+		if (folderProperties.isEmpty()) {
+			return paths;
+		}
+		Expand expand = new Expand(folderProperties);
+		return paths.stream()
+				.map(path -> expand.format(path, false))
+				.collect(Collectors.toList());
+
+	}
+
+	private static Map<String, String> getFolderPropertiesFrom(SCMSourceOwner owner) {
+		if (owner == null) {
+			return new HashMap<>();
+		}
+		ItemGroup<?> parent = owner.getParent();
+		Map<String, String> propertyMap = new HashMap<>();
+		while (parent instanceof AbstractFolder) {
+			AbstractFolder<?> folder = (AbstractFolder<?>) parent;
+			DescribableList<AbstractFolderProperty<?>, AbstractFolderPropertyDescriptor> properties = folder.getProperties();
+			addFolderPropertiesToMap(properties, propertyMap);
+			parent = folder.getParent();
+		}
+		return propertyMap;
+	}
+
+	private static void addFolderPropertiesToMap(DescribableList<AbstractFolderProperty<?>, AbstractFolderPropertyDescriptor> properties, Map<String, String> propertyMap) {
+		if (properties == null) {
+			return;
+		}
+		FolderProperties folderProperties = properties.get(FolderProperties.class);
+
+		if (folderProperties == null) {
+			return;
+		}
+		Arrays.stream(folderProperties.getProperties())
+				.filter(Objects::nonNull)
+				.forEach(prop -> propertyMap.put(prop.getKey(), prop.getValue()));
+	}
+}
diff --git a/src/main/resources/org/jenkinsci/plugins/p4/scm/BranchesScmSource/config-detail.jelly b/src/main/resources/org/jenkinsci/plugins/p4/scm/BranchesScmSource/config-detail.jelly
@@ -41,7 +41,7 @@
         </f:entry>
 
         <f:entry field="useNewDirectoryStructure">
-            <f:checkbox title="Use new directory structure" default="false"/>
+            <f:checkbox title="Enable variable branch position in “Include branches”." default="false"/>
         </f:entry>
 
     	<t:listScmBrowsers name="p4.browser"/>
diff --git a/src/main/resources/org/jenkinsci/plugins/p4/scm/BranchesScmSource/help-useNewDirectoryStructure.html b/src/main/resources/org/jenkinsci/plugins/p4/scm/BranchesScmSource/help-useNewDirectoryStructure.html
@@ -0,0 +1,4 @@
+<div>
+    <p>When this checkbox is checked, then branch name is the position denoted by “*” in  path in “include branches” field.</p>
+    <p>When it is unchecked then the branch name is the directory that contains the jenkins file.</p>
+</div>
diff --git a/src/test/java/org/jenkinsci/plugins/p4/client/FreeStyleTest.java b/src/test/java/org/jenkinsci/plugins/p4/client/FreeStyleTest.java
@@ -241,7 +241,7 @@ public void testFreeStyleProject_buildShelf() throws Exception {
 		assertNotNull(desc);
 
 		SwarmBrowser.DescriptorImpl impl = (SwarmBrowser.DescriptorImpl) desc;
-		FormValidation form = impl.doCheck(url.toString());
+		FormValidation form = impl.doCheckUrl(url.toString());
 		assertEquals(FormValidation.Kind.OK, form.kind);
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public String getDisplayName() {`
`65`	`65`	`return "Swarm browser";`
`66`	`66`	`}`
`67`	`67`
`68`		`- public FormValidation doCheck(@QueryParameter final String value) throws IOException, ServletException {`
	`68`	`+ public FormValidation doCheckUrl(@QueryParameter final String value) throws IOException, ServletException {`
`69`	`69`
`70`	`70`	`String url = Util.fixEmpty(value);`
`71`	`71`	`if (url == null) {`