aboutsummaryrefslogtreecommitdiffstats
path: root/org.eclipse.jgit.test/tst/org/eclipse/jgit/submodule/SubmoduleUpdateTest.java
blob: d54117005d767a9b8bc8994c7704ae4003ef9ea1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
/*
 * Copyright (C) 2011, GitHub Inc. and others
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0 which is available at
 * https://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
package org.eclipse.jgit.submodule;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

import java.io.File;
import java.io.IOException;
import java.util.Collection;

import org.eclipse.jgit.api.CheckoutCommand;
import org.eclipse.jgit.api.Git;
import org.eclipse.jgit.api.InitCommand;
import org.eclipse.jgit.api.SubmoduleAddCommand;
import org.eclipse.jgit.api.SubmoduleUpdateCommand;
import org.eclipse.jgit.api.errors.GitAPIException;
import org.eclipse.jgit.dircache.DirCache;
import org.eclipse.jgit.dircache.DirCacheEditor;
import org.eclipse.jgit.dircache.DirCacheEditor.PathEdit;
import org.eclipse.jgit.dircache.DirCacheEntry;
import org.eclipse.jgit.junit.JGitTestUtil;
import org.eclipse.jgit.junit.RepositoryTestCase;
import org.eclipse.jgit.lib.AnyObjectId;
import org.eclipse.jgit.lib.ConfigConstants;
import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.FileMode;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.lib.StoredConfig;
import org.eclipse.jgit.storage.file.FileBasedConfig;
import org.junit.Test;

/**
 * Unit tests of {@link SubmoduleUpdateCommand}
 */
public class SubmoduleUpdateTest extends RepositoryTestCase {

	private Repository submoduleRepo;

	private Git git;

	private AnyObjectId subRepoCommit2;

	private void createSubmoduleRepo() throws IOException, GitAPIException {
		File directory = createTempDirectory("submodule_repo");
		InitCommand init = Git.init();
		init.setDirectory(directory);
		init.call();
		submoduleRepo = Git.open(directory).getRepository();
		try (Git sub = Git.wrap(submoduleRepo)) {
			// commit something
			JGitTestUtil.writeTrashFile(submoduleRepo, "commit1.txt",
					"commit 1");
			sub.add().addFilepattern("commit1.txt").call();
			sub.commit().setMessage("commit 1").call().getId();

			JGitTestUtil.writeTrashFile(submoduleRepo, "commit2.txt",
					"commit 2");
			sub.add().addFilepattern("commit2.txt").call();
			subRepoCommit2 = sub.commit().setMessage("commit 2").call().getId();
		}
	}

	private void addSubmodule(String path) throws GitAPIException {
		SubmoduleAddCommand command = new SubmoduleAddCommand(db);
		command.setPath(path);
		String uri = submoduleRepo.getDirectory().toURI().toString();
		command.setURI(uri);
		try (Repository repo = command.call()) {
			assertNotNull(repo);
		}
		git.add().addFilepattern(path).addFilepattern(Constants.DOT_GIT_MODULES)
				.call();
		git.commit().setMessage("adding submodule").call();
		recursiveDelete(new File(git.getRepository().getWorkTree(), path));
		recursiveDelete(
				new File(new File(git.getRepository().getCommonDirectory(),
						Constants.MODULES), path));
	}

	@Override
	public void setUp() throws Exception {
		super.setUp();
		createSubmoduleRepo();

		git = Git.wrap(db);
		// commit something
		writeTrashFile("initial.txt", "initial");
		git.add().addFilepattern("initial.txt").call();
		git.commit().setMessage("initial commit").call();
	}

	public void updateModeClonedRestoredSubmoduleTemplate(String mode)
			throws Exception {
		String path = "sub";
		addSubmodule(path);

		StoredConfig cfg = git.getRepository().getConfig();
		if (mode != null) {
			cfg.load();
			cfg.setString(ConfigConstants.CONFIG_SUBMODULE_SECTION, path,
					ConfigConstants.CONFIG_KEY_UPDATE, mode);
			cfg.save();
		}
		SubmoduleUpdateCommand update = new SubmoduleUpdateCommand(db);
		update.call();
		try (Git subGit = Git.open(new File(db.getWorkTree(), path))) {
			update.call();
			assertEquals(subRepoCommit2.getName(),
					subGit.getRepository().getBranch());
		}

		recursiveDelete(new File(db.getWorkTree(), path));

		update.call();
		try (Git subGit = Git.open(new File(db.getWorkTree(), path))) {
			update.call();
			assertEquals(subRepoCommit2.getName(),
					subGit.getRepository().getBranch());
		}
	}

	@Test
	public void repositoryWithNoSubmodules() throws GitAPIException {
		SubmoduleUpdateCommand command = new SubmoduleUpdateCommand(db);
		Collection<String> modules = command.call();
		assertNotNull(modules);
		assertTrue(modules.isEmpty());
	}

	@Test
	public void repositoryWithSubmodule() throws Exception {

		final String path = "sub";
		addSubmodule(path);

		SubmoduleUpdateCommand command = new SubmoduleUpdateCommand(db);
		Collection<String> updated = command.call();
		assertNotNull(updated);
		assertEquals(1, updated.size());
		assertEquals(path, updated.iterator().next());

		try (SubmoduleWalk generator = SubmoduleWalk.forIndex(db)) {
			assertTrue(generator.next());
			try (Repository subRepo = generator.getRepository()) {
				assertNotNull(subRepo);
				assertEquals(subRepoCommit2, subRepo.resolve(Constants.HEAD));
				String worktreeDir = subRepo.getConfig().getString(
						ConfigConstants.CONFIG_CORE_SECTION, null,
						ConfigConstants.CONFIG_KEY_WORKTREE);
				assertEquals("../../../sub", worktreeDir);
				String gitdir = read(
						new File(subRepo.getWorkTree(), Constants.DOT_GIT));
				assertEquals("gitdir: ../.git/modules/sub", gitdir);

			}
		}
	}

	@Test
	public void repositoryWithUnconfiguredSubmodule()
			throws IOException, GitAPIException {
		final ObjectId id = ObjectId
				.fromString("abcd1234abcd1234abcd1234abcd1234abcd1234");
		final String path = "sub";
		DirCache cache = db.lockDirCache();
		DirCacheEditor editor = cache.editor();
		editor.add(new PathEdit(path) {

			@Override
			public void apply(DirCacheEntry ent) {
				ent.setFileMode(FileMode.GITLINK);
				ent.setObjectId(id);
			}
		});
		editor.commit();

		FileBasedConfig modulesConfig = new FileBasedConfig(
				new File(db.getWorkTree(), Constants.DOT_GIT_MODULES),
				db.getFS());
		modulesConfig.setString(ConfigConstants.CONFIG_SUBMODULE_SECTION, path,
				ConfigConstants.CONFIG_KEY_PATH, path);
		String url = "git://server/repo.git";
		modulesConfig.setString(ConfigConstants.CONFIG_SUBMODULE_SECTION, path,
				ConfigConstants.CONFIG_KEY_URL, url);
		modulesConfig.save();

		SubmoduleUpdateCommand command = new SubmoduleUpdateCommand(db);
		Collection<String> updated = command.call();
		assertNotNull(updated);
		assertTrue(updated.isEmpty());
	}

	@Test
	public void repositoryWithInitializedSubmodule()
			throws IOException, GitAPIException {
		final ObjectId id = ObjectId
				.fromString("abcd1234abcd1234abcd1234abcd1234abcd1234");
		final String path = "sub";
		DirCache cache = db.lockDirCache();
		DirCacheEditor editor = cache.editor();
		editor.add(new PathEdit(path) {

			@Override
			public void apply(DirCacheEntry ent) {
				ent.setFileMode(FileMode.GITLINK);
				ent.setObjectId(id);
			}
		});
		editor.commit();

		try (Repository subRepo = Git.init().setBare(false)
				.setDirectory(new File(db.getWorkTree(), path)).call()
				.getRepository()) {
			assertNotNull(subRepo);
		}

		SubmoduleUpdateCommand command = new SubmoduleUpdateCommand(db);
		Collection<String> updated = command.call();
		assertNotNull(updated);
		assertTrue(updated.isEmpty());
	}

	@Test
	public void updateModeMergeClonedRestoredSubmodule() throws Exception {
		updateModeClonedRestoredSubmoduleTemplate(
				ConfigConstants.CONFIG_KEY_MERGE);
	}

	@Test
	public void updateModeRebaseClonedRestoredSubmodule() throws Exception {
		updateModeClonedRestoredSubmoduleTemplate(
				ConfigConstants.CONFIG_KEY_REBASE);
	}

	@Test
	public void updateModeCheckoutClonedRestoredSubmodule() throws Exception {
		updateModeClonedRestoredSubmoduleTemplate(
				ConfigConstants.CONFIG_KEY_CHECKOUT);
	}

	@Test
	public void updateModeMissingClonedRestoredSubmodule() throws Exception {
		updateModeClonedRestoredSubmoduleTemplate(null);
	}

	@Test
	public void updateMode() throws Exception {
		String path = "sub";
		addSubmodule(path);

		StoredConfig cfg = git.getRepository().getConfig();
		cfg.load();
		cfg.setString(ConfigConstants.CONFIG_SUBMODULE_SECTION, path,
				ConfigConstants.CONFIG_KEY_UPDATE,
				ConfigConstants.CONFIG_KEY_REBASE);
		cfg.save();

		SubmoduleUpdateCommand update = new SubmoduleUpdateCommand(db);
		update.call();
		try (Git subGit = Git.open(new File(db.getWorkTree(), path))) {
			CheckoutCommand checkout = subGit.checkout();
			checkout.setName("master");
			checkout.call();
			update.call();
			assertEquals("master", subGit.getRepository().getBranch());
		}

		cfg.load();
		cfg.setString(ConfigConstants.CONFIG_SUBMODULE_SECTION, path,
				ConfigConstants.CONFIG_KEY_UPDATE,
				ConfigConstants.CONFIG_KEY_CHECKOUT);
		cfg.save();

		update.call();
		try (Git subGit = Git.open(new File(db.getWorkTree(), path))) {
			assertEquals(subRepoCommit2.getName(),
					subGit.getRepository().getBranch());
		}

		cfg.load();
		cfg.setString(ConfigConstants.CONFIG_SUBMODULE_SECTION, path,
				ConfigConstants.CONFIG_KEY_UPDATE,
				ConfigConstants.CONFIG_KEY_MERGE);
		cfg.save();

		update.call();
		try (Git subGit = Git.open(new File(db.getWorkTree(), path))) {
			CheckoutCommand checkout = subGit.checkout();
			checkout.setName("master");
			checkout.call();
			update.call();
			assertEquals("master", subGit.getRepository().getBranch());
		}
	}
}