feat: add dislpaying enum values as a list (#139)

Skarlso · web-flow · commit 20f38548e90d · 2024-10-30T10:53:28.000+01:00
* feat: add dislpaying enum values as a list

* fixed the failing tests
diff --git a/pkg/create_html_output.go b/pkg/create_html_output.go
@@ -10,6 +10,7 @@ import (
 	"os"
 	"slices"
 	"sort"
+	"strings"
 
 	"github.com/Skarlso/crd-to-sample-yaml/v1beta1"
 )
@@ -196,6 +197,7 @@ type Property struct {
 	Default     string
 	Required    bool
 	Properties  []*Property
+	Enums       string
 }
 
 // parseCRD takes the properties and constructs a linked list out of the embedded properties that the recursive
@@ -237,6 +239,12 @@ func parseCRD(properties map[string]v1beta1.JSONSchemaProps, version string, min
 				description = kind
 			}
 		}
+
+		var enums []string
+		for _, e := range v.Enum {
+			enums = append(enums, string(e.Raw))
+		}
+
 		p := &Property{
 			Name:        k,
 			Type:        v.Type,
@@ -246,6 +254,7 @@ func parseCRD(properties map[string]v1beta1.JSONSchemaProps, version string, min
 			Nullable:    v.Nullable,
 			Version:     version,
 			Required:    required,
+			Enums:       strings.Join(enums, ", "),
 		}
 		if v.Default != nil {
 			p.Default = string(v.Default.Raw)
@@ -255,7 +264,7 @@ func parseCRD(properties map[string]v1beta1.JSONSchemaProps, version string, min
 		case len(properties[k].Properties) > 0 && properties[k].AdditionalProperties == nil:
 			requiredList = v.Required
 			depth++
-			out, err := parseCRD(properties[k].Properties, version, minimal, "", "", requiredList, depth)
+			out, err := parseCRD(properties[k].Properties, version, minimal, group, kind, requiredList, depth)
 			if err != nil {
 				return nil, err
 			}
@@ -264,7 +273,7 @@ func parseCRD(properties map[string]v1beta1.JSONSchemaProps, version string, min
 		case properties[k].Type == array && properties[k].Items.Schema != nil && len(properties[k].Items.Schema.Properties) > 0:
 			depth++
 			requiredList = v.Required
-			out, err := parseCRD(properties[k].Items.Schema.Properties, version, minimal, "", "", requiredList, depth)
+			out, err := parseCRD(properties[k].Items.Schema.Properties, version, minimal, group, kind, requiredList, depth)
 			if err != nil {
 				return nil, err
 			}
@@ -273,7 +282,7 @@ func parseCRD(properties map[string]v1beta1.JSONSchemaProps, version string, min
 		case properties[k].AdditionalProperties != nil:
 			depth++
 			requiredList = v.Required
-			out, err := parseCRD(properties[k].AdditionalProperties.Schema.Properties, version, minimal, "", "", requiredList, depth)
+			out, err := parseCRD(properties[k].AdditionalProperties.Schema.Properties, version, minimal, group, kind, requiredList, depth)
 			if err != nil {
 				return nil, err
 			}
diff --git a/pkg/generate.go b/pkg/generate.go
@@ -227,7 +227,12 @@ func outputValueType(v v1beta1.JSONSchemaProps, skipRandom bool) string {
 	}
 
 	if v.Enum != nil {
-		return string(v.Enum[0].Raw)
+		var value []string
+		for _, ev := range v.Enum {
+			value = append(value, string(ev.Raw))
+		}
+
+		return string(v.Enum[0].Raw) + " # " + strings.Join(value, ", ")
 	}
 
 	st := "string"
diff --git a/pkg/templates/view_with_groups.html b/pkg/templates/view_with_groups.html
@@ -98,6 +98,9 @@ <h1>
                                             {{if $v.Required}}
                                             <span class="badge badge-primary">required</span>
                                             {{end}}
+                                            {{if $v.Enums}}
+                                            <kbd class="text-muted">{{$v.Enums}}</kbd>
+                                            {{end}}
                                         </summary>
                                         <div id="{{$v.Name}}" class="collapse-content">
                                             <div class="property-description">
@@ -140,6 +143,9 @@ <h1>
         {{if .Required}}
         <span class="badge badge-primary">required</span>
         {{end}}
+        {{if .Enums}}
+        <kbd class="text-muted">{{.Enums}}</kbd>
+        {{end}}
     </summary>
     <div id="{{.Name}}" class="collapse-content">
         <div class="property-description">
diff --git a/pkg/testdata/sample_crd.yaml b/pkg/testdata/sample_crd.yaml
@@ -57,6 +57,13 @@ spec:
                 items:
                   type: string
                 type: array
+              suspendStrategy:
+                description: SuspendStrategy can be used to modify the behaviour that
+                  is used when setting suspend to true.
+                enum:
+                  - ScaleDown
+                  - ScaleDownAndDeleteDisk
+                type: string
               readInputFromSecret:
                 description: ReadInputFromSecret if defined, the command will take
                   a list of key/value pairs in a secret and apply them as arguments
diff --git a/pkg/testdata/sample_crd_different_crd_type_golden.yaml b/pkg/testdata/sample_crd_different_crd_type_golden.yaml
@@ -3,11 +3,11 @@ kind: xXtStorageAccount
 spec:
   parameters:
     accessTier: "Hot"
-    environment: "production"
+    environment: "production" # "production", "staging", "preproduction", "quality_assurance", "test", "development", "proof_of_concept", "disaster_recovery", "sandbox", "global"
     hnsEnabled: false
     kind: "StorageV2"
     largeFileShareEnabled: false
-    location: "westeurope"
+    location: "westeurope" # "westeurope", "northeurope", "eastus2", "centralus", "australiaeast", "australiacentral", "global"
     projectName: string
     replicationType: "ZRS"
     resourceGroupName: string
diff --git a/pkg/testdata/sample_crd_golden.yaml b/pkg/testdata/sample_crd_golden.yaml
@@ -11,4 +11,5 @@ spec:
     name: string
     namespace: string
   schedule: string
+  suspendStrategy: "ScaleDown" # "ScaleDown", "ScaleDownAndDeleteDisk"
 status: {}
diff --git a/pkg/testdata/sample_crd_with_comments_golden.yaml b/pkg/testdata/sample_crd_with_comments_golden.yaml
@@ -21,5 +21,7 @@ spec:
     namespace: string
   # Schedule of the command. example: 0 * * * * // follows cron job syntax.
   schedule: string
+  # SuspendStrategy can be used to modify the behaviour that is used when setting suspend to true.
+  suspendStrategy: "ScaleDown" # "ScaleDown", "ScaleDownAndDeleteDisk"
 # KrokCommandStatus defines the observed state of KrokCommand
 status: {}
diff --git a/pkg/testdata/sample_crd_with_list_and_multiple_versions_golden.yaml b/pkg/testdata/sample_crd_with_list_and_multiple_versions_golden.yaml
@@ -20,7 +20,7 @@ spec:
     scheme: "internet-facing"
     subnets: [] # minItems 0 of type string
   identityRef:
-    kind: "AWSClusterControllerIdentity"
+    kind: "AWSClusterControllerIdentity" # "AWSClusterControllerIdentity", "AWSClusterRoleIdentity", "AWSClusterStaticIdentity"
     name: string
   imageLookupBaseOS: string
   imageLookupFormat: string
@@ -158,7 +158,7 @@ spec:
     scheme: "internet-facing"
     subnets: [] # minItems 0 of type string
   identityRef:
-    kind: "AWSClusterControllerIdentity"
+    kind: "AWSClusterControllerIdentity" # "AWSClusterControllerIdentity", "AWSClusterRoleIdentity", "AWSClusterStaticIdentity"
     name: string
   imageLookupBaseOS: string
   imageLookupFormat: string
diff --git a/sample-crd/crd_with_enum.yaml b/sample-crd/crd_with_enum.yaml
@@ -0,0 +1,96 @@
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.9.2
+  creationTimestamp: null
+  name: krokcommands.delivery.krok.app
+spec:
+  group: delivery.krok.app
+  names:
+    kind: KrokCommand
+    listKind: KrokCommandList
+    plural: krokcommands
+    singular: krokcommand
+  scope: Namespaced
+  versions:
+  - name: v1alpha1
+    schema:
+      openAPIV3Schema:
+        description: KrokCommand is the Schema for the krokcommands API
+        properties:
+          apiVersion:
+            description: 'APIVersion defines the versioned schema of this representation
+              of an object. Servers should convert recognized schemas to the latest
+              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            type: string
+          kind:
+            description: 'Kind is a string value representing the REST resource this
+              object represents. Servers may infer this from the endpoint the client
+              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            type: string
+          metadata:
+            type: object
+          spec:
+            description: KrokCommandSpec defines the desired state of KrokCommand
+            properties:
+              commandHasOutputToWrite:
+                description: CommandHasOutputToWrite if defined, it signals the underlying
+                  Job, to put its output into a generated and created secret.
+                type: boolean
+              dependencies:
+                description: Dependencies defines a list of command names that this
+                  command depends on.
+                items:
+                  type: string
+                type: array
+              enabled:
+                description: Enabled defines if this command can be executed or not.
+                type: boolean
+              suspendStrategy:
+                default: ScaleDown
+                description: SuspendStrategy can be used to modify the behaviour that
+                  is used when setting suspend to true.
+                enum:
+                  - ScaleDown
+                  - ScaleDownAndDeleteDisk
+                type: string
+              image:
+                description: 'Image defines the image name and tag of the command
+                  example: krok-hook/slack-notification:v0.0.1'
+                type: string
+              platforms:
+                description: Platforms holds all the platforms which this command
+                  supports.
+                items:
+                  type: string
+                type: array
+              readInputFromSecret:
+                description: ReadInputFromSecret if defined, the command will take
+                  a list of key/value pairs in a secret and apply them as arguments
+                  to the command.
+                properties:
+                  name:
+                    type: string
+                  namespace:
+                    type: string
+                required:
+                - name
+                - namespace
+                type: object
+              schedule:
+                description: 'Schedule of the command. example: 0 * * * * // follows
+                  cron job syntax.'
+                type: string
+            required:
+            - image
+            type: object
+          status:
+            description: KrokCommandStatus defines the observed state of KrokCommand
+            type: object
+        type: object
+    served: true
+    storage: true
+    subresources:
+      status: {}

Original file line number	Diff line number	Diff line change
`@@ -227,7 +227,12 @@ func outputValueType(v v1beta1.JSONSchemaProps, skipRandom bool) string {`
`227`	`227`	`}`
`228`	`228`
`229`	`229`	`if v.Enum != nil {`
`230`		`- return string(v.Enum[0].Raw)`
	`230`	`+ var value []string`
	`231`	`+ for _, ev := range v.Enum {`
	`232`	`+ value = append(value, string(ev.Raw))`
	`233`	`+ }`
	`234`	`+`
	`235`	`+ return string(v.Enum[0].Raw) + " # " + strings.Join(value, ", ")`
`231`	`236`	`}`
`232`	`237`
`233`	`238`	`st := "string"`