[JAXRS-CXF] Invalid generation for reusable Enum definition

[DarrenC]

Description

When using enums defined outside of objects (so they can be reusable in multiple objects), the jaxrs-cxf codegen is not generating valid class files.
The same enum definition works correctly when defined within another object or when generating with other server stub types such as jaxrs or spring boot for example.

Swagger-codegen version

Latest - 2.2.2-SNAPSHOT

Swagger declaration file content or url

The swagger spec I'm using is based on the petstore example at - http://petstore.swagger.io/v2/swagger.json

I've added the statusExternal property with a $ref to the enum definition

definitions:
  Order:
    type: "object"
    properties:
      ...
      status:
        type: "string"
        description: "Order Status"
        enum:
        - "placed"
        - "approved"
        - "delivered"
      statusExternal:
        $ref: '#/definitions/StatusExt'  
...
  StatusExt:
        type: "string"
        enum:
        - "placed"
        - "approved"
        - "delivered"

The JaxRS-CXF generation correctly creates the status enum within the Order.java file but the StatusExt.java file is junk

Here's the Order class showing a valid StatusEnum

@XmlRootElement(name="Order")
public class Order  {

@XmlType(name="StatusEnum")
@XmlEnum(String.class)
public enum StatusEnum {

    @XmlEnumValue("placed") PLACED(String.valueOf("placed")), @XmlEnumValue("approved") APPROVED(String.valueOf("approved")), @XmlEnumValue("delivered") DELIVERED(String.valueOf("delivered"));

    private String value;

    StatusEnum (String v) {
        value = v;
    }

    public String value() {
        return value;
    }

    @Override
    public String toString() {
        return String.valueOf(value);
    }

    public static StatusEnum fromValue(String v) {
        for (StatusEnum b : StatusEnum.values()) {
            if (String.valueOf(b.value).equals(v)) {
                return b;
            }
        }
        return null;
    }
}


  @XmlElement(name="status")
  @ApiModelProperty(example = "null", value = "Order Status")
  private StatusEnum status = null;

  @XmlElement(name="statusExternal")
  @ApiModelProperty(example = "null", value = "")
  private StatusExt statusExternal = null;
...

And here's the StatusExt class which is missing the type name for the enum and the String type in various places

package io.swagger.model;

@XmlType(name="")
@XmlEnum(.class)
public enum  {

    @XmlEnumValue("placed") PLACED(.valueOf("placed")), @XmlEnumValue("approved") APPROVED(.valueOf("approved")), @XmlEnumValue("delivered") DELIVERED(.valueOf("delivered"));


    private  value;

     ( v) {
        value = v;
    }

    public String value() {
        return value;
    }

    @Override
    public String toString() {
        return String.valueOf(value);
    }

    public static  fromValue(String v) {
        for (StatusExt b : StatusExt.values()) {
            if (String.valueOf(b.value).equals(v)) {
                return b;
            }
        }
        return null;
    }
}

If some other server generator is used such as Spring-boot, the StatusExt class is generated correctly

/**
 * Gets or Sets StatusExt
 */
public enum StatusExt {
  
  PLACED("placed"),
  
  APPROVED("approved"),
  
  DELIVERED("delivered");

  private String value;

  StatusExt(String value) {
    this.value = value;
  }

  @Override
  @JsonValue
  public String toString() {
    return String.valueOf(value);
  }

  @JsonCreator
  public static StatusExt fromValue(String text) {
    for (StatusExt b : StatusExt.values()) {
      if (String.valueOf(b.value).equals(text)) {
        return b;
      }
    }
    return null;
  }
}

Command line used for generation

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate   \
-i testspec/swagger.yaml   \
-l jaxrs-cxf  \
-o testsamples/server/petstore/java-jaxrs-cxf

Steps to reproduce

• Modify the petstore 2.0 sample yaml file to include a reusable enum definition
• Launch the generation of a server stub for JAXRS-CXF using the command line above
• Check the \src\gen\java\io\swagger\model\StatusExt.java file
• See that it is not a valid java class declaration and that the enum declarations are missing the "String" type.

Related issues

There have been some fixes around the JAXRS-CXF enum generation recently but seem to deal just with the enums defined within another object definition.

Suggest a Fix

The issue comes from the JAX-RS CXF mustache template for generating the enum. It would seem to be missing some of the extra code in the same template in other languages for handling both cases.
(https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/enumClass.mustache)

There is no variable for the classname when compared to the SpringBoot or JAX-RS templates for the enum generation. The datatypeWithEnum value is not set when running the code-gen for an reusable enum definition and so the resulting enum class is not valid.

CXF enumClass.mustache

public enum {{datatypeWithEnum}} {

JAX-RS enumClass.mustache

public enum {{#datatypeWithEnum}}{{{.}}}{{/datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} {

Can someone confirm that my analysis above is correct and is it okay for me to work on a possible pull request with a fix?

Cheers
Darren

[jfiala]

@DarrenC I fixed this with PR #4164 as I was already working at cxf, the enumOuterClass.mustache + reference to it in model.mustache was missing. I re-generated using the modified petstore with the external enum as you described.

You can re-generate with all CLI-flags on and get a running Spring-Boot app with swagger-ui shipped in it ready for usage.

@wing328: shall I commit the modified petstore with external enum to a new file like petstore-enum.yaml as I found no other samples for this?

[wing328]

@jfiala I would suggest updating https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml with the additional test cases instead of creating another YAML file to cover more test cases.

[jfiala]

@wing328 I added the test case and the generated code looks good regarding the outerEnum.

Contract file:

Enum_Test:
...
      outerEnum:
        type: string
        $ref: '#/definitions/OuterEnum'
...
  OuterEnum:
    type: "string"
    enum:
    - "placed"
    - "approved"
    - "delivered"

EnumTest.java:

  @ApiModelProperty(example = "null", value = "")
  private OuterEnum outerEnum = null;

OuterEnum.java:

public enum OuterEnum {

  PLACED("placed"),

  APPROVED("approved"),

  DELIVERED("delivered");

  private String value;

  OuterEnum(String value) {
    this.value = value;
  }
...

However there are problems with other characters, but I'd rather fix them in a separate issue to keep this one scoped.

[jfiala]

@DarrenC can you pls take a look at my forked repo https://github.com/jfiala/swagger-codegen/tree/cxf_refine, branch cxf_refine if you have time and confirm if it is working for you (of course you can pick the relevant changes to enumOuterClass + model.mustache)?

[DarrenC]

Hi @jfiala ,
Apologies for completing forgetting to report back to you.
I've been using your code and it does indeed work for me now.
Thank you very much for your excellent work and thanks to the community for the reactivity!

@wing328 - should I now close out this issue?

[wing328]

@DarrenC yup, let's close this for the time being.

(If your company is using Swagger Codegen, please consider adding your company name to this list)