github
/
jgit
mirror of https://gitee.com/github-mirror-repo/jgit.git
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

CLI: Add support for excluding paths from Git log command 

Git log supports the exclude pathspec, which allows for excluding paths
from the log command. JGit only supports adding paths to the log
command. See the following StackOverflow question for details:
https://stackoverflow.com/questions/59143934/java-jgit-how-to-get-git-
commits-not-affecting-certain-directories
This commit adds an excludePath() method to the log command. It does not
yet support regex or glob wildcards.

Change-Id: I8cd59950b87850b55a15c7e2ea5470145c9aae28
Signed-off-by: John Tipper <john_tipper@hotmail.com>
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
stable-5.6
John Tipper 5 years ago committed by Matthias Sohn
parent
b24ec8f715
commit
5bf226d50c
3 changed files with 258 additions and 60 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 54
      org.eclipse.jgit.test/tst/org/eclipse/jgit/api/CommitAndLogCommandTest.java
  2. 221
      org.eclipse.jgit.test/tst/org/eclipse/jgit/api/LogFilterTest.java
  3. 43
      org.eclipse.jgit/src/org/eclipse/jgit/api/LogCommand.java

54
org.eclipse.jgit.test/tst/org/eclipse/jgit/api/CommitAndLogCommandTest.java
Unescape View File

@ -40,6 +40,7 @@
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
package org.eclipse.jgit.api; package org.eclipse.jgit.api;
import static java.nio.charset.StandardCharsets.UTF_8; import static java.nio.charset.StandardCharsets.UTF_8;
@ -113,59 +114,6 @@ public class CommitAndLogCommandTest extends RepositoryTestCase {
} }
} }
@Test
public void testLogWithFilter() throws IOException, JGitInternalException,
GitAPIException {
try (Git git = new Git(db)) {
// create first file
File file = new File(db.getWorkTree(), "a.txt");
FileUtils.createNewFile(file);
try (PrintWriter writer = new PrintWriter(file, UTF_8.name())) {
writer.print("content1");
}
// First commit - a.txt file
git.add().addFilepattern("a.txt").call();
git.commit().setMessage("commit1").setCommitter(committer).call();
// create second file
file = new File(db.getWorkTree(), "b.txt");
FileUtils.createNewFile(file);
try (PrintWriter writer = new PrintWriter(file, UTF_8.name())) {
writer.print("content2");
}
// Second commit - b.txt file
git.add().addFilepattern("b.txt").call();
git.commit().setMessage("commit2").setCommitter(committer).call();
// First log - a.txt filter
int count = 0;
for (RevCommit c : git.log().addPath("a.txt").call()) {
assertEquals("commit1", c.getFullMessage());
count++;
}
assertEquals(1, count);
// Second log - b.txt filter
count = 0;
for (RevCommit c : git.log().addPath("b.txt").call()) {
assertEquals("commit2", c.getFullMessage());
count++;
}
assertEquals(1, count);
// Third log - without filter
count = 0;
for (RevCommit c : git.log().call()) {
assertEquals(committer, c.getCommitterIdent());
count++;
}
assertEquals(2, count);
}
}
// try to do a commit without specifying a message. Should fail! // try to do a commit without specifying a message. Should fail!
@Test @Test
public void testWrongParams() throws GitAPIException { public void testWrongParams() throws GitAPIException {

221
org.eclipse.jgit.test/tst/org/eclipse/jgit/api/LogFilterTest.java
Unescape View File

@ -0,0 +1,221 @@
/*
* Copyright (C) 2019, John Tipper <John_Tipper@hotmail.com>
* and other copyright owners as documented in the project's IP log.
*
* This program and the accompanying materials are made available
* under the terms of the Eclipse Distribution License v1.0 which
* accompanies this distribution, is reproduced below, and is
* available at http://www.eclipse.org/org/documents/edl-v10.php
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* - Neither the name of the Eclipse Foundation, Inc. nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.eclipse.jgit.api;
import static java.nio.charset.StandardCharsets.UTF_8;
import static org.junit.Assert.assertEquals;
import java.io.File;
import java.io.PrintWriter;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Iterator;
import org.eclipse.jgit.junit.RepositoryTestCase;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.util.FileUtils;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
/**
* Testing the log command with include and exclude filters
*/
public class LogFilterTest extends RepositoryTestCase {
private Git git;
@Before
public void setup() throws Exception {
super.setUp();
git = new Git(db);
// create first file
File file = new File(db.getWorkTree(), "a.txt");
FileUtils.createNewFile(file);
try (PrintWriter writer = new PrintWriter(file, UTF_8.name())) {
writer.print("content1");
}
// First commit - a.txt file
git.add().addFilepattern("a.txt").call();
git.commit().setMessage("commit1").setCommitter(committer).call();
// create second file
file = new File(db.getWorkTree(), "b.txt");
FileUtils.createNewFile(file);
try (PrintWriter writer = new PrintWriter(file, UTF_8.name())) {
writer.print("content2");
}
// Second commit - b.txt file
git.add().addFilepattern("b.txt").call();
git.commit().setMessage("commit2").setCommitter(committer).call();
// create third file
Path includeSubdir = Paths.get(db.getWorkTree().toString(),
"subdir-include");
includeSubdir.toFile().mkdirs();
file = Paths.get(includeSubdir.toString(), "c.txt").toFile();
FileUtils.createNewFile(file);
try (PrintWriter writer = new PrintWriter(file, UTF_8.name())) {
writer.print("content3");
}
// Third commit - c.txt file
git.add().addFilepattern("subdir-include").call();
git.commit().setMessage("commit3").setCommitter(committer).call();
// create fourth file
Path excludeSubdir = Paths.get(db.getWorkTree().toString(),
"subdir-exclude");
excludeSubdir.toFile().mkdirs();
file = Paths.get(excludeSubdir.toString(), "d.txt").toFile();
FileUtils.createNewFile(file);
try (PrintWriter writer = new PrintWriter(file, UTF_8.name())) {
writer.print("content4");
}
// Fourth commit - d.txt file
git.add().addFilepattern("subdir-exclude").call();
git.commit().setMessage("commit4").setCommitter(committer).call();
}
@After
@Override
public void tearDown() throws Exception {
git.close();
super.tearDown();
}
@Test
public void testLogWithFilterCanDistinguishFilesByPath() throws Exception {
int count = 0;
for (RevCommit c : git.log().addPath("a.txt").call()) {
assertEquals("commit1", c.getFullMessage());
count++;
}
assertEquals(1, count);
count = 0;
for (RevCommit c : git.log().addPath("b.txt").call()) {
assertEquals("commit2", c.getFullMessage());
count++;
}
assertEquals(1, count);
}
@Test
public void testLogWithFilterCanIncludeFilesInDirectory() throws Exception {
int count = 0;
for (RevCommit c : git.log().addPath("subdir-include").call()) {
assertEquals("commit3", c.getFullMessage());
count++;
}
assertEquals(1, count);
}
@Test
public void testLogWithFilterCanExcludeFilesInDirectory() throws Exception {
int count = 0;
Iterator it = git.log().excludePath("subdir-exclude").call().iterator();
while (it.hasNext()) {
it.next();
count++;
}
// of all the commits, we expect to filter out only d.txt
assertEquals(3, count);
}
@Test
public void testLogWithoutFilter() throws Exception {
int count = 0;
for (RevCommit c : git.log().call()) {
assertEquals(committer, c.getCommitterIdent());
count++;
}
assertEquals(4, count);
}
@Test
public void testLogWithFilterCanExcludeAndIncludeFilesInDifferentDirectories()
throws Exception {
int count = 0;
Iterator it = git.log().addPath("subdir-include")
.excludePath("subdir-exclude").call().iterator();
while (it.hasNext()) {
it.next();
count++;
}
// we expect to include c.txt
assertEquals(1, count);
}
@Test
public void testLogWithFilterExcludeAndIncludeSameFileIncludesNothing()
throws Exception {
int count = 0;
Iterator it = git.log().addPath("subdir-exclude")
.excludePath("subdir-exclude").call().iterator();
while (it.hasNext()) {
it.next();
count++;
}
// we expect the exclude to trump everything
assertEquals(0, count);
}
@Test
public void testLogWithFilterCanExcludeFileAndDirectory() throws Exception {
int count = 0;
Iterator it = git.log().excludePath("b.txt")
.excludePath("subdir-exclude").call().iterator();
while (it.hasNext()) {
it.next();
count++;
}
// we expect a.txt and c.txt
assertEquals(2, count);
}
}

43
org.eclipse.jgit/src/org/eclipse/jgit/api/LogCommand.java
Unescape View File

@ -64,10 +64,7 @@ import org.eclipse.jgit.revwalk.filter.AndRevFilter;
import org.eclipse.jgit.revwalk.filter.MaxCountRevFilter; import org.eclipse.jgit.revwalk.filter.MaxCountRevFilter;
import org.eclipse.jgit.revwalk.filter.RevFilter; import org.eclipse.jgit.revwalk.filter.RevFilter;
import org.eclipse.jgit.revwalk.filter.SkipRevFilter; import org.eclipse.jgit.revwalk.filter.SkipRevFilter;
import org.eclipse.jgit.treewalk.filter.AndTreeFilter; import org.eclipse.jgit.treewalk.filter.*;
import org.eclipse.jgit.treewalk.filter.PathFilter;
import org.eclipse.jgit.treewalk.filter.PathFilterGroup;
import org.eclipse.jgit.treewalk.filter.TreeFilter;
/** /**
* A class used to execute a {@code Log} command. It has setters for all * A class used to execute a {@code Log} command. It has setters for all
@ -105,6 +102,7 @@ public class LogCommand extends GitCommand<Iterable<RevCommit>> {
private RevFilter revFilter; private RevFilter revFilter;
private final List<PathFilter> pathFilters = new ArrayList<>(); private final List<PathFilter> pathFilters = new ArrayList<>();
private final List<TreeFilter> excludeTreeFilters = new ArrayList<>();
private int maxCount = -1; private int maxCount = -1;
@ -133,9 +131,22 @@ public class LogCommand extends GitCommand<Iterable<RevCommit>> {
@Override @Override
public Iterable<RevCommit> call() throws GitAPIException, NoHeadException { public Iterable<RevCommit> call() throws GitAPIException, NoHeadException {
checkCallable(); checkCallable();
if (!pathFilters.isEmpty()) List<TreeFilter> filters = new ArrayList<>();
walk.setTreeFilter(AndTreeFilter.create( if (!pathFilters.isEmpty()) {
PathFilterGroup.create(pathFilters), TreeFilter.ANY_DIFF)); filters.add(AndTreeFilter.create(PathFilterGroup.create(pathFilters), TreeFilter.ANY_DIFF));
}
if (!excludeTreeFilters.isEmpty()) {
for (TreeFilter f : excludeTreeFilters) {
filters.add(AndTreeFilter.create(f, TreeFilter.ANY_DIFF));
}
}
if (!filters.isEmpty()) {
if (filters.size() == 1) {
filters.add(TreeFilter.ANY_DIFF);
}
walk.setTreeFilter(AndTreeFilter.create(filters));
}
if (skip > -1 && maxCount > -1) if (skip > -1 && maxCount > -1)
walk.setRevFilter(AndRevFilter.create(SkipRevFilter.create(skip), walk.setRevFilter(AndRevFilter.create(SkipRevFilter.create(skip),
MaxCountRevFilter.create(maxCount))); MaxCountRevFilter.create(maxCount)));
@ -309,6 +320,24 @@ public class LogCommand extends GitCommand<Iterable<RevCommit>> {
return this; return this;
} }
/**
* Show all commits that are not within any of the specified paths. The path
* must either name a file or a directory exactly and use <code>/</code>
* (slash) as separator. Note that regular expressions or wildcards are not
* yet supported. If a path is both added and excluded from the search, then
* the exclusion wins.
*
* @param path
* a repository-relative path (with <code>/</code> as separator)
* @return {@code this}
* @since 5.6
*/
public LogCommand excludePath(String path) {
checkCallable();
excludeTreeFilters.add(PathFilter.create(path).negate());
return this;
}
/** /**
* Skip the number of commits before starting to show the commit output. * Skip the number of commits before starting to show the commit output.
* *

Write Preview
Loading…
Cancel
Save