SCMSourceRetrieverTest: complete the checkDefaultVersion_MBPsingleBranch_*() cases [JENKINS-69731]

Author: jimklimov

src/test/java/org/jenkinsci/plugins/workflow/libs/SCMSourceRetrieverTest.java

@@ -52,7 +52,9 @@
 import java.util.List;
 import java.util.TreeMap;
 import hudson.util.DescribableList;
+import jenkins.branch.BranchProperty;
 import jenkins.branch.BranchSource;
+import jenkins.branch.DefaultBranchPropertyStrategy;
 import jenkins.plugins.git.GitSCMSource;
 import jenkins.plugins.git.GitSampleRepoRule;
 import jenkins.scm.api.SCMHead;
@@ -569,14 +571,10 @@ public class SCMSourceRetrieverTest {
     }
 
     @Issue("JENKINS-69731")
-    //@Ignore("Need help setting up MBP+SingleSCMSource")
     @Test public void checkDefaultVersion_MBPsingleBranch_staticStrings() throws Exception {
-        // FAILS: Setup below does not instantiate any jobs!
-        // (expected one for "feature")
-
         // Test that lc.setAllowBRANCH_NAME(false) does not
         // preclude fixed branch names (they should work),
-        // like @Library('branchylib@master') when used
+        // like @Library('branchylib@feature') when used
         // for MBP with "Single repository and branch" as
         // the SCM source.
 
@@ -612,41 +610,45 @@ public class SCMSourceRetrieverTest {
         sampleRepo2.git("add", "Jenkinsfile");
         sampleRepo2.git("commit", "--message=bogus");
 
-        // TODO: Test also another MBP where we would
-        // set options "List of branches to build" and
-        // "Branch Specifier" to a different value than
-        // the "name" of branchSource. While the "name"
-        // becomes "BRANCH_NAME" envvar (and MBP job name
-        // generated for the branch), the specifier is
-        // what gets placed into SCMs list.
-
-        // FAILS: Setup below does not instantiate any jobs!
-        // (expected one for "feature")
         WorkflowMultiBranchProject mbp = r.jenkins.createProject(WorkflowMultiBranchProject.class, "mbp");
-        //GitSCM gitSCM = new GitSCM(sampleRepo2.toString());
         GitSCM gitSCM = new GitSCM(
                 GitSCM.createRepoList(sampleRepo2.toString(), null),
                 Collections.singletonList(new BranchSpec("*/feature")),
                 null, null, Collections.emptyList());
-        BranchSource branchSource = new BranchSource(new SingleSCMSource("feature-id", "feature", gitSCM));
-        mbp.getSourcesList().add(branchSource);
+        // We test an MBP with two leaf jobs where we
+        // set options "List of branches to build"/
+        // "Branch Specifier" to a same and a different
+        // value than the "name" of branchSource.
+        // While the "name" becomes "BRANCH_NAME" envvar
+        // (and MBP job name generated for the branch),
+        // the specifier is what gets placed into SCMs list.
+        BranchSource branchSource1 = new BranchSource(
+                new SingleSCMSource("feature-id1", "feature", gitSCM),
+                new DefaultBranchPropertyStrategy(new BranchProperty[0]));
+        BranchSource branchSource2 = new BranchSource(
+                new SingleSCMSource("feature-id2", "featurette", gitSCM),
+                new DefaultBranchPropertyStrategy(new BranchProperty[0]));
+        mbp.getSourcesList().add(branchSource1);
+        mbp.getSourcesList().add(branchSource2);
         mbp.save();
-        // Note: this notification causes discovery of branches,
-        // definition of MBP "leaf" jobs, and launch of builds,
-        // so below we just make sure they complete and analyze
-        // the outcomes.
+        // Rescan to actually define leaf jobs:
+        mbp.scheduleBuild(0);
         sampleRepo2.notifyCommit(r);
         r.waitUntilNoActivity();
+        System.out.println("All Jenkins items: " + r.jenkins.getItems().toString());
+        System.out.println("MBP sources: " + mbp.getSourcesList().toString());
+        System.out.println("MBP source 0: " + mbp.getSourcesList().get(0).getSource().toString());
+        System.out.println("MBP source 1: " + mbp.getSourcesList().get(1).getSource().toString());
         System.out.println("Jobs generated by MBP: " + mbp.getItems().toString());
-        assumeFalse("MBP should have generated 'feature' pipeline job", mbp.getItems().isEmpty());
+        assumeFalse("MBP should have generated 'feature' and 'featurette' pipeline job", mbp.getItems().size() != 2);
 
         // In case of MBP with "Single repository and branch"
-        // it only defines one job, so those for other branches
-        // should be null:
+        // it only defines one job (per single-branch source),
+        // so those for other known branches should be null:
         WorkflowJob p1 = mbp.getItem("master");
         assertNull(p1);
 
-        WorkflowJob p2 = mbp.getItem("feature-id");
+        WorkflowJob p2 = mbp.getItem("feature");
         assertNotNull(p2);
         WorkflowRun b2 = p2.getLastBuild();
         r.waitForCompletion(b2);
@@ -657,14 +659,28 @@ public class SCMSourceRetrieverTest {
 
         WorkflowJob p3 = mbp.getItem("bogus");
         assertNull(p3);
+
+        // For fixed branch in @Library spec, we see the
+        // SingleSCMSource checkout out the "*/feature"
+        // specified in its GitSCM and so request the
+        // @Library('branchylib@feature') spelled there.
+        // And then MBP sets BRANCH_NAME='featurette'
+        // (and leaf job) per SingleSCMSource "name".
+        WorkflowJob p4 = mbp.getItem("featurette");
+        assertNotNull(p4);
+        WorkflowRun b4 = p4.getLastBuild();
+        r.waitForCompletion(b4);
+        assertFalse(p4.isBuilding());
+        r.assertBuildStatusSuccess(b4);
+        System.out.println("Envvar BRANCH_NAME set into 'featurette' job: " + b4.getEnvironment().get("BRANCH_NAME"));
+        // We use same gitSCM source, and so same static
+        // version of the library:
+        r.assertLogContains("Loading library branchylib@feature", b4);
+        r.assertLogContains("something very special", b4);
     }
 
     @Issue("JENKINS-69731")
-    //@Ignore("Need help setting up MBP+SingleSCMSource")
     @Test public void checkDefaultVersion_MBPsingleBranch_BRANCH_NAME() throws Exception {
-        // FAILS: Setup below does not instantiate any jobs!
-        // (expected one for "feature")
-
         // Test that @Library('branchylib@${BRANCH_NAME}') works
         // also for MBP with "Single repository and branch" as
         // the SCM source.
@@ -682,7 +698,7 @@ public class SCMSourceRetrieverTest {
         lc.setDefaultVersion("master");
         lc.setIncludeInChangesets(false);
         lc.setAllowVersionOverride(true);
-        lc.setAllowBRANCH_NAME(false);
+        lc.setAllowBRANCH_NAME(true);
         lc.setTraceDefaultedVersion(true);
         GlobalLibraries.get().setLibraries(Collections.singletonList(lc));
 
@@ -695,37 +711,41 @@ public class SCMSourceRetrieverTest {
         sampleRepo2.git("branch", "feature");
         sampleRepo2.git("branch", "bogus");
 
-        // TODO: Test also another MBP where we would
-        // set options "List of branches to build" and
-        // "Branch Specifier" to a different value than
-        // the "name" of branchSource. While the "name"
-        // becomes "BRANCH_NAME" envvar (and MBP job name
-        // generated for the branch), the specifier is
-        // what gets placed into SCMs list.
-
-        // FAILS: Setup below does not instantiate any jobs!
-        // (expected one for "feature")
         WorkflowMultiBranchProject mbp = r.jenkins.createProject(WorkflowMultiBranchProject.class, "mbp");
-        //GitSCM gitSCM = new GitSCM(sampleRepo2.toString());
         GitSCM gitSCM = new GitSCM(
                 GitSCM.createRepoList(sampleRepo2.toString(), null),
                 Collections.singletonList(new BranchSpec("*/feature")),
                 null, null, Collections.emptyList());
-        BranchSource branchSource = new BranchSource(new SingleSCMSource("feature", "feature", gitSCM));
-        mbp.getSourcesList().add(branchSource);
+        // We test an MBP with two leaf jobs where we
+        // set options "List of branches to build"/
+        // "Branch Specifier" to a same and a different
+        // value than the "name" of branchSource.
+        // While the "name" becomes "BRANCH_NAME" envvar
+        // (and MBP job name generated for the branch),
+        // the specifier is what gets placed into SCMs list.
+        BranchSource branchSource1 = new BranchSource(
+                new SingleSCMSource("feature-id1", "feature", gitSCM),
+                new DefaultBranchPropertyStrategy(new BranchProperty[0]));
+        BranchSource branchSource2 = new BranchSource(
+                new SingleSCMSource("feature-id2", "featurette", gitSCM),
+                new DefaultBranchPropertyStrategy(new BranchProperty[0]));
+        mbp.getSourcesList().add(branchSource1);
+        mbp.getSourcesList().add(branchSource2);
         mbp.save();
-        // Note: this notification causes discovery of branches,
-        // definition of MBP "leaf" jobs, and launch of builds,
-        // so below we just make sure they complete and analyze
-        // the outcomes.
+        // Rescan to actually define leaf jobs:
+        mbp.scheduleBuild(0);
         sampleRepo2.notifyCommit(r);
         r.waitUntilNoActivity();
+        System.out.println("All Jenkins items: " + r.jenkins.getItems().toString());
+        System.out.println("MBP sources: " + mbp.getSourcesList().toString());
+        System.out.println("MBP source 0: " + mbp.getSourcesList().get(0).getSource().toString());
+        System.out.println("MBP source 1: " + mbp.getSourcesList().get(1).getSource().toString());
         System.out.println("Jobs generated by MBP: " + mbp.getItems().toString());
-        assumeFalse("MBP should have generated 'feature' pipeline job", mbp.getItems().isEmpty());
+        assumeFalse("MBP should have generated 'feature' and 'featurette' pipeline job", mbp.getItems().size() != 2);
 
         // In case of MBP with "Single repository and branch"
-        // it only defines one job, so those for other branches
-        // should be null:
+        // it only defines one job (per single-branch source),
+        // so those for other known branches should be null:
         WorkflowJob p1 = mbp.getItem("master");
         assertNull(p1);
 
@@ -740,6 +760,34 @@ public class SCMSourceRetrieverTest {
 
         WorkflowJob p3 = mbp.getItem("bogus");
         assertNull(p3);
+
+        // For fixed branch in @Library spec, we see the
+        // SingleSCMSource checkout out the "*/feature"
+        // specified in its GitSCM and so evaluate the
+        // @Library('branchylib@${BRANCH_NAME}')...
+        // And then MBP sets BRANCH_NAME='featurette'
+        // (and leaf job) per SingleSCMSource "name".
+        WorkflowJob p4 = mbp.getItem("featurette");
+        assertNotNull(p4);
+        WorkflowRun b4 = p4.getLastBuild();
+        r.waitForCompletion(b4);
+        assertFalse(p4.isBuilding());
+        r.assertBuildStatusSuccess(b4);
+        System.out.println("Envvar BRANCH_NAME set into 'featurette' job: " + b4.getEnvironment().get("BRANCH_NAME"));
+        // Library does not have a "featurette" branch,
+        // so if that source were tried according to the
+        // single-branch source name, should fall back
+        // to "master". But if it were tried according
+        // to the actual branch of pipeline script, it
+        // should use "feature".
+        // For now, I've sided with the MBP plugin which
+        // goes to great lengths to make-believe that
+        // the "name" specified in config is the branch
+        // name (also setting it into the WorkflowJob
+        // BranchJobProperty), even if it does not exist
+        // in actual SCM.
+        r.assertLogContains("Loading library branchylib@master", b4);
+        r.assertLogContains("something special", b4);
     }
 
     @Issue("JENKINS-69731")