The Eclipse Plugins (original) (raw)

The Eclipse plugins generate files that are used by the Eclipse IDE, thus making it possible to import the project into Eclipse (File - Import…​ - Existing Projects into Workspace).

The eclipse-wtp is automatically applied whenever the eclipse plugin is applied to a War or Ear project. For utility projects (i.e. Java projects used by other web projects), you need to apply the eclipse-wtp plugin explicitly.

What exactly the eclipse plugin generates depends on which other plugins are used:

Table 1. Eclipse plugin behavior

The eclipse-wtp plugin generates all WTP settings files and enhances the .project file. If a Java or War is applied, .classpath will be extended to get a proper packaging structure for this utility library or web application project.

Both Eclipse plugins are open to customization and provide a standardized set of hooks for adding and removing content from the generated files.

Usage

To use either the Eclipse or the Eclipse WTP plugin, include one of the lines in your build script:

Example 2. Using the Eclipse WTP plugin

build.gradle.kts

plugins {
    `eclipse-wtp`
}

build.gradle

plugins {
    id 'eclipse-wtp'
}

Note: Internally, the eclipse-wtp plugin also applies the eclipse plugin so you don’t need to apply both.

Both Eclipse plugins add a number of tasks to your projects. The main tasks that you will use are the eclipse and cleanEclipse tasks.

Tasks

The Eclipse plugins add the tasks shown below to a project.

Eclipse Plugin tasks

eclipse — Task

Depends on: all Eclipse configuration file generation tasks

Generates all Eclipse configuration files

cleanEclipse — Delete

Depends on: all Eclipse configuration file clean tasks

Removes all Eclipse configuration files

cleanEclipseProject — Delete

Removes the .project file.

cleanEclipseClasspath — Delete

Removes the .classpath file.

cleanEclipseJdt — Delete

Removes the .settings/org.eclipse.jdt.core.prefs file.

eclipseProject — GenerateEclipseProject

Generates the .project file.

eclipseClasspath — GenerateEclipseClasspath

Generates the .classpath file.

eclipseJdt — GenerateEclipseJdt

Generates the .settings/org.eclipse.jdt.core.prefs file.

Eclipse WTP Plugin — additional tasks

cleanEclipseWtpComponent — Delete

Removes the .settings/org.eclipse.wst.common.component file.

cleanEclipseWtpFacet — Delete

Removes the .settings/org.eclipse.wst.common.project.facet.core.xml file.

eclipseWtpComponent — GenerateEclipseWtpComponent

Generates the .settings/org.eclipse.wst.common.component file.

eclipseWtpFacet — GenerateEclipseWtpFacet

Generates the .settings/org.eclipse.wst.common.project.facet.core.xml file.

Configuration

Table 2. Configuration of the Eclipse plugins

Customizing the generated files

The Eclipse plugins allow you to customize the generated metadata files. The plugins provide a DSL for configuring model objects that model the Eclipse view of the project. These model objects are then merged with the existing Eclipse XML metadata to ultimately generate new metadata. The model objects provide lower level hooks for working with domain objects representing the file content before and after merging with the model configuration. They also provide a very low level hook for working directly with the raw XML for adjustment before it is persisted, for fine tuning and configuration that the Eclipse and Eclipse WTP plugins do not model.

Merging

Sections of existing Eclipse files that are also the target of generated content will be amended or overwritten, depending on the particular section. The remaining sections will be left as-is.

Disabling merging with a complete rewrite

To completely rewrite existing Eclipse files, execute a clean task together with its corresponding generation task, like “gradle cleanEclipse eclipse” (in that order). If you want to make this the default behavior, add “tasks.eclipse.dependsOn(cleanEclipse)” to your build script. This makes it unnecessary to execute the clean task explicitly.

This strategy can also be used for individual files that the plugins would generate. For instance, this can be done for the “.classpath” file with “gradle cleanEclipseClasspath eclipseClasspath”.

Hooking into the generation lifecycle

The Eclipse plugins provide objects modeling the sections of the Eclipse files that are generated by Gradle. The generation lifecycle is as follows:

1. The file is read; or a default version provided by Gradle is used if it does not exist
2. The beforeMerged hook is executed with a domain object representing the existing file
3. The existing content is merged with the configuration inferred from the Gradle build or defined explicitly in the eclipse DSL
4. The whenMerged hook is executed with a domain object representing contents of the file to be persisted
5. The withXml hook is executed with a raw representation of the XML that will be persisted
6. The final XML is persisted

Advanced configuration hooks

The following list covers the domain object used for each of the Eclipse model types:

Partial overwrite of existing content

A complete overwrite causes all existing content to be discarded, thereby losing any changes made directly in the IDE. Alternatively, the beforeMerged hook makes it possible to overwrite just certain parts of the existing content. The following example removes all existing dependencies from the Classpath domain object:

Example 3. Partial Overwrite for Classpath

build.gradle.kts

import org.gradle.plugins.ide.eclipse.model.Classpath

eclipse.classpath.file {
    beforeMerged(Action<Classpath> {
        entries.removeAll { entry -> entry.kind == "lib" || entry.kind == "var" }
    })
}

build.gradle

eclipse.classpath.file {
    beforeMerged { classpath ->
        classpath.entries.removeAll { entry -> entry.kind == 'lib' || entry.kind == 'var' }
    }
}

The resulting .classpath file will only contain Gradle-generated dependency entries, but not any other dependency entries that may have been present in the original file. (In the case of dependency entries, this is also the default behavior.) Other sections of the .classpath file will be either left as-is or merged. The same could be done for the natures in the .project file:

Example 4. Partial Overwrite for Project

build.gradle.kts

import org.gradle.plugins.ide.eclipse.model.Project

eclipse.project.file.beforeMerged(Action<Project> {
    natures.clear()
})

build.gradle

eclipse.project.file.beforeMerged { project ->
    project.natures.clear()
}

Modifying the fully populated domain objects

The whenMerged hook allows to manipulate the fully populated domain objects. Often this is the preferred way to customize Eclipse files. Here is how you would export all the dependencies of an Eclipse project:

Example 5. Export Classpath Entries

build.gradle.kts

import org.gradle.plugins.ide.eclipse.model.AbstractClasspathEntry
import org.gradle.plugins.ide.eclipse.model.Classpath

eclipse.classpath.file {
    whenMerged(Action<Classpath> { ->
        entries.filter { entry -> entry.kind == "lib" }
            .forEach { (it as AbstractClasspathEntry).isExported = false }
    })
}

build.gradle

eclipse.classpath.file {
    whenMerged { classpath ->
        classpath.entries.findAll { entry -> entry.kind == 'lib' }*.exported = false
    }
}

Modifying the XML representation

The withXml hook allows to manipulate the in-memory XML representation just before the file gets written to disk. Although Groovy’s XML support and Kotlin’s extension functions make up for a lot, this approach is less convenient than manipulating the domain objects. In return, you get total control over the generated file, including sections not modeled by the domain objects.

Example 6. Customizing the XML

build.gradle.kts

import org.w3c.dom.Element

eclipse.wtp.facet.file.withXml(Action<XmlProvider> {
    fun Element.firstElement(predicate: Element.() -> Boolean) =
        childNodes
            .run { (0 until length).map(::item) }
            .filterIsInstance<Element>()
            .first { it.predicate() }

    asElement()
        .firstElement { tagName === "fixed" && getAttribute("facet") == "jst.java" }
        .setAttribute("facet", "jst2.java")
})

build.gradle

eclipse.wtp.facet.file.withXml { provider ->
    provider.asNode().fixed.find { it.@facet == 'jst.java' }.@facet = 'jst2.java'
}

Separation of test classpath entries

Eclipse defines only one classpath per project which implies limitations on how Gradle projects can be mapped. Eclipse 4.8 introduced the concept of test sources. This feature allows the Eclipse plugin to define better separation between test and non-test sources.

The Eclipse classpath consists of classpath entries: source directories, jar files, project dependencies, etc. Each classpath entry can have a list of classpath attributes, where the attributes are string key-value pairs. There are two classpath attribute relevant for test sources: test and without_test_code, both of which can have true or false as values.

If a source directory has the test=true classpath attribute then the contents are considered test sources. Test sources have access to non-test sources, but non-test sources don’t have access to test sources. Similarly, test sources can only reference classes from a jar file if the jar file has the test=true classpath attribute. For project dependencies if the test=true attribute is present the classes in the target project are visible to test sources. If the without_test_code=false attribute is present then the test sources of the target project are also accessible. By default, test code is not available (which can be thought of as implicitly having without_test_code=true).

The following rules apply for the test attribute declaration when generating the Eclipse classpath:

• Source sets and dependency configurations are categorized as test if their name contain the 'test' substring, irrespective of case.
• All source sets and dependency configurations defined by the JVM test suite plugin are categorized as test.
• Source directories have the test=true classpath attribute if the container source set is a test source set.
• Jar files and project dependencies have the test=true attribute if they are present only in test dependency configurations.
• Project dependencies have the without_test_sources=false attribute if the target project applies the java-test-fixtures plugin.

You can customize the test source sets and configurations:

Example 7. Customizing test sources

build.gradle.kts

eclipse {
    classpath {
        testSourceSets = testSourceSets.get() + setOf(integTest)
        testConfigurations = testConfigurations.get() + setOf(functional)
    }
}

build.gradle

eclipse {
    classpath {
        testSourceSets = testSourceSets.get() + [sourceSets.integTest]
        testConfigurations = testConfigurations.get() + [configurations.functional]
    }
}

| | Consider migrating away from manual definition of additional test source sets and towards the use of the JVM Test Suite Plugin in scenarios like this. | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

You can also customize if a project should expose test sources to upstream project dependencies via the containsTestFixtures property.

Example 8. Customizing test fixtures

build.gradle.kts

eclipse {
    classpath {
        containsTestFixtures = true
    }
}

build.gradle

eclipse {
    classpath {
        containsTestFixtures = true
    }
}

Note, that this configuration also applies to the classpath of Buildship projects.