gerrit-acceptance-tests/src/test/java/com/google/gerrit/acceptance/rest/project/ListBranchesIT.java

// Copyright (C) 2013 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.gerrit.acceptance.rest.project;

import static com.google.common.truth.Truth.assertThat;
import static com.google.gerrit.acceptance.GitUtil.createProject;
import static com.google.gerrit.acceptance.rest.project.BranchAssert.assertBranches;

import com.google.common.collect.Lists;
import com.google.gerrit.acceptance.AbstractDaemonTest;
import com.google.gerrit.acceptance.RestResponse;
import com.google.gerrit.reviewdb.client.Project;
import com.google.gerrit.server.project.ListBranches.BranchInfo;
import com.google.gson.reflect.TypeToken;

import org.apache.http.HttpStatus;
import org.junit.Test;

import java.io.IOException;
import java.util.Collections;
import java.util.List;

public class ListBranchesIT extends AbstractDaemonTest {
  @Test
  public void listBranchesOfNonExistingProject_NotFound() throws Exception {
    assertThat(GET("/projects/non-existing/branches").getStatusCode())
        .isEqualTo(HttpStatus.SC_NOT_FOUND);
  }

  @Test
  public void listBranchesOfNonVisibleProject_NotFound() throws Exception {
    blockRead(project, "refs/*");
    assertThat(
        userSession.get("/projects/" + project.get() + "/branches")
            .getStatusCode()).isEqualTo(HttpStatus.SC_NOT_FOUND);
  }

  @Test
  public void listBranchesOfEmptyProject() throws Exception {
    Project.NameKey emptyProject = new Project.NameKey("empty");
    createProject(sshSession, emptyProject.get(), null, false);
    RestResponse r = adminSession.get("/projects/" + emptyProject.get() + "/branches");
    List<BranchInfo> expected = Lists.asList(
        new BranchInfo("refs/meta/config",  null, false),
        new BranchInfo[] {
          new BranchInfo("HEAD", null, false)
        });
    assertBranches(expected, toBranchInfoList(r));
  }

  @Test
  public void listBranches() throws Exception {
    pushTo("refs/heads/master");
    String masterCommit = git.getRepository().getRef("master").getTarget().getObjectId().getName();
    pushTo("refs/heads/dev");
    String devCommit = git.getRepository().getRef("master").getTarget().getObjectId().getName();
    RestResponse r = adminSession.get("/projects/" + project.get() + "/branches");
    List<BranchInfo> expected = Lists.asList(
        new BranchInfo("refs/meta/config",  null, false),
        new BranchInfo[] {
          new BranchInfo("HEAD", "master", false),
          new BranchInfo("refs/heads/master", masterCommit, false),
          new BranchInfo("refs/heads/dev", devCommit, true)
        });
    List<BranchInfo> result = toBranchInfoList(r);
    assertBranches(expected, result);

    // verify correct sorting
    assertThat(result.get(0).ref).isEqualTo("HEAD");
    assertThat(result.get(1).ref).isEqualTo("refs/meta/config");
    assertThat(result.get(2).ref).isEqualTo("refs/heads/dev");
    assertThat(result.get(3).ref).isEqualTo("refs/heads/master");
  }

  @Test
  public void listBranchesSomeHidden() throws Exception {
    blockRead(project, "refs/heads/dev");
    pushTo("refs/heads/master");
    String masterCommit = git.getRepository().getRef("master").getTarget().getObjectId().getName();
    pushTo("refs/heads/dev");
    RestResponse r = userSession.get("/projects/" + project.get() + "/branches");
    // refs/meta/config is hidden since user is no project owner
    List<BranchInfo> expected = Lists.asList(
        new BranchInfo("HEAD", "master", false),
        new BranchInfo[] {
          new BranchInfo("refs/heads/master", masterCommit, false),
        });
    assertBranches(expected, toBranchInfoList(r));
  }

  @Test
  public void listBranchesHeadHidden() throws Exception {
    blockRead(project, "refs/heads/master");
    pushTo("refs/heads/master");
    pushTo("refs/heads/dev");
    String devCommit = git.getRepository().getRef("master").getTarget().getObjectId().getName();
    RestResponse r = userSession.get("/projects/" + project.get() + "/branches");
    // refs/meta/config is hidden since user is no project owner
    assertBranches(Collections.singletonList(new BranchInfo("refs/heads/dev",
        devCommit, false)), toBranchInfoList(r));
  }

  @Test
  public void listBranchesUsingPagination() throws Exception {
    pushTo("refs/heads/master");
    pushTo("refs/heads/someBranch1");
    pushTo("refs/heads/someBranch2");
    pushTo("refs/heads/someBranch3");

    // using only limit
    RestResponse r =
        adminSession.get("/projects/" + project.get() + "/branches?n=4");
    List<BranchInfo> result = toBranchInfoList(r);
    assertThat(result).hasSize(4);
    assertThat(result.get(0).ref).isEqualTo("HEAD");
    assertThat(result.get(1).ref).isEqualTo("refs/meta/config");
    assertThat(result.get(2).ref).isEqualTo("refs/heads/master");
    assertThat(result.get(3).ref).isEqualTo("refs/heads/someBranch1");

    // limit higher than total number of branches
    r = adminSession.get("/projects/" + project.get() + "/branches?n=25");
    result = toBranchInfoList(r);
    assertThat(result).hasSize(6);
    assertThat(result.get(0).ref).isEqualTo("HEAD");
    assertThat(result.get(1).ref).isEqualTo("refs/meta/config");
    assertThat(result.get(2).ref).isEqualTo("refs/heads/master");
    assertThat(result.get(3).ref).isEqualTo("refs/heads/someBranch1");
    assertThat(result.get(4).ref).isEqualTo("refs/heads/someBranch2");
    assertThat(result.get(5).ref).isEqualTo("refs/heads/someBranch3");

    // using skip only
    r = adminSession.get("/projects/" + project.get() + "/branches?s=2");
    result = toBranchInfoList(r);
    assertThat(result).hasSize(4);
    assertThat(result.get(0).ref).isEqualTo("refs/heads/master");
    assertThat(result.get(1).ref).isEqualTo("refs/heads/someBranch1");
    assertThat(result.get(2).ref).isEqualTo("refs/heads/someBranch2");
    assertThat(result.get(3).ref).isEqualTo("refs/heads/someBranch3");

    // skip more branches than the number of available branches
    r = adminSession.get("/projects/" + project.get() + "/branches?s=7");
    result = toBranchInfoList(r);
    assertThat(result).isEmpty();

    // using skip and limit
    r = adminSession.get("/projects/" + project.get() + "/branches?s=2&n=2");
    result = toBranchInfoList(r);
    assertThat(result).hasSize(2);
    assertThat(result.get(0).ref).isEqualTo("refs/heads/master");
    assertThat(result.get(1).ref).isEqualTo("refs/heads/someBranch1");
  }

  @Test
  public void listBranchesUsingFilter() throws Exception {
    pushTo("refs/heads/master");
    pushTo("refs/heads/someBranch1");
    pushTo("refs/heads/someBranch2");
    pushTo("refs/heads/someBranch3");

    //using substring
    RestResponse r =
        adminSession.get("/projects/" + project.get() + "/branches?m=some");
    List<BranchInfo> result = toBranchInfoList(r);
    assertThat(result).hasSize(3);
    assertThat(result.get(0).ref).isEqualTo("refs/heads/someBranch1");
    assertThat(result.get(1).ref).isEqualTo("refs/heads/someBranch2");
    assertThat(result.get(2).ref).isEqualTo("refs/heads/someBranch3");

    r = adminSession.get("/projects/" + project.get() + "/branches?m=Branch");
    result = toBranchInfoList(r);
    assertThat(result).hasSize(3);
    assertThat(result.get(0).ref).isEqualTo("refs/heads/someBranch1");
    assertThat(result.get(1).ref).isEqualTo("refs/heads/someBranch2");
    assertThat(result.get(2).ref).isEqualTo("refs/heads/someBranch3");

    //using regex
    r = adminSession.get("/projects/" + project.get() + "/branches?r=.*ast.*r");
    result = toBranchInfoList(r);
    assertThat(result).hasSize(1);
    assertThat(result.get(0).ref).isEqualTo("refs/heads/master");
  }

  private RestResponse GET(String endpoint) throws IOException {
    return adminSession.get(endpoint);
  }

  private static List<BranchInfo> toBranchInfoList(RestResponse r)
      throws IOException {
    List<BranchInfo> result =
        newGson().fromJson(r.getReader(),
            new TypeToken<List<BranchInfo>>() {}.getType());
    return result;
  }
}