Add VSS Processor Plugin

.github/workflows/build-main.yaml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Project
         uses: ./.github/actions/setup-project

.github/workflows/build-pull-request.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: "Run Docker Container of Databroker in detached mode"
         run: docker run --pull=always --rm --publish 55556:55556/tcp --detach --name databroker ghcr.io/eclipse/kuksa.val/databroker:master --port 55556 --insecure

.github/workflows/check-license.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         # required to grab the history of the PR
         fetch-depth: 0

.github/workflows/commitlint.yaml

@@ -8,6 +8,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: wagoid/commitlint-github-action@v5

.github/workflows/dash.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Project
         uses: ./.github/actions/setup-project

.github/workflows/deploy-release.yaml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Project
         uses: ./.github/actions/setup-project

.github/workflows/deploy-snapshot.yaml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Project
         uses: ./.github/actions/setup-project

README.md

@@ -14,7 +14,7 @@ within an Android App. The main functionality consists of fetching, updating and
 
 ## Integration
 
-*build.gradle*
+*build.gradle.kts*
 ```
 implementation("org.eclipse.kuksa:kuksa-sdk:<VERSION>")
 ```

app/build.gradle.kts

@@ -1,5 +1,3 @@
-import org.eclipse.kuksa.property.PropertiesLoader
-
 /*
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
  *
@@ -19,9 +17,16 @@ import org.eclipse.kuksa.property.PropertiesLoader
  *
  */
 
+@file:Suppress("UnstableApiUsage")
+
+import com.google.devtools.ksp.gradle.KspTask
+import org.eclipse.kuksa.property.PropertiesLoader
+import org.eclipse.kuksa.vssprocessor.plugin.ProvideVssDefinitionTask
+
 plugins {
     id("com.android.application")
     id("com.google.devtools.ksp")
+    id("org.eclipse.kuksa.vss-processor-plugin")
     kotlin("plugin.serialization")
     kotlin("android")
 }
@@ -121,6 +126,16 @@ android {
     }
 }
 
+tasks.register<ProvideVssDefinitionTask>("ProvideVssDefinition") {
+    val vssDefinitionFilePath = "$projectDir/src/main/assets/vss_rel_4.0.yaml"
+    val regularFile = RegularFile { File(vssDefinitionFilePath) }
+    vssDefinitionFile.add(regularFile)
+}
+
+tasks.withType<KspTask> {
+    dependsOn(tasks.withType<ProvideVssDefinitionTask>())
+}
+
 tasks.withType<Test>().configureEach {
     useJUnitPlatform()
 

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

@@ -111,18 +111,12 @@ afterEvaluate {
         )
 
         sign(publishing.publications)
-    }
-}
 
-gradle.taskGraph.whenReady {
-    tasks.withType(Sign::class) {
-        val publishToMavenLocalTask = allTasks.find { it.name.contains("publishToMavenLocal") }
-        val isPublishingToMavenLocal = publishToMavenLocalTask != null
-
-        if (isPublishingToMavenLocal) {
-            println(":${project.name}:$name - Signing is disabled (publishToMavenLocal)")
-        }
+        setRequired({
+            val publishToMavenLocalTask = gradle.taskGraph.allTasks.find { it.name.contains("ToMavenLocal") }
+            val isPublishingToMavenLocal = publishToMavenLocalTask != null
 
-        onlyIf { !isPublishingToMavenLocal } // disable signing when publishing to MavenLocal
+            !isPublishingToMavenLocal // disable signing when publishing to MavenLocal
+        })
     }
 }

docs/QUICKSTART.md

@@ -4,7 +4,7 @@ Get instantly bootstrapped into the world of the KUKSA SDK with the following co
 
 ## Integration
 
-*build.gradle*
+*build.gradle.kts*
 ```
 implementation("org.eclipse.kuksa:kuksa-sdk:<VERSION>")
 ```
@@ -153,9 +153,26 @@ For a more convenient usage you can opt in to auto generate Kotlin models via [S
 of the same specification the Databroker uses. For starters you can retrieve an extensive default specification from the
 release page of the [COVESA Vehicle Signal Specification GitHub repository](https://github.com/COVESA/vehicle_signal_specification/releases).
 
-*build.gradle*
+*build.gradle.kts*
 ```
-ksp("org.eclipse.kuksa:vss-processor:<VERSION>")
+plugins {
+    id("org.eclipse.kuksa.vss-processor-plugin")
+}
+
+dependencies {
+    ksp("org.eclipse.kuksa:vss-processor:<VERSION>")
+}
+
+// Copies the given specification file to the KSP processor
+tasks.register<ProvideVssDefinitionTask>("ProvideVssDefinition") {
+    val vssDefinitionFilePath = "$projectDir/src/main/assets/<VSS_FILE.yml>"
+    val regularFile = RegularFile { File(vssDefinitionFilePath) }
+    vssDefinitionFile.add(regularFile)
+}
+
+tasks.withType<KspTask> {
+    dependsOn(tasks.withType<ProvideVssDefinitionTask>())
+}
 ```
 
 Use the new [`VssDefinition`](https://github.com/eclipse-kuksa/kuksa-android-sdk/blob/main/vss-core/src/main/java/org/eclipse/kuksa/vsscore/annotation/VssDefinition.kt) annotation and provide the path to the specification file (Inside the assets folder).

gradle.properties

@@ -1,4 +1,3 @@
-android.defaults.buildfeatures.buildconfig=true
 android.nonFinalResIds=false
 android.nonTransitiveRClass=true
 android.useAndroidX=true

gradle/libs.versions.toml

@@ -1,6 +1,6 @@
 [versions]
 activityKtx = "1.8.0"
-androidGradlePlugin = "8.1.3" # Check with detekt table first: https://detekt.dev/docs/introduction/compatibility/
+androidGradlePlugin = "8.2.2" # Check with detekt table first: https://detekt.dev/docs/introduction/compatibility/
 datastore = "1.0.0"
 constraintlayoutCompose = "1.0.1"
 datastorePreferences = "1.0.0"

kuksa-sdk/build.gradle.kts

@@ -122,3 +122,26 @@ protobuf {
         }
     }
 }
+
+// Tasks for included composite builds need to be called separately. For convenience sake we depend on the most used
+// tasks. Every task execution of the main project will then be forwarded to the included build project.
+//
+// We have to manually define the task names because the task() method of the included build throws an error for any
+// unknown task.
+val dependentCompositeTasks = setOf(
+    "setSnapshotVersion",
+    "setReleaseVersion",
+    "publishToMavenLocal",
+    "publishAllPublicationsToOSSRHSnapshotRepository",
+    "publishAllPublicationsToOSSRHReleaseRepository",
+)
+tasks
+    .filter { dependentCompositeTasks.contains(it.name) }
+    .forEach { task ->
+        val compositeTask = gradle.includedBuilds.map { compositeBuild ->
+            val compositeTaskPath = task.path.substringAfter(":kuksa-sdk")
+            compositeBuild.task(compositeTaskPath)
+        }
+
+        task.dependsOn(compositeTask)
+    }

samples/build.gradle.kts

@@ -1,3 +1,6 @@
+import com.google.devtools.ksp.gradle.KspTask
+import org.eclipse.kuksa.vssprocessor.plugin.ProvideVssDefinitionTask
+
 /*
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
  *
@@ -20,6 +23,7 @@
 plugins {
     id("com.android.application")
     id("com.google.devtools.ksp")
+    id("org.eclipse.kuksa.vss-processor-plugin")
     kotlin("android")
 }
 
@@ -54,6 +58,16 @@ android {
     }
 }
 
+tasks.register<ProvideVssDefinitionTask>("ProvideVssDefinition") {
+    val vssDefinitionFilePath = "$projectDir/src/main/assets/vss_rel_4.0.yaml"
+    val regularFile = RegularFile { File(vssDefinitionFilePath) }
+    vssDefinitionFile.add(regularFile)
+}
+
+tasks.withType<KspTask> {
+    dependsOn(tasks.withType<ProvideVssDefinitionTask>())
+}
+
 dependencies {
     implementation(project(":kuksa-sdk")) // org.eclipse.kuksa.kuksa-sdk:<VERSION>
     ksp(project(":vss-processor")) // org.eclipse.kuksa.vss-processor:<VERSION>

settings.gradle.kts

@@ -18,6 +18,8 @@
  */
 
 pluginManagement {
+    includeBuild("vss-processor-plugin")
+
     repositories {
         gradlePluginPortal()
         google()
@@ -26,6 +28,7 @@ pluginManagement {
 
     plugins {
         id("com.google.devtools.ksp") version "1.9.0-1.0.11"
+        id("org.eclipse.kuksa.vss-processor-plugin") version "0.1.3"
         kotlin("jvm") version "1.9.0-1.0.11"
         kotlin("plugin.serialization") version "1.9.0"
     }
@@ -40,6 +43,8 @@ dependencyResolutionManagement {
     }
 }
 
+rootProject.name = "kuksa-android-sdk"
+
 include(":app")
 include(":kuksa-sdk")
 include(":samples")

vss-core/build.gradle.kts

@@ -21,7 +21,6 @@
 
 plugins {
     kotlin("jvm")
-    `maven-publish`
     publish
     alias(libs.plugins.dokka)
 }

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

@@ -21,10 +21,29 @@ package org.eclipse.kuksa.vsscore.annotation
 
 /**
  * Add this annotation to any class to trigger the model generation (Kotlin Symbol Processing) for the given
- * Vehicle Signal Specification definition file. Only .yaml files are currently supported. The searched root folder
- * is the assets folder (example path: app/src/main/assets).
+ * Vehicle Signal Specification definition file. Only .yaml files are currently supported. Use the
+ * "VSS Processor Plugin" to provide the Symbol Processor with the necessary definition file(s). Then provide the file
+ * name via the [vssDefinitionName] parameter (The path can be ignored).
  *
- * ### Example
+ * ### Plugin Example
+ *
+ * ```
+ * plugins {
+ *     id("org.eclipse.kuksa.vss-processor-plugin") version "<VERSION>"
+ * }
+ *
+ * tasks.register<ProvideVssDefinitionTask>("ProvideVssDefinition") {
+ *     val vssDefinitionFilePath = "$projectDir/src/main/assets/vss_rel_4.0.yaml"
+ *     val regularFile = RegularFile { File(vssDefinitionFilePath) }
+ *     vssDefinitionFile.add(regularFile)
+ * }
+ *
+ * tasks.withType<KspTask> {
+ *     dependsOn(tasks.withType<ProvideVssDefinitionTask>())
+ * }
+ * ```
+ *
+ * ### Annotation Example
  *
  * ```
  * @VssDefinition("vss_rel_4.0.yaml")
@@ -36,10 +55,8 @@ package org.eclipse.kuksa.vsscore.annotation
  * then the incremental compiler for KSP needs to be disabled explicitly in the gradle properties.
  * ```
  * <ksp.incremental=false>
- *
- * @param vssDefinitionPath the path to the definition file
  * ```
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.SOURCE)
-annotation class VssDefinition(val vssDefinitionPath: String)
+annotation class VssDefinition(val vssDefinitionName: String)

vss-processor-plugin/.gitignore

@@ -0,0 +1 @@
+/build

vss-processor-plugin/build.gradle.kts

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ */
+
+repositories {
+    gradlePluginPortal()
+    google()
+    mavenCentral()
+}
+
+plugins {
+    `kotlin-dsl`
+    `java-gradle-plugin`
+    publish
+    version
+}
+
+gradlePlugin {
+    plugins {
+        create("VssProcessorPlugin") {
+            id = "org.eclipse.kuksa.vss-processor-plugin"
+            implementationClass = "org.eclipse.kuksa.vssprocessor.plugin.VssProcessorPlugin"
+        }
+    }
+}
+
+group = "org.eclipse.kuksa"
+version = rootProject.extra["projectVersion"].toString()
+
+dependencies {
+    implementation(kotlin("stdlib"))
+}
+
+configure<Publish_gradle.PublishPluginExtension> {
+    description = "Vehicle Signal Specification (VSS) Plugin of the KUKSA SDK"
+}