SONAR-14461 main branch detection

2 files changed, 175 insertions, 0 deletions

diff --git a/sonar-scanner-engine/src/test/java/org/sonar/scanner/report/MetadataPublisherTest.java b/sonar-scanner-engine/src/test/java/org/sonar/scanner/report/MetadataPublisherTest.java
index a7bda1c9992..d38a149a668 100644
--- a/sonar-scanner-engine/src/test/java/org/sonar/scanner/report/MetadataPublisherTest.java
+++ b/sonar-scanner-engine/src/test/java/org/sonar/scanner/report/MetadataPublisherTest.java
@@ -286,4 +286,49 @@ public class MetadataPublisherTest {
     ScannerReport.Metadata metadata = reader.readMetadata();
     assertThat(metadata.getRelativePathFromScmRoot()).isEmpty();
   }
+
+  @Test
+  public void addMainBranch_givenDefaultMainBranchSet_writeItToMetadata() throws IOException {
+    ScmProvider scmProvider = mock(ScmProvider.class);
+    when(scmProvider.getMainBranch(any())).thenReturn("Main");
+    when(scmProvider.relativePathFromScmRoot(any())).thenReturn(mock(Path.class));
+    when(scmConfiguration.provider()).thenReturn(scmProvider);
+
+    File outputDir = temp.newFolder();
+    underTest.publish(new ScannerReportWriter(outputDir));
+
+    ScannerReportReader reader = new ScannerReportReader(outputDir);
+    ScannerReport.Metadata metadata = reader.readMetadata();
+    assertThat(metadata.getGitDefaultMainBranch()).isEqualTo("Main");
+  }
+
+  @Test
+  public void addMainBranch_givenEmptyDefaultMainBranchSet_emptyDefaultMainBranchInMetadata() throws IOException {
+    ScmProvider scmProvider = mock(ScmProvider.class);
+    when(scmProvider.getMainBranch(any())).thenReturn("");
+    when(scmProvider.relativePathFromScmRoot(any())).thenReturn(mock(Path.class));
+    when(scmConfiguration.provider()).thenReturn(scmProvider);
+
+    File outputDir = temp.newFolder();
+    underTest.publish(new ScannerReportWriter(outputDir));
+
+    ScannerReportReader reader = new ScannerReportReader(outputDir);
+    ScannerReport.Metadata metadata = reader.readMetadata();
+    assertThat(metadata.getGitDefaultMainBranch()).isEmpty();
+  }
+
+  @Test
+  public void addMainBranch_givenNullMainBranchSet_emptyDefaultMainBranchInMetadata() throws IOException {
+    ScmProvider scmProvider = mock(ScmProvider.class);
+    when(scmProvider.getMainBranch(any())).thenReturn(null);
+    when(scmProvider.relativePathFromScmRoot(any())).thenReturn(mock(Path.class));
+    when(scmConfiguration.provider()).thenReturn(scmProvider);
+
+    File outputDir = temp.newFolder();
+    underTest.publish(new ScannerReportWriter(outputDir));
+
+    ScannerReportReader reader = new ScannerReportReader(outputDir);
+    ScannerReport.Metadata metadata = reader.readMetadata();
+    assertThat(metadata.getGitDefaultMainBranch()).isEmpty();
+  }
 }
diff --git a/sonar-scanner-engine/src/test/java/org/sonar/scm/git/GitScmProviderTest.java b/sonar-scanner-engine/src/test/java/org/sonar/scm/git/GitScmProviderTest.java
index 4efb0ddcb33..4a9a6121aa9 100644
--- a/sonar-scanner-engine/src/test/java/org/sonar/scm/git/GitScmProviderTest.java
+++ b/sonar-scanner-engine/src/test/java/org/sonar/scm/git/GitScmProviderTest.java
@@ -39,15 +39,19 @@ import java.util.Random;
 import java.util.Set;
 import java.util.TimeZone;
 import java.util.concurrent.atomic.AtomicInteger;
+
+import org.eclipse.jgit.api.CreateBranchCommand;
 import org.eclipse.jgit.api.DiffCommand;
 import org.eclipse.jgit.api.Git;
 import org.eclipse.jgit.api.errors.GitAPIException;
 import org.eclipse.jgit.lib.ObjectId;
 import org.eclipse.jgit.lib.PersonIdent;
+import org.eclipse.jgit.lib.Ref;
 import org.eclipse.jgit.lib.RefDatabase;
 import org.eclipse.jgit.lib.Repository;
 import org.eclipse.jgit.revwalk.RevCommit;
 import org.eclipse.jgit.storage.file.FileRepositoryBuilder;
+import org.eclipse.jgit.transport.URIish;
 import org.eclipse.jgit.treewalk.AbstractTreeIterator;
 import org.junit.Before;
 import org.junit.Rule;
@@ -732,6 +736,132 @@ public class GitScmProviderTest {
     assertThat(provider.revisionId(projectDir)).isNull();
   }
 
+  @Test
+  public void getMainBranch_givenRepoWithOneBranchCalledMain_returnMainBranchCalledMain() throws Exception {
+    //given
+    worktree = temp.newFolder().toPath();
+    Repository repo = FileRepositoryBuilder.create(worktree.resolve(".git").toFile());
+    repo.create();
+    git = new Git(repo);
+
+    addBranchInConfig("Main");
+
+    Path projectDir = worktree.resolve("project");
+    Files.createDirectory(projectDir);
+
+    GitScmProvider provider = newGitScmProvider();
+
+    //when
+    String mainBranch = provider.getMainBranch(projectDir);
+
+    //then
+    assertThat(mainBranch).isEqualTo("Main");
+  }
+
+  @Test
+  public void getMainBranch_givenRepoWithTwoBranches_returnFirstBranch() throws Exception {
+    //given
+    worktree = temp.newFolder().toPath();
+    Repository repo = FileRepositoryBuilder.create(worktree.resolve(".git").toFile());
+    repo.create();
+    git = new Git(repo);
+
+    addBranchInConfig("First");
+    addBranchInConfig("Second");
+
+    Path projectDir = worktree.resolve("project");
+    Files.createDirectory(projectDir);
+
+    GitScmProvider provider = newGitScmProvider();
+
+    //when
+    String mainBranch = provider.getMainBranch(projectDir);
+
+    //then
+    assertThat(mainBranch).isEqualTo("First");
+  }
+
+  @Test
+  public void getMainBranch_givenNoBranches_dontThrowException() throws Exception {
+    //given
+    worktree = temp.newFolder().toPath();
+    Repository repo = FileRepositoryBuilder.create(worktree.resolve(".git").toFile());
+    repo.create();
+    git = new Git(repo);
+
+    Path projectDir = worktree.resolve("project");
+    Files.createDirectory(projectDir);
+
+    GitScmProvider provider = newGitScmProvider();
+
+    //when
+    String mainBranch = provider.getMainBranch(projectDir);
+
+    //then no exception
+    assertThat(mainBranch).isNullOrEmpty();
+  }
+
+  @Test
+  public void getMainBranch_givenRepositoryNotFoundExceptionWhenBuildingRepo_returnNull() throws Exception {
+    //given
+
+    worktree = temp.newFolder().toPath();
+    Repository repo = FileRepositoryBuilder.create(worktree.resolve(".git").toFile());
+    repo.create();
+    git = new Git(repo);
+    repo.getObjectDatabase().close(); //This is here to force RepositoryBuilder to throw subclass of IOException
+
+    Path projectDir = worktree.resolve("project");
+    Files.createDirectory(projectDir);
+
+    GitScmProvider provider = newGitScmProvider();
+
+    //when
+    String mainBranch = provider.getMainBranch(projectDir);
+
+    //then no exception
+    assertThat(mainBranch).isNullOrEmpty();
+  }
+
+  @Test
+  public void getMainBranch_givenIOExceptionWhenBuildingRepo_returnNull() throws Exception {
+    //given
+
+    worktree = temp.newFolder().toPath();
+    Repository repo = FileRepositoryBuilder.create(worktree.resolve(".git").toFile());
+    repo.create();
+    git = new Git(repo);
+
+    Path projectDir = worktree.resolve("project");
+    Files.createDirectory(projectDir);
+
+    GitScmProvider provider = new GitScmProvider(mockCommand(), analysisWarnings, gitIgnoreCommand, system2) {
+      @Override
+      Repository buildRepo(Path basedir) throws IOException {
+        throw new IOException();
+      }
+    };
+
+    //when
+    String mainBranch = provider.getMainBranch(projectDir);
+
+    //then no exception
+    assertThat(mainBranch).isNullOrEmpty();
+  }
+
+  /**
+   * Normally after cloning the repository we would have at least one
+   * branch it git config. This method adds these branches without
+   * cloning any repository (because unit tests ought to be fast)
+   */
+  private void addBranchInConfig(String ... branches) throws IOException {
+    for(String branch : branches) {
+      git.getRepository().getConfig().setStringList("branch", branch, "remote", Arrays.asList("origin"));
+      git.getRepository().getConfig().setStringList("branch", branch, "merge", Arrays.asList("refs/head/" + branch));
+    }
+    git.getRepository().getConfig().save();
+  }
+
   private String randomizedContent(String prefix, int numLines) {
     StringBuilder sb = new StringBuilder();
     for (int line = 0; line < numLines; line++) {