[JENKINS-63102] Added two new Project Naming Strategies for "Contextual Project Path" and "Simple Project Path" (#181)

Co-authored-by: Robert Ross <robert.ross@nurocor.com>

Author: robross0606

README.md

@@ -16,7 +16,7 @@ you require the following plugins:
      * `io.jenkins.plugins.gitlabserverconfig` - Manages server configuration and web hooks management. Ideally should reside inside another plugin with name `GitLab Plugin`. In future, this package will be moved into a new plugin.
 
      * `io.jenkins.plugins.gitlabbranchsource` - Adds GitLab Branch Source for Multi-branch Pipeline Jobs (including
-     Merge Requests) and Folder organisation.
+     Merge Requests) and Folder organization.
 
 ## Getting Started
 
@@ -364,7 +364,7 @@ See handling secrets [section](https://github.com/jenkinsci/configuration-as-cod
 GitLab Branch Source Plugin allows you to create 2 type of jobs:
 
 * `Multibranch Pipeline Jobs` - For single project.
-* `Folder Organisation` - For multiple projects inside a owner (user/group/subgroup).
+* `Folder Organization` - For multiple projects inside a owner (user/group/subgroup).
 
 ### Multibranch Pipeline Jobs
 
@@ -476,7 +476,7 @@ You may want to disable this option because trusted members do not include membe
 
 * `Disable GitLab project avatar` - Disable avatars of GitLab project(s). It is not possible to fetch avatars when API has no token authentication or project is private. So you may use this option as a workaround. We will fix this issue in a later release.
 
-* `Project Naming Strategy` - Choose whether you want `project name` or the `project path (with namespace)` as job names of each project. Users generally prefer the first option but due to legacy reasons we have `project path (with namespace)` as default naming scheme. Note if a job is already created and the naming strategy is changed it will cause projects and build logs to be destroyed.
+* `Project Naming Strategy` - Choose whether you want `project name`, the `full project path (with namespace)`, `contextual project path (partial namespace`, or `simple project path (no namespace)` as job names of each project. Due to legacy reasons, we have `project path (with namespace)` as default naming scheme. Note if a job is already created and the naming strategy is changed it will cause projects and build logs to be destroyed.
 
 * `Filter by name (with regex)` - Filter the type of items you want to discover in your project based on the regular expression specified. For example, to discover only `master` branch, `develop` branch and all Merge Requests add `(master|develop|MR-.*)`.
 
@@ -747,7 +747,7 @@ GITLAB_CHANGES_UPDATED_AT_CURR
 
 To create a Job DSL seed job see this [tutorial](https://github.com/jenkinsci/job-dsl-plugin/wiki/Tutorial---Using-the-Jenkins-Job-DSL).
 
-Here is a sample seed job script for folder organisation job:
+Here is a sample seed job script for folder organization job:
 
 ```groovy
 organizationFolder('GitLab Organization Folder') {

src/main/java/io/jenkins/plugins/gitlabbranchsource/GitLabSCMNavigator.java

@@ -25,6 +25,8 @@
 import io.jenkins.plugins.gitlabserverconfig.servers.GitLabServer;
 import io.jenkins.plugins.gitlabserverconfig.servers.GitLabServers;
 import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashSet;
@@ -93,7 +95,7 @@ public class GitLabSCMNavigator extends SCMNavigator {
     private String credentialsId;
 
     /**
-     * The behavioural traits to apply.
+     * The behavioral traits to apply.
      */
     private List<SCMTrait<? extends SCMTrait<?>>> traits;
 
@@ -159,23 +161,23 @@ public String getProjectOwner() {
     }
 
     /**
-     * Gets the behavioural traits that are applied to this navigator and any {@link
+     * Gets the behavioral traits that are applied to this navigator and any {@link
      * GitLabSCMSource} instances it discovers.
      *
-     * @return the behavioural traits.
+     * @return the behavioral traits.
      */
     @NonNull
     public List<SCMTrait<? extends SCMTrait<?>>> getTraits() {
         return Collections.unmodifiableList(traits);
     }
 
     /**
-     * Sets the behavioural traits that are applied to this navigator and any {@link
+     * Sets the behavioral traits that are applied to this navigator and any {@link
      * GitLabSCMSource} instances it discovers. The new traits will take affect on the next
      * navigation through any of the {@link #visitSources(SCMSourceObserver)} overloads or {@link
      * #visitSource(String, SCMSourceObserver)}.
      *
-     * @param traits the new behavioural traits.
+     * @param traits the new behavioral traits.
      */
     @DataBoundSetter
     public void setTraits(@CheckForNull SCMTrait[] traits) {
@@ -202,12 +204,12 @@ private GitLabOwner getGitlabOwner(GitLabApi gitLabApi) {
     }
 
     /**
-     * Sets the behavioural traits that are applied to this navigator and any {@link
+     * Sets the behavioral traits that are applied to this navigator and any {@link
      * GitLabSCMSource} instances it discovers. The new traits will take affect on the next
      * navigation through any of the {@link #visitSources(SCMSourceObserver)} overloads or {@link
      * #visitSource(String, SCMSourceObserver)}.
      *
-     * @param traits the new behavioural traits.
+     * @param traits the new behavioral traits.
      */
     @Override
     public void setTraits(@CheckForNull List<SCMTrait<? extends SCMTrait<?>>> traits) {
@@ -310,25 +312,37 @@ public void visitSources(@NonNull final SCMSourceObserver observer)
                 }
             }
             observer.getListener().getLogger().format("%n%d projects were processed%n", count);
-        } catch (GitLabApiException e) {
+        } catch (GitLabApiException | URISyntaxException e) {
             LOGGER.log(Level.WARNING, "Exception caught:" + e, e);
             throw new IOException("Failed to visit SCM source", e);
         }
     }
 
     @NonNull
-    private String getProjectName(int projectNamingStrategy, Project project) {
+    private String getProjectName(int projectNamingStrategy, Project project) throws URISyntaxException {
+        String fullPath = project.getPathWithNamespace();
         String projectName;
         switch (projectNamingStrategy) {
             default:
-                // for legacy reasons default naming strategy is set to full path
+                // for legacy reasons default naming strategy is set to Full Project path
             case 1:
-                projectName = project.getPathWithNamespace();
+                projectName = fullPath;
                 break;
             case 2:
+                // Project name
                 projectName = project.getNameWithNamespace()
                     .replace(String.format("%s / ", getGitlabOwner().getFullName()), "");
                 break;
+            case 3:
+                // Contextual project path
+                URI ownerPathUri = new URI(projectOwner);
+                URI fullPathUri = new URI(fullPath);
+                projectName = ownerPathUri.relativize(fullPathUri).toString();
+                break;
+            case 4:
+                // Simple project path
+                projectName = fullPath.substring(fullPath.lastIndexOf('/') + 1);
+                break;
         }
         return projectName;
     }

src/main/java/io/jenkins/plugins/gitlabbranchsource/ProjectNamingStrategyTrait.java

@@ -38,7 +38,7 @@ public void setStrategyId(int strategyId) {
     protected void decorateContext(SCMNavigatorContext<?, ?> context) {
         if (context instanceof GitLabSCMNavigatorContext) {
             GitLabSCMNavigatorContext ctx = (GitLabSCMNavigatorContext) context;
-            ctx.withProjectNamingStrategy(strategyId);
+            ctx.withProjectNamingStrategy(getStrategyId());
         }
     }
 
@@ -75,6 +75,8 @@ public ListBoxModel doFillStrategyIdItems() {
             ListBoxModel result = new ListBoxModel();
             result.add(Messages.ProjectNamingStrategyTrait_fullProjectPath(), "1");
             result.add(Messages.ProjectNamingStrategyTrait_projectName(), "2");
+            result.add(Messages.ProjectNamingStrategyTrait_contextualProjectPath(), "3");
+            result.add(Messages.ProjectNamingStrategyTrait_simpleProjectPath(), "4");
             return result;
         }
     }

src/main/java/io/jenkins/plugins/gitlabbranchsource/helpers/GitLabPipelineStatusNotifier.java

@@ -266,26 +266,23 @@ private static void sendNotifications(Run<?, ?> build, TaskListener listener) {
         status.setTargetUrl(url);
 
         if (Result.SUCCESS.equals(result)) {
-            status.setDescription(build.getParent().getFullName() + ": This commit looks good");
+            status.setDescription(build.toString() + ": This commit looks good.");
             status.setStatus("SUCCESS");
             state = Constants.CommitBuildState.SUCCESS;
         } else if (Result.UNSTABLE.equals(result)) {
-            status.setDescription(
-                build.getParent().getFullName() + ": This commit has test failures");
+            status.setDescription(build.toString() + ": This commit is unstable with partial failure.");
             status.setStatus("FAILED");
             state = Constants.CommitBuildState.FAILED;
         } else if (Result.FAILURE.equals(result)) {
-            status.setDescription(
-                build.getParent().getFullName() + ": There was a failure building this commit");
+            status.setDescription(build.toString() + ": There was a failure building this commit.");
             status.setStatus("FAILED");
             state = Constants.CommitBuildState.FAILED;
         } else if (result != null) { // ABORTED, NOT_BUILT.
-            status.setDescription(build.getParent().getFullName()
-                + ": Something is wrong with the build of this commit");
+            status.setDescription(build.toString() + ": Something is wrong with the build of this commit.");
             status.setStatus("CANCELED");
             state = Constants.CommitBuildState.CANCELED;
         } else {
-            status.setDescription(build.getParent().getFullName() + ": Build started...");
+            status.setDescription(build.toString() + ": Build started...");
             status.setStatus("RUNNING");
             state = Constants.CommitBuildState.RUNNING;
         }

src/main/resources/index.jelly

@@ -1,4 +1,4 @@
 <?jelly escape-by-default='true'?>
 <div>
-  Provides branch source and folder organisation functionality for GitLab Repositories in Jenkins
+  Provides branch source and folder organization functionality for GitLab Repositories in Jenkins
 </div>

src/main/resources/io/jenkins/plugins/gitlabbranchsource/Messages.properties

@@ -18,6 +18,8 @@ ForkMergeRequestDiscoveryTrait.permissionsDisplayName=Trusted Members
 GitLabTagSCMHead.Pronoun=Tag
 ProjectNamingStrategyTrait.displayName=Project Naming Strategy
 ProjectNamingStrategyTrait.fullProjectPath=Full Project Path
+ProjectNamingStrategyTrait.contextualProjectPath=Contextual Project Path
+ProjectNamingStrategyTrait.simpleProjectPath=Simple Project Path
 ProjectNamingStrategyTrait.projectName=Project Name
 SubGroupProjectDiscoveryTrait.displayName=Discover subgroup projects
 TagDiscoveryTrait.authorityDisplayName=Trust origin tags

src/main/resources/io/jenkins/plugins/gitlabbranchsource/ProjectNamingStrategyTrait/help-strategyId.html

@@ -3,17 +3,44 @@
   <dl>
     <dt>Full Project Path</dt>
     <dd>
-      This option will use the full project path for the group and project. Example:
-      my-group/my-project
-      my-group/other-project
-      my-group/my-subgroup/third-project
+      This option will use the full project path for the group and project. 
+      Examples:
+      <ul>
+      	<li><code><mark>my-group/</mark>my-project</code></li>
+	      <li><code><mark>my-group/</mark>other-project</code></li>
+	      <li><code><mark>my-group/my-subgroup/</mark>third-project</code></li>
+	  </ul>
     </dd>
     <dt>Project Name</dt>
     <dd>
-      This option will use project names from GitLab project name. Example:
-      My Project
-      Other project
-      My Subgroup / Third project
+      This option will use project <b>names</b> from GitLab project name. 
+      This is the "friendly" name of the project and could contain capitalization, spaces or other special characters. 
+      Examples:
+      <ul>
+      	<li>My Project</li>
+	      <li>Other project</li>
+	      <li>My Subgroup / Third project</li>
+	  </ul>
+    </dd>
+    <dt>Contextual Project Path</dt>
+    <dd>
+      This option will use the project path with nested groups, but not the top-level <code>owner</code> segment specified on the Jenkins pipeline. 
+      Examples where <code>owner</code> on pipeline has been set to "my-group":
+      <ul>
+	      <li><code>my-project</code></li>
+	      <li><code>other-project</code></li>
+	      <li><code><mark>my-subgroup/</mark>third-project</code></li>
+	  </ul>
+    </dd>
+    <dt>Simple Project Path</dt>
+    <dd>
+      This option will use the project path with <i>no</i> parent group information added. 
+      Examples:
+      <ul>
+	      <li><code>my-project</code></li>
+	      <li><code>other-project</code></li>
+	      <li><code>third-project</code></li>
+	  </ul>
     </dd>
   </dl>
 </div>