From 97210fd6db864026b8745003ea999eb5501aecb7 Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Mon, 19 Dec 2011 09:46:37 -0800 Subject: [PATCH] Add command support for listing stashed commits Bug: 309355 Change-Id: I34a8c251b89abcdb67565ca49bee02e5e2113593 Signe-off-by: Chris Aniszczyk --- .../jgit/api/StashListCommandTest.java | 136 ++++++++++++++++++ .../src/org/eclipse/jgit/api/Git.java | 11 +- .../eclipse/jgit/api/StashListCommand.java | 113 +++++++++++++++ .../src/org/eclipse/jgit/lib/Constants.java | 6 + .../jgit/storage/file/RefDirectory.java | 4 +- 5 files changed, 268 insertions(+), 2 deletions(-) create mode 100644 org.eclipse.jgit.test/tst/org/eclipse/jgit/api/StashListCommandTest.java create mode 100644 org.eclipse.jgit/src/org/eclipse/jgit/api/StashListCommand.java diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/api/StashListCommandTest.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/api/StashListCommandTest.java new file mode 100644 index 000000000..8d7ecada1 --- /dev/null +++ b/org.eclipse.jgit.test/tst/org/eclipse/jgit/api/StashListCommandTest.java @@ -0,0 +1,136 @@ +/* + * Copyright (C) 2011, GitHub Inc. + * 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.assertNotNull; +import static org.junit.Assert.assertTrue; + +import java.util.Collection; +import java.util.Iterator; + +import org.eclipse.jgit.lib.Constants; +import org.eclipse.jgit.lib.RefUpdate; +import org.eclipse.jgit.lib.RefUpdate.Result; +import org.eclipse.jgit.lib.RepositoryTestCase; +import org.eclipse.jgit.revwalk.RevCommit; +import org.junit.Test; + +/** + * Unit tests of {@link StashListCommand} + */ +public class StashListCommandTest extends RepositoryTestCase { + + @Test + public void noStashRef() throws Exception { + StashListCommand command = Git.wrap(db).stashList(); + Collection stashed = command.call(); + assertNotNull(stashed); + assertTrue(stashed.isEmpty()); + } + + @Test + public void emptyStashReflog() throws Exception { + Git git = Git.wrap(db); + writeTrashFile("file.txt", "content"); + git.add().addFilepattern("file.txt").call(); + RevCommit commit = git.commit().setMessage("create file").call(); + + RefUpdate update = db.updateRef(Constants.R_STASH); + update.setNewObjectId(commit); + update.disableRefLog(); + assertEquals(Result.NEW, update.update()); + + StashListCommand command = Git.wrap(db).stashList(); + Collection stashed = command.call(); + assertNotNull(stashed); + assertTrue(stashed.isEmpty()); + } + + @Test + public void singleStashedCommit() throws Exception { + Git git = Git.wrap(db); + writeTrashFile("file.txt", "content"); + git.add().addFilepattern("file.txt").call(); + RevCommit commit = git.commit().setMessage("create file").call(); + + RefUpdate update = db.updateRef(Constants.R_STASH); + update.setNewObjectId(commit); + assertEquals(Result.NEW, update.update()); + + StashListCommand command = git.stashList(); + Collection stashed = command.call(); + assertNotNull(stashed); + assertEquals(1, stashed.size()); + assertEquals(commit, stashed.iterator().next()); + } + + @Test + public void multipleStashedCommits() throws Exception { + Git git = Git.wrap(db); + + writeTrashFile("file.txt", "content"); + git.add().addFilepattern("file.txt").call(); + RevCommit commit1 = git.commit().setMessage("create file").call(); + + writeTrashFile("file.txt", "content2"); + git.add().addFilepattern("file.txt").call(); + RevCommit commit2 = git.commit().setMessage("edit file").call(); + + RefUpdate create = db.updateRef(Constants.R_STASH); + create.setNewObjectId(commit1); + assertEquals(Result.NEW, create.update()); + + RefUpdate update = db.updateRef(Constants.R_STASH); + update.setNewObjectId(commit2); + assertEquals(Result.FAST_FORWARD, update.update()); + + StashListCommand command = git.stashList(); + Collection stashed = command.call(); + assertNotNull(stashed); + assertEquals(2, stashed.size()); + Iterator iter = stashed.iterator(); + assertEquals(commit2, iter.next()); + assertEquals(commit1, iter.next()); + } +} 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 c72ad08e0..7d34902e9 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java @@ -506,7 +506,7 @@ public DiffCommand diff() { /** * Returns a command object used to delete tags - * + * * @return a {@link DeleteTagCommand} */ public DeleteTagCommand tagDelete() { @@ -564,6 +564,15 @@ public SubmoduleUpdateCommand submoduleUpdate() { return new SubmoduleUpdateCommand(repo); } + /** + * Returns a command object used to list stashed commits + * + * @return a {@link StashListCommand} + */ + public StashListCommand stashList() { + return new StashListCommand(repo); + } + /** * @return the git repository this class is interacting with */ diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/StashListCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/StashListCommand.java new file mode 100644 index 000000000..0cccb20bf --- /dev/null +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/StashListCommand.java @@ -0,0 +1,113 @@ +/* + * Copyright (C) 2011, GitHub Inc. + * 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 java.text.MessageFormat; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.List; + +import org.eclipse.jgit.JGitText; +import org.eclipse.jgit.api.errors.InvalidRefNameException; +import org.eclipse.jgit.api.errors.JGitInternalException; +import org.eclipse.jgit.lib.Constants; +import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.revwalk.RevCommit; +import org.eclipse.jgit.revwalk.RevWalk; +import org.eclipse.jgit.storage.file.ReflogEntry; + +/** + * Command class to list the stashed commits in a repository. + * + * @see Git documentation about Stash + */ +public class StashListCommand extends GitCommand> { + + /** + * Create a new stash list command + * + * @param repo + */ + public StashListCommand(final Repository repo) { + super(repo); + } + + public Collection call() throws Exception { + checkCallable(); + + try { + if (repo.getRef(Constants.R_STASH) == null) + return Collections.emptyList(); + } catch (IOException e) { + throw new InvalidRefNameException(MessageFormat.format( + JGitText.get().cannotRead, Constants.R_STASH), e); + } + + final ReflogCommand refLog = new ReflogCommand(repo); + refLog.setRef(Constants.R_STASH); + final Collection stashEntries = refLog.call(); + if (stashEntries.isEmpty()) + return Collections.emptyList(); + + final List stashCommits = new ArrayList( + stashEntries.size()); + final RevWalk walk = new RevWalk(repo); + walk.setRetainBody(true); + try { + for (ReflogEntry entry : stashEntries) + try { + stashCommits.add(walk.parseCommit(entry.getNewId())); + } catch (IOException e) { + throw new JGitInternalException(MessageFormat.format( + JGitText.get().cannotReadCommit, entry.getNewId()), + e); + } + } finally { + walk.dispose(); + } + return stashCommits; + } +} diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/Constants.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/Constants.java index f6dff9998..2d49d6be5 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/Constants.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/Constants.java @@ -231,6 +231,9 @@ public final class Constants { /** Default main branch name */ public static final String MASTER = "master"; + /** Default stash branch name */ + public static final String STASH = "stash"; + /** Prefix for branch refs */ public static final String R_HEADS = "refs/heads/"; @@ -249,6 +252,9 @@ public final class Constants { /** Prefix for any ref */ public static final String R_REFS = "refs/"; + /** Standard stash ref */ + public static final String R_STASH = R_REFS + STASH; + /** Logs folder name */ public static final String LOGS = "logs"; diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/RefDirectory.java b/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/RefDirectory.java index 47b484e39..37d8f38ec 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/RefDirectory.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/storage/file/RefDirectory.java @@ -54,6 +54,7 @@ import static org.eclipse.jgit.lib.Constants.R_HEADS; import static org.eclipse.jgit.lib.Constants.R_REFS; import static org.eclipse.jgit.lib.Constants.R_REMOTES; +import static org.eclipse.jgit.lib.Constants.R_STASH; import static org.eclipse.jgit.lib.Constants.R_TAGS; import static org.eclipse.jgit.lib.Constants.encode; import static org.eclipse.jgit.lib.Ref.Storage.LOOSE; @@ -671,7 +672,8 @@ private boolean isLogAllRefUpdates() { private boolean shouldAutoCreateLog(final String refName) { return refName.equals(HEAD) // || refName.startsWith(R_HEADS) // - || refName.startsWith(R_REMOTES); + || refName.startsWith(R_REMOTES) // + || refName.equals(R_STASH); } private Ref resolve(final Ref ref, int depth, String prefix,