motiejus
/
jgit
1
Fork 0
Code Releases Activity

Don't assume name = path in .gitmodules 

While parsing .gitmodules, the name of the submodule subsection is
purely arbitrary: it frequently is the path of the submodule, but
there's no requirement for it to be. By building a map of paths to
the section name in .gitmodules, we can more accurately return
the submodule URL.

Bug: 508801
Change-Id: I8399ccada1834d4cc5d023344b97dcf8d5869b16
Also-by: Doug Kelly <dougk.ff7@gmail.com>
Signed-off-by: Doug Kelly <dougk.ff7@gmail.com>
Signed-off-by: Thomas Wolf <thomas.wolf@paranor.ch>
Signed-off-by: David Pursehouse <david.pursehouse@gmail.com>
This commit is contained in:
Thomas Wolf 2017-08-29 09:37:30 +02:00 committed by Matthias Sohn
parent 7317432c31
commit 06ea633c18
2 changed files with 83 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
org.eclipse.jgit.test/tst/org/eclipse/jgit/submodule/SubmoduleWalkTest.java
View File

@ -444,4 +444,44 @@ public void apply(DirCacheEntry ent) {
assertNull(gen.getRepository());
assertFalse(gen.next());
}
@Test
public void testTreeIteratorWithGitmodulesNameNotPath() throws Exception {
final ObjectId subId = ObjectId
.fromString("abcd1234abcd1234abcd1234abcd1234abcd1234");
final String path = "sub";
final String arbitraryName = "x";
final Config gitmodules = new Config();
gitmodules.setString(CONFIG_SUBMODULE_SECTION, arbitraryName,
CONFIG_KEY_PATH, "sub");
gitmodules.setString(CONFIG_SUBMODULE_SECTION, arbitraryName,
CONFIG_KEY_URL, "git://example.com/sub");
RevCommit commit = testDb.getRevWalk()
.parseCommit(testDb.commit().noParents()
.add(DOT_GIT_MODULES, gitmodules.toText())
.edit(new PathEdit(path) {
@Override
public void apply(DirCacheEntry ent) {
ent.setFileMode(FileMode.GITLINK);
ent.setObjectId(subId);
}
}).create());
final CanonicalTreeParser p = new CanonicalTreeParser();
p.reset(testDb.getRevWalk().getObjectReader(), commit.getTree());
SubmoduleWalk gen = SubmoduleWalk.forPath(db, p, "sub");
assertEquals(path, gen.getPath());
assertEquals(subId, gen.getObjectId());
assertEquals(new File(db.getWorkTree(), path), gen.getDirectory());
assertNull(gen.getConfigUpdate());
assertNull(gen.getConfigUrl());
assertEquals("sub", gen.getModulesPath());
assertNull(gen.getModulesUpdate());
assertEquals("git://example.com/sub", gen.getModulesUrl());
assertNull(gen.getRepository());
assertFalse(gen.next());
}
}

54
org.eclipse.jgit/src/org/eclipse/jgit/submodule/SubmoduleWalk.java
View File

@ -46,6 +46,8 @@
import java.io.IOException;
import java.text.MessageFormat;
import java.util.Locale;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.jgit.dircache.DirCache;
import org.eclipse.jgit.dircache.DirCacheIterator;
@ -330,6 +332,8 @@ else if (submoduleUrl.startsWith("../")) { //$NON-NLS-1$
private String path;
private Map<String, String> pathToName;
/**
* Create submodule generator
*
@ -355,6 +359,7 @@ public SubmoduleWalk(final Repository repository) throws IOException {
*/
public SubmoduleWalk setModulesConfig(final Config config) {
modulesConfig = config;
loadPathNames();
return this;
}
@ -374,6 +379,7 @@ public SubmoduleWalk setModulesConfig(final Config config) {
public SubmoduleWalk setRootTree(final AbstractTreeIterator tree) {
rootTree = tree;
modulesConfig = null;
pathToName = null;
return this;
}
@ -396,6 +402,7 @@ public SubmoduleWalk setRootTree(final AnyObjectId id) throws IOException {
p.reset(walk.getObjectReader(), id);
rootTree = p;
modulesConfig = null;
pathToName = null;
return this;
}
@ -419,6 +426,7 @@ public SubmoduleWalk loadModulesConfig() throws IOException, ConfigInvalidExcept
repository.getFS());
config.load();
modulesConfig = config;
loadPathNames();
} else {
try (TreeWalk configWalk = new TreeWalk(repository)) {
configWalk.addTree(rootTree);
@ -438,10 +446,12 @@ public SubmoduleWalk loadModulesConfig() throws IOException, ConfigInvalidExcept
if (filter.isDone(configWalk)) {
modulesConfig = new BlobBasedConfig(null, repository,
configWalk.getObjectId(0));
loadPathNames();
return this;
}
}
modulesConfig = new Config();
pathToName = null;
} finally {
if (idx > 0)
rootTree.next(idx);
@ -451,6 +461,20 @@ public SubmoduleWalk loadModulesConfig() throws IOException, ConfigInvalidExcept
return this;
}
private void loadPathNames() {
pathToName = null;
if (modulesConfig != null) {
HashMap<String, String> pathNames = new HashMap<>();
for (String name : modulesConfig
.getSubsections(ConfigConstants.CONFIG_SUBMODULE_SECTION)) {
pathNames.put(modulesConfig.getString(
ConfigConstants.CONFIG_SUBMODULE_SECTION, name,
ConfigConstants.CONFIG_KEY_PATH), name);
}
pathToName = pathNames;
}
}
/**
* Checks whether the working tree contains a .gitmodules file. That's a
* hint that the repo contains submodules.
@ -475,8 +499,14 @@ public static boolean containsGitModulesFile(Repository repository)
}
private void lazyLoadModulesConfig() throws IOException, ConfigInvalidException {
if (modulesConfig == null)
if (modulesConfig == null) {
loadModulesConfig();
}
}
private String getModuleName(String modulePath) {
String name = pathToName != null ? pathToName.get(modulePath) : null;
return name != null ? name : modulePath;
}
/**
@ -525,6 +555,7 @@ public SubmoduleWalk setTree(final AnyObjectId treeId) throws IOException {
public SubmoduleWalk reset() {
repoConfig = repository.getConfig();
modulesConfig = null;
pathToName = null;
walk.reset();
return this;
}
@ -586,9 +617,8 @@ public ObjectId getObjectId() {
*/
public String getModulesPath() throws IOException, ConfigInvalidException {
lazyLoadModulesConfig();
return modulesConfig.getString(
ConfigConstants.CONFIG_SUBMODULE_SECTION, path,
ConfigConstants.CONFIG_KEY_PATH);
return modulesConfig.getString(ConfigConstants.CONFIG_SUBMODULE_SECTION,
getModuleName(path), ConfigConstants.CONFIG_KEY_PATH);
}
/**
@ -600,6 +630,10 @@ public String getModulesPath() throws IOException, ConfigInvalidException {
* @throws IOException
*/
public String getConfigUrl() throws IOException, ConfigInvalidException {
// SubmoduleInitCommand copies the submodules.*.url and
// submodules.*.update values from .gitmodules to the config, and
// does so using the path defined in .gitmodules as the subsection
// name. So no path-to-name translation is necessary here.
return repoConfig.getString(ConfigConstants.CONFIG_SUBMODULE_SECTION,
path, ConfigConstants.CONFIG_KEY_URL);
}
@ -614,9 +648,8 @@ public String getConfigUrl() throws IOException, ConfigInvalidException {
*/
public String getModulesUrl() throws IOException, ConfigInvalidException {
lazyLoadModulesConfig();
return modulesConfig.getString(
ConfigConstants.CONFIG_SUBMODULE_SECTION, path,
ConfigConstants.CONFIG_KEY_URL);
return modulesConfig.getString(ConfigConstants.CONFIG_SUBMODULE_SECTION,
getModuleName(path), ConfigConstants.CONFIG_KEY_URL);
}
/**
@ -642,9 +675,8 @@ public String getConfigUpdate() throws IOException, ConfigInvalidException {
*/
public String getModulesUpdate() throws IOException, ConfigInvalidException {
lazyLoadModulesConfig();
return modulesConfig.getString(
ConfigConstants.CONFIG_SUBMODULE_SECTION, path,
ConfigConstants.CONFIG_KEY_UPDATE);
return modulesConfig.getString(ConfigConstants.CONFIG_SUBMODULE_SECTION,
getModuleName(path), ConfigConstants.CONFIG_KEY_UPDATE);
}
/**
@ -660,7 +692,7 @@ public IgnoreSubmoduleMode getModulesIgnore() throws IOException,
ConfigInvalidException {
lazyLoadModulesConfig();
String name = modulesConfig.getString(
ConfigConstants.CONFIG_SUBMODULE_SECTION, path,
ConfigConstants.CONFIG_SUBMODULE_SECTION, getModuleName(path),
ConfigConstants.CONFIG_KEY_IGNORE);
if (name == null)
return null;