[crd-gen] Enum fields written in generated crd yaml

[leoandrea7]

Describe the bug

When the crd-gen tool tries to generate schema properties from an enum, both values and fields are written in the generated crd yaml.

Fabric8 Kubernetes Client version

5.12.2

Steps to reproduce

Create an enum with values and at least a field and put it into Spec.
Example:

@Group("com.example")
@Version("mycrd")
@Plural("mycrds")
public class MyCRD extends CustomResource<MyCRDSpec, Void> implements Namespaced {

  public class MyCRDSpec {

    private Test test;

    public enum Test {
      A("test-a"),
      B("test-b");

      private final String field1;

      Test(String field1) {
        this.field1 = field1;
      }

      public String getField1() {
        return field1;
      }
    }
  }
}

Exec mvn clean compile

the generated file target/classes/META-INF/fabric8/mycrds.com.example-v1.yml will contain:

# Generated by Fabric8 CRDGenerator, manual edits might get overwritten!
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: mycrds.com.example
spec:
  group: com.example
  names:
    kind: MyCRD
    plural: mycrds
    singular: mycrd
  scope: Namespaced
  versions:
  - name: mycrd
    schema:
      openAPIV3Schema:
        properties:
          spec:
            properties:
              test:
                enum:
                - A
                - B
                - field1
                type: string
            type: object
          status:
            type: object
        type: object
    served: true
    storage: true

Expected behavior

A crd with just enum values and without enum fields:

# Generated by Fabric8 CRDGenerator, manual edits might get overwritten!
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: mycrds.com.example
spec:
  group: com.example
  names:
    kind: MyCRD
    plural: mycrds
    singular: mycrd
  scope: Namespaced
  versions:
  - name: mycrd
    schema:
      openAPIV3Schema:
        properties:
          spec:
            properties:
              test:
                enum:
                - A
                - B
                type: string
            type: object
          status:
            type: object
        type: object
    served: true
    storage: true

Runtime

Kubernetes (vanilla)

Kubernetes API Server version

1.22.3@latest

Environment

Windows

Fabric8 Kubernetes Client Logs

No response

Additional context

No response

[leoandrea7]

I think that the problem is here:

kubernetes-client/crd-generator/api/src/main/java/io/fabric8/crd/generator/AbstractJsonSchema.java

Line 592 in b90ee77

final JsonNode[] enumValues = def.getProperties().stream()

def.getProperties() return both fields and values...We are need of something like getValues().

[andreaTP]

Can reproduce the bug and is valid indeed.

[stale]

This issue has been automatically marked as stale because it has not had any activity since 90 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions!

[andreaTP]

this issue is not stale, the underlying bug is still valid.

[andreaTP]

ping to @iocanel on this.

[bachmanity1]

@andreaTP
is it possible to put enum field's value in the generated crd? Like in the example above, instead of this

enum:
    - A
    - B
    type: string

generate this

enum:
    - test-a
    - test-b
    type: string

I need this because I have field in CR file that has hyphens in it and I'm not able to use enums for that field because enums can't use hyphens, so I was looking for a work around.

[iocanel]

Sundrio does not treat enums differently. This means for sundrio enums are regular classes with kind == ENUM.
This means that if you want to just grab the values of the enum, you'll have to chech if kind == ENUM and then return static final fields that have the same type as the declaring class.

[andreaTP]

you'll have to chech if kind == ENUM and then return static final fields that have the same type as the declaring class.

This is only a partial solution, as it leaves space for other issues as demonstrated here.