/*
* Copyright 2000-2014 JetBrains s.r.o.
*
* 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 git4idea.log;
import com.intellij.openapi.components.ServiceManager;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.openapi.vcs.VcsException;
import com.intellij.util.ArrayUtil;
import com.intellij.util.CollectConsumer;
import com.intellij.util.Function;
import com.intellij.util.containers.ContainerUtil;
import com.intellij.vcs.log.*;
import com.intellij.vcs.log.data.VcsLogBranchFilterImpl;
import com.intellij.vcs.log.impl.*;
import com.intellij.vcs.log.impl.VcsLogFilterCollectionImpl.VcsLogFilterCollectionBuilder;
import com.intellij.vcs.log.ui.filter.VcsLogTextFilterImpl;
import com.intellij.vcsUtil.VcsFileUtil;
import git4idea.test.GitSingleRepoTest;
import git4idea.test.GitTestUtil;
import org.jetbrains.annotations.NotNull;
import java.io.IOException;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import static com.intellij.openapi.vcs.Executor.echo;
import static com.intellij.openapi.vcs.Executor.touch;
import static git4idea.test.GitExecutor.*;
import static java.util.Collections.singleton;
public class GitLogProviderTest extends GitSingleRepoTest {
private GitLogProvider myLogProvider;
private VcsLogObjectsFactory myObjectsFactory;
public void setUp() throws Exception {
super.setUp();
myLogProvider = GitTestUtil.findGitLogProvider(myProject);
myObjectsFactory = ServiceManager.getService(myProject, VcsLogObjectsFactory.class);
}
public void tearDown() throws Exception {
super.tearDown();
}
public void test_init_with_tagged_branch() throws VcsException {
prepareSomeHistory();
List<VcsCommitMetadata> expectedLogWithoutTaggedBranch = log();
createTaggedBranch();
VcsLogProvider.DetailedLogData block =
myLogProvider.readFirstBlock(myProjectRoot, new RequirementsImpl(1000, false, Collections.emptySet()));
assertOrderedEquals(block.getCommits(), expectedLogWithoutTaggedBranch);
}
public void test_refresh_with_new_tagged_branch() throws VcsException {
prepareSomeHistory();
Set<VcsRef> prevRefs = GitTestUtil.readAllRefs(myProjectRoot, myObjectsFactory);
createTaggedBranch();
List<VcsCommitMetadata> expectedLog = log();
VcsLogProvider.DetailedLogData block = myLogProvider.readFirstBlock(myProjectRoot, new RequirementsImpl(1000, true, prevRefs));
assertSameElements(block.getCommits(), expectedLog);
}
public void test_refresh_when_new_tag_moved() throws VcsException {
prepareSomeHistory();
Set<VcsRef> prevRefs = GitTestUtil.readAllRefs(myProjectRoot, myObjectsFactory);
git("tag -f ATAG");
List<VcsCommitMetadata> expectedLog = log();
Set<VcsRef> refs = GitTestUtil.readAllRefs(myProjectRoot, myObjectsFactory);
VcsLogProvider.DetailedLogData block = myLogProvider.readFirstBlock(myProjectRoot, new RequirementsImpl(1000, true, prevRefs));
assertSameElements(block.getCommits(), expectedLog);
assertSameElements(block.getRefs(), refs);
}
public void test_new_tag_on_old_commit() throws VcsException {
prepareSomeHistory();
Set<VcsRef> prevRefs = GitTestUtil.readAllRefs(myProjectRoot, myObjectsFactory);
List<VcsCommitMetadata> log = log();
String firstCommit = log.get(log.size() - 1).getId().asString();
git("tag NEW_TAG " + firstCommit);
Set<VcsRef> refs = GitTestUtil.readAllRefs(myProjectRoot, myObjectsFactory);
VcsLogProvider.DetailedLogData block = myLogProvider.readFirstBlock(myProjectRoot, new RequirementsImpl(1000, true, prevRefs));
assertSameElements(block.getRefs(), refs);
}
public void test_all_log_with_tagged_branch() throws VcsException {
prepareSomeHistory();
createTaggedBranch();
List<VcsCommitMetadata> expectedLog = log();
List<TimedVcsCommit> collector = ContainerUtil.newArrayList();
//noinspection unchecked
myLogProvider.readAllHashes(myProjectRoot, new CollectConsumer<>(collector));
assertOrderedEquals(expectedLog, collector);
}
public void test_get_current_user() throws Exception {
VcsUser user = myLogProvider.getCurrentUser(myProjectRoot);
assertNotNull("User is not defined", user);
VcsUser expected = getDefaultUser();
assertEquals("User name is incorrect", expected.getName(), user.getName());
assertEquals("User email is incorrect", expected.getEmail(), user.getEmail());
}
public void test_dont_report_origin_HEAD() throws Exception {
prepareSomeHistory();
git("update-ref refs/remotes/origin/HEAD master");
VcsLogProvider.DetailedLogData block = myLogProvider.readFirstBlock(myProjectRoot,
new RequirementsImpl(1000, false, Collections.emptySet()));
assertFalse("origin/HEAD should be ignored", ContainerUtil.exists(block.getRefs(), ref -> ref.getName().equals("origin/HEAD")));
}
public void test_support_equally_named_branch_and_tag() throws Exception {
prepareSomeHistory();
git("branch build");
git("tag build");
VcsLogProvider.DetailedLogData data = myLogProvider.readFirstBlock(myProjectRoot,
new RequirementsImpl(1000, true, Collections.emptySet()));
List<VcsCommitMetadata> expectedLog = log();
assertOrderedEquals(data.getCommits(), expectedLog);
assertTrue(ContainerUtil.exists(data.getRefs(), ref -> ref.getName().equals("build") && ref.getType() == GitRefManager.LOCAL_BRANCH));
assertTrue(ContainerUtil.exists(data.getRefs(), ref -> ref.getName().equals("build") && ref.getType() == GitRefManager.TAG));
}
public void test_filter_by_branch() throws Exception {
List<String> hashes = generateHistoryForFilters(true, false);
VcsLogBranchFilter branchFilter = VcsLogBranchFilterImpl.fromBranch("feature");
List<String> actualHashes = getFilteredHashes(new VcsLogFilterCollectionBuilder().with(branchFilter).build());
assertEquals(hashes, actualHashes);
}
public void test_filter_by_branch_and_user() throws Exception {
List<String> hashes = generateHistoryForFilters(false, false);
VcsLogBranchFilter branchFilter = VcsLogBranchFilterImpl.fromBranch("feature");
VcsUserImpl user = new VcsUserImpl(GitTestUtil.USER_NAME, GitTestUtil.USER_EMAIL);
VcsLogUserFilter userFilter = new VcsLogUserFilterImpl(singleton(GitTestUtil.USER_NAME),
Collections.emptyMap(),
singleton(user));
List<String> actualHashes = getFilteredHashes(new VcsLogFilterCollectionBuilder().with(branchFilter).with(userFilter).build());
assertEquals(hashes, actualHashes);
}
public void test_filter_by_text() throws Exception {
String initial = last();
String fileName = "f";
touch(fileName, "content" + Math.random());
String smallBrackets = addCommit("[git] " + fileName);
echo(fileName, "content" + Math.random());
String bigBrackets = addCommit("[GIT] " + fileName);
echo(fileName, "content" + Math.random());
String smallNoBrackets = addCommit("git " + fileName);
echo(fileName, "content" + Math.random());
String bigNoBrackets = addCommit("GIT " + fileName);
String text = "[git]";
assertEquals(Collections.singletonList(smallBrackets), getFilteredHashes(
new VcsLogFilterCollectionBuilder().with(new VcsLogTextFilterImpl(text, false, true)).build()));
assertEquals(Arrays.asList(bigBrackets, smallBrackets), getFilteredHashes(
new VcsLogFilterCollectionBuilder().with(new VcsLogTextFilterImpl(text, false, false)).build()));
assertEquals(Arrays.asList(bigNoBrackets, smallNoBrackets, bigBrackets, smallBrackets, initial),
getFilteredHashes(new VcsLogFilterCollectionBuilder().with(new VcsLogTextFilterImpl(text, true, false)).build()));
assertEquals(Arrays.asList(smallNoBrackets, smallBrackets, initial),
getFilteredHashes(new VcsLogFilterCollectionBuilder().with(new VcsLogTextFilterImpl(text, true, true)).build()));
}
public void test_filter_by_text_and_user() throws Exception {
List<String> hashes = generateHistoryForFilters(false, true);
VcsUserImpl user = new VcsUserImpl(GitTestUtil.USER_NAME, GitTestUtil.USER_EMAIL);
VcsLogUserFilter userFilter = new VcsLogUserFilterImpl(singleton(GitTestUtil.USER_NAME),
Collections.emptyMap(),
singleton(user));
assertEquals(hashes, getFilteredHashes(
new VcsLogFilterCollectionBuilder().with(userFilter).with(new VcsLogTextFilterImpl("", false, false)).build()));
assertEquals(hashes, getFilteredHashes(
new VcsLogFilterCollectionBuilder().with(userFilter).with(new VcsLogTextFilterImpl("", true, false)).build()));
}
public void test_short_details() throws Exception {
prepareLongHistory(VcsFileUtil.FILE_PATH_LIMIT * 2 / 40);
List<VcsCommitMetadata> log = log();
final List<String> hashes = ContainerUtil.newArrayList();
myLogProvider.readAllHashes(myProjectRoot, timedVcsCommit -> hashes.add(timedVcsCommit.getId().asString()));
List<? extends VcsShortCommitDetails> shortDetails = myLogProvider.readShortDetails(myProjectRoot, hashes);
Function<VcsShortCommitDetails, String> shortDetailsToString = getShortDetailsToString();
assertOrderedEquals(ContainerUtil.map(shortDetails, shortDetailsToString), ContainerUtil.map(log, shortDetailsToString));
}
public void test_full_details() throws Exception {
prepareLongHistory(VcsFileUtil.FILE_PATH_LIMIT * 2 / 40);
List<VcsCommitMetadata> log = log();
final List<String> hashes = ContainerUtil.newArrayList();
myLogProvider.readAllHashes(myProjectRoot, timedVcsCommit -> hashes.add(timedVcsCommit.getId().asString()));
List<VcsFullCommitDetails> result = ContainerUtil.newArrayList();
myLogProvider.readFullDetails(myProjectRoot, hashes, result::add);
// we do not check for changes here
final Function<VcsShortCommitDetails, String> shortDetailsToString = getShortDetailsToString();
Function<VcsCommitMetadata, String> metadataToString = details -> shortDetailsToString.fun(details) + "\n" + details.getFullMessage();
assertOrderedEquals(ContainerUtil.map(result, metadataToString), ContainerUtil.map(log, metadataToString));
}
@NotNull
private Function<VcsShortCommitDetails, String> getShortDetailsToString() {
return details -> {
String result = "";
result += details.getId().toShortString() + "\n";
result += details.getAuthorTime() + "\n";
result += details.getAuthor() + "\n";
result += details.getCommitTime() + "\n";
result += details.getCommitter() + "\n";
result += details.getSubject();
return result;
};
}
/**
* Generates some history with two branches: master and feature, and made by two users.
* Returns hashes of this history filtered by the given parameters:
*
* @param takeAllUsers if true, don't filter by users, otherwise filter by default user.
*/
private List<String> generateHistoryForFilters(boolean takeAllUsers, boolean allBranches) {
List<String> hashes = ContainerUtil.newArrayList();
hashes.add(last());
GitTestUtil.setupUsername("bob.smith", "bob.smith@example.com");
if (takeAllUsers) {
String commitByBob = tac("file.txt");
hashes.add(commitByBob);
}
GitTestUtil.setupDefaultUsername();
hashes.add(tac("file1.txt"));
git("checkout -b feature");
String commitOnlyInFeature = tac("file2.txt");
hashes.add(commitOnlyInFeature);
git("checkout master");
String commitOnlyInMaster = tac("master.txt");
if (allBranches) hashes.add(commitOnlyInMaster);
Collections.reverse(hashes);
refresh();
return hashes;
}
@NotNull
private List<String> getFilteredHashes(@NotNull VcsLogFilterCollection filters) throws VcsException {
List<TimedVcsCommit> commits = myLogProvider.getCommitsMatchingFilter(myProjectRoot, filters, -1);
return ContainerUtil.map(commits, commit -> commit.getId().asString());
}
private static void prepareSomeHistory() {
tac("a.txt");
git("tag ATAG");
tac("b.txt");
}
private static void prepareLongHistory(int size) throws IOException {
for (int i = 0; i < size; i++) {
String file = "a" + (i % 10) + ".txt";
if (i < 10) {
tac(file);
}
else {
modify(file);
}
}
}
private static void createTaggedBranch() {
String hash = last();
tac("c.txt");
tac("d.txt");
tac("e.txt");
git("tag poor-tag");
git("reset --hard " + hash);
}
@NotNull
private static VcsUser getDefaultUser() {
return new VcsUserImpl(GitTestUtil.USER_NAME, GitTestUtil.USER_EMAIL);
}
@NotNull
private List<VcsCommitMetadata> log() {
String output = git("log --all --date-order --full-history --sparse --pretty='%H|%P|%ct|%s|%B'");
final VcsUser defaultUser = getDefaultUser();
final Function<String, Hash> TO_HASH = s -> HashImpl.build(s);
return ContainerUtil.map(StringUtil.splitByLines(output), record -> {
String[] items = ArrayUtil.toStringArray(StringUtil.split(record, "|", true, false));
long time = Long.valueOf(items[2]) * 1000;
return new VcsCommitMetadataImpl(TO_HASH.fun(items[0]), ContainerUtil.map(items[1].split(" "), TO_HASH), time,
myProjectRoot, items[3], defaultUser, items[4], defaultUser, time);
});
}
}