git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[JGIT PATCH 3/5] JUnit test for FileTreeIterator, WorkingTreeIterator

From
Shawn O. Pearce <spearce@spearce.org>
Date
Aug 28, 2008, 15:27 UTC
Message-ID
<1219937266-24903-3-git-send-email-spearce@spearce.org>
In-Reply-To
<1219937266-24903-2-git-send-email-spearce@spearce.org>

This test is an indirect test of WorkingTreeIterator as the class is abstract. An easy way to test it is through the FileTreeIterator as that relies only on standard Java IO.

We don't have full coverage yet, but most of the cases are dealt with by this test. A better test of WorkingTreeIterator would be to setup a mock implementation that works strictly in memory and throws it all of the corner cases. Building that is a lot more work, and the test will be focusing more on the mock code than on the live library, so I'm punting on it for now.

Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
---
 .../jgit/treewalk/FileTreeIteratorTest.java        |  167 ++++++++++++++++++++
 1 files changed, 167 insertions(+), 0 deletions(-)
 create mode 100644 org.spearce.jgit.test/tst/org/spearce/jgit/treewalk/FileTreeIteratorTest.java
diff --git a/org.spearce.jgit.test/tst/org/spearce/jgit/treewalk/FileTreeIteratorTest.java b/org.spearce.jgit.test/tst/org/spearce/jgit/treewalk/FileTreeIteratorTest.java
new file mode 100644
index 0000000..ca31991
--- /dev/null
+++ b/org.spearce.jgit.test/tst/org/spearce/jgit/treewalk/FileTreeIteratorTest.java
@@ -0,0 +1,167 @@
+/*
+ * Copyright (C) 2008, Google Inc.
+ *
+ * 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 Git Development Community 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.spearce.jgit.treewalk;
+
+import java.io.File;
+import java.security.MessageDigest;
+
+import org.spearce.jgit.lib.Constants;
+import org.spearce.jgit.lib.FileMode;
+import org.spearce.jgit.lib.ObjectId;
+import org.spearce.jgit.lib.RepositoryTestCase;
+import org.spearce.jgit.util.RawParseUtils;
+
+public class FileTreeIteratorTest extends RepositoryTestCase {
+	private final String[] paths = { "a.", "a.b", "a/b", "a0b" };
+
+	private long[] mtime;
+
+	public void setUp() throws Exception {
+		super.setUp();
+
+		// We build the entries backwards so that on POSIX systems we
+		// are likely to get the entries in the trash directory in the
+		// opposite order of what they should be in for the iteration.
+		// This should stress the sorting code better than doing it in
+		// the correct order.
+		//
+		mtime = new long[paths.length];
+		for (int i = paths.length - 1; i >= 0; i--) {
+			final String s = paths[i];
+			writeTrashFile(s, s);
+			mtime[i] = new File(trash, s).lastModified();
+		}
+	}
+
+	public void testEmptyIfRootIsFile() throws Exception {
+		final File r = new File(trash, paths[0]);
+		assertTrue(r.isFile());
+		final FileTreeIterator fti = new FileTreeIterator(r);
+		assertTrue(fti.first());
+		assertTrue(fti.eof());
+	}
+
+	public void testEmptyIfRootDoesNotExist() throws Exception {
+		final File r = new File(trash, "not-existing-file");
+		assertFalse(r.exists());
+		final FileTreeIterator fti = new FileTreeIterator(r);
+		assertTrue(fti.first());
+		assertTrue(fti.eof());
+	}
+
+	public void testEmptyIfRootIsEmpty() throws Exception {
+		final File r = new File(trash, "not-existing-file");
+		assertFalse(r.exists());
+		r.mkdir();
+		assertTrue(r.isDirectory());
+
+		final FileTreeIterator fti = new FileTreeIterator(r);
+		assertTrue(fti.first());
+		assertTrue(fti.eof());
+	}
+
+	public void testSimpleIterate() throws Exception {
+		final FileTreeIterator top = new FileTreeIterator(trash);
+
+		assertTrue(top.first());
+		assertFalse(top.eof());
+		assertEquals(FileMode.REGULAR_FILE.getBits(), top.mode);
+		assertEquals(paths[0], nameOf(top));
+		assertEquals(paths[0].length(), top.getEntryLength());
+		assertEquals(mtime[0], top.getEntryLastModified());
+
+		top.next(1);
+		assertFalse(top.first());
+		assertFalse(top.eof());
+		assertEquals(FileMode.REGULAR_FILE.getBits(), top.mode);
+		assertEquals(paths[1], nameOf(top));
+		assertEquals(paths[1].length(), top.getEntryLength());
+		assertEquals(mtime[1], top.getEntryLastModified());
+
+		top.next(1);
+		assertFalse(top.first());
+		assertFalse(top.eof());
+		assertEquals(FileMode.TREE.getBits(), top.mode);
+
+		final AbstractTreeIterator sub = top.createSubtreeIterator(db);
+		assertTrue(sub instanceof FileTreeIterator);
+		final FileTreeIterator subfti = (FileTreeIterator) sub;
+		assertTrue(sub.first());
+		assertFalse(sub.eof());
+		assertEquals(paths[2], nameOf(sub));
+		assertEquals(paths[2].length(), subfti.getEntryLength());
+		assertEquals(mtime[2], subfti.getEntryLastModified());
+
+		sub.next(1);
+		assertTrue(sub.eof());
+
+		top.next(1);
+		assertFalse(top.first());
+		assertFalse(top.eof());
+		assertEquals(FileMode.REGULAR_FILE.getBits(), top.mode);
+		assertEquals(paths[3], nameOf(top));
+		assertEquals(paths[3].length(), top.getEntryLength());
+		assertEquals(mtime[3], top.getEntryLastModified());
+
+		top.next(1);
+		assertTrue(top.eof());
+	}
+
+	public void testComputeFileObjectId() throws Exception {
+		final FileTreeIterator top = new FileTreeIterator(trash);
+
+		final MessageDigest md = Constants.newMessageDigest();
+		md.update(Constants.encodeASCII(Constants.TYPE_BLOB));
+		md.update((byte) ' ');
+		md.update(Constants.encodeASCII(paths[0].length()));
+		md.update((byte) 0);
+		md.update(Constants.encode(paths[0]));
+		final ObjectId expect = ObjectId.fromRaw(md.digest());
+
+		assertEquals(expect, top.getEntryObjectId());
+
+		// Verify it was cached by removing the file and getting it again.
+		//
+		new File(trash, paths[0]).delete();
+		assertEquals(expect, top.getEntryObjectId());
+	}
+
+	private static String nameOf(final AbstractTreeIterator i) {
+		return RawParseUtils.decode(Constants.CHARSET, i.path, 0, i.pathLen);
+	}
+}
-- 
1.6.0.174.gd789c
Previous: Shawn O. PearceNext: Shawn O. Pearce
Message 3 of 5 in “JUnit test for EmptyTreeIterator”
  1. 1/5 JUnit test for EmptyTreeIteratorShawn O. Pearce, Aug 28, 2008
  2. 2/5 JUnit tests for some TreeFilter implementationsShawn O. Pearce, Aug 28, 2008
  3. 3/5 JUnit test for FileTreeIterator, WorkingTreeIteratorShawn O. Pearce, Aug 28, 2008
  4. 4/5 Increase JUnit coverage on CanonicalTreeParserShawn O. Pearce, Aug 28, 2008
  5. 5/5 Restore IContainer.INCLUDE_HIDDEN within ContainerTreeIteratorShawn O. Pearce, Aug 28, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.