feat: Add support for (custom) types #498
Open
Conversation
This file contains 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
added 4 commits
April 8, 2025 14:12
This fragment is repeated in the downstream functions. I guess it is a left-over from refactorings.
This adds the `Types` field to the ResourceGraphDefinition CRD. It
contains a map of names to type definitions, where the definitions
follow the simple schema.
The defined types are then loaded into the transformer as predefined
types. Appearances in the spec are then properly resolved.
An example for usage would be:
``` yaml
apiVersion: kro.run/v1alpha1
kind: ResourceGraphDefinition
metadata:
name: service-entry-dns
spec:
schema:
apiVersion: v1alpha1
kind: ServiceEntryDNS
spec:
ports: "[]port | required=true"
types:
port:
name: string
protocol: string
number: integer | required
```
Known issues: Currently there is no support for references of custom
types within the definition of a custom type!
Fixes kro-run#144
If a simple type was used with the required marker: ``` yaml types: myType: string | required=true description="my description" spec: myValue: myType ``` the required marker was lost, while the description was set properly. This happened as in the applyMarkers method of the transformer the required information is set to the parent. While loading the predefined types this parent is just a shell object, that is later read to fill the list of predefined types and then discarded. Now the information on required types is captured in the `predefinedType` type and then later used to set the parent object required fields when handling predefined types.
csantanapr
reviewed
Apr 10, 2025
a-hilaly
reviewed
Apr 16, 2025
Comment on lines
+25
to
+29
| // A predefined type is a type that is predefined in the schema. | ||
| // It is used to resolve references in the schema, while capturing the fact | ||
| // whether the type has the required marker set (this information would | ||
| // otherwise be lost in the parsing process). | ||
| type predefinedType struct { |
There was a problem hiding this comment.
Good call! initially i wasn't sure about this, but i just remembered that required fields always live parent-type-schema-definition.
There was a problem hiding this comment.
I just noticed that adding this broke the test for the predefined types. So, I fixed that.
pkg/simpleschema/transform_test.go
Outdated
| if err != nil { | ||
| t.Fatalf("Failed to load pre-defined types: %v", err) | ||
| } | ||
| func floatPtr(f float64) *float64 { |
There was a problem hiding this comment.
looks like this function isn't used, shall we remove it?
added 3 commits
April 16, 2025 08:23
This was never used but accidentally committed. So removing it.
This is reported when `gofmt` is run with the `-s` option.
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.
This is the first implementation that was discussed in the slack channel. The other idea of having the
typesfield in thespecpart of the schema, seems to be more complicated to implement.Fixes #144.