Skip to content

Commit 748cf02

Browse files
hgschmiehgschmie
committed
Allow defined and automatic modules to co-exist
In a maven project, a maven module creates two artifacts: - a main artifact with a module-info.class file that defines a JPMS module "foo.bar". The jar is called foo-bar-1.0.jar - a test artifact which is not a JPMS module. It is called foo-bar-1.0-tests.jar Another module declares dependencies on both modules: <dependencies> <dependency> <groupId>xxx</groupId> <artifactId>foo-bar</artifactId> <version>1.0</version> </dependency> <dependency> <groupId>xxx</groupId> <artifactId>foo-bar</artifactId> <version>1.0</version> <classifier>tests</classifier> <scope>test</scope> </dependency> </dependencies> This is a common use case in large projects. The LocationManager now creates two JavaModuleDescriptors for the "foo.bar" JPMS module. One from the main artifact and its module-info.class (automatic == false) and one from the test artifact (automatic == true). The current code considers these duplicates and drops one. As a result, the test code no longer compiles because a dependency is missing. The patch separates out modules with a module descriptor and automatic modules. Then it adds the modules with module descriptors to the module path. Any duplicate is dropped for modules with module descriptors. Finally, it adds the automatic modules; if a module with the same module id already exists on the module path, it adds it to the class path. In the case above, this will allow the compile to successfully compile test code (the tests dependency drops to the class path, while the main artifact is on the module path).
1 parent 6d7f315 commit 748cf02

File tree

4 files changed

+95
-14
lines changed

4 files changed

+95
-14
lines changed

‎plexus-java/src/main/java/org/codehaus/plexus/languages/java/jpms/LocationManager.java‎

Lines changed: 38 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
import java.util.Map;
3535
import java.util.Map.Entry;
3636
import java.util.Set;
37+
import java.util.function.Consumer;
3738

3839
import org.codehaus.plexus.languages.java.jpms.JavaModuleDescriptor.JavaProvides;
3940

@@ -249,22 +250,47 @@ public String extract(Path path) throws IOException {
249250
request.isIncludeStatic());
250251
}
251252

252-
// in case of identical module names, first one wins
253+
Map<T, JavaModuleDescriptor> definedModules = new HashMap<>();
254+
Map<T, JavaModuleDescriptor> automaticModules = new HashMap<>();
255+
256+
pathElements.forEach((k, v) -> {
257+
if (v != null && !v.isAutomatic()) {
258+
definedModules.put(k, v);
259+
} else {
260+
automaticModules.put(k, v);
261+
}
262+
});
263+
264+
// in case of identical module names, first one wins, others drop onto classpath
265+
// if they are automatic modules.
253266
Set<String> collectedModules = new HashSet<>(requiredNamedModules.size());
254267

255-
for (Entry<T, JavaModuleDescriptor> entry : pathElements.entrySet()) {
256-
if (entry.getValue() != null
257-
&& requiredNamedModules.contains(entry.getValue().name())) {
258-
if (collectedModules.add(entry.getValue().name())) {
259-
result.getModulepathElements()
260-
.put(
261-
entry.getKey(),
262-
moduleNameSources.get(entry.getValue().name()));
268+
Consumer<Map<T, JavaModuleDescriptor>> moduleAcceptor = moduleSet -> {
269+
for (Entry<T, JavaModuleDescriptor> entry : moduleSet.entrySet()) {
270+
if (entry.getValue() != null
271+
&& requiredNamedModules.contains(entry.getValue().name())) {
272+
if (collectedModules.add(entry.getValue().name())) {
273+
result.getModulepathElements()
274+
.put(
275+
entry.getKey(),
276+
moduleNameSources.get(entry.getValue().name()));
277+
// if the module is an automatic module, add it to the classpath
278+
} else if (entry.getValue().isAutomatic()) {
279+
result.getClasspathElements().add(entry.getKey());
280+
}
281+
} else {
282+
result.getClasspathElements().add(entry.getKey());
263283
}
264-
} else {
265-
result.getClasspathElements().add(entry.getKey());
266284
}
267-
}
285+
};
286+
287+
// process defined modules first. This fixes a corner case where a project creates
288+
// a main artifact that is a JPMS module and a tests artifact that is not. If the
289+
// main artifact and the test artifact happen to have the same module id (one from
290+
// the module-info, one from the automatic module naming), the main artifact will
291+
// be on the module path and the test artifact will be on the class path.
292+
moduleAcceptor.accept(definedModules);
293+
moduleAcceptor.accept(automaticModules);
268294

269295
return result;
270296
}

‎plexus-java/src/test/java/org/codehaus/plexus/languages/java/jpms/LocationManagerTest.java‎

Lines changed: 57 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,10 +168,10 @@ public void testIdenticalModuleNames() throws Exception {
168168

169169
when(asmParser.getModuleDescriptor(pj1))
170170
.thenReturn(
171-
JavaModuleDescriptor.newAutomaticModule("plexus.java").build());
171+
JavaModuleDescriptor.newModule("plexus.java").build());
172172
when(asmParser.getModuleDescriptor(pj2))
173173
.thenReturn(
174-
JavaModuleDescriptor.newAutomaticModule("plexus.java").build());
174+
JavaModuleDescriptor.newModule("plexus.java").build());
175175

176176
ResolvePathsResult<Path> result = locationManager.resolvePaths(request);
177177

@@ -184,6 +184,61 @@ public void testIdenticalModuleNames() throws Exception {
184184
assertThat(result.getPathExceptions().size(), is(0));
185185
}
186186

187+
@Test
188+
public void testIdenticalAutomaticModuleNames() throws Exception {
189+
Path pj1 = Paths.get("src/test/resources/jar.empty/plexus-java-1.0.0-SNAPSHOT.jar");
190+
Path pj2 = Paths.get("src/test/resources/jar.empty.2/plexus-java-2.0.0-SNAPSHOT.jar");
191+
JavaModuleDescriptor descriptor =
192+
JavaModuleDescriptor.newModule("base").requires("plexus.java").build();
193+
when(qdoxParser.fromSourcePath(any(Path.class))).thenReturn(descriptor);
194+
ResolvePathsRequest<Path> request =
195+
ResolvePathsRequest.ofPaths(Arrays.asList(pj1, pj2)).setMainModuleDescriptor(mockModuleInfoJava);
196+
197+
when(asmParser.getModuleDescriptor(pj1))
198+
.thenReturn(
199+
JavaModuleDescriptor.newAutomaticModule("plexus.java").build());
200+
when(asmParser.getModuleDescriptor(pj2))
201+
.thenReturn(
202+
JavaModuleDescriptor.newAutomaticModule("plexus.java").build());
203+
204+
ResolvePathsResult<Path> result = locationManager.resolvePaths(request);
205+
206+
assertThat(result.getMainModuleDescriptor(), is(descriptor));
207+
assertThat(result.getPathElements().size(), is(2));
208+
assertThat(result.getModulepathElements().size(), is(1));
209+
assertThat(result.getModulepathElements().containsKey(pj1), is(true));
210+
assertThat(result.getModulepathElements().containsKey(pj2), is(false));
211+
assertThat(result.getClasspathElements().size(), is(1));
212+
assertThat(result.getPathExceptions().size(), is(0));
213+
}
214+
215+
@Test
216+
public void testMainJarModuleAndTestJarAutomatic() throws Exception {
217+
Path pj1 = Paths.get("src/test/resources/jar.tests/plexus-java-1.0.0-SNAPSHOT.jar");
218+
Path pj2 = Paths.get("src/test/resources/jar.tests/plexus-java-1.0.0-SNAPSHOT-tests.jar");
219+
JavaModuleDescriptor descriptor =
220+
JavaModuleDescriptor.newModule("base").requires("plexus.java").build();
221+
when(qdoxParser.fromSourcePath(any(Path.class))).thenReturn(descriptor);
222+
ResolvePathsRequest<Path> request =
223+
ResolvePathsRequest.ofPaths(Arrays.asList(pj1, pj2)).setMainModuleDescriptor(mockModuleInfoJava);
224+
225+
when(asmParser.getModuleDescriptor(pj1))
226+
.thenReturn(JavaModuleDescriptor.newModule("plexus.java").build());
227+
when(asmParser.getModuleDescriptor(pj2)).thenReturn(null);
228+
229+
ResolvePathsResult<Path> result = locationManager.resolvePaths(request);
230+
231+
assertThat(result.getMainModuleDescriptor(), is(descriptor));
232+
assertThat(result.getPathElements().size(), is(2));
233+
assertThat(result.getModulepathElements().size(), is(1));
234+
assertThat(result.getModulepathElements().containsKey(pj1), is(true));
235+
assertThat(result.getModulepathElements().containsKey(pj2), is(false));
236+
assertThat(result.getClasspathElements().size(), is(1));
237+
assertThat(result.getClasspathElements().contains(pj2), is(true));
238+
assertThat(result.getClasspathElements().contains(pj1), is(false));
239+
assertThat(result.getPathExceptions().size(), is(0));
240+
}
241+
187242
@Test
188243
public void testNonJar() throws Exception {
189244
Path p = Paths.get("src/test/resources/nonjar/pom.xml");

‎plexus-java/src/test/resources/jar.tests/plexus-java-1.0.0-SNAPSHOT-tests.jar‎

371 Bytes
Binary file not shown.

‎plexus-java/src/test/resources/jar.tests/plexus-java-1.0.0-SNAPSHOT.jar‎

855 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)