View Javadoc
1   /*
2    * Copyright (C) 2010, Google Inc.
3    * and other copyright owners as documented in the project's IP log.
4    *
5    * This program and the accompanying materials are made available
6    * under the terms of the Eclipse Distribution License v1.0 which
7    * accompanies this distribution, is reproduced below, and is
8    * available at http://www.eclipse.org/org/documents/edl-v10.php
9    *
10   * All rights reserved.
11   *
12   * Redistribution and use in source and binary forms, with or
13   * without modification, are permitted provided that the following
14   * conditions are met:
15   *
16   * - Redistributions of source code must retain the above copyright
17   *   notice, this list of conditions and the following disclaimer.
18   *
19   * - Redistributions in binary form must reproduce the above
20   *   copyright notice, this list of conditions and the following
21   *   disclaimer in the documentation and/or other materials provided
22   *   with the distribution.
23   *
24   * - Neither the name of the Eclipse Foundation, Inc. nor the
25   *   names of its contributors may be used to endorse or promote
26   *   products derived from this software without specific prior
27   *   written permission.
28   *
29   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42   */
43  
44  package org.eclipse.jgit.internal.storage.file;
45  
46  import static java.nio.charset.StandardCharsets.UTF_8;
47  import static org.junit.Assert.assertEquals;
48  import static org.junit.Assert.assertNotNull;
49  import static org.junit.Assert.assertTrue;
50  import static org.junit.Assert.fail;
51  
52  import java.io.BufferedWriter;
53  import java.io.File;
54  import java.io.IOException;
55  import java.nio.file.Files;
56  
57  import org.eclipse.jgit.junit.LocalDiskRepositoryTestCase;
58  import org.eclipse.jgit.lib.ConfigConstants;
59  import org.eclipse.jgit.lib.Constants;
60  import org.eclipse.jgit.lib.Repository;
61  import org.eclipse.jgit.lib.StoredConfig;
62  import org.eclipse.jgit.storage.file.FileRepositoryBuilder;
63  import org.eclipse.jgit.util.FileUtils;
64  import org.junit.Test;
65  
66  public class FileRepositoryBuilderTest extends LocalDiskRepositoryTestCase {
67  	@Test
68  	public void testShouldAutomagicallyDetectGitDirectory() throws Exception {
69  		Repository r = createWorkRepository();
70  		File d = new File(r.getDirectory(), "sub-dir");
71  		FileUtils.mkdir(d);
72  
73  		assertEquals(r.getDirectory(), new FileRepositoryBuilder()
74  				.findGitDir(d).getGitDir());
75  	}
76  
77  	@Test
78  	public void emptyRepositoryFormatVersion() throws Exception {
79  		Repository r = createWorkRepository();
80  		StoredConfig config = r.getConfig();
81  		config.setString(ConfigConstants.CONFIG_CORE_SECTION, null,
82  				ConfigConstants.CONFIG_KEY_REPO_FORMAT_VERSION, "");
83  		config.save();
84  
85  		try (FileRepository repo = new FileRepository(r.getDirectory())) {
86  			// Unused
87  		}
88  	}
89  
90  	@Test
91  	public void invalidRepositoryFormatVersion() throws Exception {
92  		Repository r = createWorkRepository();
93  		StoredConfig config = r.getConfig();
94  		config.setString(ConfigConstants.CONFIG_CORE_SECTION, null,
95  				ConfigConstants.CONFIG_KEY_REPO_FORMAT_VERSION, "notanumber");
96  		config.save();
97  
98  		try (FileRepository repo = new FileRepository(r.getDirectory())) {
99  			fail("IllegalArgumentException not thrown");
100 		} catch (IllegalArgumentException e) {
101 			assertNotNull(e.getMessage());
102 		}
103 	}
104 
105 	@Test
106 	public void unknownRepositoryFormatVersion() throws Exception {
107 		Repository r = createWorkRepository();
108 		StoredConfig config = r.getConfig();
109 		config.setLong(ConfigConstants.CONFIG_CORE_SECTION, null,
110 				ConfigConstants.CONFIG_KEY_REPO_FORMAT_VERSION, 999999);
111 		config.save();
112 
113 		try (FileRepository repo = new FileRepository(r.getDirectory())) {
114 			fail("IOException not thrown");
115 		} catch (IOException e) {
116 			assertNotNull(e.getMessage());
117 		}
118 	}
119 
120 	@Test
121 	public void absoluteGitDirRef() throws Exception {
122 		Repository repo1 = createWorkRepository();
123 		File dir = createTempDirectory("dir");
124 		File dotGit = new File(dir, Constants.DOT_GIT);
125 		try (BufferedWriter writer = Files.newBufferedWriter(dotGit.toPath(),
126 				UTF_8)) {
127 			writer.append("gitdir: " + repo1.getDirectory().getAbsolutePath());
128 		}
129 		FileRepositoryBuilder builder = new FileRepositoryBuilder();
130 
131 		builder.setWorkTree(dir);
132 		builder.setMustExist(true);
133 		Repository repo2 = builder.build();
134 
135 		assertEquals(repo1.getDirectory().getAbsolutePath(),
136 				repo2.getDirectory().getAbsolutePath());
137 		assertEquals(dir, repo2.getWorkTree());
138 	}
139 
140 	@Test
141 	public void relativeGitDirRef() throws Exception {
142 		Repository repo1 = createWorkRepository();
143 		File dir = new File(repo1.getWorkTree(), "dir");
144 		assertTrue(dir.mkdir());
145 		File dotGit = new File(dir, Constants.DOT_GIT);
146 		try (BufferedWriter writer = Files.newBufferedWriter(dotGit.toPath(),
147 				UTF_8)) {
148 			writer.append("gitdir: ../" + Constants.DOT_GIT);
149 		}
150 		FileRepositoryBuilder builder = new FileRepositoryBuilder();
151 		builder.setWorkTree(dir);
152 		builder.setMustExist(true);
153 		Repository repo2 = builder.build();
154 
155 		// The tmp directory may be a symlink so the actual path
156 		// may not
157 		assertEquals(repo1.getDirectory().getCanonicalPath(),
158 				repo2.getDirectory().getCanonicalPath());
159 		assertEquals(dir, repo2.getWorkTree());
160 	}
161 
162 	@Test
163 	public void scanWithGitDirRef() throws Exception {
164 		Repository repo1 = createWorkRepository();
165 		File dir = createTempDirectory("dir");
166 		File dotGit = new File(dir, Constants.DOT_GIT);
167 		try (BufferedWriter writer = Files.newBufferedWriter(dotGit.toPath(),
168 				UTF_8)) {
169 			writer.append(
170 					"gitdir: " + repo1.getDirectory().getAbsolutePath());
171 		}
172 		FileRepositoryBuilder builder = new FileRepositoryBuilder();
173 
174 		builder.setWorkTree(dir);
175 		builder.findGitDir(dir);
176 		assertEquals(repo1.getDirectory().getAbsolutePath(),
177 				builder.getGitDir().getAbsolutePath());
178 		builder.setMustExist(true);
179 		Repository repo2 = builder.build();
180 
181 		// The tmp directory may be a symlink
182 		assertEquals(repo1.getDirectory().getCanonicalPath(),
183 				repo2.getDirectory().getCanonicalPath());
184 		assertEquals(dir, repo2.getWorkTree());
185 	}
186 }