-
-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor code to take into account optional fields
Refactor code so we are not passing in values and only using the defaults from the module config Show parent field if there are no child fields to show We want to show the labels field (among others) in the markdown table if so that it is part of the documentation rather than showing all the preset labels as individual fields in the docs. Signed-off-by: Luke Mallon (Nalum) <[email protected]>
- Loading branch information
Showing
4 changed files
with
184 additions
and
64 deletions.
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| /* | ||
| Copyright 2023 Stefan Prodan | ||
| 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. | ||
| */ | ||
|
|
||
| package engine | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "regexp" | ||
| "strings" | ||
|
|
||
| "cuelang.org/go/cue" | ||
| "cuelang.org/go/cue/ast" | ||
| "cuelang.org/go/cue/load" | ||
|
|
||
| apiv1 "github.com/stefanprodan/timoni/api/v1alpha1" | ||
| ) | ||
|
|
||
| // GetConfigDoc extracts the config structure from the module. | ||
| func (b *ModuleBuilder) GetConfigDoc() ([][]string, error) { | ||
| var value cue.Value | ||
|
|
||
| cfg := &load.Config{ | ||
| ModuleRoot: b.moduleRoot, | ||
| Package: b.pkgName, | ||
| Dir: b.pkgPath, | ||
| DataFiles: true, | ||
| Tags: []string{ | ||
| "name=" + b.name, | ||
| "namespace=" + b.namespace, | ||
| }, | ||
| TagVars: map[string]load.TagVar{ | ||
| "moduleVersion": { | ||
| Func: func() (ast.Expr, error) { | ||
| return ast.NewString(b.moduleVersion), nil | ||
| }, | ||
| }, | ||
| "kubeVersion": { | ||
| Func: func() (ast.Expr, error) { | ||
| return ast.NewString(b.kubeVersion), nil | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| modInstances := load.Instances([]string{}, cfg) | ||
| if len(modInstances) == 0 { | ||
| return nil, errors.New("no instances found") | ||
| } | ||
|
|
||
| modInstance := modInstances[0] | ||
| if modInstance.Err != nil { | ||
| return nil, fmt.Errorf("instance error: %w", modInstance.Err) | ||
| } | ||
|
|
||
| value = b.ctx.BuildInstance(modInstance) | ||
| if value.Err() != nil { | ||
| return nil, value.Err() | ||
| } | ||
|
|
||
| cfgValues := value.LookupPath(cue.ParsePath(apiv1.ConfigValuesSelector.String())) | ||
| if cfgValues.Err() != nil { | ||
| return nil, fmt.Errorf("lookup %s failed: %w", apiv1.ConfigValuesSelector, cfgValues.Err()) | ||
| } | ||
|
|
||
| rows, err := iterateFields(cfgValues) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return rows, nil | ||
| } | ||
|
|
||
| func iterateFields(v cue.Value) ([][]string, error) { | ||
| var rows [][]string | ||
|
|
||
| fields, err := v.Fields( | ||
| cue.Optional(true), | ||
| cue.Concrete(true), | ||
| cue.Docs(true), | ||
| ) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("Cue Fields Error: %w", err) | ||
| } | ||
|
|
||
| for fields.Next() { | ||
| v := fields.Value() | ||
|
|
||
| // We are chekcing if the field is a struct and not optional and is concrete before we iterate through it | ||
| // this allows for definition of default values as full structs without generating output for each | ||
| // field in the struct where it doesn't make sense e.g. | ||
| // | ||
| // - annotations?: {[string]: string} | ||
| // - affinity: corev1.Affinity | *{nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: nodeSelectorTerms: [...]} | ||
| if v.IncompleteKind() == cue.StructKind && !fields.IsOptional() && v.IsConcrete() { | ||
| // Assume we want to use the field | ||
| useField := true | ||
| iRows, err := iterateFields(v) | ||
|
|
||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| for _, row := range iRows { | ||
| if len(row) > 0 { | ||
| // If we have a row with more than 0 elements, we don't want to use the field and should use the child rows instead | ||
| useField = false | ||
| rows = append(rows, row) | ||
| } | ||
| } | ||
|
|
||
| if useField { | ||
| rows = append(rows, getField(v)) | ||
| } | ||
| } else { | ||
| rows = append(rows, getField(v)) | ||
| } | ||
| } | ||
|
|
||
| return rows, nil | ||
| } | ||
|
|
||
| func getField(v cue.Value) []string { | ||
| var row []string | ||
| labelDomain := regexp.MustCompile(`^([a-zA-Z0-9-_.]+)?(".+")?$`) | ||
|
|
||
| var noDoc bool | ||
| var doc string | ||
|
|
||
| for _, d := range v.Doc() { | ||
| if line := len(d.List) - 1; line >= 0 { | ||
| switch d.List[line].Text { | ||
| case "// +nodoc": | ||
| noDoc = true | ||
| break | ||
| } | ||
| } | ||
|
|
||
| doc += d.Text() | ||
| doc = strings.ReplaceAll(doc, "\n", " ") | ||
| doc = strings.ReplaceAll(doc, "+required", "") | ||
| doc = strings.ReplaceAll(doc, "+optional", "") | ||
| } | ||
|
|
||
| if !noDoc { | ||
| defaultVal, _ := v.Default() | ||
| valueBytes, _ := defaultVal.MarshalJSON() | ||
| valueType := strings.ReplaceAll(v.IncompleteKind().String(), "|", "\\|") | ||
|
|
||
| value := strings.ReplaceAll(string(valueBytes), "\":", "\": ") | ||
| value = strings.ReplaceAll(value, "\":[", "\": [") | ||
| value = strings.ReplaceAll(value, "},", "}, ") | ||
| value = strings.ReplaceAll(value, "|", "\\|") | ||
|
|
||
| if len(value) == 0 { | ||
| value = " " | ||
| } | ||
|
|
||
| field := strings.Replace(v.Path().String(), "timoni.instance.config.", "", 1) | ||
| match := labelDomain.FindStringSubmatch(field) | ||
|
|
||
| row = append(row, fmt.Sprintf("`%s:`", strings.ReplaceAll(match[1], ".", ": ")+match[2])) | ||
| row = append(row, fmt.Sprintf("`%s`", valueType)) | ||
| row = append(row, fmt.Sprintf("`%s`", value)) | ||
| row = append(row, fmt.Sprintf("%s", doc)) | ||
| } | ||
|
|
||
| return row | ||
| } |
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