Convert PluginPropertiesExtension Groovy to Java #39605

rhamedy · 2019-03-02T20:47:27Z

Contributes to #34459

Converted

PluginPropertiesExtension.groovy -> java
Deleted the groovy files

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesTask.java

rhamedy · 2019-03-04T00:04:20Z

Tried to convert the BuildPluginBuild.groovy to java and include it in this PR however, I hit a few roadblocks relating to

Replacing project.pluginProperties.extension.name equivalentwith project.getTasks().getByName("pluginProperties").getName()?
How to access module in project.integTestCluster.module(project)?
No publishing property on project for project.publishing.publications.nebula(MavenPublication).artifactId
A few others like this

I have paused working on BuildPluginBuild.groovy because of one too many question marks. Not sure if this PR can go through independent of BuildPluginBuild refactor?

elasticmachine · 2019-03-04T15:28:02Z

Pinging @elastic/es-core-infra

alpar-t

Thank you for your contribution @rhamedy !
We prefer small PRs so this is even better than having the plugin converted too.
I left a few comments. Also would be kind enough and add tests for these classes ?
We want all the java code to have tests.

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesExtension.java

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesTask.java

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesExtension.java

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesTask.java

rhamedy · 2019-03-08T07:32:57Z

@atorok thank you for the review. I have addressed them in my recent commit as well as replied to some of your comments that need a reply.

I would definitely write tests! Is there a test class that I could use as a guide? I need a little sense of direction on how write tests 🙂

alpar-t · 2019-03-08T08:13:09Z

Thanks @rhamedy for the quick update. For tests I think you should look at GradleUnitTestCase and other classes that implement it.

@elasticmachine test this please

rhamedy · 2019-03-12T06:22:51Z

@atorok I have addressed the code review comments as well as added some tests. I could not find a class that I could use as baseline to write tests probably because the tests are different in other classes and this is plugin.

The test ensures tha the plugin-descriptor.properties file is picked up from classpath and it's substituted with props from extension and it's saved in the project build directory under templates.

Please let me know if any changes to be made 👍

alpar-t · 2019-03-12T15:56:47Z

@elasticmachine test this please

rjernst

Thanks for taking this on @rhamedy. I left a few comments.

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesExtension.java

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesTask.java

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesExtension.java

buildSrc/src/test/resources/plugin-descriptor.properties

rhamedy · 2019-03-12T21:29:26Z

@rjernst and @atorok thank you for the review. Replied to the comments. Do you have any feedback on unit tests? It would be nice to tackle the review changes along with tests all at once.

rhamedy · 2019-03-14T00:52:41Z

@rjernst @atorok I pushed up my new changes taking into account the code review comments. I have removed the unecessary test/resources/plugin-descriptor.properties file and after throwing away the doLast everything works magically and according to my tests the templates and generated-resources directories have correct content 👍

alpar-t · 2019-03-19T06:30:09Z

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesExtension.java

+
+    public PluginPropertiesExtension(Project project) {
+        this.name = project.getName();
+        this.version = project.getVersion().toString();


I just realized this now, this is a problem present in the old code as well.
The way we assign this default makes it prone to ordering.
If the extension is created before project.version is assigned we won't pick it up.
We should have a null check in the getter instead and returnproject.version if version is null
This is fine also in a subsequent PR.

I can update the PluginPropertiesExtension.getVersion() to return project.getVersion().toString() if version is null 👍

It is not possible for version to be null. VersionProperties statically loads the version. BuildPlugin is initialized before any PluginPropertiesExtension, since it is applied by PluginBuildPlugin, which extends BuildPlugin. Adding null checks all over for version will only make the code more complicated to understand with no actual additional safety.

We do this early on in the root level build.gradle

allprojects { group = 'org.elasticsearch' version = VersionProperties.elasticsearch description = "Elasticsearch subproject ${project.path}" }

So indeed it's not possible for project.version to be null in our build,
but all bets are off for external plugins, there's no guarantee that it won't be null.
We might not want to be lenient here and throw an exception if the version is null, but I still think we should do it rather than leave it be an NPE.
Alternatively, we could hard code this to VersionProperties.elasticsearch as we only test building plugins where the version of build-tools matches that of elasticsearch.
External plugins can then have whatever project.version they like.
What do you think of this approach @rjernst

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesTask.java

alpar-t · 2019-03-19T06:48:31Z

@elasticmachine test this please

rhamedy · 2019-03-22T03:34:48Z

@atorok @rjernst I have factored the changes requested and pushed the changes up. The tests that I have added are working 👍 however when running the command ./gradlw check I get the following error

> Task :modules:aggs-matrix-stats:pluginProperties FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':modules:aggs-matrix-stats:pluginProperties'.
> java.nio.file.FileAlreadyExistsException: /Users/raf/workspace/opensource-contributions/elastic/elasticsearch/modules/aggs-matrix-stats/build/templates/plugin-descriptor.properties

I double checked the modules:aggs-matrix-stats and unlike the exception the file modules/aggs-matrix-stats/build/templates/plugin-descriptor.properties is `present 🤔

alpar-t · 2019-03-22T09:22:02Z

@elasticmachine test this please

buildSrc/src/main/groovy/org/elasticsearch/gradle/plugin/PluginBuildPlugin.groovy

rhamedy · 2019-03-23T14:40:23Z

@atorok @rjernst please let me know if any further changes need to be made. I will clean up (squash) the commits after the PR is in mergeable state 🙂

alpar-t

LGTM no need to squash we do that on merge anyhow.

rjernst · 2019-03-28T18:23:27Z

@elasticmachine test this please

…classes

…sk, update the tests

…ethod calls

…me hasNativeController to getHasNativeController

buildSrc/src/main/groovy/org/elasticsearch/gradle/plugin/PluginBuildPlugin.groovy

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesExtension.java

alpar-t · 2019-04-17T05:32:21Z

@elasticmachine test this please

rhamedy · 2019-04-17T13:39:09Z

@atorok pushed my changes! 👍

alpar-t · 2019-04-17T13:43:04Z

@elasticmachine test this please

alpar-t · 2019-04-18T07:03:00Z

@rhamedy looks like there are some failing tests

rhamedy · 2019-04-20T00:47:55Z

@atorok the recent changes fix the test failures 👍

alpar-t · 2019-04-23T11:27:23Z

@elasticmachine test this please

alpar-t · 2019-06-12T12:25:48Z

Sorry for the delay @rhamedy I'll see to merge this as soon as the PR checks pass

Merge remote-tracking branch 'origin/master' into plugin-properties-task-tojava When the version is not set, use the project version bu do so lazily so we don't snapshot it at construction time

rhamedy · 2019-06-13T02:08:36Z

@atorok that would be awesome! 🙂

rhamedy commented Mar 2, 2019

View reviewed changes

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesTask.java Outdated Show resolved Hide resolved

rhamedy commented Mar 2, 2019

View reviewed changes

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesTask.java Outdated Show resolved Hide resolved

colings86 added the :Delivery/Build Build or test infrastructure label Mar 4, 2019

alpar-t requested changes Mar 6, 2019

View reviewed changes

This was referenced Mar 6, 2019

Replace groovy build-tools (buildSrc) with java #34459

Open

Refactor: Convert PluginPropertiesExtension to Java (#34459) #36673

Closed

rjernst requested changes Mar 12, 2019

View reviewed changes

alpar-t reviewed Mar 19, 2019

View reviewed changes

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesTask.java Outdated Show resolved Hide resolved

alpar-t reviewed Mar 19, 2019

View reviewed changes

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesTask.java Outdated Show resolved Hide resolved

alpar-t reviewed Mar 19, 2019

View reviewed changes

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesTask.java Outdated Show resolved Hide resolved

alpar-t reviewed Mar 19, 2019

View reviewed changes

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesTask.java Outdated Show resolved Hide resolved

alpar-t reviewed Mar 22, 2019

View reviewed changes

buildSrc/src/main/groovy/org/elasticsearch/gradle/plugin/PluginBuildPlugin.groovy Outdated Show resolved Hide resolved

alpar-t approved these changes Mar 25, 2019

View reviewed changes

alpar-t added >non-issue v8.0.0 v7.2.0 labels Mar 25, 2019

rhamedy added 10 commits April 16, 2019 23:49

Addressed review comments

8874a69

Refactored the code with regards to code review comments

d376c1e

Added plugin-descriptor.proerties along with unit tests for new java …

66e4a93

…classes

Removed unnecessary properties file

3b35c96

Changed the implmentation and addressed code review

cdb746a

Fixed the tests and verified its working

d01e612

Register extension in PluginBuildPlugin, Refactore PluginPropertiesTa…

d144e6a

…sk, update the tests

Wrap the inputstream in try-with-resource

a9aca3b

Use StandardCopyOption.REPLACE_EXISTING when File.copy, unchain the m…

f00f100

…ethod calls

Delete previously converted PluginPropertiesTask and it's tests, rena…

03fa92f

…me hasNativeController to getHasNativeController

rhamedy force-pushed the plugin-properties-task-tojava branch from 758a406 to 03fa92f Compare April 17, 2019 05:07

alpar-t reviewed Apr 17, 2019

View reviewed changes

buildSrc/src/main/groovy/org/elasticsearch/gradle/plugin/PluginBuildPlugin.groovy Outdated Show resolved Hide resolved

buildSrc/src/main/java/org/elasticsearch/gradle/plugin/PluginPropertiesExtension.java Outdated Show resolved Hide resolved

removed apply plugin and updated hasNativeController getter name

8a0c6e3

set license and notice file on extensions extra properties

441680d

rhamedy changed the title ~~Convert PluginPropertiesExtension & PluginPropertiesTask Groovy to Java~~ Convert PluginPropertiesExtension Groovy to Java Apr 20, 2019

Merge master and make version lazy

4affbf5

Merge remote-tracking branch 'origin/master' into plugin-properties-task-tojava When the version is not set, use the project version bu do so lazily so we don't snapshot it at construction time

alpar-t merged commit 04df52a into elastic:master Jun 13, 2019

alpar-t pushed a commit that referenced this pull request Jun 13, 2019

Convert PluginPropertiesExtension Groovy to Java (#39605)

a1b8d48

rhamedy deleted the plugin-properties-task-tojava branch October 7, 2019 01:17

mark-vieira added the Team:Delivery Meta label for Delivery team label Nov 11, 2020

jakelandis added v8.0.0-alpha1 and removed v8.0.0 labels Jul 26, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert PluginPropertiesExtension Groovy to Java #39605

Convert PluginPropertiesExtension Groovy to Java #39605

rhamedy commented Mar 2, 2019 •

edited

Loading

rhamedy commented Mar 4, 2019

elasticmachine commented Mar 4, 2019

alpar-t left a comment

rhamedy commented Mar 8, 2019

alpar-t commented Mar 8, 2019

rhamedy commented Mar 12, 2019

alpar-t commented Mar 12, 2019

rjernst left a comment

rhamedy commented Mar 12, 2019

rhamedy commented Mar 14, 2019

alpar-t Mar 19, 2019

rhamedy Mar 19, 2019

rjernst Mar 20, 2019

alpar-t Mar 20, 2019

alpar-t commented Mar 19, 2019

rhamedy commented Mar 22, 2019

alpar-t commented Mar 22, 2019

rhamedy commented Mar 23, 2019

alpar-t left a comment

rjernst commented Mar 28, 2019

alpar-t commented Apr 17, 2019

rhamedy commented Apr 17, 2019

alpar-t commented Apr 17, 2019

alpar-t commented Apr 18, 2019

rhamedy commented Apr 20, 2019 •

edited

Loading

alpar-t commented Apr 23, 2019

alpar-t commented Jun 12, 2019

rhamedy commented Jun 13, 2019 •

edited

Loading

Convert PluginPropertiesExtension Groovy to Java #39605

Convert PluginPropertiesExtension Groovy to Java #39605

Conversation

rhamedy commented Mar 2, 2019 • edited Loading

rhamedy commented Mar 4, 2019

elasticmachine commented Mar 4, 2019

alpar-t left a comment

Choose a reason for hiding this comment

rhamedy commented Mar 8, 2019

alpar-t commented Mar 8, 2019

rhamedy commented Mar 12, 2019

alpar-t commented Mar 12, 2019

rjernst left a comment

Choose a reason for hiding this comment

rhamedy commented Mar 12, 2019

rhamedy commented Mar 14, 2019

alpar-t Mar 19, 2019

Choose a reason for hiding this comment

rhamedy Mar 19, 2019

Choose a reason for hiding this comment

rjernst Mar 20, 2019

Choose a reason for hiding this comment

alpar-t Mar 20, 2019

Choose a reason for hiding this comment

alpar-t commented Mar 19, 2019

rhamedy commented Mar 22, 2019

alpar-t commented Mar 22, 2019

rhamedy commented Mar 23, 2019

alpar-t left a comment

Choose a reason for hiding this comment

rjernst commented Mar 28, 2019

alpar-t commented Apr 17, 2019

rhamedy commented Apr 17, 2019

alpar-t commented Apr 17, 2019

alpar-t commented Apr 18, 2019

rhamedy commented Apr 20, 2019 • edited Loading

alpar-t commented Apr 23, 2019

alpar-t commented Jun 12, 2019

rhamedy commented Jun 13, 2019 • edited Loading

rhamedy commented Mar 2, 2019 •

edited

Loading

rhamedy commented Apr 20, 2019 •

edited

Loading

rhamedy commented Jun 13, 2019 •

edited

Loading