From c160293d71a3d2cf1f4a89868e2bf6c420f50cf0 Mon Sep 17 00:00:00 2001 From: Christian Halstrick Date: Wed, 23 Mar 2011 00:06:07 +0100 Subject: [PATCH] Add status command to GIT api Allow users of the GIT api to get to know the state of their workingtree and index by adding a status command. The implementation is mainly a wrapper around IndexDiff class. Better support for multiple stages in the index (conflict situations) is still missing. An appropriate change to IndexDiff and StatusCommand will come in a subsequent commit. Bug: 337296 Change-Id: Idb390375a68611853c1c903299ec678c89b081dc Signed-off-by: Christian Halstrick Signed-off-by: Chris Aniszczyk --- .../eclipse/jgit/api/StatusCommandTest.java | 134 ++++++++++++++++++ .../src/org/eclipse/jgit/api/Git.java | 13 ++ .../src/org/eclipse/jgit/api/Status.java | 122 ++++++++++++++++ .../org/eclipse/jgit/api/StatusCommand.java | 103 ++++++++++++++ 4 files changed, 372 insertions(+) create mode 100644 org.eclipse.jgit.test/tst/org/eclipse/jgit/api/StatusCommandTest.java create mode 100644 org.eclipse.jgit/src/org/eclipse/jgit/api/Status.java create mode 100644 org.eclipse.jgit/src/org/eclipse/jgit/api/StatusCommand.java diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/api/StatusCommandTest.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/api/StatusCommandTest.java new file mode 100644 index 000000000..faca7ea3a --- /dev/null +++ b/org.eclipse.jgit.test/tst/org/eclipse/jgit/api/StatusCommandTest.java @@ -0,0 +1,134 @@ +/* + * Copyright (C) 2011, Christian Halstrick + * 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 org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; + +import java.io.File; +import java.io.IOException; +import java.util.HashSet; +import java.util.Set; + +import org.eclipse.jgit.api.errors.GitAPIException; +import org.eclipse.jgit.api.errors.NoFilepatternException; +import org.eclipse.jgit.lib.RepositoryTestCase; +import org.junit.Test; + +public class StatusCommandTest extends RepositoryTestCase { + + @Test + public void testEmptyStatus() throws IOException { + Git git = new Git(db); + + Status stat = git.status().call(); + assertEquals(0, stat.getAdded().size()); + assertEquals(0, stat.getChanged().size()); + assertEquals(0, stat.getMissing().size()); + assertEquals(0, stat.getModified().size()); + assertEquals(0, stat.getRemoved().size()); + assertEquals(0, stat.getUntracked().size()); + } + + @Test + public void testDifferentStates() throws IOException, + NoFilepatternException, GitAPIException { + Git git = new Git(db); + writeTrashFile("a", "content of a"); + writeTrashFile("b", "content of b"); + writeTrashFile("c", "content of c"); + git.add().addFilepattern("a").addFilepattern("b").call(); + Status stat = git.status().call(); + assertEquals(set("a", "b"), stat.getAdded()); + assertEquals(0, stat.getChanged().size()); + assertEquals(0, stat.getMissing().size()); + assertEquals(0, stat.getModified().size()); + assertEquals(0, stat.getRemoved().size()); + assertEquals(set("c"), stat.getUntracked()); + git.commit().setMessage("initial").call(); + + writeTrashFile("a", "modified content of a"); + writeTrashFile("b", "modified content of b"); + writeTrashFile("d", "content of d"); + git.add().addFilepattern("a").addFilepattern("d").call(); + writeTrashFile("a", "again modified content of a"); + stat = git.status().call(); + assertEquals(set("d"), stat.getAdded()); + assertEquals(set("a"), stat.getChanged()); + assertEquals(0, stat.getMissing().size()); + assertEquals(set("b", "a"), stat.getModified()); + assertEquals(0, stat.getRemoved().size()); + assertEquals(set("c"), stat.getUntracked()); + git.add().addFilepattern(".").call(); + git.commit().setMessage("second").call(); + + stat = git.status().call(); + assertEquals(0, stat.getAdded().size()); + assertEquals(0, stat.getChanged().size()); + assertEquals(0, stat.getMissing().size()); + assertEquals(0, stat.getModified().size()); + assertEquals(0, stat.getRemoved().size()); + assertEquals(0, stat.getUntracked().size()); + + deleteTrashFile("a"); + assertFalse(new File(git.getRepository().getWorkTree(), "a").exists()); + git.add().addFilepattern("a").setUpdate(true).call(); + writeTrashFile("a", "recreated content of a"); + stat = git.status().call(); + assertEquals(0, stat.getAdded().size()); + assertEquals(0, stat.getChanged().size()); + assertEquals(0, stat.getMissing().size()); + assertEquals(0, stat.getModified().size()); + assertEquals(set("a"), stat.getRemoved()); + assertEquals(set("a"), stat.getUntracked()); + git.commit().setMessage("t").call(); + + } + + public static Set set(String... elements) { + Set ret = new HashSet(); + for (String element : elements) + ret.add(element); + return ret; + } +} diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java index 88643f170..d2f205916 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java @@ -334,6 +334,19 @@ public ResetCommand reset() { return new ResetCommand(repo); } + /** + * Returns a command object to execute a {@code status} command + * + * @see Git documentation about status + * @return a {@link StatusCommand} used to collect all optional parameters + * and to finally execute the {@code status} command + */ + public StatusCommand status() { + return new StatusCommand(repo); + } + /** * @return the git repository this class is interacting with */ diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/Status.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/Status.java new file mode 100644 index 000000000..7852aeee6 --- /dev/null +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/Status.java @@ -0,0 +1,122 @@ +/* + * Copyright (C) 2011, Christian Halstrick + * 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 java.util.Collections; +import java.util.Set; + +import org.eclipse.jgit.lib.IndexDiff; + +/** + * A class telling where the working-tree, the index and the current HEAD differ + * from each other. Collections are exposed containing the paths of the modified + * files. E.g. to find out which files are dirty in the working tree (modified + * but not added) you would inspect the collection returned by + * {@link #getModified()}. + *

+ * The same path can be returned by multiple getters. E.g. if a modification has + * been added to the index and afterwards the corresponding working tree file is + * again modified this path will be returned by {@link #getModified()} and + * {@link #getChanged()} + */ +public class Status { + private IndexDiff diff; + + /** + * @param diff + */ + public Status(IndexDiff diff) { + super(); + this.diff = diff; + } + + /** + * @return list of files added to the index, not in HEAD (e.g. what you get + * if you call 'git add ...' on a newly created file) + */ + public Set getAdded() { + return Collections.unmodifiableSet(diff.getAdded()); + } + + /** + * @return list of files changed from HEAD to index (e.g. what you get if + * you modify an existing file and call 'git add ...' on it) + */ + public Set getChanged() { + return Collections.unmodifiableSet(diff.getChanged()); + } + + /** + * @return list of files removed from index, but in HEAD (e.g. what you get + * if you call 'git rm ...' on a existing file) + */ + public Set getRemoved() { + return Collections.unmodifiableSet(diff.getRemoved()); + } + + /** + * @return list of files in index, but not filesystem (e.g. what you get if + * you call 'rm ...' on a existing file) + */ + public Set getMissing() { + return Collections.unmodifiableSet(diff.getMissing()); + } + + /** + * @return list of files modified on disk relative to the index (e.g. what + * you get if you modify an existing file without adding it to the + * index) + */ + public Set getModified() { + return Collections.unmodifiableSet(diff.getModified()); + } + + /** + * @return list of files that are not ignored, and not in the index. (e.g. + * what you get if you create a new file without adding it to the + * index) + */ + public Set getUntracked() { + return Collections.unmodifiableSet(diff.getUntracked()); + } +} diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/StatusCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/StatusCommand.java new file mode 100644 index 000000000..eb1516be0 --- /dev/null +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/StatusCommand.java @@ -0,0 +1,103 @@ +/* + * Copyright (C) 2011, Christian Halstrick + * 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 java.io.IOException; + +import org.eclipse.jgit.errors.NoWorkTreeException; +import org.eclipse.jgit.lib.Constants; +import org.eclipse.jgit.lib.IndexDiff; +import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.treewalk.FileTreeIterator; +import org.eclipse.jgit.treewalk.WorkingTreeIterator; + +/** + * A class used to execute a {@code Status} command. It has setters for all + * supported options and arguments of this command and a {@link #call()} method + * to finally execute the command. Each instance of this class should only be + * used for one invocation of the command (means: one call to {@link #call()}) + * + * @see Git documentation about Status + */ +public class StatusCommand extends GitCommand { + private WorkingTreeIterator workingTreeIt; + + /** + * @param repo + */ + protected StatusCommand(Repository repo) { + super(repo); + // TODO Auto-generated constructor stub + } + + /** + * Executes the {@code Status} command with all the options and parameters + * collected by the setter methods of this class. Each instance of this + * class should only be used for one invocation of the command. Don't call + * this method twice on an instance. + * + * @return a {@link Status} object telling about each path where working + * tree, index or HEAD differ from each other. + */ + public Status call() throws IOException, NoWorkTreeException { + if (workingTreeIt == null) + workingTreeIt = new FileTreeIterator(repo); + + IndexDiff diff = new IndexDiff(repo, Constants.HEAD, workingTreeIt); + diff.diff(); + + return new Status(diff); + } + + /** + * To set the {@link WorkingTreeIterator} which should be used. If this + * method is not called a standard {@link FileTreeIterator} is used. + * + * @param workingTreeIt + */ + public void setWorkingTreeIt(WorkingTreeIterator workingTreeIt) { + this.workingTreeIt = workingTreeIt; + } +}