1
2
3
4
5
6
7
8
9
10
11 package org.eclipse.jgit.dircache;
12
13 import static java.nio.charset.StandardCharsets.UTF_8;
14 import static org.eclipse.jgit.junit.Assert.assertEquals;
15 import static org.junit.Assert.assertArrayEquals;
16 import static org.junit.Assert.assertEquals;
17 import static org.junit.Assert.assertNotNull;
18 import static org.junit.Assert.assertTrue;
19 import static org.junit.Assert.fail;
20
21 import java.io.BufferedReader;
22 import java.io.ByteArrayOutputStream;
23 import java.io.File;
24 import java.io.FileInputStream;
25 import java.io.InputStreamReader;
26 import java.util.ArrayList;
27 import java.util.Iterator;
28 import java.util.LinkedHashMap;
29 import java.util.Map;
30
31 import org.eclipse.jgit.dircache.DirCache.DirCacheVersion;
32 import org.eclipse.jgit.errors.CorruptObjectException;
33 import org.eclipse.jgit.junit.JGitTestUtil;
34 import org.eclipse.jgit.junit.LocalDiskRepositoryTestCase;
35 import org.eclipse.jgit.lib.FileMode;
36 import org.eclipse.jgit.lib.ObjectId;
37 import org.eclipse.jgit.lib.Repository;
38 import org.eclipse.jgit.treewalk.TreeWalk;
39 import org.eclipse.jgit.util.FS;
40 import org.eclipse.jgit.util.IO;
41 import org.junit.Test;
42
43 public class DirCacheCGitCompatabilityTest extends LocalDiskRepositoryTestCase {
44 private final File index = pathOf("gitgit.index");
45
46 @Test
47 public void testReadIndex_LsFiles() throws Exception {
48 final Map<String, CGitIndexRecord> ls = readLsFiles();
49 final DirCache dc = new DirCache(index, FS.DETECTED);
50 assertEquals(0, dc.getEntryCount());
51 dc.read();
52 assertEquals(ls.size(), dc.getEntryCount());
53 {
54 final Iterator<CGitIndexRecord> rItr = ls.values().iterator();
55 for (int i = 0; rItr.hasNext(); i++)
56 assertEqual(rItr.next(), dc.getEntry(i));
57 }
58 }
59
60 @Test
61 public void testTreeWalk_LsFiles() throws Exception {
62 final Repository db = createBareRepository();
63 final Map<String, CGitIndexRecord> ls = readLsFiles();
64 final DirCache dc = new DirCache(index, db.getFS());
65 assertEquals(0, dc.getEntryCount());
66 dc.read();
67 assertEquals(ls.size(), dc.getEntryCount());
68 {
69 final Iterator<CGitIndexRecord> rItr = ls.values().iterator();
70 try (TreeWalk tw = new TreeWalk(db)) {
71 tw.setRecursive(true);
72 tw.addTree(new DirCacheIterator(dc));
73 while (rItr.hasNext()) {
74 final DirCacheIterator dcItr;
75
76 assertTrue(tw.next());
77 dcItr = tw.getTree(0, DirCacheIterator.class);
78 assertNotNull(dcItr);
79
80 assertEqual(rItr.next(), dcItr.getDirCacheEntry());
81 }
82 }
83 }
84 }
85
86 @Test
87 public void testUnsupportedOptionalExtension() throws Exception {
88 final DirCache dc = new DirCache(pathOf("gitgit.index.ZZZZ"),
89 FS.DETECTED);
90 dc.read();
91 assertEquals(1, dc.getEntryCount());
92 assertEquals("A", dc.getEntry(0).getPathString());
93 }
94
95 @Test
96 public void testUnsupportedRequiredExtension() throws Exception {
97 final DirCache dc = new DirCache(pathOf("gitgit.index.aaaa"),
98 FS.DETECTED);
99 try {
100 dc.read();
101 fail("Cache loaded an unsupported extension");
102 } catch (CorruptObjectException err) {
103 assertEquals("DIRC extension 'aaaa'"
104 + " not supported by this version.", err.getMessage());
105 }
106 }
107
108 @Test
109 public void testCorruptChecksumAtFooter() throws Exception {
110 final DirCache dc = new DirCache(pathOf("gitgit.index.badchecksum"),
111 FS.DETECTED);
112 try {
113 dc.read();
114 fail("Cache loaded despite corrupt checksum");
115 } catch (CorruptObjectException err) {
116 assertEquals("DIRC checksum mismatch", err.getMessage());
117 }
118 }
119
120 private static void assertEqual(final CGitIndexRecord c,
121 final DirCacheEntry j) {
122 assertNotNull(c);
123 assertNotNull(j);
124
125 assertEquals(c.path, j.getPathString());
126 assertEquals(c.id, j.getObjectId());
127 assertEquals(c.mode, j.getRawMode());
128 assertEquals(c.stage, j.getStage());
129 }
130
131 @Test
132 public void testReadIndex_DirCacheTree() throws Exception {
133 final Map<String, CGitIndexRecord> cList = readLsFiles();
134 final Map<String, CGitLsTreeRecord> cTree = readLsTree();
135 final DirCache dc = new DirCache(index, FS.DETECTED);
136 assertEquals(0, dc.getEntryCount());
137 dc.read();
138 assertEquals(cList.size(), dc.getEntryCount());
139
140 final DirCacheTree jTree = dc.getCacheTree(false);
141 assertNotNull(jTree);
142 assertEquals("", jTree.getNameString());
143 assertEquals("", jTree.getPathString());
144 assertTrue(jTree.isValid());
145 assertEquals(ObjectId
146 .fromString("698dd0b8d0c299f080559a1cffc7fe029479a408"), jTree
147 .getObjectId());
148 assertEquals(cList.size(), jTree.getEntrySpan());
149
150 final ArrayList<CGitLsTreeRecord> subtrees = new ArrayList<>();
151 for (CGitLsTreeRecord r : cTree.values()) {
152 if (FileMode.TREE.equals(r.mode))
153 subtrees.add(r);
154 }
155 assertEquals(subtrees.size(), jTree.getChildCount());
156
157 for (int i = 0; i < jTree.getChildCount(); i++) {
158 final DirCacheTree sj = jTree.getChild(i);
159 final CGitLsTreeRecord sc = subtrees.get(i);
160 assertEquals(sc.path, sj.getNameString());
161 assertEquals(sc.path + "/", sj.getPathString());
162 assertTrue(sj.isValid());
163 assertEquals(sc.id, sj.getObjectId());
164 }
165 }
166
167 @Test
168 public void testReadWriteV3() throws Exception {
169 final File file = pathOf("gitgit.index.v3");
170 final DirCache dc = new DirCache(file, FS.DETECTED);
171 dc.read();
172
173 assertEquals(10, dc.getEntryCount());
174 assertV3TreeEntry(0, "dir1/file1.txt", false, false, dc);
175 assertV3TreeEntry(1, "dir2/file2.txt", true, false, dc);
176 assertV3TreeEntry(2, "dir3/file3.txt", false, false, dc);
177 assertV3TreeEntry(3, "dir3/file3a.txt", true, false, dc);
178 assertV3TreeEntry(4, "dir4/file4.txt", true, false, dc);
179 assertV3TreeEntry(5, "dir4/file4a.txt", false, false, dc);
180 assertV3TreeEntry(6, "file.txt", true, false, dc);
181 assertV3TreeEntry(7, "newdir1/newfile1.txt", false, true, dc);
182 assertV3TreeEntry(8, "newdir1/newfile2.txt", false, true, dc);
183 assertV3TreeEntry(9, "newfile.txt", false, true, dc);
184
185 final ByteArrayOutputStream bos = new ByteArrayOutputStream();
186 dc.writeTo(null, bos);
187 final byte[] indexBytes = bos.toByteArray();
188 final byte[] expectedBytes = IO.readFully(file);
189 assertArrayEquals(expectedBytes, indexBytes);
190 }
191
192 @Test
193 public void testReadWriteV4() throws Exception {
194 final File file = pathOf("gitgit.index.v4");
195 final DirCache dc = new DirCache(file, FS.DETECTED);
196 dc.read();
197 assertEquals(DirCacheVersion.DIRC_VERSION_PATHCOMPRESS,
198 dc.getVersion());
199 assertEquals(5, dc.getEntryCount());
200 assertV4TreeEntry(0, "src/org/eclipse/jgit/atest/foo.txt", false, dc);
201 assertV4TreeEntry(1, "src/org/eclipse/jgit/atest/foobar.txt", false,
202 dc);
203 assertV4TreeEntry(2, "src/org/eclipse/jgit/other/bar.txt", true, dc);
204 assertV4TreeEntry(3, "test.txt", false, dc);
205 assertV4TreeEntry(4, "test.txt2", false, dc);
206
207 final ByteArrayOutputStream bos = new ByteArrayOutputStream();
208 dc.writeTo(null, bos);
209 final byte[] indexBytes = bos.toByteArray();
210 final byte[] expectedBytes = IO.readFully(file);
211 assertArrayEquals(expectedBytes, indexBytes);
212 }
213
214 private static void assertV3TreeEntry(int indexPosition, String path,
215 boolean skipWorkTree, boolean intentToAdd, DirCache dc) {
216 final DirCacheEntry entry = dc.getEntry(indexPosition);
217 assertEquals(path, entry.getPathString());
218 assertEquals(skipWorkTree, entry.isSkipWorkTree());
219 assertEquals(intentToAdd, entry.isIntentToAdd());
220 }
221
222 private static void assertV4TreeEntry(int indexPosition, String path,
223 boolean skipWorkTree, DirCache dc) {
224 final DirCacheEntry entry = dc.getEntry(indexPosition);
225 assertEquals(path, entry.getPathString());
226 assertEquals(skipWorkTree, entry.isSkipWorkTree());
227 }
228
229 private static File pathOf(String name) {
230 return JGitTestUtil.getTestResourceFile(name);
231 }
232
233 private static Map<String, CGitIndexRecord> readLsFiles() throws Exception {
234 final LinkedHashMap<String, CGitIndexRecord> r = new LinkedHashMap<>();
235 try (BufferedReader br = new BufferedReader(new InputStreamReader(
236 new FileInputStream(pathOf("gitgit.lsfiles")), UTF_8))) {
237 String line;
238 while ((line = br.readLine()) != null) {
239 final CGitIndexRecord cr = new CGitIndexRecord(line);
240 r.put(cr.path, cr);
241 }
242 }
243 return r;
244 }
245
246 private static Map<String, CGitLsTreeRecord> readLsTree() throws Exception {
247 final LinkedHashMap<String, CGitLsTreeRecord> r = new LinkedHashMap<>();
248 try (BufferedReader br = new BufferedReader(new InputStreamReader(
249 new FileInputStream(pathOf("gitgit.lstree")), UTF_8))) {
250 String line;
251 while ((line = br.readLine()) != null) {
252 final CGitLsTreeRecord cr = new CGitLsTreeRecord(line);
253 r.put(cr.path, cr);
254 }
255 }
256 return r;
257 }
258
259 private static class CGitIndexRecord {
260 final int mode;
261
262 final ObjectId id;
263
264 final int stage;
265
266 final String path;
267
268 CGitIndexRecord(String line) {
269 final int tab = line.indexOf('\t');
270 final int sp1 = line.indexOf(' ');
271 final int sp2 = line.indexOf(' ', sp1 + 1);
272 mode = Integer.parseInt(line.substring(0, sp1), 8);
273 id = ObjectId.fromString(line.substring(sp1 + 1, sp2));
274 stage = Integer.parseInt(line.substring(sp2 + 1, tab));
275 path = line.substring(tab + 1);
276 }
277 }
278
279 private static class CGitLsTreeRecord {
280 final int mode;
281
282 final ObjectId id;
283
284 final String path;
285
286 CGitLsTreeRecord(String line) {
287 final int tab = line.indexOf('\t');
288 final int sp1 = line.indexOf(' ');
289 final int sp2 = line.indexOf(' ', sp1 + 1);
290 mode = Integer.parseInt(line.substring(0, sp1), 8);
291 id = ObjectId.fromString(line.substring(sp2 + 1, tab));
292 path = line.substring(tab + 1);
293 }
294 }
295 }