WIP: AVRO-4223 Gradle plugin for generating Java code #3614
Conversation
Fix Intellij not finding generated sources Add generating BigDecimal property
Add dynamic output directory
lang/java/gradle-plugin/README.md
Outdated
| Kotlin will recognize which value is nullable. | ||
|
|
||
| #### When I update my schemas and generate code, the Java classes stay the same | ||
| Yes, for now you have to `./gradlew clean` every time you update your Avro schemas. |
There was a problem hiding this comment.
We should clear controlled output directories (outputDir/testOutputDir) instead of requiring the user to do so.
lang/java/gradle-plugin/src/main/resources/META-INF/eu.eventloopsoftware.properties
Outdated
Show resolved
Hide resolved
| import org.gradle.api.tasks.Input | ||
| import org.gradle.api.tasks.SourceTask | ||
|
|
||
| abstract class AbstractCompileTask : SourceTask() { |
There was a problem hiding this comment.
Gradle's SourceTask is probably not the preferred superclass for this task, that's usually used for things like compilation, analysis. I'd recommend DefaultTask.
There was a problem hiding this comment.
DefaultTask is being deprecated. Why is SourceTask not preferred? From the docs: A {@code SourceTask} performs some operation on source files, which is kind of what we're doing.
There was a problem hiding this comment.
I've not seen anything that would indicate DefaultTask being deprecated, and I can't imagine they could considering how many tasks already inherit directly from DefaultTask.
There was a problem hiding this comment.
That's an error on my side, DefaultTask is indeed not being deprecated.
Anyway, with DefaultTask we don't have source, setIncludes(..) and setExcludes(..)which are very useful in filtering for specific Avro file extension like "**/*.avsc". Then we have to manually filter the FileTree for Avro file extensions. Do you still recommend it?
There was a problem hiding this comment.
I think I'm starting to understand why SourceTask is maybe not the right fit. We now use source and sourceDirectory, which are used for the same things. If we use DefaultTask we don't have the issue of this ambiguity, and only use sourceDirectory
...n/src/main/kotlin/eu/eventloopsoftware/avro/gradle/plugin/extension/GradlePluginExtension.kt
Outdated
Show resolved
Hide resolved
|
|
||
| @TaskAction | ||
| fun compileSchema() { | ||
| project.logger.info("Generating Java files from Avro schemas...") |
There was a problem hiding this comment.
We should be using the task's logger, not the project's logger. I also don't think these logs provide any useful information.
|
|
||
|
|
||
| private fun getSourceDirectoryFullPath(directoryProperty: Property<String>): File = | ||
| project.layout.projectDirectory.dir(directoryProperty.get()).asFile |
There was a problem hiding this comment.
Calling project at runtime is soft-deprecated in Gradle 8, deprecated in Gradle 9 and will be unsupported in Gradle 10. https://docs.gradle.org/8.12.1/userguide/configuration_cache.html#config_cache:requirements:use_project_during_execution
There was a problem hiding this comment.
This would be avoided by using DirectoryPropertys, which would already be project-relative.
lang/java/gradle-plugin/src/main/kotlin/eu/eventloopsoftware/avro/gradle/plugin/GradlePlugin.kt
Outdated
Show resolved
Hide resolved
| * at schema compiling time. All files can therefore be referenced as classpath | ||
| * resources following the directory structure under the source directory. | ||
| * | ||
| * @parameter property="sourceDirectory" |
There was a problem hiding this comment.
Can we use the Maven annotations instead? IMHO they're easier to read (less likely to be missed when reading the code).
There was a problem hiding this comment.
Which annotations do you mean?
This documentation isn't correct any way, so I'll remove it.
|
New BETA |
|
New BETA 0.0.8 release is now on Gradle plugin portal: https://plugins.gradle.org/plugin/eu.eventloopsoftware.avro-gradle-plugin. |
4 participants
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 testDocumentation
Release
0.0.2is 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 use0.0.5https://plugins.gradle.org/plugin/eu.eventloopsoftware.avro-gradle-plugin0.0.8https://plugins.gradle.org/plugin/eu.eventloopsoftware.avro-gradle-pluginInstallation 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