Add VSS Symbol Processing processor #11

Chrylo · 2023-09-22T13:47:43Z

Closes #4

An input specification file (for now only .yaml is supported) can now be injected via an annotation. Like this:
@VssDefinition("vss_rel_4.0.yaml")

For example from here: https://github.com/COVESA/vehicle_signal_specification/releases/tag/v4.0

The new KSP module will now generate fitting Kotlin data classes which can be used in combination with the SDK. This will simplify the back and forth parsing of the manual approach (vssPath + value) tremendously. See the API doc for the new methods inside the DataBrokerConnection for detailed information.

TODO: Unit tests will follow. After discussions with the reviewers we wanted to start the review already because it's a big feature.

Potential features for the future:

Support multiple input files like json
Improve performance of the KSP and parsing between server responses + models
Improve readability inside the test app for really big parent specifications

Signed-Off-By: Mark Hüsers <mark.huesers@etas.com>

Instead of using the generic interface VSSSpeciaction, all classes are now references to the concrete class type.

Duplicated names like "Middle" with different vssPaths should be added as nested classes.

Some description have a "," so the parsing would be incorrect.

Consists of common models used inside the SDK + Processor

- Some cleanup + renaming

No logical changes were made besides adapting the code to the new interface.

Chrylo · 2023-09-25T11:54:20Z

Had to force push the author so it matches my eclipse account e-mail.

app/src/main/kotlin/org/eclipse/kuksa/testapp/databroker/DataBrokerEngine.kt

gradle.properties

kuksa-sdk/src/main/kotlin/org/eclipse/kuksa/DataBrokerConnection.kt

app/build.gradle.kts

app/src/main/java/org/eclipse/kuksa/testapp/databroker/JavaDataBrokerEngine.java

vss-core/src/main/java/org/eclipse/kuksa/vsscore/model/VssSpecification.kt

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

kuksa-sdk/build.gradle.kts

.gitignore

app/src/main/kotlin/org/eclipse/kuksa/testapp/databroker/viewmodel/ConnectionViewModel.kt

config/detekt/config.yml

kuksa-sdk/build.gradle.kts

kuksa-sdk/src/main/kotlin/org/eclipse/kuksa/DataBrokerConnection.kt

...ocessor/src/test/kotlin/org/eclipse/kuksa/vssprocessor/spec/VssSpecificationSpecModelTest.kt

SebastianSchildt · 2023-10-08T12:26:14Z

CI fails due to missing license headers in 2 files:

NO SPDX /home/runner/work/kuksa-android-sdk/kuksa-android-sdk/app/src/main/kotlin/org/eclipse/kuksa/testapp/databroker/viewmodel/VssSpecificationsViewModel.kt

NO SPDX /home/runner/work/kuksa-android-sdk/kuksa-android-sdk/vss-core/src/main/java/org/eclipse/kuksa/vsscore/extension/StringExtension.kt

# Conflicts: # build.gradle.kts # kuksa-sdk/build.gradle.kts

# Conflicts: # app/src/main/kotlin/org/eclipse/kuksa/testapp/KuksaDataBrokerActivity.kt # kuksa-sdk/src/main/kotlin/org/eclipse/kuksa/DataBrokerConnection.kt

wba2hi

Functional Test looked good (fetch, subscribe, minify, consumer-proguard-rules).

I still expect some follow-up findings or changes during the integration into the Demo app, but I can't anticipate them yet.

LGTM

lukasmittag · 2023-10-10T14:10:09Z

NO SPDX /home/runner/work/kuksa-android-sdk/kuksa-android-sdk/vss-core/src/main/java/org/eclipse/kuksa/vsscore/extension/StringExtension.kt

please check

lukasmittag

LGTM. What I did:

build project ran App with two different yaml files
build project with one yaml file that has some errors like not a real datatype and its not working -> good

lukasmittag · 2023-10-13T13:28:33Z

check conflciting files please :)

# Conflicts: # app/build.gradle.kts # app/src/main/java/org/eclipse/kuksa/testapp/databroker/JavaDataBrokerEngine.java # app/src/main/kotlin/org/eclipse/kuksa/testapp/KuksaDataBrokerActivity.kt # app/src/main/kotlin/org/eclipse/kuksa/testapp/databroker/DataBrokerEngine.kt # app/src/main/kotlin/org/eclipse/kuksa/testapp/databroker/KotlinDataBrokerEngine.kt # app/src/main/kotlin/org/eclipse/kuksa/testapp/databroker/view/DataBrokerView.kt # app/src/main/kotlin/org/eclipse/kuksa/testapp/databroker/viewmodel/ConnectionViewModel.kt # app/src/main/kotlin/org/eclipse/kuksa/testapp/extension/UriExtension.kt # gradle/libs.versions.toml # kuksa-sdk/build.gradle.kts # kuksa-sdk/consumer-rules.pro # kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/DataBrokerConnectionTest.kt # kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/DataBrokerConnectorSecureTest.kt # kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/DataBrokerConnectorTest.kt # kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/databroker/DataBrokerConfig.kt # kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/databroker/DataBrokerConnectorProvider.kt # kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/kotest/KotestProjectConfig.kt # kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/kotest/Tag.kt # kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/pattern/listener/MultiListenerTest.kt # kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/test/databroker/DataBrokerConfig.kt # kuksa-sdk/src/test/kotlin/org/eclipse/kuksa/test/databroker/DataBrokerConnectorProvider.kt # kuksa-sdk/src/test/kotlin/test/databroker/DataBrokerConfig.kt # kuksa-sdk/src/test/kotlin/test/databroker/DataBrokerConnectorProvider.kt # kuksa-sdk/src/test/kotlin/test/kotest/KotestProjectConfig.kt # kuksa-sdk/src/test/kotlin/test/kotest/Tag.kt # settings.gradle.kts # test/src/main/java/org/eclipse/kuksa/test/kotest/KotestProjectConfig.kt # test/src/main/java/org/eclipse/kuksa/test/kotest/Tag.kt

Chrylo · 2023-10-16T14:26:58Z

@lukasmittag @wba2hi Merged main into feature branch and fixed all conflicts. Pls have a quick look :)

wba2hi · 2023-10-17T05:30:48Z

LGTM

lukasmittag

LGTM

Chrylo marked this pull request as draft September 22, 2023 13:48

Chrylo force-pushed the feature-4 branch from 0baf3d9 to 71cb620 Compare September 25, 2023 11:45

Chrylo added 22 commits September 25, 2023 13:47

chore: Add missing types to proguard

a03e158

Signed-Off-By: Mark Hüsers <mark.huesers@etas.com>

chore: Add VSS processing module

01e5403

chore: Add symbol processing dependency

794b142

feature: Add VSS Symbol Processing processor

18926ee

chore: Move to org.eclipse package

a0173a6

chore: Use concrete types as data class parameter

51b5a3e

Instead of using the generic interface VSSSpeciaction, all classes are now references to the concrete class type.

chore: Add comment to VssSpecification

38bca3c

chore: Add maven publish plugin

4402dda

chore: Add nested classes

90fb9e0

Duplicated names like "Middle" with different vssPaths should be added as nested classes.

chore: Replace separator with ";"

9fe41c8

Some description have a "," so the parsing would be incorrect.

chore: Increase target SDK to 34

e19a1c8

chore: Add vss-core module

12b3bb5

Consists of common models used inside the SDK + Processor

chore: Add subscribe API for generated properties

0870531

chore: Add children and parent information to generated models

1a6bce1

chore: Correct copying child specifications

45e225c

chore: Add specifications view

e9c07e0

chore: Improve suspend API methods for Java + Kotlin

ee86e5a

chore: Improve output view to use a list instead of String

fea4452

chore: Add convenience extensions for heritage algorithms

e51a13f

chore: Improve animation of data broker mode

597e719

chore: Extract YamlParser

2d6ee49

- Some cleanup + renaming

chore: Extract SpecModel from Processor

646d6d4

No logical changes were made besides adapting the code to the new interface.

Chrylo force-pushed the feature-4 branch from 71cb620 to 646d6d4 Compare September 25, 2023 11:47

wba2hi requested changes Sep 25, 2023

View reviewed changes

Chrylo added 3 commits September 26, 2023 17:15

chore: Change generated classes to CamelCase

2ad2d7c

chore: Move processing annotation to core module

5fc42ab

chore: Add proguard rules for protobuf

7777efb

wba2hi requested changes Oct 6, 2023

View reviewed changes

Chrylo added 2 commits October 6, 2023 18:07

chore: Reduce redundant connection state code

ccac27e

test: Add int32 and uint32 tests for the spec model

8d9a134

Chrylo added 9 commits October 9, 2023 12:38

chore: Optimize consumer-proguard rules

ee3043a

docs: Improve documentation

61b34cc

Merge remote-tracking branch 'Eclipse/main' into feature-4

50d3d2e

# Conflicts: # build.gradle.kts # kuksa-sdk/build.gradle.kts

Merge remote-tracking branch 'Eclipse/main' into feature-4

32b95a5

# Conflicts: # app/src/main/kotlin/org/eclipse/kuksa/testapp/KuksaDataBrokerActivity.kt # kuksa-sdk/src/main/kotlin/org/eclipse/kuksa/DataBrokerConnection.kt

chore: Adapt publish plugin for pure java modules

2163071

chore: Fix copy for string arrays

19776bf

chore: Fix proguard for multi parameter

1e1e790

test: Fix tag import

f2a860a

chore: Add milli seconds to timestamp

e4f9b6d

wba2hi approved these changes Oct 10, 2023

View reviewed changes

chore: Fix missing copryight

d8c529c

lukasmittag previously approved these changes Oct 11, 2023

View reviewed changes

lukasmittag closed this Oct 11, 2023

lukasmittag reopened this Oct 11, 2023

Chrylo added 4 commits October 16, 2023 15:00

chore: Fix conflicts

2f411f8

test: Fix test conflicts

a043d0f

test: Add run config for all unit tests

972f585

Chrylo dismissed lukasmittag’s stale review via 972f585 October 16, 2023 14:19

lukasmittag approved these changes Oct 17, 2023

View reviewed changes

lukasmittag merged commit 21460f1 into eclipse-kuksa:main Oct 17, 2023
3 checks passed

wba2hi deleted the feature-4 branch March 7, 2024 12:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add VSS Symbol Processing processor #11

Add VSS Symbol Processing processor #11

Chrylo commented Sep 22, 2023

Chrylo commented Sep 25, 2023

SebastianSchildt commented Oct 8, 2023

wba2hi left a comment

lukasmittag commented Oct 10, 2023

lukasmittag left a comment

lukasmittag commented Oct 13, 2023

Chrylo commented Oct 16, 2023

wba2hi commented Oct 17, 2023

lukasmittag left a comment

Add VSS Symbol Processing processor #11

Add VSS Symbol Processing processor #11

Conversation

Chrylo commented Sep 22, 2023

Chrylo commented Sep 25, 2023

SebastianSchildt commented Oct 8, 2023

wba2hi left a comment

Choose a reason for hiding this comment

lukasmittag commented Oct 10, 2023

lukasmittag left a comment

Choose a reason for hiding this comment

lukasmittag commented Oct 13, 2023

Chrylo commented Oct 16, 2023

wba2hi commented Oct 17, 2023

lukasmittag left a comment

Choose a reason for hiding this comment