JAVA-5452 #1378

rozza · 2024-05-03T10:25:00Z

Two commits:

Bump gradle to the latest 7.6 release.
Decouple scala multi version plugin and remove Scala from the root build.gradle.
Scala is now only configured by the project build file eg:
bson-scala\build.gradle.kts & bson-driver\build.gradle.kts

Part of the decoupling required the creation of buildSrc conventions. See: https://docs.gradle.org/current/userguide/organizing_gradle_projects.html#sec:build_sources

Note: My current plan is this will merge into a scala3 branch and won't make master until all the scala 3 work is done.

JAVA-5452

Implement scala version support via standard gradle build conventions JAVA-5452

rozza · 2024-05-03T10:39:54Z

.evergreen/.evg.yml

@@ -1916,15 +1916,15 @@ axes:
      - id: "2.11"
        display_name: "Scala 2.11"
        variables:
-          SCALA: "2.11.12"


libs.versions.toml now handles the scala library versioning. So this is now just for which scala release to test against.

rozza · 2024-05-03T10:40:33Z

bson-scala/build.gradle.kts

+import config.Extensions.scalaVersion
+import config.Extensions.setAll
+
+plugins { id("conventions.scala") }


Main scala configuration is done by using buildSrc conventions

rozza · 2024-05-03T10:44:44Z

bson-scala/build.gradle.kts

+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import config.Extensions.scalaVersion


Some buildSrc extension functions to make life easier.

rozza · 2024-05-03T10:46:07Z

bson-scala/src/test/scala/org/mongodb/scala/bson/BaseSpec.scala


-@RunWith(classOf[JUnitRunner])


No longer needed thanks to the scala test configurations done in the scala convention.

rozza · 2024-05-03T10:48:58Z

bson-scala/src/test/scala/org/mongodb/scala/bson/codecs/MacrosSpec.scala

@@ -530,6 +530,7 @@ class MacrosSpec extends BaseSpec {
  }

  it should "support tagged types in case classes" in {
+    assume(!scala.util.Properties.versionNumberString.startsWith("2.11"))


This is failing to compile with Scala 2.11 - not sure how it worked with the previous plugin as its a scala error. Its possible that we are using a newer scala 2.11 version patch which highlights this error.

As Scala 2.11 has been EOL for a long time so I'm not sure its worth investigating further.

rozza · 2024-05-03T10:51:00Z

bson/src/test/unit/util/JsonPoweredTestHelper.java

+        try {
+            directory = new File(resource.toURI());
+        } catch (IllegalArgumentException e) {
+            directory = new File(resource.toExternalForm());


Resources may now come from test jars so use the external form in that case.

rozza · 2024-05-03T10:51:31Z

build.gradle

@@ -106,68 +106,6 @@ configure(javaProjects) {

 }

-configure(scalaProjects) {


The root build.gradle no longer handles the configuration of scala projects.

rozza · 2024-05-03T10:52:47Z

buildSrc/build.gradle.kts

+}
+
+dependencies {
+    implementation(libs.spotless.plugin)


Conventions now configure the spotless and logger plugins for the projects that use them.

rozza · 2024-05-03T10:54:04Z

buildSrc/build.gradle.kts

+plugins {
+    `kotlin-dsl`
+    // When updating, update in libs.versions.toml
+    id("com.diffplug.spotless") version "6.25.0"


The buildSrc project also uses spotless for formatting. Unfortunately, at the plugin stage we can't access the version from libs.versions.toml.

rozza · 2024-05-03T10:54:29Z

buildSrc/build.gradle.kts

+    implementation(files(libs.javaClass.superclass.protectionDomain.codeSource.location))
+}
+
+spotless {


The spotless configuration for buildSrc files only.

rozza · 2024-05-03T10:57:22Z

buildSrc/settings.gradle.kts

@@ -13,22 +13,13 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
+@Suppress("UnstableApiUsage")
+dependencyResolutionManagement { versionCatalogs { create("libs") { from(files("../gradle/libs.versions.toml")) } } }


Allows access from within the convention to the libs.versions.toml

rozza · 2024-05-03T10:57:49Z

buildSrc/src/main/kotlin/config/Extensions.kt

+import org.gradle.api.Project
+import org.gradle.api.plugins.ExtraPropertiesExtension
+
+object Extensions {


Handy extension functions that make life easier

rozza · 2024-05-03T10:58:44Z

buildSrc/src/main/kotlin/conventions/integrationTesting.gradle.kts

+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package conventions


A convention to add integrationTesting

rozza · 2024-05-03T10:59:00Z

buildSrc/src/main/kotlin/conventions/publishing.gradle.kts

+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package conventions


A convention to support publishing

rozza · 2024-05-03T10:59:51Z

buildSrc/src/main/kotlin/conventions/scala.gradle.kts

+ * limitations under the License.
+ */
+
+package conventions


A convention to support scala.

Note it builds upon other plugin extensions! (publishing, testing, spotless).

rozza · 2024-05-03T11:05:16Z

buildSrc/src/main/kotlin/conventions/testArtifacts.gradle.kts

+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package conventions


A convention to create test artifact jars. This provides support for test resources / classes to be consumed across projects using the kotlin dsl.

Previously, we'd use the following gradle syntax:

testImplementation project(':bson').sourceSets.test.output testImplementation project(':driver-core').sourceSets.test.output testImplementation project(':driver-sync').sourceSets.test.output

This isn't supported in the kotlin dsl. Infact sourceSets is even greyed out in intellij with the groovy. So its unclear how this is resolved.

There are test fixtures in gradle now - but I'm not sure they meet our requirements (and require their own project layout conventions).

rozza · 2024-05-03T11:06:18Z

driver-core/build.gradle

@@ -17,6 +17,7 @@

 plugins {
    id 'com.github.gmazzo.buildconfig' version '3.0.3'
+    id('conventions.testArtifacts')


Configures driver-core to produce test artifacts that can be consumed by other projects (eg the Scala project).

rozza · 2024-05-03T11:07:13Z

driver-scala/build.gradle.kts

+
+base.archivesName.set("mongo-scala-driver")
+
+extra.setAll(


Configures extra properties, which are consumed by the various conventions - mainly the publishing convention.

rozza · 2024-05-03T11:07:26Z

driver-scala/build.gradle.kts

+
+plugins {
+    id("conventions.scala")
+    id("conventions.integrationTesting")


Adds integration testing support to the driver-scala project.

rozza · 2024-05-03T11:08:07Z

driver-scala/build.gradle.kts

+
+    "integrationTestImplementation"(project(path = ":driver-sync"))
+    "integrationTestImplementation"(project(path = ":driver-reactive-streams"))
+    "integrationTestImplementation"(project(path = ":bson", configuration = "testArtifacts"))


Here we define the test artifacts that are needed to run the tests. eg. resources files and JsonPoweredTestHelper.

rozza · 2024-05-03T11:08:40Z

gradle.properties

@@ -16,8 +16,8 @@

 org.gradle.daemon=true
 org.gradle.jvmargs=-Duser.country=US -Duser.language=en
-scalaVersions=2.11.12,2.12.15,2.13.6
-defaultScalaVersions=2.13.6
+supportedScalaVersions=2.13,2.12,2.11


Use an explicit naming scheme for our own scala convention.

rozza · 2024-05-03T11:09:25Z

gradle/deploy.gradle

@@ -19,28 +19,12 @@ def deployedProjects =  subprojects - utilProjects

 configure(deployedProjects) {

-    def isScala = project.name.contains('scala')


This was all disabled anyway - so have removed. I've also closed JAVA-3564 as won't fix, its not possible with a single gradle run.

rozza · 2024-05-03T11:12:04Z

gradle/publish.gradle

@@ -116,43 +116,6 @@ configure(javaProjects) { project ->
    }
 }

-configure(scalaProjects) { project ->


The publishing convention now handles scala publishing.

rozza · 2024-05-03T11:12:19Z

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.3-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.4-bin.zip


Gradle bump

jyemin

Not quite done but here's a first round.

The main sanity check I did so far was to diff every MANIFEST.MF and pom.xml and look for significant differences. I found one significant one, a couple of perhaps significant ones, and a few nits.

bson-scala/build.gradle.kts

driver-scala/build.gradle.kts

bson-scala/build.gradle.kts

driver-scala/build.gradle.kts

buildSrc/src/main/kotlin/config/publishing.kt

gradle/libs.versions.toml

settings.gradle.kts

.evergreen/publish.sh

bson/src/test/unit/util/JsonPoweredTestHelper.java

rozza · 2024-05-10T09:59:05Z

Evergreen patch: https://spruce.mongodb.com/version/663def7a6ab3400007a2b9f4/tasks?sorts=STATUS%3AASC%3BBASE_STATUS%3ADESC

jyemin

LGTM

gradle/libs.versions.toml

bson-scala/build.gradle.kts

vbabanin

Thanks for your responses, @rozza . Since @jyemin has already verified the build output, I didn’t recheck it in my review to avoid duplicating efforts. Nice improvements, LGTM!

rozza added 2 commits May 3, 2024 10:40

Gradle updated to 7.6.4

5f8f164

Build: Remove Scala multiversion plugin

96471b6

Implement scala version support via standard gradle build conventions JAVA-5452

rozza commented May 3, 2024

View reviewed changes

rozza requested review from a team, vbabanin and jyemin and removed request for a team May 3, 2024 11:18

rozza changed the base branch from master to scala3 May 3, 2024 11:19

rozza marked this pull request as ready for review May 7, 2024 12:35

jyemin requested changes May 7, 2024

View reviewed changes

PR Updates

f22ce91

rozza requested a review from jyemin May 9, 2024 10:59

jyemin requested changes May 9, 2024

View reviewed changes

bson/src/test/unit/util/JsonPoweredTestHelper.java Outdated Show resolved Hide resolved

bson/src/test/unit/util/JsonPoweredTestHelper.java Outdated Show resolved Hide resolved

PR updates

0fb0fdb

rozza requested a review from jyemin May 10, 2024 13:57

jyemin approved these changes May 16, 2024

View reviewed changes

vbabanin reviewed Jun 10, 2024

View reviewed changes

gradle/libs.versions.toml Show resolved Hide resolved

vbabanin reviewed Jun 10, 2024

View reviewed changes

bson-scala/build.gradle.kts Show resolved Hide resolved

vbabanin approved these changes Jun 11, 2024

View reviewed changes

jyemin changed the title ~~Java 5452~~ JAVA-5452 Oct 31, 2024

jyemin marked this pull request as draft November 18, 2024 21:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JAVA-5452 #1378

JAVA-5452 #1378

rozza commented May 3, 2024 •

edited by jyemin

Loading

rozza May 3, 2024

rozza May 3, 2024 •

edited

Loading

rozza May 3, 2024

rozza May 3, 2024

rozza May 3, 2024

rozza May 3, 2024

rozza May 3, 2024

rozza May 3, 2024

rozza May 3, 2024

rozza May 3, 2024

rozza May 3, 2024

rozza May 3, 2024

rozza May 3, 2024

rozza May 3, 2024

rozza May 3, 2024 •

edited

Loading

rozza May 3, 2024

rozza May 3, 2024

rozza May 3, 2024

rozza May 3, 2024

rozza May 3, 2024

rozza May 3, 2024 •

edited

Loading

rozza May 3, 2024 •

edited

Loading

rozza May 3, 2024

rozza May 3, 2024

jyemin left a comment

rozza commented May 10, 2024

jyemin left a comment

vbabanin left a comment

		@@ -106,68 +106,6 @@ configure(javaProjects) {

		}

		configure(scalaProjects) {

		@@ -19,28 +19,12 @@ def deployedProjects = subprojects - utilProjects

		configure(deployedProjects) {

		def isScala = project.name.contains('scala')


		@RunWith(classOf[JUnitRunner])


		base.archivesName.set("mongo-scala-driver")

		extra.setAll(

JAVA-5452 #1378

Are you sure you want to change the base?

JAVA-5452 #1378

Conversation

rozza commented May 3, 2024 • edited by jyemin Loading

Choose a reason for hiding this comment

rozza May 3, 2024 • 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

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

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

Choose a reason for hiding this comment

rozza May 3, 2024 • 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rozza May 3, 2024 • edited Loading

Choose a reason for hiding this comment

rozza May 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jyemin left a comment

Choose a reason for hiding this comment

rozza commented May 10, 2024

jyemin left a comment

Choose a reason for hiding this comment

vbabanin left a comment

Choose a reason for hiding this comment

rozza commented May 3, 2024 •

edited by jyemin

Loading

rozza May 3, 2024 •

edited

Loading

rozza May 3, 2024 •

edited

Loading

rozza May 3, 2024 •

edited

Loading

rozza May 3, 2024 •

edited

Loading