Skip to content

Apache Lucene open-source search software

LUCENE-10308: Make ecj and javadoc run with modular paths

Dawid Weiss5b3b75efd80e
diff --git a/gradle/documentation/render-javadoc.gradle b/gradle/documentation/render-javadoc.gradle
index b84f6030c0a..55aa9b570ac 100644
--- a/gradle/documentation/render-javadoc.gradle
+++ b/gradle/documentation/render-javadoc.gradle
@@ -353,9 +353,7 @@ class RenderJavadocTask extends DefaultTask {
@TaskAction
public void render() {
- def srcDirs = srcDirSet.sourceDirectories
- .findAll { dir -> dir.exists() }
- .findAll { dir -> dir.name != "java-module" }
+ def srcDirs = srcDirSet.sourceDirectories.filter { dir -> dir.exists() }
def optionsFile = project.file("${getTemporaryDir()}/javadoc-options.txt")
@@ -363,9 +361,10 @@ class RenderJavadocTask extends DefaultTask {
outputDir.mkdirs();
def opts = []
- opts << [ '-overview', project.file("${srcDirs[0]}/overview.html") ]
- opts << [ '-sourcepath', srcDirs.join(File.pathSeparator) ]
- opts << [ '-subpackages', 'org.apache.lucene' ]
+
+ def overviewSourceSetDir = srcDirs.filter { dir -> project.file("${dir}/overview.html").exists() }.singleFile
+ opts << [ '-overview', project.file("${overviewSourceSetDir}/overview.html") ]
+
opts << [ '-d', outputDir ]
opts << '-protected'
opts << [ '-encoding', 'UTF-8' ]
@@ -457,6 +456,24 @@ class RenderJavadocTask extends DefaultTask {
def jOpts = opts.findAll { opt -> opt instanceof String && opt.startsWith("-J") }
opts.removeAll(jOpts)
+ // Collect all source files, for now excluding module descriptors.
+ opts.addAll(
+ srcDirs.collectMany { dir ->
+ project.fileTree(dir: dir, include: "**/*.java", exclude: "**/module-info.java").files
+ }.collect { it.toString() }
+ )
+
+ // handle doc-files manually since in explicit source file mode javadoc does not copy them.
+ srcDirs.each { File dir ->
+ project.copy {
+ into outputDir
+
+ from(dir, {
+ include "**/doc-files/**"
+ })
+ }
+ }
+
// Temporary file that holds all javadoc options for the current task (except jOpts)
optionsFile.withWriter("UTF-8", { writer ->
// escapes an option with single quotes or whitespace to be passed in the options.txt file for
diff --git a/gradle/java/folder-layout.gradle b/gradle/java/folder-layout.gradle
index 9f41c056be9..fe79e0425e3 100644
--- a/gradle/java/folder-layout.gradle
+++ b/gradle/java/folder-layout.gradle
@@ -19,10 +19,7 @@
allprojects {
plugins.withType(JavaPlugin) {
sourceSets {
- main.java.srcDirs = [
- 'src/java',
- 'src/java-module'
- ]
+ main.java.srcDirs = ['src/java' ]
main.resources.srcDirs = ['src/resources']
test.java.srcDirs = ['src/test']
test.resources.srcDirs = ['src/test-files']
diff --git a/gradle/java/modules.gradle b/gradle/java/modules.gradle
index db6a0f922e4..45405a25791 100644
--- a/gradle/java/modules.gradle
+++ b/gradle/java/modules.gradle
@@ -15,12 +15,8 @@
* limitations under the License.
*/
-import java.util.function.Predicate
-
// Configure miscellaneous aspects required for supporting the java module system layer.
-// TODO: remove the hacks excluding java-module source folder from ecjLint and javadoc rendering.
-
allprojects {
plugins.withType(JavaPlugin) {
// We won't be using gradle's built-in automatic module finder.
@@ -28,13 +24,6 @@ allprojects {
modularity.inferModulePath.set(false)
}
- // Utility method that detects whether a source set contains a module-info descriptor.
- Predicate<SourceSet> hasModuleDescriptor = { SourceSet ss ->
- ss.allJava.srcDirs.stream()
- .map(dir -> new File(dir, "module-info.java"))
- .anyMatch(file -> file.exists())
- }
-
// Map convention configuration names to "modular" corresponding configurations.
Closure<String> moduleConfigurationNameFor = { String configurationName ->
return "module" + configurationName.capitalize().replace("Classpath", "Path")
@@ -111,25 +100,31 @@ allprojects {
Configuration runtimeModulePathConfiguration = createResolvableModuleConfiguration(sourceSet.runtimeClasspathConfigurationName)
runtimeModulePathConfiguration.extendsFrom(moduleRuntimeOnly, moduleImplementation)
+ // Create and register a source set extension for manipulating classpath/ module-path
+ ModularPathsExtension modularPaths = new ModularPathsExtension(project, sourceSet,
+ compileModulePathConfiguration,
+ runtimeModulePathConfiguration)
+ sourceSet.extensions.add("modularPaths", modularPaths)
+
// Customized the JavaCompile for this source set so that it has proper module path.
tasks.named(sourceSet.getCompileJavaTaskName()).configure({ JavaCompile task ->
- task.dependsOn compileModulePathConfiguration
+ task.dependsOn modularPaths.compileModulePathConfiguration
// Add modular dependencies and their transitive dependencies to module path.
task.options.compilerArgumentProviders.add((CommandLineArgumentProvider) {
+ def modularPathFiles = modularPaths.compileModulePathConfiguration.files
def extraArgs = []
- if (!compileModulePathConfiguration.isEmpty()) {
- if (!hasModuleDescriptor.test(sourceSet)) {
+ if (!modularPathFiles.isEmpty()) {
+ if (!modularPaths.hasModuleDescriptor()) {
// We're compiling a non-module so we'll bring everything on module path in
// otherwise things wouldn't be part of the resolved module graph.
extraArgs += ["--add-modules", "ALL-MODULE-PATH"]
}
- extraArgs += ["--module-path", compileModulePathConfiguration.files.join(File.pathSeparator)]
+ extraArgs += ["--module-path", modularPathFiles.join(File.pathSeparator)]
}
- task.logger.info("Module path for ${task.path}:\n "
- + compileModulePathConfiguration.files.sort().join("\n "))
+ task.logger.info("Module path for ${task.path}:\n " + modularPathFiles.sort().join("\n "))
return extraArgs
})
@@ -141,7 +136,7 @@ allprojects {
// This could be done in a fancier way but a set difference is just fine for us here. Use a lazy
// provider to delay computation of the actual path.
task.classpath = files({ ->
- def trimmedClasspath = sourceSet.compileClasspath - compileModulePathConfiguration
+ def trimmedClasspath = sourceSet.compileClasspath - modularPaths.compileModulePathConfiguration
task.logger.info("Class path for ${task.path}:\n " + trimmedClasspath.files.sort().join("\n "))
return trimmedClasspath
})
@@ -170,7 +165,7 @@ allprojects {
// Determine whether the source set classes themselves should be appended
// to classpath or module path.
- boolean sourceSetIsAModule = hasModuleDescriptor.test(sourceSet)
+ boolean sourceSetIsAModule = sourceSet.modularPaths.hasModuleDescriptor()
if (!modulePath.isEmpty() || sourceSetIsAModule) {
if (sourceSetIsAModule) {
@@ -200,7 +195,7 @@ allprojects {
task.classpath = files({ ->
def trimmedClasspath = sourceSet.runtimeClasspath - modulePath
- boolean sourceSetIsAModule = hasModuleDescriptor.test(sourceSet)
+ boolean sourceSetIsAModule = sourceSet.modularPaths.hasModuleDescriptor()
if (sourceSetIsAModule) {
// also subtract the sourceSet's output directories.
trimmedClasspath = trimmedClasspath - sourceSet.output.classesDirs
@@ -234,3 +229,26 @@ allprojects {
}
}
}
+
+
+class ModularPathsExtension {
+ Project project
+ SourceSet sourceSet
+ Configuration compileModulePathConfiguration
+ Configuration runtimeModulePathConfiguration
+
+ ModularPathsExtension(Project project, SourceSet sourceSet,
+ Configuration compileModulePathConfiguration,
+ Configuration runtimeModulePathConfiguration) {
+ this.project = project
+ this.sourceSet = sourceSet
+ this.compileModulePathConfiguration = compileModulePathConfiguration
+ this.runtimeModulePathConfiguration = runtimeModulePathConfiguration
+ }
+
+ boolean hasModuleDescriptor() {
+ return sourceSet.allJava.srcDirs.stream()
+ .map(dir -> new File(dir, "module-info.java"))
+ .anyMatch(file -> file.exists())
+ }
+}
\ No newline at end of file
diff --git a/gradle/validation/ecj-lint.gradle b/gradle/validation/ecj-lint.gradle
index a2947303f6b..96a6cc57cac 100644
--- a/gradle/validation/ecj-lint.gradle
+++ b/gradle/validation/ecj-lint.gradle
@@ -31,20 +31,14 @@ def resources = scriptResources(buildscript)
allprojects {
plugins.withType(JavaPlugin) {
- // For now, turn off ECJ linting of module test projects.
- if (project.path.endsWith(".tests")) {
- return
- }
-
// Create a [sourceSetName]EcjLint task for each source set
// with a non-empty java.srcDirs. These tasks are then
// attached to project's "ecjLint" task.
def lintTasks = sourceSets.collect { sourceSet ->
def srcDirs = sourceSet.java.sourceDirectories
- .findAll { dir -> dir.exists() }
- .findAll { dir -> dir.name != "java-module" }
+ .filter { dir -> dir.exists() }
- tasks.create(sourceSet.getTaskName("ecjLint", null), JavaExec, {task ->
+ tasks.create(sourceSet.getTaskName("ecjLint", null), JavaExec, {JavaExec task ->
// This dependency is on a configuration; technically it causes
// all dependencies to be resolved before this task executes
// (this includes scheduling tasks that compile the
@@ -67,6 +61,16 @@ allprojects {
def tmpDst = getTemporaryDir()
workingDir tmpDst
+ // Place input files in an external file to dodge command line argument
+ // limits. We could pass a directory but ecj seems to be buggy: when it
+ // encounters a module-info.java file it no longer compiles other source files.
+ def inputsFile = file("${tmpDst}/ecj-inputs.txt")
+ inputsFile.setText(
+ srcDirs.collectMany { dir ->
+ project.fileTree(dir: dir, include: "**/*.java" ).files
+ }
+ .collect {file -> file.absolutePath.toString()}.join("\n"), "UTF-8")
+
args += [ "-d", "none" ]
// Compilation environment.
@@ -79,22 +83,41 @@ allprojects {
args += [ "-enableJavadoc" ]
args += [ "-properties", file("${resources}/ecj.javadocs.prefs").absolutePath ]
- doFirst {
- tmpDst.mkdirs()
+ // We depend on modular paths.
+ def modularPaths = sourceSet.modularPaths
+ dependsOn modularPaths.compileModulePathConfiguration
+
+ task.argumentProviders.add((CommandLineArgumentProvider) {
+ // Add modular dependencies and their transitive dependencies to module path.
+ def modularPathFiles = modularPaths.compileModulePathConfiguration.files
+ def extraArgs = []
+ if (!modularPathFiles.isEmpty()) {
+ if (!modularPaths.hasModuleDescriptor()) {
+ // We're compiling a non-module so we'll bring everything on module path in
+ // otherwise things wouldn't be part of the resolved module graph.
+ extraArgs += ["--add-modules", "ALL-MODULE-PATH"]
+ }
+
+ extraArgs += ["--module-path", modularPathFiles.join(File.pathSeparator)]
+ }
- // Add classpath locations at execution time (can't resolve the
+ // Add classpath locations in a lazy provider (can't resolve the
// configuration at evaluation time). Filter out non-existing entries
// (output folders for non-existing input source dirs like resources).
def cpath = sourceSet.compileClasspath.filter { p -> p.exists() }
+ cpath = cpath - modularPathFiles
if (!cpath.isEmpty()) {
- args += ["-classpath", cpath.asPath]
+ extraArgs += ["-classpath", cpath.join(File.pathSeparator)]
}
- // Add source location(s). Ideally we'd provide a set of files as in:
- // args += sourceSet.java.files
- // but this exceeds max allowed command line size. So we pass source
- // directories instead:
- args += srcDirs
+ // Add source location(s) in an external file to avoid command line argument limits.
+ extraArgs += ["@" + inputsFile.absolutePath]
+
+ return extraArgs
+ })
+
+ doFirst {
+ tmpDst.mkdirs()
}
})
}
diff --git a/gradle/validation/ecj-lint/ecj.javadocs.prefs b/gradle/validation/ecj-lint/ecj.javadocs.prefs
index a5352aa1971..25d527a7278 100644
--- a/gradle/validation/ecj-lint/ecj.javadocs.prefs
+++ b/gradle/validation/ecj-lint/ecj.javadocs.prefs
@@ -17,7 +17,8 @@ org.eclipse.jdt.core.compiler.debug.lineNumber=generate
org.eclipse.jdt.core.compiler.debug.localVariable=generate
org.eclipse.jdt.core.compiler.debug.sourceFile=generate
org.eclipse.jdt.core.compiler.doc.comment.support=enabled
-org.eclipse.jdt.core.compiler.problem.APILeak=error
+# TODO: disabled because we do have api leaks in modules
+org.eclipse.jdt.core.compiler.problem.APILeak=ignore
org.eclipse.jdt.core.compiler.problem.annotatedTypeArgumentToUnannotated=error
org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=error
org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
@@ -120,7 +121,8 @@ org.eclipse.jdt.core.compiler.problem.unlikelyEqualsArgumentType=error
org.eclipse.jdt.core.compiler.problem.unnecessaryElse=ignore
org.eclipse.jdt.core.compiler.problem.unnecessaryTypeCheck=ignore
org.eclipse.jdt.core.compiler.problem.unqualifiedFieldAccess=ignore
-org.eclipse.jdt.core.compiler.problem.unstableAutoModuleName=error
+# TODO: ideally, we shouldn't rely on these... but we do.
+org.eclipse.jdt.core.compiler.problem.unstableAutoModuleName=ignore
org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownException=ignore
org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionExemptExceptionAndThrowable=enabled
org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionIncludeDocCommentReference=enabled
@@ -144,4 +146,4 @@ org.eclipse.jdt.core.compiler.release=disabled
org.eclipse.jdt.core.compiler.source=11
org.eclipse.jdt.core.compiler.taskCaseSensitive=enabled
org.eclipse.jdt.core.compiler.taskPriorities=HIGH
-org.eclipse.jdt.core.compiler.taskTags=nocommit
+org.eclipse.jdt.core.compiler.taskTags=nocommit
\ No newline at end of file
diff --git a/lucene/analysis/common/src/java-module/module-info.java b/lucene/analysis/common/src/java/module-info.java
similarity index 100%
rename from lucene/analysis/common/src/java-module/module-info.java
rename to lucene/analysis/common/src/java/module-info.java
diff --git a/lucene/analysis/icu/src/java-module/module-info.java b/lucene/analysis/icu/src/java/module-info.java
similarity index 100%
rename from lucene/analysis/icu/src/java-module/module-info.java
rename to lucene/analysis/icu/src/java/module-info.java
diff --git a/lucene/analysis/kuromoji/src/java-module/module-info.java b/lucene/analysis/kuromoji/src/java/module-info.java
similarity index 100%
rename from lucene/analysis/kuromoji/src/java-module/module-info.java
rename to lucene/analysis/kuromoji/src/java/module-info.java
diff --git a/lucene/analysis/morfologik/src/java-module/module-info.java b/lucene/analysis/morfologik/src/java/module-info.java
similarity index 100%
rename from lucene/analysis/morfologik/src/java-module/module-info.java
rename to lucene/analysis/morfologik/src/java/module-info.java
diff --git a/lucene/analysis/nori/src/java-module/module-info.java b/lucene/analysis/nori/src/java/module-info.java
similarity index 100%
rename from lucene/analysis/nori/src/java-module/module-info.java
rename to lucene/analysis/nori/src/java/module-info.java
diff --git a/lucene/analysis/opennlp/src/java-module/module-info.java b/lucene/analysis/opennlp/src/java/module-info.java
similarity index 100%
rename from lucene/analysis/opennlp/src/java-module/module-info.java
rename to lucene/analysis/opennlp/src/java/module-info.java
diff --git a/lucene/analysis/phonetic/src/java-module/module-info.java b/lucene/analysis/phonetic/src/java/module-info.java
similarity index 100%
rename from lucene/analysis/phonetic/src/java-module/module-info.java
rename to lucene/analysis/phonetic/src/java/module-info.java
diff --git a/lucene/analysis/smartcn/src/java-module/module-info.java b/lucene/analysis/smartcn/src/java/module-info.java
similarity index 100%
rename from lucene/analysis/smartcn/src/java-module/module-info.java
rename to lucene/analysis/smartcn/src/java/module-info.java
diff --git a/lucene/analysis/stempel/src/java-module/module-info.java b/lucene/analysis/stempel/src/java/module-info.java
similarity index 100%
rename from lucene/analysis/stempel/src/java-module/module-info.java
rename to lucene/analysis/stempel/src/java/module-info.java
diff --git a/lucene/backward-codecs/src/java-module/module-info.java b/lucene/backward-codecs/src/java/module-info.java
similarity index 100%
rename from lucene/backward-codecs/src/java-module/module-info.java
rename to lucene/backward-codecs/src/java/module-info.java
diff --git a/lucene/benchmark/src/java-module/module-info.java b/lucene/benchmark/src/java/module-info.java
similarity index 100%
rename from lucene/benchmark/src/java-module/module-info.java
rename to lucene/benchmark/src/java/module-info.java
diff --git a/lucene/classification/src/java-module/module-info.java b/lucene/classification/src/java/module-info.java
similarity index 100%
rename from lucene/classification/src/java-module/module-info.java
rename to lucene/classification/src/java/module-info.java
diff --git a/lucene/codecs/src/java-module/module-info.java b/lucene/codecs/src/java/module-info.java
similarity index 100%
rename from lucene/codecs/src/java-module/module-info.java
rename to lucene/codecs/src/java/module-info.java
diff --git a/lucene/core/src/java-module/module-info.java b/lucene/core/src/java/module-info.java
similarity index 100%
rename from lucene/core/src/java-module/module-info.java
rename to lucene/core/src/java/module-info.java
diff --git a/lucene/demo/src/java-module/module-info.java b/lucene/demo/src/java/module-info.java
similarity index 100%
rename from lucene/demo/src/java-module/module-info.java
rename to lucene/demo/src/java/module-info.java
diff --git a/lucene/expressions/src/java-module/module-info.java b/lucene/expressions/src/java/module-info.java
similarity index 100%
rename from lucene/expressions/src/java-module/module-info.java
rename to lucene/expressions/src/java/module-info.java
diff --git a/lucene/facet/src/java-module/module-info.java b/lucene/facet/src/java/module-info.java
similarity index 100%
rename from lucene/facet/src/java-module/module-info.java
rename to lucene/facet/src/java/module-info.java
diff --git a/lucene/grouping/src/java-module/module-info.java b/lucene/grouping/src/java/module-info.java
similarity index 100%
rename from lucene/grouping/src/java-module/module-info.java
rename to lucene/grouping/src/java/module-info.java
diff --git a/lucene/highlighter/src/java-module/module-info.java b/lucene/highlighter/src/java/module-info.java
similarity index 100%
rename from lucene/highlighter/src/java-module/module-info.java
rename to lucene/highlighter/src/java/module-info.java
diff --git a/lucene/join/src/java-module/module-info.java b/lucene/join/src/java/module-info.java
similarity index 100%
rename from lucene/join/src/java-module/module-info.java
rename to lucene/join/src/java/module-info.java
diff --git a/lucene/luke/src/java-module/module-info.java b/lucene/luke/src/java/module-info.java
similarity index 100%
rename from lucene/luke/src/java-module/module-info.java
rename to lucene/luke/src/java/module-info.java
diff --git a/lucene/memory/src/java-module/module-info.java b/lucene/memory/src/java/module-info.java
similarity index 100%
rename from lucene/memory/src/java-module/module-info.java
rename to lucene/memory/src/java/module-info.java
diff --git a/lucene/misc/src/java-module/module-info.java b/lucene/misc/src/java/module-info.java
similarity index 100%
rename from lucene/misc/src/java-module/module-info.java
rename to lucene/misc/src/java/module-info.java
diff --git a/lucene/monitor/src/java-module/module-info.java b/lucene/monitor/src/java/module-info.java
similarity index 100%
rename from lucene/monitor/src/java-module/module-info.java
rename to lucene/monitor/src/java/module-info.java
diff --git a/lucene/queries/src/java-module/module-info.java b/lucene/queries/src/java/module-info.java
similarity index 100%
rename from lucene/queries/src/java-module/module-info.java
rename to lucene/queries/src/java/module-info.java
diff --git a/lucene/queryparser/src/java-module/module-info.java b/lucene/queryparser/src/java/module-info.java
similarity index 100%
rename from lucene/queryparser/src/java-module/module-info.java
rename to lucene/queryparser/src/java/module-info.java
diff --git a/lucene/replicator/src/java-module/module-info.java b/lucene/replicator/src/java/module-info.java
similarity index 100%
rename from lucene/replicator/src/java-module/module-info.java
rename to lucene/replicator/src/java/module-info.java
diff --git a/lucene/sandbox/src/java-module/module-info.java b/lucene/sandbox/src/java/module-info.java
similarity index 100%
rename from lucene/sandbox/src/java-module/module-info.java
rename to lucene/sandbox/src/java/module-info.java
diff --git a/lucene/spatial-extras/src/java-module/module-info.java b/lucene/spatial-extras/src/java/module-info.java
similarity index 100%
rename from lucene/spatial-extras/src/java-module/module-info.java
rename to lucene/spatial-extras/src/java/module-info.java
diff --git a/lucene/spatial3d/src/java-module/module-info.java b/lucene/spatial3d/src/java/module-info.java
similarity index 100%
rename from lucene/spatial3d/src/java-module/module-info.java
rename to lucene/spatial3d/src/java/module-info.java
diff --git a/lucene/suggest/src/java-module/module-info.java b/lucene/suggest/src/java/module-info.java
similarity index 100%
rename from lucene/suggest/src/java-module/module-info.java
rename to lucene/suggest/src/java/module-info.java