Add branch to changeset collections

Branch information is added to a changeset collection and therefore
removed from single changesets for git repositories. Mercurial
repositories now also set the default branch in changesets.

scm-core/src/main/java/sonia/scm/repository/ChangesetPagingResult.java

@@ -82,6 +82,22 @@ public class ChangesetPagingResult implements Iterable<Changeset>, Serializable
   {
     this.total = total;
     this.changesets = changesets;
+    this.branchName = null;
+  }
+
+  /**
+   * Constructs a new changeset paging result for a specific branch.
+   *
+   *
+   * @param total total number of changesets
+   * @param changesets current list of fetched changesets
+   * @param branchName branch name this result was created for
+   */
+  public ChangesetPagingResult(int total, List<Changeset> changesets, String branchName)
+  {
+    this.total = total;
+    this.changesets = changesets;
+    this.branchName = branchName;
   }
 
   //~--- methods --------------------------------------------------------------
@@ -158,6 +174,7 @@ public class ChangesetPagingResult implements Iterable<Changeset>, Serializable
     return MoreObjects.toStringHelper(this)
                   .add("changesets", changesets)
                   .add("total", total)
+                  .add("branch", branchName)
                   .toString();
     //J+
   }
@@ -186,37 +203,35 @@ public class ChangesetPagingResult implements Iterable<Changeset>, Serializable
     return total;
   }
 
-  //~--- set methods ----------------------------------------------------------
+  void setChangesets(List<Changeset> changesets)
-
-  /**
-   * Sets the current list of changesets.
-   *
-   *
-   * @param changesets current list of changesets
-   */
-  public void setChangesets(List<Changeset> changesets)
   {
     this.changesets = changesets;
   }
 
-  /**
+  void setTotal(int total)
-   * Sets the total number of changesets
-   *
-   *
-   * @param total total number of changesets
-   */
-  public void setTotal(int total)
   {
     this.total = total;
   }
 
+  void setBranchName(String branchName) {
+    this.branchName = branchName;
+  }
+
+  /**
+   * Returns the branch name this result was created for. This can either be an explicit branch ("give me all
+   * changesets for branch xyz") or an implicit one ("give me the changesets for the default").
+   */
+  public String getBranchName() {
+    return branchName;
+  }
+
   //~--- fields ---------------------------------------------------------------
 
-  /** current list of changesets */
   @XmlElement(name = "changeset")
   @XmlElementWrapper(name = "changesets")
   private List<Changeset> changesets;
 
-  /** total number of changesets */
   private int total;
+
+  private String branchName;
 }

scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitChangesetConverter.java

@@ -39,7 +39,6 @@ import com.google.common.collect.Lists;
 import com.google.common.collect.Multimap;
 import org.eclipse.jgit.lib.ObjectId;
 import org.eclipse.jgit.lib.PersonIdent;
-import org.eclipse.jgit.lib.Ref;
 import org.eclipse.jgit.revwalk.RevCommit;
 import org.eclipse.jgit.revwalk.RevWalk;
 import org.eclipse.jgit.treewalk.TreeWalk;
@@ -51,8 +50,8 @@ import java.io.Closeable;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.List;
-import java.util.Set;
 
 //~--- JDK imports ------------------------------------------------------------
 
@@ -130,27 +129,9 @@ public class GitChangesetConverter implements Closeable
    *
    * @throws IOException
    */
-  public Changeset createChangeset(RevCommit commit) throws IOException
+  public Changeset createChangeset(RevCommit commit)
   {
-    List<String> branches = Lists.newArrayList();
+    return createChangeset(commit, Collections.emptyList());
-    Set<Ref> refs = repository.getAllRefsByPeeledObjectId().get(commit.getId());
-
-    if (Util.isNotEmpty(refs))
-    {
-
-      for (Ref ref : refs)
-      {
-        String branch = GitUtil.getBranch(ref);
-
-        if (branch != null)
-        {
-          branches.add(branch);
-        }
-      }
-
-    }
-
-    return createChangeset(commit, branches);
   }
 
   /**
@@ -165,7 +146,6 @@ public class GitChangesetConverter implements Closeable
    * @throws IOException
    */
   public Changeset createChangeset(RevCommit commit, String branch)
-    throws IOException
   {
     return createChangeset(commit, Lists.newArrayList(branch));
   }
@@ -183,7 +163,6 @@ public class GitChangesetConverter implements Closeable
    * @throws IOException
    */
   public Changeset createChangeset(RevCommit commit, List<String> branches)
-    throws IOException
   {
     String id = commit.getId().name();
     List<String> parentList = null;

scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/AbstractGitCommand.java

@@ -34,7 +34,6 @@ package sonia.scm.repository.spi;
 
 //~--- non-JDK imports --------------------------------------------------------
 
-import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Strings;
 import org.eclipse.jgit.lib.Repository;
 
@@ -98,6 +97,14 @@ public class AbstractGitCommand
     return commit;
   }
 
+  protected String getBranchNameOrDefault(String requestedBranch) {
+    if ( Strings.isNullOrEmpty(requestedBranch) ) {
+      return getDefaultBranchName();
+    } else {
+      return requestedBranch;
+    }
+  }
+
   protected ObjectId getBranchOrDefault(Repository gitRepository, String requestedBranch) throws IOException {
     ObjectId head;
     if ( Strings.isNullOrEmpty(requestedBranch) ) {
@@ -108,6 +115,15 @@ public class AbstractGitCommand
     return head;
   }
 
+  protected String getDefaultBranchName() {
+    String defaultBranchName = repository.getProperty(GitConstants.PROPERTY_DEFAULT_BRANCH);
+    if (!Strings.isNullOrEmpty(defaultBranchName)) {
+      return defaultBranchName;
+    } else {
+      return null;
+    }
+  }
+
   protected ObjectId getDefaultBranch(Repository gitRepository) throws IOException {
     ObjectId head;
     String defaultBranchName = repository.getProperty(GitConstants.PROPERTY_DEFAULT_BRANCH);

scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/spi/GitLogCommand.java

@@ -170,8 +170,8 @@ public class GitLogCommand extends AbstractGitCommand implements LogCommand
     GitChangesetConverter converter = null;
     RevWalk revWalk = null;
 
-    try (org.eclipse.jgit.lib.Repository gr = open()) {
+    try (org.eclipse.jgit.lib.Repository repository = open()) {
-      if (!gr.getAllRefs().isEmpty()) {
+      if (!repository.getAllRefs().isEmpty()) {
         int counter = 0;
         int start = request.getPagingStart();
 
@@ -188,18 +188,18 @@ public class GitLogCommand extends AbstractGitCommand implements LogCommand
         ObjectId startId = null;
 
         if (!Strings.isNullOrEmpty(request.getStartChangeset())) {
-          startId = gr.resolve(request.getStartChangeset());
+          startId = repository.resolve(request.getStartChangeset());
         }
 
         ObjectId endId = null;
 
         if (!Strings.isNullOrEmpty(request.getEndChangeset())) {
-          endId = gr.resolve(request.getEndChangeset());
+          endId = repository.resolve(request.getEndChangeset());
         }
 
-        revWalk = new RevWalk(gr);
+        revWalk = new RevWalk(repository);
 
-        converter = new GitChangesetConverter(gr, revWalk);
+        converter = new GitChangesetConverter(repository, revWalk);
 
         if (!Strings.isNullOrEmpty(request.getPath())) {
           revWalk.setTreeFilter(
@@ -207,7 +207,8 @@ public class GitLogCommand extends AbstractGitCommand implements LogCommand
               PathFilter.create(request.getPath()), TreeFilter.ANY_DIFF));
         }
 
-        ObjectId head = getBranchOrDefault(gr, request.getBranch());
+        ObjectId head = getBranchOrDefault(repository, request.getBranch());
+        String branch = getBranchNameOrDefault(request.getBranch());
 
         if (head != null) {
           if (startId != null) {
@@ -234,10 +235,14 @@ public class GitLogCommand extends AbstractGitCommand implements LogCommand
           }
         }
 
+        if (branch != null) {
+          changesets = new ChangesetPagingResult(counter, changesetList, branch);
+        } else {
           changesets = new ChangesetPagingResult(counter, changesetList);
+        }
       } else if (logger.isWarnEnabled()) {
         logger.warn("the repository {} seems to be empty",
-          repository.getName());
+          this.repository.getName());
 
         changesets = new ChangesetPagingResult(0, Collections.EMPTY_LIST);
       }

scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/spi/GitLogCommandTest.java

@@ -45,6 +45,7 @@ import static org.hamcrest.Matchers.contains;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertThat;
 import static org.junit.Assert.assertTrue;
 
@@ -72,6 +73,8 @@ public class GitLogCommandTest extends AbstractGitCommandTestBase
     assertEquals("86a6645eceefe8b9a247db5eb16e3d89a7e6e6d1", result.getChangesets().get(1).getId());
     assertEquals("592d797cd36432e591416e8b2b98154f4f163411", result.getChangesets().get(2).getId());
     assertEquals("435df2f061add3589cb326cc64be9b9c3897ceca", result.getChangesets().get(3).getId());
+    assertNull(result.getBranchName());
+    assertTrue(result.getChangesets().stream().allMatch(r -> r.getBranches().isEmpty()));
 
     // set default branch and fetch again
     repository.setProperty(GitConstants.PROPERTY_DEFAULT_BRANCH, "test-branch");
@@ -83,6 +86,8 @@ public class GitLogCommandTest extends AbstractGitCommandTestBase
     assertEquals("3f76a12f08a6ba0dc988c68b7f0b2cd190efc3c4", result.getChangesets().get(0).getId());
     assertEquals("592d797cd36432e591416e8b2b98154f4f163411", result.getChangesets().get(1).getId());
     assertEquals("435df2f061add3589cb326cc64be9b9c3897ceca", result.getChangesets().get(2).getId());
+    assertEquals("test-branch", result.getBranchName());
+    assertTrue(result.getChangesets().stream().allMatch(r -> r.getBranches().isEmpty()));
   }
 
   @Test

scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/HgLogCommand.java

@@ -132,7 +132,11 @@ public class HgLogCommand extends AbstractCommand implements LogCommand
         List<Changeset> changesets = on(repository).rev(start + ":"
                                        + end).execute();
 
+        if (request.getBranch() == null) {
           result = new ChangesetPagingResult(total, changesets);
+        } else {
+          result = new ChangesetPagingResult(total, changesets, request.getBranch());
+        }
       }
       else
       {

scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/repository/spi/javahg/AbstractChangesetCommand.java

@@ -216,10 +216,7 @@ public abstract class AbstractChangesetCommand extends AbstractCommand
 
     String branch = in.textUpTo('\n');
 
-    if (!BRANCH_DEFAULT.equals(branch))
-    {
     changeset.getBranches().add(branch);
-    }
 
     String p1 = readId(in, changeset, PROPERTY_PARENT1_REVISION);
 

scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/spi/HgLogCommandTest.java

@@ -88,6 +88,21 @@ public class HgLogCommandTest extends AbstractHgCommandTestBase
       result.getChangesets().get(2).getId());
   }
 
+  @Test
+  public void testGetDefaultBranchInfo() {
+    LogCommandRequest request = new LogCommandRequest();
+
+    request.setPath("a.txt");
+
+    ChangesetPagingResult result = createComamnd().getChangesets(request);
+
+    assertNotNull(result);
+    assertEquals(1,
+      result.getChangesets().get(0).getBranches().size());
+    assertEquals("default",
+      result.getChangesets().get(0).getBranches().get(0));
+  }
+
   @Test
   public void testGetAllWithLimit() {
     LogCommandRequest request = new LogCommandRequest();

scm-webapp/src/main/java/sonia/scm/api/v2/resources/BranchChangesetCollectionToDtoMapper.java

@@ -12,12 +12,12 @@ public class BranchChangesetCollectionToDtoMapper extends ChangesetCollectionToD
 
   @Inject
   public BranchChangesetCollectionToDtoMapper(ChangesetToChangesetDtoMapper changesetToChangesetDtoMapper, ResourceLinks resourceLinks) {
-    super(changesetToChangesetDtoMapper);
+    super(changesetToChangesetDtoMapper, resourceLinks);
     this.resourceLinks = resourceLinks;
   }
 
   public CollectionDto map(int pageNumber, int pageSize, PageResult<Changeset> pageResult, Repository repository, String branch) {
-    return this.map(pageNumber, pageSize, pageResult, repository, () -> createSelfLink(repository, branch));
+    return this.map(pageNumber, pageSize, pageResult, repository, () -> createSelfLink(repository, branch), branch);
   }
 
   private String createSelfLink(Repository repository, String branch) {

scm-webapp/src/main/java/sonia/scm/api/v2/resources/BranchReferenceDto.java

@@ -0,0 +1,19 @@
+package sonia.scm.api.v2.resources;
+
+import de.otto.edison.hal.HalRepresentation;
+import de.otto.edison.hal.Links;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+
+@NoArgsConstructor @AllArgsConstructor @Getter @Setter
+public class BranchReferenceDto extends HalRepresentation {
+  private String name;
+
+  @Override
+  @SuppressWarnings("squid:S1185") // We want to have this method available in this package
+  protected HalRepresentation add(Links links) {
+    return super.add(links);
+  }
+}

scm-webapp/src/main/java/sonia/scm/api/v2/resources/ChangesetCollectionToDtoMapper.java

@@ -12,10 +12,13 @@ public class ChangesetCollectionToDtoMapper extends ChangesetCollectionToDtoMapp
 
   @Inject
   public ChangesetCollectionToDtoMapper(ChangesetToChangesetDtoMapper changesetToChangesetDtoMapper, ResourceLinks resourceLinks) {
-    super(changesetToChangesetDtoMapper);
+    super(changesetToChangesetDtoMapper, resourceLinks);
     this.resourceLinks = resourceLinks;
   }
 
+  public CollectionDto map(int pageNumber, int pageSize, PageResult<Changeset> pageResult, Repository repository, String branchName) {
+    return super.map(pageNumber, pageSize, pageResult, repository, () -> createSelfLink(repository), branchName);
+  }
   public CollectionDto map(int pageNumber, int pageSize, PageResult<Changeset> pageResult, Repository repository) {
     return super.map(pageNumber, pageSize, pageResult, repository, () -> createSelfLink(repository));
   }

scm-webapp/src/main/java/sonia/scm/api/v2/resources/ChangesetCollectionToDtoMapperBase.java

@@ -1,5 +1,6 @@
 package sonia.scm.api.v2.resources;
 
+import de.otto.edison.hal.Links;
 import sonia.scm.PageResult;
 import sonia.scm.repository.Changeset;
 import sonia.scm.repository.Repository;
@@ -10,14 +11,28 @@ import java.util.function.Supplier;
 class ChangesetCollectionToDtoMapperBase extends PagedCollectionToDtoMapper<Changeset, ChangesetDto> {
 
   private final ChangesetToChangesetDtoMapper changesetToChangesetDtoMapper;
+  private final ResourceLinks resourceLinks;
 
-  ChangesetCollectionToDtoMapperBase(ChangesetToChangesetDtoMapper changesetToChangesetDtoMapper) {
+  ChangesetCollectionToDtoMapperBase(ChangesetToChangesetDtoMapper changesetToChangesetDtoMapper, ResourceLinks resourceLinks) {
     super("changesets");
     this.changesetToChangesetDtoMapper = changesetToChangesetDtoMapper;
+    this.resourceLinks = resourceLinks;
   }
 
   CollectionDto map(int pageNumber, int pageSize, PageResult<Changeset> pageResult, Repository repository, Supplier<String> selfLinkSupplier) {
     return super.map(pageNumber, pageSize, pageResult, selfLinkSupplier.get(), Optional.empty(), changeset -> changesetToChangesetDtoMapper.map(changeset, repository));
   }
-}
 
+  CollectionDto map(int pageNumber, int pageSize, PageResult<Changeset> pageResult, Repository repository, Supplier<String> selfLinkSupplier, String branchName) {
+    CollectionDto collectionDto = this.map(pageNumber, pageSize, pageResult, repository, selfLinkSupplier);
+    collectionDto.withEmbedded("branch", createBranchReferenceDto(repository, branchName));
+    return collectionDto;
+  }
+
+  private BranchReferenceDto createBranchReferenceDto(Repository repository, String branchName) {
+    BranchReferenceDto branchReferenceDto = new BranchReferenceDto();
+    branchReferenceDto.setName(branchName);
+    branchReferenceDto.add(Links.linkingTo().self(resourceLinks.branch().self(repository.getNamespaceAndName(), branchName)).build());
+    return branchReferenceDto;
+  }
+}

scm-webapp/src/main/java/sonia/scm/api/v2/resources/ChangesetRootResource.java

@@ -65,7 +65,11 @@ public class ChangesetRootResource {
         .getChangesets();
       if (changesets != null && changesets.getChangesets() != null) {
         PageResult<Changeset> pageResult = new PageResult<>(changesets.getChangesets(), changesets.getTotal());
+        if (changesets.getBranchName() != null) {
+          return Response.ok(changesetCollectionToDtoMapper.map(page, pageSize, pageResult, repository, changesets.getBranchName())).build();
+        } else {
           return Response.ok(changesetCollectionToDtoMapper.map(page, pageSize, pageResult, repository)).build();
+        }
       } else {
         return Response.ok().build();
       }

scm-webapp/src/main/java/sonia/scm/api/v2/resources/CollectionDto.java

@@ -15,4 +15,9 @@ class CollectionDto extends HalRepresentation {
   CollectionDto(Links links, Embedded embedded) {
     super(links, embedded);
   }
+
+  @Override
+  protected HalRepresentation withEmbedded(String rel, HalRepresentation embeddedItem) {
+    return super.withEmbedded(rel, embeddedItem);
+  }
 }

scm-webapp/src/main/java/sonia/scm/api/v2/resources/FileHistoryCollectionToDtoMapper.java

@@ -13,7 +13,7 @@ public class FileHistoryCollectionToDtoMapper extends ChangesetCollectionToDtoMa
 
   @Inject
   public FileHistoryCollectionToDtoMapper(ChangesetToChangesetDtoMapper changesetToChangesetDtoMapper, ResourceLinks resourceLinks) {
-    super(changesetToChangesetDtoMapper);
+    super(changesetToChangesetDtoMapper, resourceLinks);
     this.resourceLinks = resourceLinks;
   }
 

scm-webapp/src/test/java/sonia/scm/api/v2/resources/ChangesetCollectionToDtoMapperTest.java

@@ -0,0 +1,61 @@
+package sonia.scm.api.v2.resources;
+
+import org.assertj.core.api.Assertions;
+import org.junit.Test;
+import sonia.scm.PageResult;
+import sonia.scm.repository.Changeset;
+import sonia.scm.repository.Repository;
+
+import java.net.URI;
+
+import static java.util.Arrays.asList;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+public class ChangesetCollectionToDtoMapperTest {
+
+  public static final Repository REPOSITORY = new Repository("", "git", "space", "name");
+  public static final Changeset CHANGESET = new Changeset();
+  private final ChangesetToChangesetDtoMapper changesetToChangesetDtoMapper = mock(ChangesetToChangesetDtoMapper.class);
+
+  private final ChangesetCollectionToDtoMapper changesetCollectionToDtoMapper = new ChangesetCollectionToDtoMapper(changesetToChangesetDtoMapper, ResourceLinksMock.createMock(URI.create("/")));
+
+  @Test
+  public void shouldMapCollectionEntries() {
+    ChangesetDto expectedChangesetDto = new ChangesetDto();
+    when(changesetToChangesetDtoMapper.map(CHANGESET, REPOSITORY)).thenReturn(expectedChangesetDto);
+
+    CollectionDto collectionDto = changesetCollectionToDtoMapper.map(0, 1, new PageResult<>(asList(CHANGESET), 1), REPOSITORY);
+
+    assertThat(collectionDto.getEmbedded().hasItem("changesets")).isTrue();
+    assertThat(collectionDto.getEmbedded().getItemsBy("changesets")).containsExactly(expectedChangesetDto);
+    assertThat(collectionDto.getEmbedded().hasItem("branch")).isFalse();
+  }
+
+  @Test
+  public void shouldNotEmbedBranchIfNotSpecified() {
+    ChangesetDto expectedChangesetDto = new ChangesetDto();
+    when(changesetToChangesetDtoMapper.map(CHANGESET, REPOSITORY)).thenReturn(expectedChangesetDto);
+
+    CollectionDto collectionDto = changesetCollectionToDtoMapper.map(0, 1, new PageResult<>(asList(CHANGESET), 1), REPOSITORY);
+
+    assertThat(collectionDto.getEmbedded().hasItem("branch")).isFalse();
+  }
+
+  @Test
+  public void shouldEmbedBranchIfSpecified() {
+    ChangesetDto expectedChangesetDto = new ChangesetDto();
+    when(changesetToChangesetDtoMapper.map(CHANGESET, REPOSITORY)).thenReturn(expectedChangesetDto);
+
+    CollectionDto collectionDto = changesetCollectionToDtoMapper.map(0, 1, new PageResult<>(asList(CHANGESET), 1), REPOSITORY, "someBranch");
+
+    assertThat(collectionDto.getEmbedded().hasItem("branch")).isTrue();
+    assertThat(collectionDto.getEmbedded().getItemsBy("branch"))
+      .hasSize(1)
+      .first().matches(b -> b.getLinks().getLinkBy("self").isPresent())
+      .extracting(b -> b.getLinks().getLinkBy("self").get().getHref()).first().isEqualTo("/v2/repositories/space/name/branches/someBranch");
+    assertThat(collectionDto.getEmbedded().getItemsBy("branch"))
+      .first().extracting("name").first().isEqualTo("someBranch");
+  }
+}