From 2cebb7dbc712898197029881a8c1f41628e51804 Mon Sep 17 00:00:00 2001 From: Chris Aniszczyk Date: Sun, 19 Jun 2011 09:17:21 -0500 Subject: [PATCH] Add ReflogCommand Adds a git-reflog command and associated tests. Bug: 347859 Change-Id: Iba146ac842cc9ca0be43d3381b4082c9e92bf56f Signed-off-by: Chris Aniszczyk --- .../eclipse/jgit/api/ReflogCommandTest.java | 90 +++++++++++++++++ .../src/org/eclipse/jgit/api/Git.java | 13 +++ .../org/eclipse/jgit/api/ReflogCommand.java | 99 +++++++++++++++++++ 3 files changed, 202 insertions(+) create mode 100644 org.eclipse.jgit.test/tst/org/eclipse/jgit/api/ReflogCommandTest.java create mode 100644 org.eclipse.jgit/src/org/eclipse/jgit/api/ReflogCommand.java diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/api/ReflogCommandTest.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/api/ReflogCommandTest.java new file mode 100644 index 000000000..03cae44da --- /dev/null +++ b/org.eclipse.jgit.test/tst/org/eclipse/jgit/api/ReflogCommandTest.java @@ -0,0 +1,90 @@ +/* + * Copyright (C) 2011, Chris Aniszczyk + * 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.assertTrue; + +import java.util.Collection; + +import org.eclipse.jgit.lib.RepositoryTestCase; +import org.eclipse.jgit.revwalk.RevCommit; +import org.eclipse.jgit.storage.file.ReflogEntry; +import org.junit.Before; +import org.junit.Test; + +public class ReflogCommandTest extends RepositoryTestCase { + + private Git git; + + private RevCommit commit1, commit2; + + private static final String FILE = "test.txt"; + + @Override + @Before + public void setUp() throws Exception { + super.setUp(); + + git = new Git(db); + // commit something + writeTrashFile(FILE, "Hello world"); + git.add().addFilepattern(FILE).call(); + commit1 = git.commit().setMessage("Initial commit").call(); + git.rm().addFilepattern(FILE).call(); + commit2 = git.commit().setMessage("Removed file").call(); + git.notesAdd().setObjectId(commit1) + .setMessage("data").call(); + } + + @Test + public void testReflog() throws Exception { + Collection reflog = git.reflog().call(); + assertTrue(reflog.size() == 2); + ReflogEntry[] reflogs = reflog.toArray(new ReflogEntry[reflog.size()]); + assertEquals(reflogs[1].getComment(), "commit: Initial commit"); + assertEquals(reflogs[0].getNewId(), commit2.getId()); + assertEquals(reflogs[0].getOldId(), commit1.getId()); + } + +} 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 4d81e86ef..9114f8bac 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java @@ -468,6 +468,19 @@ public class Git { return new BlameCommand(repo); } + /** + * Returns a command object to execute a {@code reflog} command + * + * @see Git documentation about reflog + * @return a {@link ReflogCommand} used to collect all optional parameters + * and to finally execute the {@code reflog} command + */ + public ReflogCommand reflog() { + return new ReflogCommand(repo); + } + /** * @return the git repository this class is interacting with */ diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/ReflogCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/ReflogCommand.java new file mode 100644 index 000000000..71f680745 --- /dev/null +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/ReflogCommand.java @@ -0,0 +1,99 @@ +/* + * Copyright (C) 2011, Chris Aniszczyk + * 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.Collection; + +import org.eclipse.jgit.JGitText; +import org.eclipse.jgit.api.errors.InvalidRemoteException; +import org.eclipse.jgit.lib.Constants; +import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.storage.file.ReflogEntry; +import org.eclipse.jgit.storage.file.ReflogReader; + +/** + * The reflog command + * + * @see Git documentation about reflog + */ +public class ReflogCommand extends GitCommand> { + + private String ref = Constants.R_HEADS + Constants.MASTER; + + /** + * @param repo + */ + public ReflogCommand(Repository repo) { + super(repo); + } + + /** + * The ref used for the reflog operation. If no ref is set, the default + * value of refs/heads/master will be used. + * + * @param ref + * @return {@code this} + */ + public ReflogCommand setRef(String ref) { + checkCallable(); + this.ref = ref; + return this; + } + + public Collection call() throws Exception { + checkCallable(); + + try { + ReflogReader reader = new ReflogReader(repo, ref); + return reader.getReverseEntries(); + } catch (IOException e) { + throw new InvalidRemoteException(MessageFormat.format( + JGitText.get().cannotRead, ref)); + } + } + +} \ No newline at end of file