com.google.gerrit.acceptance.testsuite.change.TestChangeCreation Maven / Gradle / Ivy
Show all versions of gerrit-acceptance-framework Show documentation
// Copyright (C) 2020 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.testsuite.change;
import static com.google.common.base.Preconditions.checkState;
import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.google.gerrit.acceptance.testsuite.ThrowingFunction;
import com.google.gerrit.common.UsedAt;
import com.google.gerrit.entities.Account;
import com.google.gerrit.entities.Change;
import com.google.gerrit.entities.Project;
import com.google.gerrit.server.edit.tree.TreeModification;
import java.util.Optional;
import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.PersonIdent;
import org.eclipse.jgit.merge.MergeStrategy;
/** Initial attributes of the change. If not provided, arbitrary values will be used. */
@AutoValue
public abstract class TestChangeCreation {
@UsedAt(UsedAt.Project.GOOGLE)
public abstract Optional host();
public abstract Optional project();
public abstract String branch();
public abstract Optional owner();
public abstract Optional author();
public abstract Optional authorIdent();
public abstract Optional committer();
public abstract Optional committerIdent();
public abstract Optional topic();
public abstract ImmutableMap approvals();
public abstract String commitMessage();
public abstract ImmutableList treeModifications();
public abstract Optional> parents();
public abstract MergeStrategy mergeStrategy();
abstract ThrowingFunction changeCreator();
public static Builder builder(ThrowingFunction changeCreator) {
return new AutoValue_TestChangeCreation.Builder()
.changeCreator(changeCreator)
.branch(Constants.R_HEADS + Constants.MASTER)
.commitMessage("A test change")
// Which value we choose here doesn't matter. All relevant code paths set the desired value.
.mergeStrategy(MergeStrategy.OURS)
.approvals(ImmutableMap.of());
}
@AutoValue.Builder
public abstract static class Builder {
/** Host name in a multi-tenant deployment. */
@UsedAt(UsedAt.Project.GOOGLE)
public abstract Builder host(String host);
/** Target project/Repository of the change. Must be an existing project. */
public abstract Builder project(Project.NameKey project);
/**
* Target branch of the change. Neither needs to exist nor needs to point to an actual commit.
*/
public abstract Builder branch(String branch);
/**
* The change owner.
*
* Must be an existing user account.
*/
public abstract Builder owner(Account.Id owner);
/**
* The author of the commit for which the change is created.
*
*
Must be an existing user account.
*
*
Cannot be set together with {@link #authorIdent()} is set.
*
*
If neither {@link #author()} nor {@link #authorIdent()} is set the {@link
* TestChangeCreation#owner()} is used as the author.
*/
public abstract Builder author(Account.Id author);
/**
* The author ident of the commit for which the change is created.
*
*
Cannot be set together with {@link #author()} is set.
*
*
If neither {@link #author()} nor {@link #authorIdent()} is set the {@link
* TestChangeCreation#owner()} is used as the author.
*/
public abstract Builder authorIdent(PersonIdent authorIdent);
public abstract Optional author();
public abstract Optional authorIdent();
/**
* The committer of the commit for which the change is created.
*
* Must be an existing user account.
*
*
Cannot be set together with {@link #committerIdent()} is set.
*
*
If neither {@link #committer()} nor {@link #committerIdent()} is set the {@link
* TestChangeCreation#owner()} is used as the committer.
*/
public abstract Builder committer(Account.Id committer);
/**
* The committer ident of the commit for which the change is created.
*
*
Cannot be set together with {@link #committer()} is set.
*
*
If neither {@link #committer()} nor {@link #committerIdent()} is set the {@link
* TestChangeCreation#owner()} is used as the committer.
*/
public abstract Builder committerIdent(PersonIdent committerIdent);
public abstract Optional committer();
public abstract Optional committerIdent();
/** The topic to add this change to. */
public abstract Builder topic(String topic);
/**
* The approvals to apply to this change. Map of label name to value. All approvals will be
* granted by the uploader.
*/
public abstract Builder approvals(ImmutableMap approvals);
/**
* The commit message. The message may contain a {@code Change-Id} footer but does not need to.
* If the footer is absent, it will be generated.
*/
public abstract Builder commitMessage(String commitMessage);
/** Modified file of the change. The file content is specified via the returned builder. */
public FileContentBuilder file(String filePath) {
return new FileContentBuilder<>(this, filePath, 0, treeModificationsBuilder()::add);
}
/**
* Modified file of the change. The file content is specified via the returned builder. The
* second parameter indicates the git file mode for the modified file if it has been changed.
*
* @see org.eclipse.jgit.lib.FileMode
*/
public FileContentBuilder file(String filePath, int newGitFileMode) {
return new FileContentBuilder<>(
this, filePath, newGitFileMode, treeModificationsBuilder()::add);
}
abstract ImmutableList.Builder treeModificationsBuilder();
/**
* Parent commit of the change. The commit can be specified via various means in the returned
* builder.
*/
public ParentBuilder childOf() {
return new ParentBuilder<>(parentCommit -> parents(ImmutableList.of(parentCommit)));
}
/**
* Parent commits of the change. Each parent commit can be specified via various means in the
* returned builder. The order of the parents matters and is preserved (first parent commit in
* fluent change -> first parent of the change).
*
* This method will automatically merge the parent commits and use the resulting commit as
* base for the change. Use {@link #file(String)} for additional file adjustments on top of that
* merge commit.
*
*
Note: If this method fails with a merge conflict, use {@link
* #mergeOfButBaseOnFirst()} instead and specify all other necessary file contents manually via
* {@link #file(String)}.
*/
public ParentBuilder> mergeOf() {
return new ParentBuilder<>(parent -> mergeBuilder(MergeStrategy.RECURSIVE, parent));
}
/**
* Parent commits of the change. Each parent commit can be specified via various means in the
* returned builder. The order of the parents matters and is preserved (first parent commit in
* fluent change -> first parent of the change).
*
* This method will use the first specified parent commit as base for the resulting change.
* This approach is especially useful if merging the parents is not possible.
*/
public ParentBuilder> mergeOfButBaseOnFirst() {
return new ParentBuilder<>(parent -> mergeBuilder(MergeStrategy.OURS, parent));
}
MultipleParentBuilder mergeBuilder(
MergeStrategy mergeStrategy, TestCommitIdentifier parent) {
mergeStrategy(mergeStrategy);
return new MultipleParentBuilder<>(this::parents, parent);
}
abstract Builder parents(ImmutableList parents);
abstract Builder mergeStrategy(MergeStrategy mergeStrategy);
abstract Builder changeCreator(ThrowingFunction changeCreator);
abstract TestChangeCreation autoBuild();
public TestChangeCreation build() {
checkState(
author().isEmpty() || authorIdent().isEmpty(),
"author and authorIdent cannot be set together");
checkState(
committer().isEmpty() || committerIdent().isEmpty(),
"committer and committerIdent cannot be set together");
return autoBuild();
}
/**
* Creates the change.
*
* @return the {@code Change.Id} of the created change
*/
@CanIgnoreReturnValue
public Change.Id create() {
TestChangeCreation changeUpdate = build();
return changeUpdate.changeCreator().applyAndThrowSilently(changeUpdate);
}
}
}