blob: f0f262ff18ffa7daa8246fed0f4e9a2c0b6cd5e3 [file] [log] [blame]
// Copyright (C) 2017 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.api.change;
import static com.google.common.truth.Truth.assertThat;
import static com.google.gerrit.acceptance.testsuite.project.TestProjectUpdate.allow;
import static com.google.gerrit.extensions.client.ListChangesOption.MESSAGES;
import static com.google.gerrit.server.group.SystemGroupBackend.REGISTERED_USERS;
import static com.google.gerrit.testing.GerritJUnit.assertThrows;
import static java.util.concurrent.TimeUnit.HOURS;
import static java.util.stream.Collectors.toList;
import static org.eclipse.jgit.lib.Constants.HEAD;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import com.google.gerrit.acceptance.AbstractDaemonTest;
import com.google.gerrit.acceptance.PushOneCommit;
import com.google.gerrit.acceptance.UseClockStep;
import com.google.gerrit.acceptance.config.GerritConfig;
import com.google.gerrit.acceptance.testsuite.project.ProjectOperations;
import com.google.gerrit.acceptance.testsuite.request.RequestScopeOperations;
import com.google.gerrit.entities.Permission;
import com.google.gerrit.entities.Project;
import com.google.gerrit.extensions.api.changes.ReviewInput;
import com.google.gerrit.extensions.client.ChangeStatus;
import com.google.gerrit.extensions.common.ChangeInfo;
import com.google.gerrit.extensions.restapi.AuthException;
import com.google.gerrit.extensions.restapi.BadRequestException;
import com.google.gerrit.extensions.restapi.ResourceConflictException;
import com.google.gerrit.server.CurrentUser;
import com.google.gerrit.server.change.AbandonUtil;
import com.google.gerrit.server.config.ChangeCleanupConfig;
import com.google.gerrit.server.query.change.ChangeData;
import com.google.gerrit.testing.TestTimeUtil;
import com.google.inject.Inject;
import java.util.List;
import java.util.Locale;
import org.eclipse.jgit.internal.storage.dfs.InMemoryRepository;
import org.eclipse.jgit.junit.TestRepository;
import org.eclipse.jgit.lib.ObjectId;
import org.junit.Test;
public class AbandonIT extends AbstractDaemonTest {
@Inject private AbandonUtil abandonUtil;
@Inject private ChangeCleanupConfig cleanupConfig;
@Inject private ProjectOperations projectOperations;
@Inject private RequestScopeOperations requestScopeOperations;
@Test
public void abandon() throws Exception {
PushOneCommit.Result r = createChange();
String changeId = r.getChangeId();
assertThat(info(changeId).status).isEqualTo(ChangeStatus.NEW);
gApi.changes().id(changeId).abandon();
ChangeInfo info = get(changeId, MESSAGES);
assertThat(info.status).isEqualTo(ChangeStatus.ABANDONED);
assertThat(Iterables.getLast(info.messages).message.toLowerCase(Locale.US))
.contains("abandoned");
ResourceConflictException thrown =
assertThrows(ResourceConflictException.class, () -> gApi.changes().id(changeId).abandon());
assertThat(thrown).hasMessageThat().contains("change is abandoned");
}
@Test
public void batchAbandon() throws Exception {
CurrentUser user = localCtx.getContext().getUser();
PushOneCommit.Result a = createChange();
PushOneCommit.Result b = createChange();
ImmutableList<ChangeData> list = ImmutableList.of(a.getChange(), b.getChange());
batchAbandon.batchAbandon(batchUpdateFactory, a.getChange().project(), user, list, "deadbeef");
ChangeInfo info = get(a.getChangeId(), MESSAGES);
assertThat(info.status).isEqualTo(ChangeStatus.ABANDONED);
assertThat(Iterables.getLast(info.messages).message.toLowerCase(Locale.US))
.contains("abandoned");
assertThat(Iterables.getLast(info.messages).message.toLowerCase(Locale.US))
.contains("deadbeef");
info = get(b.getChangeId(), MESSAGES);
assertThat(info.status).isEqualTo(ChangeStatus.ABANDONED);
assertThat(Iterables.getLast(info.messages).message.toLowerCase(Locale.US))
.contains("abandoned");
assertThat(Iterables.getLast(info.messages).message.toLowerCase(Locale.US))
.contains("deadbeef");
}
@Test
public void batchAbandonChangeProject() throws Exception {
String project1Name = name("Project1");
String project2Name = name("Project2");
gApi.projects().create(project1Name);
gApi.projects().create(project2Name);
TestRepository<InMemoryRepository> project1 = cloneProject(Project.nameKey(project1Name));
TestRepository<InMemoryRepository> project2 = cloneProject(Project.nameKey(project2Name));
CurrentUser user = localCtx.getContext().getUser();
PushOneCommit.Result a = createChange(project1, "master", "x", "x", "x", "");
PushOneCommit.Result b = createChange(project2, "master", "x", "x", "x", "");
ImmutableList<ChangeData> list = ImmutableList.of(a.getChange(), b.getChange());
ResourceConflictException thrown =
assertThrows(
ResourceConflictException.class,
() ->
batchAbandon.batchAbandon(
batchUpdateFactory, Project.nameKey(project1Name), user, list));
assertThat(thrown)
.hasMessageThat()
.contains(
String.format("Project name \"%s\" doesn't match \"%s\"", project2Name, project1Name));
}
@Test
@UseClockStep
@GerritConfig(name = "changeCleanup.abandonAfter", value = "1w")
public void abandonInactiveOpenChanges() throws Exception {
// create 2 changes which will be abandoned ...
int id1 = createChange().getChange().getId().get();
int id2 = createChange().getChange().getId().get();
// ... because they are older than 1 week
TestTimeUtil.incrementClock(7 * 24, HOURS);
// create 1 new change that will not be abandoned
ChangeData cd = createChange().getChange();
int id3 = cd.getId().get();
assertThat(toChangeNumbers(query("is:open"))).containsExactly(id1, id2, id3);
assertThat(query("is:abandoned")).isEmpty();
abandonUtil.abandonInactiveOpenChanges(batchUpdateFactory);
assertThat(toChangeNumbers(query("is:open"))).containsExactly(id3);
assertThat(toChangeNumbers(query("is:abandoned"))).containsExactly(id1, id2);
}
@Test
@UseClockStep
@GerritConfig(name = "changeCleanup.abandonAfter", value = "1w")
@GerritConfig(name = "changeCleanup.abandonIfMergeable", value = "false")
@GerritConfig(
name = "change.mergeabilityComputationBehavior",
value = "API_REF_UPDATED_AND_CHANGE_REINDEX")
public void notAbandonedIfMergeableWhenMergeableOperatorIsEnabled() throws Exception {
ObjectId initial = repo().exactRef(HEAD).getLeaf().getObjectId();
// create 2 changes
int id1 = createChange().getChange().getId().get();
int id2 = createChange().getChange().getId().get();
// create 2 changes that conflict with each other
testRepo.reset(initial);
int id3 = createChange("change 3", "file.txt", "content").getChange().getId().get();
testRepo.reset(initial);
int id4 = createChange("change 4", "file.txt", "other content").getChange().getId().get();
// make all 4 previously created changes older than 1 week
TestTimeUtil.incrementClock(7 * 24, HOURS);
// create 1 new change that will not be abandoned because it is not older than 1 week
testRepo.reset(initial);
ChangeData cd = createChange().getChange();
int id5 = cd.getId().get();
assertThat(toChangeNumbers(query("is:open"))).containsExactly(id1, id2, id3, id4, id5);
assertThat(query("is:abandoned")).isEmpty();
// submit one of the conflicting changes
gApi.changes().id(project.get(), id3).current().review(ReviewInput.approve());
gApi.changes().id(project.get(), id3).current().submit();
assertThat(toChangeNumbers(query("is:merged"))).containsExactly(id3);
assertThat(toChangeNumbers(query("-is:mergeable"))).containsExactly(id4);
abandonUtil.abandonInactiveOpenChanges(batchUpdateFactory);
assertThat(toChangeNumbers(query("is:open"))).containsExactly(id5, id2, id1);
assertThat(toChangeNumbers(query("is:abandoned"))).containsExactly(id4);
}
/**
* When indexing mergeable is disabled then the abandonIfMergeable option is ineffective and the
* auto abandon behaves as though it were set to its default value (true).
*/
@Test
@UseClockStep
@GerritConfig(name = "changeCleanup.abandonAfter", value = "1w")
@GerritConfig(name = "changeCleanup.abandonIfMergeable", value = "false")
@GerritConfig(name = "change.mergeabilityComputationBehavior", value = "NEVER")
public void abandonedIfMergeableWhenMergeableOperatorIsDisabled() throws Exception {
ObjectId initial = repo().exactRef(HEAD).getLeaf().getObjectId();
// create 2 changes
int id1 = createChange().getChange().getId().get();
int id2 = createChange().getChange().getId().get();
// create 2 changes that conflict with each other
testRepo.reset(initial);
int id3 = createChange("change 3", "file.txt", "content").getChange().getId().get();
testRepo.reset(initial);
int id4 = createChange("change 4", "file.txt", "other content").getChange().getId().get();
// make all 4 previously created changes older than 1 week
TestTimeUtil.incrementClock(7 * 24, HOURS);
// create 1 new change that will not be abandoned because it is not older than 1 week
testRepo.reset(initial);
ChangeData cd = createChange().getChange();
int id5 = cd.getId().get();
assertThat(toChangeNumbers(query("is:open"))).containsExactly(id1, id2, id3, id4, id5);
assertThat(query("is:abandoned")).isEmpty();
// submit one of the conflicting changes
gApi.changes().id(project.get(), id3).current().review(ReviewInput.approve());
gApi.changes().id(project.get(), id3).current().submit();
assertThat(toChangeNumbers(query("is:merged"))).containsExactly(id3);
BadRequestException thrown =
assertThrows(BadRequestException.class, () -> query("-is:mergeable"));
assertThat(thrown).hasMessageThat().contains("operator is not supported");
abandonUtil.abandonInactiveOpenChanges(batchUpdateFactory);
assertThat(toChangeNumbers(query("is:open"))).containsExactly(id5);
assertThat(toChangeNumbers(query("is:abandoned"))).containsExactly(id4, id2, id1);
}
@Test
public void changeCleanupConfigDefaultAbandonMessage() throws Exception {
assertThat(cleanupConfig.getAbandonMessage())
.startsWith(
"Auto-Abandoned due to inactivity, see "
+ canonicalWebUrl.get()
+ "Documentation/user-change-cleanup.html#auto-abandon");
}
@Test
@GerritConfig(name = "changeCleanup.abandonMessage", value = "XX ${URL} XX")
public void changeCleanupConfigCustomAbandonMessageWithUrlReplacement() throws Exception {
assertThat(cleanupConfig.getAbandonMessage())
.isEqualTo(
"XX "
+ canonicalWebUrl.get()
+ "Documentation/user-change-cleanup.html#auto-abandon XX");
}
@Test
@GerritConfig(name = "changeCleanup.abandonMessage", value = "XX YYY XX")
public void changeCleanupConfigCustomAbandonMessageWithoutUrlReplacement() throws Exception {
assertThat(cleanupConfig.getAbandonMessage()).isEqualTo("XX YYY XX");
}
@Test
public void abandonNotAllowedWithoutPermission() throws Exception {
PushOneCommit.Result r = createChange();
String changeId = r.getChangeId();
assertThat(info(changeId).status).isEqualTo(ChangeStatus.NEW);
requestScopeOperations.setApiUser(user.id());
AuthException thrown =
assertThrows(AuthException.class, () -> gApi.changes().id(changeId).abandon());
assertThat(thrown).hasMessageThat().contains("abandon not permitted");
}
@Test
public void abandonAndRestoreAllowedWithPermission() throws Exception {
PushOneCommit.Result r = createChange();
String changeId = r.getChangeId();
assertThat(info(changeId).status).isEqualTo(ChangeStatus.NEW);
projectOperations
.project(project)
.forUpdate()
.add(allow(Permission.ABANDON).ref("refs/heads/master").group(REGISTERED_USERS))
.update();
requestScopeOperations.setApiUser(user.id());
gApi.changes().id(changeId).abandon();
assertThat(info(changeId).status).isEqualTo(ChangeStatus.ABANDONED);
gApi.changes().id(changeId).restore();
assertThat(info(changeId).status).isEqualTo(ChangeStatus.NEW);
}
@Test
public void restore() throws Exception {
PushOneCommit.Result r = createChange();
String changeId = r.getChangeId();
assertThat(info(changeId).status).isEqualTo(ChangeStatus.NEW);
gApi.changes().id(changeId).abandon();
assertThat(info(changeId).status).isEqualTo(ChangeStatus.ABANDONED);
gApi.changes().id(changeId).restore();
ChangeInfo info = get(changeId, MESSAGES);
assertThat(info.status).isEqualTo(ChangeStatus.NEW);
assertThat(Iterables.getLast(info.messages).message.toLowerCase(Locale.US))
.contains("restored");
ResourceConflictException thrown =
assertThrows(ResourceConflictException.class, () -> gApi.changes().id(changeId).restore());
assertThat(thrown).hasMessageThat().contains("change is new");
}
@Test
public void restoreNotAllowedWithoutPermission() throws Exception {
PushOneCommit.Result r = createChange();
String changeId = r.getChangeId();
assertThat(info(changeId).status).isEqualTo(ChangeStatus.NEW);
gApi.changes().id(changeId).abandon();
requestScopeOperations.setApiUser(user.id());
assertThat(info(changeId).status).isEqualTo(ChangeStatus.ABANDONED);
AuthException thrown =
assertThrows(AuthException.class, () -> gApi.changes().id(changeId).restore());
assertThat(thrown).hasMessageThat().contains("restore not permitted");
}
private List<Integer> toChangeNumbers(List<ChangeInfo> changes) {
return changes.stream().map(i -> i._number).collect(toList());
}
}