WIP: AVRO-4223 Gradle plugin for generating Java code by frevib · Pull Request #3614 · apache/avro

frevib · 2026-01-05T07:52:26Z

What is the purpose of the change

Gradle plugin to generate Java code from Avro files

Verifying this change

This change added tests and can be verified as follows:

cd to avro/lang/java/gradle-plugin

./gradlew test

Documentation

Does this pull request introduce a new feature? (yes)
If yes, how is the feature documented? (docs): https://github.com/frevib/avro/blob/AVRO-4223-gradle-plugin/lang/java/gradle-plugin/README.md

Release

0.0.2 is released and fully works with AVSC files: https://central.sonatype.com/artifact/eu.eventloopsoftware.avro-gradle-plugin/eu.eventloopsoftware.avro-gradle-plugin.gradle.plugin/versions - read docs (above) how to use

0.0.5 https://plugins.gradle.org/plugin/eu.eventloopsoftware.avro-gradle-plugin

0.0.8 https://plugins.gradle.org/plugin/eu.eventloopsoftware.avro-gradle-plugin

0.1.0 https://plugins.gradle.org/plugin/eu.eventloopsoftware.avro-gradle-plugin - this release adds Protocol support.

Protocol support has been added in this release

Installation instructions: https://github.com/frevib/avro/blob/AVRO-4223-gradle-plugin/lang/java/gradle-plugin/README.md#version

An official release will be done in the coming month

Fix Intellij not finding generated sources Add generating BigDecimal property

Add dynamic output directory

Add Maven phase hooks for compiling, testing, building and publishing the Gradle plugin

Improve Javadoc Add information to warning

Remove unused task property Rename field

Add Gradle plugin to root POM Add windows profile

Remove unused file

@get

Template directory is inside the classpath, so it should not be an @get:InputDirectory

Move reusable methods to abstract class

refactor

Rename

Add Protocol support

Fix tests

Refactor

Release 0.1.0

frevib · 2026-01-26T16:25:41Z

Avro gradle plugin 0.1.0 is released: https://plugins.gradle.org/plugin/eu.eventloopsoftware.avro-gradle-plugin

Protocol support has been added in this release

frevib · 2026-01-27T07:36:23Z

@raphaelauv did you test the latest release https://plugins.gradle.org/plugin/eu.eventloopsoftware.avro-gradle-plugin? No need to add compileJava.source(avroGenerateJavaClasses) any more.

Sineaggi · 2026-01-27T19:59:08Z

lang/java/gradle-plugin/README.md

+
+```kotlin
+avro {
+    sourceZipFiles = listOf("/home/user/.gradle/caches/modules-2/files-2.1/eu.eventloopsoftware.group-id/artifact-id/1.0.0/92ac3d0533de9dd79ac35373c892ebaa01763d4d/jar_with_schemas-1.0.0.jar")


Instead of this, we probably want to add some pre-configured configuration, called avroSources or something that way people can add their dependencies as normal, like

dependencies { avroSources("eu.eventloopsoftware.group-id:artifact-id:1.0.0") // ...

Certain plugins ship their own dependencies block (like in Gradle's test suites plugin) so perhaps something like

avro { sourceZipFiles { dependencies { avroSources("eu.eventloopsoftware.group-id:artifact-id:1.0.0") // ...

could be used.

Is is possible to add the compile- & runtime dependencies while generating code? Then we wouldn't need any configuration at all.

@opwvhk I'm not quite following? I think the dependencies here was just to allow people to add avro sources that are zipped in jars deployed to a standard maven repo.

Otherwise, if we at least made sourceZipFiles a ConfigurableFileCollection, then users could configure either via files, or a their own custom configuration.

@Sineaggi you're right, this is to allow ppl to add Avro sources that are in JAR files. Maybe the example with the full path isn't the best one. I've added an example with Configuration. What do think now @Sineaggi ?

opwvhk

This is yet another marked improvement. Thank you!

I have a few open comments, and we'll want to fix the build, but otherwise I'm happy with the result.

lang/java/gradle-plugin/build.gradle.kts

opwvhk · 2026-01-29T07:07:41Z

lang/java/gradle-plugin/pom.xml

+              <executable>./gradlew</executable>
+              <arguments>
+                <argument>assemble</argument>
+                <argument>-i</argument>


Can we pass the Maven log level here? I doubt it, but it would be convenient.

Which Maven log level? The Maven log level can be passed when this Maven command is run, which in turn runs this Gradle command: ./gradlew assemble -i. Passing a Maven argument here would be on the wrong level, one too deep.

...va/gradle-plugin/src/main/kotlin/eu/eventloopsoftware/avro/gradle/plugin/AvroGradlePlugin.kt

lang/java/gradle-plugin/src/test/resources/templates/protocol.vm

…ugin

Improve docs on add sources from JAR files

Add license files

Format with Spotless

Add Spotless config

Format

martin-g · 2026-02-03T09:02:43Z

I have created https://issues.apache.org/jira/browse/INFRA-27616 for the requirement from Gradle to prove the ownership of avro.apache.org DNS domain.

martin-g · 2026-02-08T13:24:44Z

...va/gradle-plugin/src/main/kotlin/eu/eventloopsoftware/avro/gradle/plugin/AvroGradlePlugin.kt

+            project,
+            extension,
+            includesProtocol,
+            extension.testSourceDirectory,


Suggested change

extension.testSourceDirectory,

extension.sourceDirectory,

martin-g · 2026-02-08T13:29:35Z

...-plugin/src/main/kotlin/eu/eventloopsoftware/avro/gradle/plugin/tasks/AbstractCompileTask.kt

+  private fun instantiateAdditionalVelocityTools(velocityToolsClassesNames: List<String>): List<Any> {
+    return velocityToolsClassesNames.map { velocityToolClassName ->
+      try {
+        Class.forName(velocityToolClassName).getDeclaredConstructor().newInstance()


Why this uses the current class' loader ?
loadLogicalTypesFactories() and doCompile() use the thread's class loader

martin-g · 2026-02-08T13:30:24Z

lang/java/gradle-plugin/README.md

+
+`0.0.8`
+
+Add `sourceZipFiles` property to add zip files with schemas in them


This sentence seems unfinished

martin-g · 2026-02-08T13:32:10Z

...c/main/kotlin/eu/eventloopsoftware/avro/gradle/plugin/extension/AvroGradlePluginExtension.kt

+  val testSourceDirectory: Property<String> = objects.property(String::class.java).convention("src/test/avro")
+
+  /**
+   * @parameter property="outputDirectory" default-value="${project.layout.buildDirectory}/generated-test-sources/avro"


This Javadoc seems like a copy/paste from Maven

martin-g · 2026-02-08T13:35:04Z

...lugin/src/main/kotlin/eu/eventloopsoftware/avro/gradle/plugin/tasks/CompileAvroSchemaTask.kt

+
+  private fun compileSchemas(schemaFileTree: ConfigurableFileCollection, outputDirectory: File) {
+    val sourceFileForModificationDetection: File? =
+        schemaFileTree.asFileTree.files.filter { file: File -> file.lastModified() > 0 }.maxBy { it.lastModified() }


Suggested change

schemaFileTree.asFileTree.files.filter { file: File -> file.lastModified() > 0 }.maxBy { it.lastModified() }

schemaFileTree.asFileTree.files.filter { file: File -> file.lastModified() > 0 }.maxByOrNull { it.lastModified() }

to avoid NoSuchElementException if there are no files to filter

martin-g · 2026-02-08T13:36:29Z

...-plugin/src/main/kotlin/eu/eventloopsoftware/avro/gradle/plugin/tasks/AbstractCompileTask.kt

+      try {
+        Class.forName(velocityToolClassName).getDeclaredConstructor().newInstance()
+      } catch (e: Exception) {
+        throw RuntimeException(e)


Suggested change

throw RuntimeException(e)

throw org.gradle.api.GradleException(e)

martin-g · 2026-02-08T13:40:29Z

...va/gradle-plugin/src/main/kotlin/eu/eventloopsoftware/avro/gradle/plugin/AvroGradlePlugin.kt

+    compileSchemaTask.schemaFiles.from(
+        project.fileTree(sourceDirectory).apply {
+          setIncludes(includes)
+          setExcludes(extension.excludes.get())


addSchemaFiles() is also used for tests, so this should use setTestExcludes(extension.testExcludes.get()) in that cases

martin-g · 2026-02-08T13:40:47Z

...va/gradle-plugin/src/main/kotlin/eu/eventloopsoftware/avro/gradle/plugin/AvroGradlePlugin.kt

+    compileSchemaTask.protocolFiles.from(
+        project.fileTree(sourceDirectory).apply {
+          setIncludes(includesProtocol)
+          setExcludes(extension.excludes.get())


Same here - testExcludes

martin-g · 2026-02-08T13:44:04Z

lang/java/gradle-plugin/pom.xml

+          </execution>
+          <execution>
+            <id>run-gradle-task-publish</id>
+            <phase>deploy</phase>


We use deploy to deploy -SNAPSHOTs for the Maven artefacts.
AFAIK Gradle plugins repo does not allow -SNAPSHOTs

martin-g · 2026-02-08T13:45:05Z

lang/java/gradle-plugin/build.gradle.kts

+ */
+
+plugins {
+  kotlin("jvm") version "2.2.10"


Should this be 2.3.0 ?
Below it uses org.jetbrains.kotlin:kotlin-gradle-plugin-api:2.3.0

frevib added 30 commits November 19, 2025 21:24

Add Gradle plugin bootstrap

3f04a2c

Add test for generating Java code

7a18d79

Rename task

e6082e6

Add Maven publish

8947e41

Rever change to Java file

d0b8794

Rever changes to Java files

ea3e5b6

Cleanup

2589fdd

Add schemaType

28934e0

Cleanup test

737e585

Use Path instead of File for tests

543c66b

Remove null checks because it's Kotlin

5f1ac64

Improve test

3a9ae61

Add test source and output dir

93d7194

Refactor

afd90c8

Add field visibility property

b765eb7

Add excludes property

1b0d7f5

Add stringType and templateDirectory

fafd298

Add properties

634cd63

Add properties

f71ba50

Check if source directories exist

7c67834

Cleanup

453c7a0

Cleanup

1b449b4

Cleanup

4fdab98

Add readme

c4a06ae

Move to SourceTask

1b6efe7

Fix Intellij not finding generated sources Add generating BigDecimal property

Update readme

6c0b29e

Add dependency for generated sources

444d91c

Update reamde

6daa02e

Add dynamic output directory

Remove unneeded adding of dependency

626e90c

Update readme

21c8340

frevib added 15 commits January 11, 2026 09:50

AVRO-4223

78b67d7

Add Maven phase hooks for compiling, testing, building and publishing the Gradle plugin

AVRO-4223

f309faf

Improve Javadoc Add information to warning

AVRO-4223

3519eb8

Remove unused task property Rename field

AVRO-4223

89a4629

Add Gradle plugin to root POM Add windows profile

AVRO-4223

9e7bd24

Remove unused file

AVRO-4223

1cf8762

Template directory is inside the classpath, so it should not be an @get:InputDirectory

AVRO-4223

6183c73

Move reusable methods to abstract class

AVRO-4223

f0af7c5

refactor

AVRO-4223

1443f18

refactor

AVRO-4223

cce2cfc

Rename

AVRO-4223

0e06ead

Add Protocol support

AVRO-4223

761371f

Fix tests

AVRO-4223

c75d6c4

Refactor

AVRO-4223

c36cb61

Refactor

AVRO-4223

eccfed6

Release 0.1.0

Sineaggi reviewed Jan 27, 2026

View reviewed changes

opwvhk requested changes Jan 29, 2026

View reviewed changes

frevib added 7 commits February 2, 2026 14:45

Merge remote-tracking branch 'upstream/main' into AVRO-4223-gradle-pl…

9e52ae0

…ugin

AVRO-4223

83c3a50

Improve docs on add sources from JAR files

AVRO-4223

aec2b3d

Add license files

AVRO-4223

43803fd

Format with Spotless

AVRO-4223

201e4fb

Add Spotless config

AVRO-4223

8428a16

Format

AVRO-4223

e1d5284

Format

frevib marked this pull request as ready for review February 2, 2026 15:42

AVRO-4223

2db64b1

Format

martin-g reviewed Feb 8, 2026

View reviewed changes


		`0.0.8`

		Add `sourceZipFiles` property to add zip files with schemas in them

	schemaFileTree.asFileTree.files.filter { file: File -> file.lastModified() > 0 }.maxBy { it.lastModified() }
	schemaFileTree.asFileTree.files.filter { file: File -> file.lastModified() > 0 }.maxByOrNull { it.lastModified() }

	throw RuntimeException(e)
	throw org.gradle.api.GradleException(e)

Conversation

frevib commented Jan 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is the purpose of the change

Verifying this change

Documentation

Release

Uh oh!

frevib commented Jan 26, 2026

Uh oh!

frevib commented Jan 27, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

frevib Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

opwvhk left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

martin-g commented Feb 3, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

frevib commented Jan 5, 2026 •

edited

Loading

frevib Feb 2, 2026 •

edited

Loading

opwvhk left a comment •

edited

Loading