Git Porcelain API: Add Command

The new Add command adds files to the Git Index. 
It  uses the DirCache to access the git index. It 
works also in case of an existing conflict. 

Fileglobs (e.g. *.c) are not yet supported. 

The new Add command does add ignored files because
there is no gitignore support in jgit yet.

Bug: 318440
Change-Id: If16fdd4443e46b27361c2a18ed8f51668af5d9ff
Signed-off-by: Stefan Lay <stefan.lay@sap.com>
This commit is contained in:
Stefan Lay 2010-07-08 10:32:57 +02:00 committed by Christian Halstrick
parent 0ef99921fa
commit 233e0130b5
6 changed files with 572 additions and 1 deletions

View File

@ -0,0 +1,327 @@
/*
* Copyright (C) 2010, Stefan Lay <stefan.lay@sap.com>
* Copyright (C) 2010, Christian Halstrick <christian.halstrick@sap.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 java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import org.eclipse.jgit.dircache.DirCache;
import org.eclipse.jgit.dircache.DirCacheBuilder;
import org.eclipse.jgit.dircache.DirCacheEntry;
import org.eclipse.jgit.lib.FileMode;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.ObjectWriter;
import org.eclipse.jgit.lib.RepositoryTestCase;
public class AddCommandTest extends RepositoryTestCase {
public void testAddNothing() {
Git git = new Git(db);
try {
git.add().call();
fail("Expected IllegalArgumentException");
} catch (NoFilepatternException e) {
// expected
}
}
public void testAddNonExistingSingleFile() throws NoFilepatternException {
Git git = new Git(db);
DirCache dc = git.add().addFilepattern("a.txt").call();
assertEquals(0, dc.getEntryCount());
}
public void testAddExistingSingleFile() throws IOException, NoFilepatternException {
File file = new File(db.getWorkDir(), "a.txt");
file.createNewFile();
PrintWriter writer = new PrintWriter(file);
writer.print("content");
writer.close();
Git git = new Git(db);
DirCache dc = git.add().addFilepattern("a.txt").call();
assertEquals(1, dc.getEntryCount());
assertEquals("a.txt", dc.getEntry(0).getPathString());
assertNotNull(dc.getEntry(0).getObjectId());
assertEquals(file.lastModified(), dc.getEntry(0).getLastModified());
assertEquals(file.length(), dc.getEntry(0).getLength());
assertEquals(FileMode.REGULAR_FILE, dc.getEntry(0).getFileMode());
assertEquals(0, dc.getEntry(0).getStage());
}
public void testAddExistingSingleFileInSubDir() throws IOException, NoFilepatternException {
new File(db.getWorkDir(), "sub").mkdir();
File file = new File(db.getWorkDir(), "sub/a.txt");
file.createNewFile();
PrintWriter writer = new PrintWriter(file);
writer.print("content");
writer.close();
Git git = new Git(db);
DirCache dc = git.add().addFilepattern("sub/a.txt").call();
assertEquals(1, dc.getEntryCount());
assertEquals("sub/a.txt", dc.getEntry(0).getPathString());
assertNotNull(dc.getEntry(0).getObjectId());
assertEquals(file.lastModified(), dc.getEntry(0).getLastModified());
assertEquals(file.length(), dc.getEntry(0).getLength());
assertEquals(FileMode.REGULAR_FILE, dc.getEntry(0).getFileMode());
assertEquals(0, dc.getEntry(0).getStage());
}
public void testAddExistingSingleFileTwice() throws IOException, NoFilepatternException {
File file = new File(db.getWorkDir(), "a.txt");
file.createNewFile();
PrintWriter writer = new PrintWriter(file);
writer.print("content");
writer.close();
Git git = new Git(db);
DirCache dc = git.add().addFilepattern("a.txt").call();
ObjectId id1 = dc.getEntry(0).getObjectId();
writer = new PrintWriter(file);
writer.print("other content");
writer.close();
dc = git.add().addFilepattern("a.txt").call();
assertEquals(1, dc.getEntryCount());
assertEquals("a.txt", dc.getEntry(0).getPathString());
assertNotSame(id1, dc.getEntry(0).getObjectId());
assertEquals(0, dc.getEntry(0).getStage());
}
public void testAddExistingSingleFileTwiceWithCommit() throws Exception {
File file = new File(db.getWorkDir(), "a.txt");
file.createNewFile();
PrintWriter writer = new PrintWriter(file);
writer.print("content");
writer.close();
Git git = new Git(db);
DirCache dc = git.add().addFilepattern("a.txt").call();
ObjectId id1 = dc.getEntry(0).getObjectId();
git.commit().setMessage("commit a.txt").call();
writer = new PrintWriter(file);
writer.print("other content");
writer.close();
dc = git.add().addFilepattern("a.txt").call();
assertEquals(1, dc.getEntryCount());
assertEquals("a.txt", dc.getEntry(0).getPathString());
assertNotSame(id1, dc.getEntry(0).getObjectId());
assertEquals(0, dc.getEntry(0).getStage());
}
public void testAddRemovedFile() throws Exception {
File file = new File(db.getWorkDir(), "a.txt");
file.createNewFile();
PrintWriter writer = new PrintWriter(file);
writer.print("content");
writer.close();
Git git = new Git(db);
DirCache dc = git.add().addFilepattern("a.txt").call();
ObjectId id1 = dc.getEntry(0).getObjectId();
file.delete();
// is supposed to do nothing
dc = git.add().addFilepattern("a.txt").call();
assertEquals(1, dc.getEntryCount());
assertEquals("a.txt", dc.getEntry(0).getPathString());
assertEquals(id1, dc.getEntry(0).getObjectId());
assertEquals(0, dc.getEntry(0).getStage());
}
public void testAddRemovedCommittedFile() throws Exception {
File file = new File(db.getWorkDir(), "a.txt");
file.createNewFile();
PrintWriter writer = new PrintWriter(file);
writer.print("content");
writer.close();
Git git = new Git(db);
DirCache dc = git.add().addFilepattern("a.txt").call();
git.commit().setMessage("commit a.txt").call();
ObjectId id1 = dc.getEntry(0).getObjectId();
file.delete();
// is supposed to do nothing
dc = git.add().addFilepattern("a.txt").call();
assertEquals(1, dc.getEntryCount());
assertEquals("a.txt", dc.getEntry(0).getPathString());
assertEquals(id1, dc.getEntry(0).getObjectId());
assertEquals(0, dc.getEntry(0).getStage());
}
public void testAddWithConflicts() throws Exception {
// prepare conflict
File file = new File(db.getWorkDir(), "a.txt");
file.createNewFile();
PrintWriter writer = new PrintWriter(file);
writer.print("content");
writer.close();
File file2 = new File(db.getWorkDir(), "b.txt");
file2.createNewFile();
writer = new PrintWriter(file2);
writer.print("content b");
writer.close();
ObjectWriter ow = new ObjectWriter(db);
DirCache dc = DirCache.lock(db);
DirCacheBuilder builder = dc.builder();
addEntryToBuilder("b.txt", file2, ow, builder, 0);
addEntryToBuilder("a.txt", file, ow, builder, 1);
writer = new PrintWriter(file);
writer.print("other content");
writer.close();
addEntryToBuilder("a.txt", file, ow, builder, 3);
writer = new PrintWriter(file);
writer.print("our content");
writer.close();
ObjectId id1 = addEntryToBuilder("a.txt", file, ow, builder, 2)
.getObjectId();
builder.commit();
assertEquals(4, dc.getEntryCount());
// now the test begins
Git git = new Git(db);
dc = git.add().addFilepattern("a.txt").call();
assertEquals(2, dc.getEntryCount());
assertEquals("a.txt", dc.getEntry("a.txt").getPathString());
assertEquals(id1, dc.getEntry("a.txt").getObjectId());
assertEquals(0, dc.getEntry("a.txt").getStage());
assertEquals(0, dc.getEntry("b.txt").getStage());
}
public void testAddTwoFiles() throws Exception {
File file = new File(db.getWorkDir(), "a.txt");
file.createNewFile();
PrintWriter writer = new PrintWriter(file);
writer.print("content");
writer.close();
File file2 = new File(db.getWorkDir(), "b.txt");
file2.createNewFile();
writer = new PrintWriter(file2);
writer.print("content b");
writer.close();
Git git = new Git(db);
DirCache dc = git.add().addFilepattern("a.txt").addFilepattern("b.txt").call();
assertEquals("a.txt", dc.getEntry("a.txt").getPathString());
assertEquals("b.txt", dc.getEntry("b.txt").getPathString());
assertNotNull(dc.getEntry("a.txt").getObjectId());
assertNotNull(dc.getEntry("b.txt").getObjectId());
assertEquals(0, dc.getEntry("a.txt").getStage());
assertEquals(0, dc.getEntry("b.txt").getStage());
}
public void testAddFolder() throws Exception {
new File(db.getWorkDir(), "sub").mkdir();
File file = new File(db.getWorkDir(), "sub/a.txt");
file.createNewFile();
PrintWriter writer = new PrintWriter(file);
writer.print("content");
writer.close();
File file2 = new File(db.getWorkDir(), "sub/b.txt");
file2.createNewFile();
writer = new PrintWriter(file2);
writer.print("content b");
writer.close();
Git git = new Git(db);
DirCache dc = git.add().addFilepattern("sub").call();
assertEquals("sub/a.txt", dc.getEntry("sub/a.txt").getPathString());
assertEquals("sub/b.txt", dc.getEntry("sub/b.txt").getPathString());
assertNotNull(dc.getEntry("sub/a.txt").getObjectId());
assertNotNull(dc.getEntry("sub/b.txt").getObjectId());
assertEquals(0, dc.getEntry("sub/a.txt").getStage());
assertEquals(0, dc.getEntry("sub/b.txt").getStage());
}
private DirCacheEntry addEntryToBuilder(String path, File file,
ObjectWriter ow, DirCacheBuilder builder, int stage)
throws IOException {
ObjectId id = ow.writeBlob(file);
DirCacheEntry entry = new DirCacheEntry(path, stage);
entry.setObjectId(id);
entry.setFileMode(FileMode.REGULAR_FILE);
entry.setLastModified(file.lastModified());
entry.setLength((int) file.length());
builder.add(entry);
return entry;
}
}

View File

@ -13,6 +13,7 @@ amazonS3ActionFailedGivingUp={0} of '{1}' failed: Giving up after {2} attempts.
anExceptionOccurredWhileTryingToAddTheIdOfHEAD=An exception occurred while trying to add the Id of HEAD
anSSHSessionHasBeenAlreadyCreated=An SSH session has been already created
atLeastOnePathIsRequired=At least one path is required.
atLeastOnePatternIsRequired=At least one pattern is required.
atLeastTwoFiltersNeeded=At least two filters needed.
badBase64InputCharacterAt=Bad Base64 input character at {0} : {1} (decimal)
badEntryDelimiter=Bad entry delimiter
@ -138,6 +139,7 @@ errorInvalidProtocolWantedOldNewRef=error: invalid protocol: wanted 'old new ref
errorListing=Error listing {0}
errorOccurredDuringUnpackingOnTheRemoteEnd=error occurred during unpacking on the remote end: {0}
errorReadingInfoRefs=error reading info/refs
exceptionCaughtDuringExecutionOfAddCommand=Exception caught during execution of add command
exceptionCaughtDuringExecutionOfCommitCommand=Exception caught during execution of commit command
exceptionCaughtDuringExecutionOfMergeCommand=Exception caught during execution of merge command. {0}
exceptionOccuredDuringAddingOfOptionToALogCommand=Exception occured during adding of {0} as option to a Log command

View File

@ -73,6 +73,7 @@ public static JGitText get() {
/***/ public String anExceptionOccurredWhileTryingToAddTheIdOfHEAD;
/***/ public String anSSHSessionHasBeenAlreadyCreated;
/***/ public String atLeastOnePathIsRequired;
/***/ public String atLeastOnePatternIsRequired;
/***/ public String atLeastTwoFiltersNeeded;
/***/ public String badBase64InputCharacterAt;
/***/ public String badEntryDelimiter;
@ -198,6 +199,7 @@ public static JGitText get() {
/***/ public String errorListing;
/***/ public String errorOccurredDuringUnpackingOnTheRemoteEnd;
/***/ public String errorReadingInfoRefs;
/***/ public String exceptionCaughtDuringExecutionOfAddCommand;
/***/ public String exceptionCaughtDuringExecutionOfCommitCommand;
/***/ public String exceptionCaughtDuringExecutionOfMergeCommand;
/***/ public String exceptionOccuredDuringAddingOfOptionToALogCommand;

View File

@ -0,0 +1,168 @@
/*
* Copyright (C) 2010, Christian Halstrick <christian.halstrick@sap.com>
* Copyright (C) 2010, Stefan Lay <stefan.lay@sap.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 java.io.File;
import java.io.IOException;
import java.util.Collection;
import java.util.LinkedList;
import org.eclipse.jgit.JGitText;
import org.eclipse.jgit.dircache.DirCache;
import org.eclipse.jgit.dircache.DirCacheBuildIterator;
import org.eclipse.jgit.dircache.DirCacheBuilder;
import org.eclipse.jgit.dircache.DirCacheEntry;
import org.eclipse.jgit.dircache.DirCacheIterator;
import org.eclipse.jgit.lib.ObjectWriter;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.treewalk.FileTreeIterator;
import org.eclipse.jgit.treewalk.TreeWalk;
import org.eclipse.jgit.treewalk.filter.PathFilterGroup;
/**
* A class used to execute a {@code Add} 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 <a href="http://www.kernel.org/pub/software/scm/git/docs/git-add.html"
* >Git documentation about Add</a>
*/
public class AddCommand extends GitCommand<DirCache> {
private Collection<String> filepatterns;
/**
*
* @param repo
*/
public AddCommand(Repository repo) {
super(repo);
filepatterns = new LinkedList<String>();
}
/**
* @param filepattern
* File to add content from. Also a leading directory name (e.g.
* dir to add dir/file1 and dir/file2) can be given to add all
* files in the directory, recursively. Fileglobs (e.g. *.c) are
* not yet supported.
* @return {@code this}
*/
public AddCommand addFilepattern(String filepattern) {
checkCallable();
filepatterns.add(filepattern);
return this;
}
/**
* Executes the {@code Add} command. 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 the DirCache after Add
*/
public DirCache call() throws NoFilepatternException {
if (filepatterns.isEmpty())
throw new NoFilepatternException(JGitText.get().atLeastOnePatternIsRequired);
checkCallable();
DirCache dc = null;
try {
dc = DirCache.lock(repo);
ObjectWriter ow = new ObjectWriter(repo);
DirCacheIterator c;
DirCacheBuilder builder = dc.builder();
final TreeWalk tw = new TreeWalk(repo);
tw.reset();
tw.addTree(new DirCacheBuildIterator(builder));
FileTreeIterator fileTreeIterator = new FileTreeIterator(
repo.getWorkDir(), repo.getFS());
tw.addTree(fileTreeIterator);
tw.setRecursive(true);
tw.setFilter(PathFilterGroup.createFromStrings(filepatterns));
String lastAddedFile = null;
while (tw.next()) {
String path = tw.getPathString();
final File file = new File(repo.getWorkDir(), path);
// In case of an existing merge conflict the
// DirCacheBuildIterator iterates over all stages of
// this path, we however want to add only one
// new DirCacheEntry per path.
if (!(path.equals(lastAddedFile))) {
FileTreeIterator f = tw.getTree(1, FileTreeIterator.class);
if (f != null) { // the file exists
DirCacheEntry entry = new DirCacheEntry(path);
entry.setLength((int)f.getEntryLength());
entry.setLastModified(f.getEntryLastModified());
entry.setFileMode(f.getEntryFileMode());
entry.setObjectId(ow.writeBlob(file));
builder.add(entry);
lastAddedFile = path;
} else {
c = tw.getTree(0, DirCacheIterator.class);
builder.add(c.getDirCacheEntry());
}
}
}
builder.commit();
setCallable(false);
} catch (IOException e) {
throw new JGitInternalException(
JGitText.get().exceptionCaughtDuringExecutionOfAddCommand, e);
} finally {
if (dc != null)
dc.unlock();
}
return dc;
}
}

View File

@ -133,9 +133,23 @@ public MergeCommand merge() {
}
/**
* @return the git repository this instance is interacting with
* Returns a command object to execute a {@code Add} command
*
* @see <a
* href="http://www.kernel.org/pub/software/scm/git/docs/git-add.html"
* >Git documentation about Add</a>
* @return a {@link AddCommand} used to collect all optional parameters
* and to finally execute the {@code Add} command
*/
public AddCommand add() {
return new AddCommand(repo);
}
/**
* @return the git repository this class is interacting with
*/
public Repository getRepository() {
return repo;
}
}

View File

@ -0,0 +1,58 @@
/*
* Copyright (C) 2010, Christian Halstrick <christian.halstrick@sap.com>,
* Copyright (C) 2010, Stefan Lay <stefan.lay@sap.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;
/**
* Exception thrown when the options given to a command don't include a
* file pattern which is mandatory for processing.
*/
public class NoFilepatternException extends GitAPIException {
private static final long serialVersionUID = 1L;
NoFilepatternException(String message, Throwable cause) {
super(message, cause);
}
NoFilepatternException(String message) {
super(message);
}
}