Organisation Folder Scan - newly discovered repositories are now processed first (#599)

* process new repositories first

* extra safety check + test

Co-authored-by: adam.mitchell <[email protected]>
Co-authored-by: Günter Grodotzki <[email protected]>

Author: 3 people

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMNavigatorRequest.java

@@ -26,9 +26,12 @@
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketRepository;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import java.util.Collection;
+import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import java.util.TreeMap;
+import java.util.stream.Collectors;
 import jenkins.scm.api.SCMNavigator;
 import jenkins.scm.api.SCMSourceObserver;
 import jenkins.scm.api.trait.SCMNavigatorRequest;
@@ -45,6 +48,11 @@ public class BitbucketSCMNavigatorRequest extends SCMNavigatorRequest {
      */
     private final Map<String, BitbucketRepository> repositoryMap = new TreeMap<>();
 
+    /**
+     * keep a reference to the observer so we can cross-reference
+     */
+    private final SCMSourceObserver observer;
+
     /**
      * Constructor.
      *
@@ -56,6 +64,7 @@ protected BitbucketSCMNavigatorRequest(@NonNull SCMNavigator source,
                                            @NonNull BitbucketSCMNavigatorContext context,
                                            @NonNull SCMSourceObserver observer) {
         super(source, context, observer);
+        this.observer = observer;
     }
 
     public void withRepositories(List<? extends BitbucketRepository> repositories) {
@@ -66,7 +75,20 @@ public void withRepositories(List<? extends BitbucketRepository> repositories) {
     }
 
     public Collection<BitbucketRepository> repositories() {
-        return this.repositoryMap.values();
+        final List<String> existingRepositories = this.observer.getContext().getSCMSources().stream()
+                                                               .filter(BitbucketSCMSource.class::isInstance)
+                                                               .map(BitbucketSCMSource.class::cast)
+                                                               .map(BitbucketSCMSource::getRepository)
+                                                               .collect(Collectors.toList());
+        // process new repositories first
+        final Set<BitbucketRepository> newRepositories = this.repositoryMap.entrySet()
+                                                                           .stream()
+                                                                           .filter(e -> !existingRepositories.contains(e.getKey()))
+                                                                           .map(Map.Entry::getValue)
+                                                                           .collect(Collectors.toCollection(LinkedHashSet::new));
+        // add remaining repositories back in. duplicates will be rejected
+        newRepositories.addAll(this.repositoryMap.values());
+        return newRepositories;
     }
 
     public BitbucketRepository getBitbucketRepository(String repositoryName) {

src/test/java/com/cloudbees/jenkins/plugins/bitbucket/SCMNavigatorTest.java

@@ -23,22 +23,26 @@
  */
 package com.cloudbees.jenkins.plugins.bitbucket;
 
+import com.google.common.collect.ImmutableList;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.model.TaskListener;
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import jenkins.scm.api.SCMSource;
 import jenkins.scm.api.SCMSourceObserver;
 import jenkins.scm.api.SCMSourceObserver.ProjectObserver;
 import jenkins.scm.api.SCMSourceOwner;
+import jenkins.scm.impl.NullSCMSource;
 import org.junit.ClassRule;
 import org.junit.Test;
 import org.jvnet.hudson.test.JenkinsRule;
 import org.mockito.Mockito;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.when;
 
 public class SCMNavigatorTest {
 
@@ -52,8 +56,10 @@ public void teamRepositoriesDiscovering() throws IOException, InterruptedExcepti
         BitbucketSCMNavigator navigator = new BitbucketSCMNavigator("myteam", null, null);
         navigator.setPattern("repo(.*)");
         navigator.setBitbucketServerUrl("http://bitbucket.test");
+        final SCMSourceOwner mock = Mockito.mock(SCMSourceOwner.class);
+        when(mock.getSCMSources()).thenReturn(Collections.singletonList(new BitbucketSCMSource("myteam", "repo1")));
         SCMSourceObserverImpl observer = new SCMSourceObserverImpl(BitbucketClientMockUtils.getTaskListenerMock(),
-                Mockito.mock(SCMSourceOwner.class));
+                                                                   mock);
         navigator.visitSources(observer);
 
         assertEquals("myteam", navigator.getRepoOwner());
@@ -62,8 +68,44 @@ public void teamRepositoriesDiscovering() throws IOException, InterruptedExcepti
         List<String> observed = observer.getObserved();
         // Only 2 repositories match the pattern
         assertEquals("There must be 2 repositories in the team", 2, observed.size());
-        assertEquals("repo1", observed.get(0));
-        assertEquals("repo2", observed.get(1));
+        assertEquals("repo2 should be first", "repo2", observed.get(0));
+        assertEquals("repo1 should be second", "repo1", observed.get(1));
+
+        List<ProjectObserver> observers = observer.getProjectObservers();
+        for (ProjectObserver obs : observers) {
+            List<SCMSource> sources = ((SCMSourceObserverImpl.ProjectObserverImpl) obs).getSources();
+            // It should contain only one source
+            assertEquals("Only one source must be created per observed repository", 1, sources.size());
+            SCMSource scmSource = sources.get(0);
+            assertTrue("BitbucketSCMSource instances must be added", scmSource instanceof BitbucketSCMSource);
+            // Check correct repoOwner (team name in this case) was set
+            assertEquals(((BitbucketSCMSource) scmSource).getRepoOwner(), "myteam");
+        }
+    }
+
+    @Test
+    public void teamRepositoriesDiscoveringNullSource() throws IOException, InterruptedException {
+        BitbucketMockApiFactory.add("http://bitbucket.test",
+                                    BitbucketClientMockUtils.getAPIClientMock(true, false));
+        BitbucketSCMNavigator navigator = new BitbucketSCMNavigator("myteam", null, null);
+        navigator.setPattern("repo(.*)");
+        navigator.setBitbucketServerUrl("http://bitbucket.test");
+        final SCMSourceOwner mock = Mockito.mock(SCMSourceOwner.class);
+        when(mock.getSCMSources())
+        .thenReturn(ImmutableList.of(new BitbucketSCMSource("myteam", "repo1"),
+                                     new NullSCMSource()));
+        SCMSourceObserverImpl observer = new SCMSourceObserverImpl(BitbucketClientMockUtils.getTaskListenerMock(),
+                                                                   mock);
+        navigator.visitSources(observer);
+
+        assertEquals("myteam", navigator.getRepoOwner());
+        assertEquals("repo(.*)", navigator.getPattern());
+
+        List<String> observed = observer.getObserved();
+        // Only 2 repositories match the pattern
+        assertEquals("There must be 2 repositories in the team", 2, observed.size());
+        assertEquals("repo2 should be first", "repo2", observed.get(0));
+        assertEquals("repo1 should be second", "repo1", observed.get(1));
 
         List<ProjectObserver> observers = observer.getProjectObservers();
         for (ProjectObserver obs : observers) {