Skip to content

Commit

Permalink
LUCENE-9438: Eclipse IDE support with gradle build system (apache#1761)
Browse files Browse the repository at this point in the history
  • Loading branch information
dweiss authored Aug 21, 2020
1 parent 66b6ce2 commit b1e2d0c
Show file tree
Hide file tree
Showing 5 changed files with 130 additions and 4 deletions.
5 changes: 4 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ import java.time.format.DateTimeFormatter
plugins {
id "base"
id "com.palantir.consistent-versions" version "1.14.0"
id 'de.thetaphi.forbiddenapis' version '3.0.1' apply false
id "org.owasp.dependencycheck" version "5.3.0"
id 'de.thetaphi.forbiddenapis' version '3.0.1' apply false
id "de.undercouch.download" version "4.0.2" apply false
}

Expand Down Expand Up @@ -63,6 +63,8 @@ ext {
buildTime = DateTimeFormatter.ofPattern("HH:mm:ss").format(tstamp)
buildYear = DateTimeFormatter.ofPattern("yyyy").format(tstamp)

minJavaVersion = JavaVersion.VERSION_11

// Declare script dependency versions outside of palantir's
// version unification control. These are not our main dependencies.
scriptDepVersions = [
Expand Down Expand Up @@ -102,6 +104,7 @@ apply from: file('gradle/maven/defaults-maven.gradle')

// IDE support, settings and specials.
apply from: file('gradle/ide/intellij-idea.gradle')
apply from: file('gradle/ide/eclipse.gradle')

// Validation tasks
apply from: file('gradle/validation/precommit.gradle')
Expand Down
6 changes: 3 additions & 3 deletions gradle/defaults-java.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@

allprojects {
plugins.withType(JavaPlugin) {
sourceCompatibility = "11"
targetCompatibility = "11"
sourceCompatibility = rootProject.minJavaVersion
targetCompatibility = rootProject.minJavaVersion

// Use 'release' flag instead of 'source' and 'target'
tasks.withType(JavaCompile) {
options.compilerArgs += ["--release", "11"]
options.compilerArgs += ["--release", rootProject.minJavaVersion.toString()]
}

// Configure warnings.
Expand Down
1 change: 1 addition & 0 deletions gradle/help.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ configure(rootProject) {
["LocalSettings", "help/localSettings.txt", "Local settings, overrides and build performance tweaks."],
["Git", "help/git.txt", "Git assistance and guides."],
["ValidateLogCalls", "help/validateLogCalls.txt", "How to use logging calls efficiently."],
["IDEs", "help/IDEs.txt", "IDE support."],
]

helpFiles.each { section, path, sectionInfo ->
Expand Down
102 changes: 102 additions & 0 deletions gradle/ide/eclipse.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import org.gradle.plugins.ide.eclipse.model.SourceFolder
import org.gradle.plugins.ide.eclipse.model.ClasspathEntry

configure(rootProject) {
apply plugin: "eclipse"

def relativize = { other -> rootProject.rootDir.relativePath(other).toString() }

eclipse {
project {
name = "Apache Lucene Solr ${version}"
}

classpath {
defaultOutputDir = file('build/eclipse')

file {
beforeMerged { classpath -> classpath.entries.removeAll { it.kind == "src" } }

whenMerged { classpath ->
def projects = allprojects.findAll { prj ->
return prj.plugins.hasPlugin(JavaPlugin) &&
prj.path != ":solr:solr-ref-guide"
}

Set<String> sources = []
Set<File> jars = []
projects.each { prj ->
prj.sourceSets.each { sourceSet ->
sources += sourceSet.java.srcDirs.findAll { dir -> dir.exists() }.collect { dir -> relativize(dir) }
}

// This is hacky - we take the resolved compile classpath and just
// include JAR files from there. We should probably make it smarter
// by looking at real dependencies. But then: this Eclipse configuration
// doesn't really separate sources anyway so why bother.
jars += prj.configurations.compileClasspath.resolve()
jars += prj.configurations.testCompileClasspath.resolve()
}

classpath.entries += sources.sort().collect {name -> new SourceFolder(name, "build/eclipse/" + name) }
classpath.entries += jars.unique().findAll { location -> location.isFile() }.collect { location ->
new LibEntry(location.toString())
}
}
}
}

jdt {
sourceCompatibility = rootProject.minJavaVersion
targetCompatibility = rootProject.minJavaVersion
javaRuntimeName = "JavaSE-${rootProject.minJavaVersion}"
}
}

eclipseJdt {
doLast {
project.sync {
from rootProject.file("dev-tools/eclipse/dot.settings")
into rootProject.file(".settings")
}
}
}
}

public class LibEntry implements ClasspathEntry {
private String path;

LibEntry(String path) {
this.path = path;
}

@Override
String getKind() {
return "lib"
}

@Override
void appendNode(Node node) {
node.appendNode("classpathentry", Map.of(
"kind", "lib",
"path", path
));
}
}
20 changes: 20 additions & 0 deletions help/IDEs.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
IntelliJ IDEA
=============

Importing the project as a gradle project should just run out of the box.


Eclipse
=======

Run the following to set up Eclipse project files:

./gradlew eclipse

then import the project into Eclipse with:

File -> Import... -> Existing Project into Workspace

Please note that Eclipse does not distinguish between sub-projects
and package sets (main/ test) so pretty much all the sources and dependencies
are available in one large bin.

0 comments on commit b1e2d0c

Please sign in to comment.