View Javadoc
1   /*
2    * Copyright (C) 2008-2010, Google Inc. and others
3    *
4    * This program and the accompanying materials are made available under the
5    * terms of the Eclipse Distribution License v. 1.0 which is available at
6    * https://www.eclipse.org/org/documents/edl-v10.php.
7    *
8    * SPDX-License-Identifier: BSD-3-Clause
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.errors.CorruptObjectException;
32  import org.eclipse.jgit.junit.JGitTestUtil;
33  import org.eclipse.jgit.junit.LocalDiskRepositoryTestCase;
34  import org.eclipse.jgit.lib.FileMode;
35  import org.eclipse.jgit.lib.ObjectId;
36  import org.eclipse.jgit.lib.Repository;
37  import org.eclipse.jgit.treewalk.TreeWalk;
38  import org.eclipse.jgit.util.FS;
39  import org.eclipse.jgit.util.IO;
40  import org.junit.Test;
41  
42  public class DirCacheCGitCompatabilityTest extends LocalDiskRepositoryTestCase {
43  	private final File index = pathOf("gitgit.index");
44  
45  	@Test
46  	public void testReadIndex_LsFiles() throws Exception {
47  		final Map<String, CGitIndexRecord> ls = readLsFiles();
48  		final DirCache dc = new DirCache(index, FS.DETECTED);
49  		assertEquals(0, dc.getEntryCount());
50  		dc.read();
51  		assertEquals(ls.size(), dc.getEntryCount());
52  		{
53  			final Iterator<CGitIndexRecord> rItr = ls.values().iterator();
54  			for (int i = 0; rItr.hasNext(); i++)
55  				assertEqual(rItr.next(), dc.getEntry(i));
56  		}
57  	}
58  
59  	@Test
60  	public void testTreeWalk_LsFiles() throws Exception {
61  		final Repository db = createBareRepository();
62  		final Map<String, CGitIndexRecord> ls = readLsFiles();
63  		final DirCache dc = new DirCache(index, db.getFS());
64  		assertEquals(0, dc.getEntryCount());
65  		dc.read();
66  		assertEquals(ls.size(), dc.getEntryCount());
67  		{
68  			final Iterator<CGitIndexRecord> rItr = ls.values().iterator();
69  			try (TreeWalk tw = new TreeWalk(db)) {
70  				tw.setRecursive(true);
71  				tw.addTree(new DirCacheIterator(dc));
72  				while (rItr.hasNext()) {
73  					final DirCacheIterator dcItr;
74  
75  					assertTrue(tw.next());
76  					dcItr = tw.getTree(0, DirCacheIterator.class);
77  					assertNotNull(dcItr);
78  
79  					assertEqual(rItr.next(), dcItr.getDirCacheEntry());
80  				}
81  			}
82  		}
83  	}
84  
85  	@Test
86  	public void testUnsupportedOptionalExtension() throws Exception {
87  		final DirCache dc = new DirCache(pathOf("gitgit.index.ZZZZ"),
88  				FS.DETECTED);
89  		dc.read();
90  		assertEquals(1, dc.getEntryCount());
91  		assertEquals("A", dc.getEntry(0).getPathString());
92  	}
93  
94  	@Test
95  	public void testUnsupportedRequiredExtension() throws Exception {
96  		final DirCache dc = new DirCache(pathOf("gitgit.index.aaaa"),
97  				FS.DETECTED);
98  		try {
99  			dc.read();
100 			fail("Cache loaded an unsupported extension");
101 		} catch (CorruptObjectException err) {
102 			assertEquals("DIRC extension 'aaaa'"
103 					+ " not supported by this version.", err.getMessage());
104 		}
105 	}
106 
107 	@Test
108 	public void testCorruptChecksumAtFooter() throws Exception {
109 		final DirCache dc = new DirCache(pathOf("gitgit.index.badchecksum"),
110 				FS.DETECTED);
111 		try {
112 			dc.read();
113 			fail("Cache loaded despite corrupt checksum");
114 		} catch (CorruptObjectException err) {
115 			assertEquals("DIRC checksum mismatch", err.getMessage());
116 		}
117 	}
118 
119 	private static void assertEqual(final CGitIndexRecord c,
120 			final DirCacheEntry j) {
121 		assertNotNull(c);
122 		assertNotNull(j);
123 
124 		assertEquals(c.path, j.getPathString());
125 		assertEquals(c.id, j.getObjectId());
126 		assertEquals(c.mode, j.getRawMode());
127 		assertEquals(c.stage, j.getStage());
128 	}
129 
130 	@Test
131 	public void testReadIndex_DirCacheTree() throws Exception {
132 		final Map<String, CGitIndexRecord> cList = readLsFiles();
133 		final Map<String, CGitLsTreeRecord> cTree = readLsTree();
134 		final DirCache dc = new DirCache(index, FS.DETECTED);
135 		assertEquals(0, dc.getEntryCount());
136 		dc.read();
137 		assertEquals(cList.size(), dc.getEntryCount());
138 
139 		final DirCacheTree jTree = dc.getCacheTree(false);
140 		assertNotNull(jTree);
141 		assertEquals("", jTree.getNameString());
142 		assertEquals("", jTree.getPathString());
143 		assertTrue(jTree.isValid());
144 		assertEquals(ObjectId
145 				.fromString("698dd0b8d0c299f080559a1cffc7fe029479a408"), jTree
146 				.getObjectId());
147 		assertEquals(cList.size(), jTree.getEntrySpan());
148 
149 		final ArrayList<CGitLsTreeRecord> subtrees = new ArrayList<>();
150 		for (CGitLsTreeRecord r : cTree.values()) {
151 			if (FileMode.TREE.equals(r.mode))
152 				subtrees.add(r);
153 		}
154 		assertEquals(subtrees.size(), jTree.getChildCount());
155 
156 		for (int i = 0; i < jTree.getChildCount(); i++) {
157 			final DirCacheTree sj = jTree.getChild(i);
158 			final CGitLsTreeRecord sc = subtrees.get(i);
159 			assertEquals(sc.path, sj.getNameString());
160 			assertEquals(sc.path + "/", sj.getPathString());
161 			assertTrue(sj.isValid());
162 			assertEquals(sc.id, sj.getObjectId());
163 		}
164 	}
165 
166 	@Test
167 	public void testReadWriteV3() throws Exception {
168 		final File file = pathOf("gitgit.index.v3");
169 		final DirCache dc = new DirCache(file, FS.DETECTED);
170 		dc.read();
171 
172 		assertEquals(10, dc.getEntryCount());
173 		assertV3TreeEntry(0, "dir1/file1.txt", false, false, dc);
174 		assertV3TreeEntry(1, "dir2/file2.txt", true, false, dc);
175 		assertV3TreeEntry(2, "dir3/file3.txt", false, false, dc);
176 		assertV3TreeEntry(3, "dir3/file3a.txt", true, false, dc);
177 		assertV3TreeEntry(4, "dir4/file4.txt", true, false, dc);
178 		assertV3TreeEntry(5, "dir4/file4a.txt", false, false, dc);
179 		assertV3TreeEntry(6, "file.txt", true, false, dc);
180 		assertV3TreeEntry(7, "newdir1/newfile1.txt", false, true, dc);
181 		assertV3TreeEntry(8, "newdir1/newfile2.txt", false, true, dc);
182 		assertV3TreeEntry(9, "newfile.txt", false, true, dc);
183 
184 		final ByteArrayOutputStream bos = new ByteArrayOutputStream();
185 		dc.writeTo(null, bos);
186 		final byte[] indexBytes = bos.toByteArray();
187 		final byte[] expectedBytes = IO.readFully(file);
188 		assertArrayEquals(expectedBytes, indexBytes);
189 	}
190 
191 	private static void assertV3TreeEntry(int indexPosition, String path,
192 			boolean skipWorkTree, boolean intentToAdd, DirCache dc) {
193 		final DirCacheEntry entry = dc.getEntry(indexPosition);
194 		assertEquals(path, entry.getPathString());
195 		assertEquals(skipWorkTree, entry.isSkipWorkTree());
196 		assertEquals(intentToAdd, entry.isIntentToAdd());
197 	}
198 
199 	private static File pathOf(String name) {
200 		return JGitTestUtil.getTestResourceFile(name);
201 	}
202 
203 	private static Map<String, CGitIndexRecord> readLsFiles() throws Exception {
204 		final LinkedHashMap<String, CGitIndexRecord> r = new LinkedHashMap<>();
205 		try (BufferedReader br = new BufferedReader(new InputStreamReader(
206 				new FileInputStream(pathOf("gitgit.lsfiles")), UTF_8))) {
207 			String line;
208 			while ((line = br.readLine()) != null) {
209 				final CGitIndexRecord cr = new CGitIndexRecord(line);
210 				r.put(cr.path, cr);
211 			}
212 		}
213 		return r;
214 	}
215 
216 	private static Map<String, CGitLsTreeRecord> readLsTree() throws Exception {
217 		final LinkedHashMap<String, CGitLsTreeRecord> r = new LinkedHashMap<>();
218 		try (BufferedReader br = new BufferedReader(new InputStreamReader(
219 				new FileInputStream(pathOf("gitgit.lstree")), UTF_8))) {
220 			String line;
221 			while ((line = br.readLine()) != null) {
222 				final CGitLsTreeRecord cr = new CGitLsTreeRecord(line);
223 				r.put(cr.path, cr);
224 			}
225 		}
226 		return r;
227 	}
228 
229 	private static class CGitIndexRecord {
230 		final int mode;
231 
232 		final ObjectId id;
233 
234 		final int stage;
235 
236 		final String path;
237 
238 		CGitIndexRecord(String line) {
239 			final int tab = line.indexOf('\t');
240 			final int sp1 = line.indexOf(' ');
241 			final int sp2 = line.indexOf(' ', sp1 + 1);
242 			mode = Integer.parseInt(line.substring(0, sp1), 8);
243 			id = ObjectId.fromString(line.substring(sp1 + 1, sp2));
244 			stage = Integer.parseInt(line.substring(sp2 + 1, tab));
245 			path = line.substring(tab + 1);
246 		}
247 	}
248 
249 	private static class CGitLsTreeRecord {
250 		final int mode;
251 
252 		final ObjectId id;
253 
254 		final String path;
255 
256 		CGitLsTreeRecord(String line) {
257 			final int tab = line.indexOf('\t');
258 			final int sp1 = line.indexOf(' ');
259 			final int sp2 = line.indexOf(' ', sp1 + 1);
260 			mode = Integer.parseInt(line.substring(0, sp1), 8);
261 			id = ObjectId.fromString(line.substring(sp2 + 1, tab));
262 			path = line.substring(tab + 1);
263 		}
264 	}
265 }