Gradle project is created with deprecated features (Project.getConvention) #1423

prithvitewatia · 2023-06-07T14:52:14Z

This PR closes #1420. In this PR gradle build project generation convention is updated to use Java configuration instead of sourceCompatibility property as they are deprecated and scheduled for removal in gradle 9.0.
Upgrading source compatibility.

As so many test resources files had been updated to validate project generation according, I have tried to make small logical units of commits that may be helpful in reviewing this PR:

Commit 1. In this commit, I have simply updated .gen files to use new java configuration that is common for both groovy and kotlin.
Commit 2 In this commit, I have added a method to write java configuration instead of source compatibility.
Commit 3 In this commit, I have added a method that returns a string representation for java configuration to be used in tests.
Commit 4 In this commit, I have updated the source compatibility test for Kotlin Dsl to check for java configuration.
Commit 5 In this commit, I have updated the source compatibility test for groovy dsl to check for java configuration and parameterised this test.
Commit 6 In this method I have updated method to check for java source compatibility
Commit 7 In this
commit, I have removed method that used to write source compatibility. Also created a class that will provide java version constant.
Commit 8 Updated tests to check for Java configuration
Commit 9 Added java configuration in gradle build settings.

…ring-iogh-1420

spring-iogh-1420

…test. spring-iogh-1420

…figuration. Also created a class that provides java version constant. spring-iogh-1420

snicoll

Thanks very much for the PR, I've added a comment for your consideration.

snicoll · 2023-06-08T08:58:42Z

...or-spring/src/test/resources/project/gradle/annotation-processor-dependency-build.gradle.gen

@@ -6,7 +6,9 @@ plugins {

 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
-sourceCompatibility = '1.8'
+java {


That's an odd place to put this. Now that it isn't an attribute anymore, it should go after the dependencies IMO.

FWIW, I wouldn't move it. How the information is expressed doesn't change the importance of that information so I'd keep it where it is, although ideally preceded by a blank line.

Thanks, I guess I am biased with how things work with Maven. It's all good keeping it there and yes with a blank line.

snicoll · 2023-06-08T09:01:25Z

We should consider also #211 as part of this as we could simply remove the code for Kotlin-based projects.

wilkinsona · 2023-06-08T09:16:07Z

...ring/initializr/generator/spring/build/gradle/GradleProjectGenerationConfigurationTests.java

@@ -118,7 +118,9 @@ void buildDotGradleIsContributedWhenGeneratingGradleProject() {
 				"",
 				"group = 'com.example'",
 				"version = '0.0.1-SNAPSHOT'",
-				"sourceCompatibility = '11'",
+				"java {",
+				"    sourceCompatibility = JavaVersion.VERSION_11",


I'd prefer that we continue to use a String for the version as it's more concise and, IMO, it reads better.

@snicoll @wilkinsona, I read in https://docs.gradle.org/8.2-rc-1/dsl/org.gradle.api.plugins.JavaPluginExtension.html#org.gradle.api.plugins.JavaPluginExtension:sourceCompatibility
that source compatibility is going to be like java version constant. That is why I added it. So should we continue with String for version or add Java version constant ?

Gradle will perform the Object -> JavaVersion conversion as it's https://docs.gradle.org/8.2-rc-1/javadoc/org/gradle/api/plugins/JavaPluginExtension.html#setSourceCompatibility-java.lang.Object- that will be called.

Thanks. I understand now.

prithvitewatia · 2023-06-08T12:59:10Z

@snicoll @wilkinsona Thanks for the review. I have one question. Currently in Gradle Build Settings I have added source compatibility as this is the only field we used to generate. However many other options are possible for java configuration as mentioned here. Should I also add them or continue with source compatibility ?

wilkinsona · 2023-06-08T13:33:31Z

...tor/src/main/java/io/spring/initializr/generator/buildsystem/gradle/GradleBuildSettings.java

+	 * Class to map common configuration for Java based projects.
+	 *
+	 */
+	public static class JavaConfiguration {


I wonder if we need this new public API? The change could be implemented by only changing the writers. We could wait to introduce a new API until a need arises to configure more of the options on JavaPluginExtension.

Yeah, I agree that it's a bit early to introduce a new API for this.

Thanks for the clarification. I will update the PR accordingly

…1420" This reverts commit ede1b9b.

This reverts commit a74fc42.

…java configuration. Also created a class that provides java version constant. spring-iogh-1420" This reverts commit 1692dad.

This reverts commit 1be85a0.

…zed the test. spring-iogh-1420" This reverts commit 321d1f8.

This reverts commit e0f652a.

…1420

…iogh-1420

…-1420

…ibility. spring-iogh-1420

…oved getJavaVersionConstant as not required. spring-iogh-1420

…ogh-1420

prithvitewatia · 2023-06-12T07:45:19Z

@snicoll @wilkinsona Requested changes have been made. I have also made changes for #211. Please review it when possible.

snicoll · 2023-06-12T09:47:53Z

@prithvitewatia I don't think that works. There is a difference between the Kotlin DSL and Kotlin as a language chosen for the application. We no longer generate a sourceCompatibility when the Kotlin DSL is chosen, whereas it should have been when Kotlin is chosen as a language.

Anyway, I don't like the idea of mixing two changes in the same PR. If you want us to consider this PR, please only focus on changing how the source compatibility is written, and ignoring #211 for now. The changes in the Groovy writer is a bit too invasive as well so hopefully this should simplify it.

Let me know if you'd like to review the PR or if you want me to take over.

prithvitewatia · 2023-06-12T10:06:51Z

@snicoll I might have intermixed two things. For now, I am planning to do changes only for #1423 in a new branch to better track changes.

snicoll · 2023-06-13T15:24:53Z

Superseded by #1427

Prithvi singh added 9 commits June 7, 2023 19:26

Updated resources to use sourceCompatibility in java configuration sp…

b0f5aed

…ring-iogh-1420

Added method to write java configuration instead of sourceCompatibility

045ee56

spring-iogh-1420

Added a method to write java configuration. spring-iogh-1420

98614b4

Updated test to check for java configuration. spring-iogh-1420

e0f652a

Updated test to check for java configuration. Also parameterized the …

321d1f8

…test. spring-iogh-1420

Updated method to check source compatibility. spring-iogh-1420

1be85a0

Removed method to write source compatibility as now we write java con…

1692dad

…figuration. Also created a class that provides java version constant. spring-iogh-1420

Updated tests to check for java configuration. spring-iogh-1420

a74fc42

GradleBuildSettings now uses java configuration. spring-iogh-1420

ede1b9b

spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jun 7, 2023

snicoll reviewed Jun 8, 2023

View reviewed changes

snicoll added the status: waiting-for-feedback We need additional information before we can continue label Jun 8, 2023

wilkinsona reviewed Jun 8, 2023

View reviewed changes

spring-projects-issues added status: feedback-provided Feedback has been provided and removed status: waiting-for-feedback We need additional information before we can continue labels Jun 8, 2023

wilkinsona reviewed Jun 8, 2023

View reviewed changes

snicoll and others added 12 commits June 9, 2023 20:33

Allow CodeBlock to be used by $L

df5e4a6

Revert "GradleBuildSettings now uses java configuration. spring-iogh-…

ea96b9e

…1420" This reverts commit ede1b9b.

Revert "Updated tests to check for java configuration. spring-iogh-1420"

a15bda0

This reverts commit a74fc42.

Revert "Removed method to write source compatibility as now we write …

4b367b4

…java configuration. Also created a class that provides java version constant. spring-iogh-1420" This reverts commit 1692dad.

Revert "Updated method to check source compatibility. spring-iogh-1420"

e5ee357

This reverts commit 1be85a0.

Revert "Updated test to check for java configuration. Also parameteri…

c42ed2e

…zed the test. spring-iogh-1420" This reverts commit 321d1f8.

Revert "Updated test to check for java configuration. spring-iogh-1420"

6969755

This reverts commit e0f652a.

Added a new line before java config. spring-iogh-1420

9b76d0c

Added a new line before java config sample-build.gradle. spring-iogh-…

d73b991

…1420

Added method to write source compatibility for kotlin.gradle. spring-…

4d23bdd

…iogh-1420

Updated tests for source compatibility. spring-iogh-1420

d4dbafa

Updated tests for source compatibility groovy dsl. spring-iogh-1420

219603b

Prithvi singh added 9 commits June 10, 2023 08:23

Added method to write java source compatibility. spring-iogh-1420

25ea121

Removed java configuration from kotlin projects. spring-iogh-1420

8f52496

Removed test for java configuration from kotlin projects. spring-iogh…

6ae3cb2

…-1420

Updated GradleBuildWriter for different project type. spring-iogh-1420

83848c5

Removed writeJavaConfiguration method. spring-iogh-1420

13ce02c

Refactored writeJavaSourceCompatibility method. spring-iogh-1420

8d909c1

Updated test to check for java configuration instead of source compat…

7ed17c6

…ibility. spring-iogh-1420

Updated write to method, removed writeJavaSourceCompatibility and rem…

04692d7

…oved getJavaVersionConstant as not required. spring-iogh-1420

Removed tests for java source compatibility as not required. spring-i…

55e8165

…ogh-1420

snicoll changed the title ~~Gh 1420. Updated Project generation convention to use java configuration~~ Gradle project is created with deprecated features (Project.getConvention) Jun 12, 2023

snicoll added type: bug and removed status: feedback-provided Feedback has been provided status: waiting-for-triage An issue we've not yet triaged labels Jun 12, 2023

snicoll self-assigned this Jun 12, 2023

snicoll added this to the 0.20.0 milestone Jun 12, 2023

snicoll mentioned this pull request Jun 12, 2023

Gradle project is created with deprecated features (Project.getConvention) #1420

Closed

snicoll added the status: waiting-for-feedback We need additional information before we can continue label Jun 12, 2023

spring-projects-issues added status: feedback-provided Feedback has been provided and removed status: waiting-for-feedback We need additional information before we can continue labels Jun 12, 2023

prithvitewatia mentioned this pull request Jun 13, 2023

Gradle project is created with deprecated features (Project.getConvention) #1427

Closed

snicoll closed this Jun 13, 2023

snicoll added the status: superseded label Jun 13, 2023

snicoll removed this from the 0.20.0 milestone Jun 13, 2023

prithvitewatia deleted the gh-1420 branch June 14, 2023 12:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Gradle project is created with deprecated features (Project.getConvention) #1423

Gradle project is created with deprecated features (Project.getConvention) #1423

prithvitewatia commented Jun 7, 2023

snicoll left a comment

snicoll Jun 8, 2023

wilkinsona Jun 8, 2023

snicoll Jun 8, 2023

snicoll commented Jun 8, 2023

wilkinsona Jun 8, 2023 •

edited

Loading

prithvitewatia Jun 8, 2023

wilkinsona Jun 8, 2023

prithvitewatia Jun 8, 2023

prithvitewatia commented Jun 8, 2023

wilkinsona Jun 8, 2023 •

edited

Loading

snicoll Jun 8, 2023

prithvitewatia Jun 8, 2023

prithvitewatia commented Jun 12, 2023

snicoll commented Jun 12, 2023 •

edited

Loading

prithvitewatia commented Jun 12, 2023

snicoll commented Jun 13, 2023

Gradle project is created with deprecated features (Project.getConvention) #1423

Gradle project is created with deprecated features (Project.getConvention) #1423

Conversation

prithvitewatia commented Jun 7, 2023

snicoll left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

snicoll commented Jun 8, 2023

wilkinsona Jun 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

prithvitewatia commented Jun 8, 2023

wilkinsona Jun 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

prithvitewatia commented Jun 12, 2023

snicoll commented Jun 12, 2023 • edited Loading

prithvitewatia commented Jun 12, 2023

snicoll commented Jun 13, 2023

wilkinsona Jun 8, 2023 •

edited

Loading

wilkinsona Jun 8, 2023 •

edited

Loading

snicoll commented Jun 12, 2023 •

edited

Loading