Add VSS Processor Plugin #71

Chrylo · 2024-01-31T13:46:48Z

Added a new composite module which provides the new vss-processor-plugin. It is mainly independent of the whole project. It has its own settings.gradle (not needed yet / default is used) etc. Which means some gradle configurations will be redundant.

Documentation:
Gradle Plugins: https://docs.gradle.org/current/userguide/custom_plugins.html
Disable signing for publishToMavenLocal: https://docs.gradle.org/current/userguide/signing_plugin.html
Task dependencies with composite builds: https://docs.gradle.org/current/userguide/composite_builds.html

Test:
Deploy: https://github.com/eclipse-kuksa/kuksa-android-sdk/actions/runs/7726264784

See documentation for how to test it with mavenLocal + Companion app. Same setup as with the SDK TestApp.

The following should now work and the workaround inside the KSP module was removed.
./gradlew clean kspDebugKotlin

close #45

The plugin is a composite project which means a higher separation to the other modules and common buildSrc plugins can't be used here. So plugins like publish / version had to be copied. The publish script had to be adapted for publishing a plugin close eclipse-kuksa#45 Signed-Off-By: Mark Hüsers <[email protected]>

app/build.gradle.kts

vss-processor/src/main/kotlin/org/eclipse/kuksa/vssprocessor/VssDefinitionProcessor.kt

vss-processor-plugin/build.gradle.kts

The plugin is now taking care of finding compatible VSS files or using the config provided by the developer. Afterwards it executes the custom task to copy the VSS files to the ksp input folder.

Update the documentation for plugin interface.

wba2hi

Short functional test:

./gradlew clean kspDebugKotlin works -> OK
./gradlew clean test -> -NOK- OK with latest version

vss-core/src/main/java/org/eclipse/kuksa/vsscore/annotation/VssDefinition.kt

settings.gradle.kts

vss-core/src/main/java/org/eclipse/kuksa/vsscore/annotation/VssDefinition.kt

vss-processor-plugin/buildSrc/src/main/kotlin/version.gradle.kts

vss-processor-plugin/src/main/java/org/eclipse/kuksa/vssprocessor/plugin/VssProcessorPlugin.kt

Using @InputDirectory and @OutputDirectory for a custom tasks allows for the usage of incremental builds.

.github/workflows/deploy-snapshot.yaml

gradle.properties

samples/build.gradle.kts

samples/src/main/java/com/example/sample/JavaActivity.java

settings.gradle.kts

.github/actions/setup-project/action.yaml

The storing inside the extra properties was removed in favour of just reading the version file.

Needed for compatibility with the config cache.

# Conflicts: # gradle/libs.versions.toml

wba2hi

Functional Test:

./gradlew clean build -Dkotest.tags="\!Secure" reliably fails with different errors:
also it does not fail when running with --no-configuration-cache.

ERROR 1

Execution failed for task ':app:clean'.

java.io.IOException: Unable to delete directory '/Users/wba2hi/git/kuksa-android-sdk/app/build'
New files were found. This might happen because a process is still writing to the target directory.
- /Users/wba2hi/git/kuksa-android-sdk/app/build/kspInput
- /Users/wba2hi/git/kuksa-android-sdk/app/build/kspInput/vss_rel_4.0.yaml

ERROR 2

e: [ksp] No VSS definition files were found! Is the plugin correctly configured?
e: Error occurred in KSP, check log for detail

FAILURE: Build failed with an exception.

What went wrong:
Execution failed for task ':app:kspDebugKotlin'.

A failure occurred while executing org.jetbrains.kotlin.compilerRunner.GradleCompilerRunnerWithWorkers$GradleKotlinCompilerWorkAction
Compilation error. See log for more details

Try:

Run with --stacktrace option to get the stack trace.
Run with --info or --debug option to get more log output.
Run with --scan to get full insights.
Get more help at https://help.gradle.org.

buildSrc/src/main/kotlin/org/eclipse/kuksa/version/SemanticVersion.kt

buildSrc/src/main/kotlin/version.gradle.kts

vss-core/src/main/java/org/eclipse/kuksa/vsscore/annotation/VssDefinition.kt

build.gradle.kts

buildSrc/src/main/kotlin/version.gradle.kts

README.md

docs/QUICKSTART.md

vss-processor-plugin/src/main/java/org/eclipse/kuksa/vssprocessor/plugin/VssProcessorPlugin.kt

vss-core/build.gradle.kts

- Improves error handling

wba2hi

Scenario: Add a VSS Property to VSS Spec file

-> ./gradlew clean build -> OK: Property is correctly generated
-> ./gradlew build -> NOK: Property is not correctly generated because task is up-to-date. That's probably the best we can do for now, because there is no clear dependency between our Specification and the ksp*Kotlin task. Could be solved when the files are generated inside the Plugin?

Scenario: Changing Version

-> ./gradlew setSnapshotVersion -> OK
-> ./gradlew setReleaseVersion -> OK

Scenario: vssProcessor.searchPath does not exist

-> Android Studio Gradle Synch -> OK
-> ./gradlew clean build -> OK
-> minor improvements with the message to be done, see corresponding finding

Scenario: Create Dash Report

-> ./gradlew clean mergeDashFiles -> OK

=> Function-wise OK!

vss-processor-plugin/src/main/java/org/eclipse/kuksa/vssprocessor/plugin/VssProcessorPlugin.kt

build.gradle.kts

vss-processor-plugin/build.gradle.kts

.github/actions/setup-project/action.yaml

Chrylo · 2024-02-15T11:53:31Z

Scenario: Add a VSS Property to VSS Spec file

-> ./gradlew clean build -> OK: Property is correctly generated -> ./gradlew build -> NOK: Property is not correctly generated because task is up-to-date. That's probably the best we can do for now, because there is no clear dependency between our Specification and the ksp*Kotlin task. Could be solved when the files are generated inside the Plugin?

Scenario: Changing Version

-> ./gradlew setSnapshotVersion -> OK -> ./gradlew setReleaseVersion -> OK

Scenario: vssProcessor.searchPath does not exist

-> Android Studio Gradle Synch -> OK -> ./gradlew clean build -> OK -> minor improvements with the message to be done, see corresponding finding

Scenario: Create Dash Report

-> ./gradlew clean mergeDashFiles -> OK

=> Function-wise OK!

For the NOK I also think this can only properly solved when we move the generation code aways from KSP. Known issue for now.

BREAKING CHANGE: - A new Gradle plugin(VssProcessorPlugin) was introduced to improve the input (VSS files) handling of the VSS KSP generation. This plugin is now mandatory if the VssProcessor KSP module is used in the project.

- Added a filter for the composite build so if more composite builds were available it does not automatically link against them too.

I tried to decouple the gradle kts generation from the tests so new tests can just reuse the generator classes.

Chrylo · 2024-02-21T11:38:58Z

Added tests for the vss processor plugin. Used the following guide:

https://docs.gradle.org/current/userguide/test_kit.html#sub:test-kit-build-cache

Use the following command to test or execute the Android Studio run config:

./gradlew vss-processor-plugin:test

Note:

Debugging into the tests does not work here.
Sometimes tests errors are obscured so I recommend opening the test results file.
Everything was implemented in kotlin so the recommended "spock" framework was not necessary.

wba2hi

Functional Test looks good

buildSrc/src/main/kotlin/org/eclipse/kuksa/version/SemanticVersion.kt

vss-processor-plugin/src/main/java/org/eclipse/kuksa/vssprocessor/plugin/VssProcessorPlugin.kt

...essor-plugin/src/test/kotlin/org/eclipse/kuksa/vssprocessor/plugin/VssProcessorPluginTest.kt

vss-processor/build.gradle.kts

.run/kuksa-vss-processor-Plugin_FunctionalTests.run.xml

vss-processor/build.gradle.kts

.github/actions/setup-project/action.yaml

- Removed print from SemanticVersion because it spams the logs and can be printed via the "printVersion" task.

wba2hi

./gradlew clean publishToMavenLocal-> NOK (Unable to make progress running work. There are items queued for execution but none of them can be started)

./gradlew :vss-processor-plugin:clean :vss-processor-plugin:publishToMavenLocal-> NOK (Execution failed for task ':vss-processor-plugin:generateMetadataFileForPluginMavenPublication'.

java.io.FileNotFoundException: /Users/wba2hi/git/kuksa-android-sdk/vss-processor-plugin/build/libs/vss-processor-plugin-0.1.3-SNAPSHOT.jar (No such file or directory))

> cd vss-processor-plugin
> gradle wrapper # add gradle wrapper; requires gradle being installed
> ./gradlew wrapper --gradle-version=8.6 # use same version as in sdk rootProject
> ./gradlew clean publishToMavenLocal

-> OK

The composite linking of clean seems to break something? Maybe the composite links are not adequately "planned into the dependency graph"?

Without clean everything works fine. In this particular case I would be ok with not executing clean, but the minimum I expect is a follow-up ticket.
Also it mean that if more of these issues appear we have to remove the composite links again and handle the project as a "real and independent rootProject" (which I also would be fine with, because I don't expect many changes in this project over time)

The "generateMetadataFileForPluginMavenPublication" task is currently not using the configuration cache correctly. The cache was disabled for this task until it is fixed.

Chrylo · 2024-02-26T13:19:00Z

./gradlew clean publishToMavenLocal-> NOK (Unable to make progress running work. There are items queued for execution but none of them can be started)

./gradlew :vss-processor-plugin:clean :vss-processor-plugin:publishToMavenLocal-> NOK (Execution failed for task ':vss-processor-plugin:generateMetadataFileForPluginMavenPublication'.

java.io.FileNotFoundException: /Users/wba2hi/git/kuksa-android-sdk/vss-processor-plugin/build/libs/vss-processor-plugin-0.1.3-SNAPSHOT.jar (No such file or directory))
> cd vss-processor-plugin
> gradle wrapper # add gradle wrapper; requires gradle being installed
> ./gradlew wrapper --gradle-version=8.6 # use same version as in sdk rootProject
> ./gradlew clean publishToMavenLocal
-> OK

The composite linking of clean seems to break something? Maybe the composite links are not adequately "planned into the dependency graph"?

Without clean everything works fine. In this particular case I would be ok with not executing clean, but the minimum I expect is a follow-up ticket. Also it mean that if more of these issues appear we have to remove the composite links again and handle the project as a "real and independent rootProject" (which I also would be fine with, because I don't expect many changes in this project over time)

Created an issue for the first problem: Unable to execute task "publishToMavenLocal" if executed with "clean" for composite build #80
Fixed the java.io.FileNotFoundException

There is currently a limitation with "clean" + composite builds. gradle/gradle#23585

wba2hi

LGTM

Chrylo added 5 commits January 31, 2024 14:30

chore: Add publish of VSS Processor Plugin

121a0e6

chore: Enable publish for VSS Processor Plugin

848f019

docs: Add VSS Processor Plugin docs

aad0a0c

chore: Update Checkout to v4

09411de

wba2hi reviewed Jan 31, 2024

View reviewed changes

app/build.gradle.kts Outdated Show resolved Hide resolved

wba2hi reviewed Jan 31, 2024

View reviewed changes

vss-processor/src/main/kotlin/org/eclipse/kuksa/vssprocessor/VssDefinitionProcessor.kt Outdated Show resolved Hide resolved

wba2hi reviewed Feb 1, 2024

View reviewed changes

vss-processor-plugin/build.gradle.kts Outdated Show resolved Hide resolved

wba2hi linked an issue Feb 2, 2024 that may be closed by this pull request

Add VssDefinition plugin for KSP usage #45

Closed

Chrylo and others added 4 commits February 2, 2024 14:10

chore: Add automatic search to VSS files

e997a91

The plugin is now taking care of finding compatible VSS files or using the config provided by the developer. Afterwards it executes the custom task to copy the VSS files to the ksp input folder.

chore: Switch to gradle publish plugin

3227633

chore: Update documentation

c35e53e

Update the documentation for plugin interface.

Merge branch 'main' into feature-45

ba976fe

wba2hi requested changes Feb 8, 2024

View reviewed changes

Chrylo added 2 commits February 9, 2024 12:22

chore: Support incremental builds Vss Plugin tasks

bf74188

Using @InputDirectory and @OutputDirectory for a custom tasks allows for the usage of incremental builds.

chore: Enable Gradle configuration cache

eef025c

wba2hi requested changes Feb 9, 2024

View reviewed changes

Chrylo added 4 commits February 13, 2024 15:52

chore: Add support for config caches

f08a5a9

chore: Change SemanticVersion handling

f4b3882

The storing inside the extra properties was removed in favour of just reading the version file.

chore: Update dependencies

25345ad

Needed for compatibility with the config cache.

Merge branch 'main' into feature-45

4d56a1d

# Conflicts: # gradle/libs.versions.toml

wba2hi requested changes Feb 14, 2024

View reviewed changes

wba2hi reviewed Feb 14, 2024

View reviewed changes

vss-core/build.gradle.kts Outdated Show resolved Hide resolved

Chrylo added 2 commits February 14, 2024 21:50

chore: Improve semantic version handling

486b371

chore: Fix clean builds for VSS Plugin

6b5c34a

- Improves error handling

wba2hi requested changes Feb 15, 2024

View reviewed changes

Chrylo added 3 commits February 15, 2024 18:15

chore: Fix buildDir for javadocJar task

49729c4

BREAKING CHANGE: - A new Gradle plugin(VssProcessorPlugin) was introduced to improve the input (VSS files) handling of the VSS KSP generation. This plugin is now mandatory if the VssProcessor KSP module is used in the project.

chore: Link composite plugin build only to vss-processor

ac9d61a

- Added a filter for the composite build so if more composite builds were available it does not automatically link against them too.

test: Add VSS Processor Plugin tests

3a03c0f

I tried to decouple the gradle kts generation from the tests so new tests can just reuse the generator classes.

wba2hi requested changes Feb 21, 2024

View reviewed changes

Chrylo added 6 commits February 22, 2024 09:56

test: Add tests for outdated cache

1b2dfc0

chore: Improve logging

33441b7

chore: Link :clean task with VSS Processor Plugin

8f00509

chore: Correct composite task linking logging

e4d6734

chore: Reverse logging order for linked composite tasks

890393d

chore: Remove FunctionTests run config

77efd21

wba2hi requested changes Feb 22, 2024

View reviewed changes

.github/actions/setup-project/action.yaml Outdated Show resolved Hide resolved

chore: Fix missing oss/all folder during clean build

889b329

- Removed print from SemanticVersion because it spams the logs and can be printed via the "printVersion" task.

Chrylo mentioned this pull request Feb 23, 2024

Replace buildSrc plugins with composite build #79

Open

Chrylo added 2 commits February 23, 2024 14:12

chore: Add comment to be mindful of oss licenses

fb3e8fd

chore: Add known issue explanation for build warning

9da0507

wba2hi requested changes Feb 26, 2024

View reviewed changes

wba2hi mentioned this pull request Feb 26, 2024

Add error handling for specification generation (KSP) #17

Open

chore: Disable config cache for maven task

6c3d7bc

The "generateMetadataFileForPluginMavenPublication" task is currently not using the configuration cache correctly. The cache was disabled for this task until it is fixed.

Chrylo and others added 2 commits February 27, 2024 09:01

chore: Remove clean from composite linking

d4ebab1

There is currently a limitation with "clean" + composite builds. gradle/gradle#23585

Merge branch 'main' into feature-45

f591fb5

wba2hi approved these changes Feb 28, 2024

View reviewed changes

wba2hi merged commit f41d383 into eclipse-kuksa:main Feb 28, 2024
5 checks passed

wba2hi deleted the feature-45 branch February 28, 2024 06:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add VSS Processor Plugin #71

Add VSS Processor Plugin #71

Chrylo commented Jan 31, 2024 •

edited

Loading

wba2hi left a comment •

edited

Loading

wba2hi left a comment

wba2hi left a comment •

edited

Loading

Chrylo commented Feb 15, 2024

Chrylo commented Feb 21, 2024

wba2hi left a comment

wba2hi left a comment

Chrylo commented Feb 26, 2024

wba2hi left a comment

Add VSS Processor Plugin #71

Add VSS Processor Plugin #71

Conversation

Chrylo commented Jan 31, 2024 • edited Loading

wba2hi left a comment • edited Loading

Choose a reason for hiding this comment

wba2hi left a comment

Choose a reason for hiding this comment

ERROR 1

ERROR 2

wba2hi left a comment • edited Loading

Choose a reason for hiding this comment

Chrylo commented Feb 15, 2024

Chrylo commented Feb 21, 2024

wba2hi left a comment

Choose a reason for hiding this comment

wba2hi left a comment

Choose a reason for hiding this comment

Chrylo commented Feb 26, 2024

wba2hi left a comment

Choose a reason for hiding this comment

Chrylo commented Jan 31, 2024 •

edited

Loading

wba2hi left a comment •

edited

Loading

wba2hi left a comment •

edited

Loading