Generate KSP classes jar as output #1329
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bencodes
reviewed
Jun 7, 2025
| @@ -145,6 +145,9 @@ class KotlinJvmTaskExecutor | |||
| if (outputs.generatedKspSrcJar.isNotEmpty()) { | |||
| context.execute("creating KSP generated src jar", ::createGeneratedKspKotlinSrcJar) | |||
| } | |||
| if (outputs.generatedKspClassesJar.isNotEmpty()) { | |||
| context.execute("creating KSP generated classes jar", ::createdGeneratedKspClassesJar) | |||
There was a problem hiding this comment.
Would you be able to add some tests for this to KotlinJvmKspAssertionTest?
There was a problem hiding this comment.
I wasn't able to add tests with Micronaut because that'd require upgrading the repo to Java 17 (which introduces other breakages and probably out of scope for this PR). I'm not aware of other KSP processors that generate bytecode on the fly, so I wrote an example/dummy processor that generates class files and then added test cases to validate those class files are present in the final jar. Let me know if that works.
smocherla-brex
commented
Jun 8, 2025
| /** | ||
| * An example KSP processor that generates bytecode to be used only for tests | ||
| */ | ||
| class BytecodeGeneratorProcessor( |
There was a problem hiding this comment.
This was written purely for tests to validate the functionality.
smocherla-brex
requested review from
ahumesky,
cgruber,
restingbull and
nkoroste
as code owners
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1328
Right now, the ksp generated src JAR has the generated sources and files from
META-INF/. This doesn't suffice for KSP processors (Micronaut) which rely on generated .class files in annotation processing which isn't included in that jar now. We could include these files in that src jar but wasn't sure if it makes sense to include .class files, so I've added another output to theKotlinKsptask which generates this jar and is then forwarded as one of the outputs of thekt_jvm_libraryaction.I'll test this internally and verify it fixes our issue. I wanted to add tests with Micronaut in
src/testalong with the existing KSP test cases, but Micronaut 4/KSP requires Java 17 which would require upgrading rules_kotlin to Java 17 which could be a breaking change for other users, so I didn't (let me know if I should). Instead I've added tests with a dummy processor that generates bytecode and updated the tests to verify the functionality.