Merge branch 'master' into simplify-rate-limit-queue-check

Author: jglick

pom.xml

@@ -29,7 +29,7 @@
   <parent>
     <groupId>org.jenkins-ci.plugins</groupId>
     <artifactId>plugin</artifactId>
-    <version>4.66</version>
+    <version>4.68</version>
     <relativePath/>
   </parent>
 

src/main/java/jenkins/branch/MultiBranchProjectDisplayNamingStrategy.java

@@ -24,6 +24,7 @@
 package jenkins.branch;
 
 import edu.umd.cs.findbugs.annotations.NonNull;
+import java.util.Objects;
 import jenkins.scm.api.metadata.ObjectMetadataAction;
 import org.jvnet.localizer.Localizable;
 
@@ -42,7 +43,7 @@ public enum MultiBranchProjectDisplayNamingStrategy {
     OBJECT_DISPLAY_NAME(true, Messages._MultiBranchProjectDisplayNamingTrait_DisplayName()) {
         @Override
         public String generateName(@NonNull final String rawName, final String displayName) {
-            return displayName;
+            return isBlank(displayName) ? rawName : displayName;
         }
     },
     /**
@@ -51,7 +52,15 @@ public String generateName(@NonNull final String rawName, final String displayNa
     RAW_AND_OBJECT_DISPLAY_NAME(true, Messages._MultiBranchProjectDisplayNamingTrait_RawAndDisplayName()) {
         @Override
         public String generateName(@NonNull final String rawName, final String displayName) {
-            return isBlank(displayName) ? rawName : format("%s: %s", rawName, displayName);
+            if (isBlank(displayName)) {
+                return rawName;
+            }
+
+            if (Objects.equals(rawName, displayName)) {
+                return rawName;
+            }
+
+            return format("%s - %s", rawName, displayName);
         }
     },
     ;
@@ -67,6 +76,7 @@ public String generateName(@NonNull final String rawName, final String displayNa
     public boolean needsObjectDisplayName() {
         return needsObjectDisplayName;
     }
+
     public String getDisplayName() {
         return displayName.toString();
     }

src/main/resources/jenkins/branch/MultiBranchProjectDisplayNamingTrait/help-displayNamingStrategy.html

@@ -1,13 +1,23 @@
 <div>
-    The different strategies:
-    <ul>
-        <li>
-            <strong>Object display name:</strong>
-            <span>Uses the branch source plugin's display name for the PR instead of the raw name</span>
-        </li>
-        <li>
-            <strong>Raw and object display name:</strong>
-            <span>Joins the raw name and the branch source plugin's display name</span>
-        </li>
-    </ul>
+  The different strategies:
+  <ul>
+    <li>
+      <p>
+        <strong>Job display name with fallback to name:</strong>
+        <br>
+        Uses the branch source plugin's display name for the PR instead of the raw name
+        <br>
+        Value for configuration-as-code: <code>OBJECT_DISPLAY_NAME</code>
+      </p>
+    </li>
+    <li>
+      <p>
+        <strong>Name and, if available, display name:</strong>
+        <br>
+        Joins the raw name and the branch source plugin's display name
+        <br>
+        Value for configuration-as-code: <code>RAW_AND_OBJECT_DISPLAY_NAME</code>
+      </p>
+    </li>
+  </ul>
 </div>

src/test/java/jenkins/branch/ProjectNamingStrategyTest.java

@@ -5,8 +5,8 @@
 import integration.harness.BasicDummyStepBranchProperty;
 import integration.harness.BasicMultiBranchProject;
 import jenkins.model.Jenkins;
-import jenkins.scm.api.SCMSource;
 import jenkins.scm.impl.mock.MockSCMController;
+import jenkins.scm.impl.mock.MockSCMDiscoverBranches;
 import jenkins.scm.impl.mock.MockSCMDiscoverChangeRequests;
 import jenkins.scm.impl.mock.MockSCMSource;
 import org.junit.ClassRule;
@@ -42,12 +42,13 @@ public void testObjectNameStrategy() throws Exception {
 
     public void testNamingStrategy(final MultiBranchProjectDisplayNamingStrategy namingStrategy) throws Exception {
         final Jenkins jenkinsInstance = r.jenkins;
+        final String mainBranch = "master";
         final String projectName = String.format("Project_%s", namingStrategy.name());
 
         try (final MockSCMController mockScm = MockSCMController.create()) {
             mockScm.createRepository(REPO_NAME);
 
-            final Integer crNumber = mockScm.openChangeRequest(REPO_NAME, "master");
+            final Integer crNumber = mockScm.openChangeRequest(REPO_NAME, mainBranch);
             final String crName = String.format("CR-%s", crNumber);
             final String crTitle = String.format("Change request #%s", crNumber);
 
@@ -58,6 +59,7 @@ public void testNamingStrategy(final MultiBranchProjectDisplayNamingStrategy nam
             final MockSCMSource scmSource = new MockSCMSource(
                 mockScm,
                 REPO_NAME,
+                new MockSCMDiscoverBranches(),
                 new MockSCMDiscoverChangeRequests(),
                 new MultiBranchProjectDisplayNamingTrait(namingStrategy)
             );
@@ -67,14 +69,23 @@ public void testNamingStrategy(final MultiBranchProjectDisplayNamingStrategy nam
             project.getSourcesList().add(source);
             r.configRoundtrip(project);
 
+            final FreeStyleProject branchProject = jenkinsInstance.getItemByFullName(
+                String.format("%s/%s", projectName, mainBranch),
+                FreeStyleProject.class
+            );
+
+            final String expectedBranchProjectName = namingStrategy.generateName(mainBranch, "");
+            assertNotNull(branchProject, "No job was created for the main branch");
+            assertEquals(expectedBranchProjectName, branchProject.getDisplayName(), "The job name doesn't match the naming strategy");
+
             final FreeStyleProject crProject = jenkinsInstance.getItemByFullName(
                 String.format("%s/%s", projectName, crName),
                 FreeStyleProject.class
             );
 
-            final String expectedName = namingStrategy.generateName(crName, crTitle);
+            final String expectedCrProjectName = namingStrategy.generateName(crName, crTitle);
             assertNotNull(crProject, "No job was created for the pull request");
-            assertEquals(expectedName, crProject.getDisplayName(), "The job name doesn't match the naming strategy");
+            assertEquals(expectedCrProjectName, crProject.getDisplayName(), "The job name doesn't match the naming strategy");
         }
     }
 }