Extending BoatSpringCodeGen to use existing code and updated test class

Author: RanjeethKbb

boat-scaffold/src/main/java/com/backbase/oss/codegen/java/BoatWebhooksCodeGen.java

@@ -1,39 +1,19 @@
 package com.backbase.oss.codegen.java;
 
 import io.swagger.v3.oas.models.Operation;
-import io.swagger.v3.oas.models.media.Schema;
-import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.servers.Server;
-import lombok.Getter;
-import lombok.Setter;
 import lombok.extern.slf4j.Slf4j;
-import org.openapitools.codegen.CodegenConstants;
-import org.openapitools.codegen.CodegenModel;
-import org.openapitools.codegen.CodegenOperation;
-import org.openapitools.codegen.CodegenParameter;
-import org.openapitools.codegen.CodegenProperty;
 import org.openapitools.codegen.CliOption;
+import org.openapitools.codegen.CodegenOperation;
 import org.openapitools.codegen.SupportingFile;
-import org.openapitools.codegen.config.GlobalSettings;
-import org.openapitools.codegen.languages.SpringCodegen;
-import org.openapitools.codegen.templating.mustache.IndentedLambda;
-import org.openapitools.codegen.utils.ModelUtils;
 
 import java.io.File;
-import java.util.LinkedHashMap;
 import java.util.List;
-import java.util.Locale;
-import java.util.Set;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-import java.util.stream.Stream;
 
-import static com.backbase.oss.codegen.java.BoatCodeGenUtils.getCollectionCodegenValue;
-import static org.apache.commons.lang3.StringUtils.isEmpty;
 import static org.openapitools.codegen.utils.StringUtils.camelize;
 
 @Slf4j
-public class BoatWebhooksCodeGen extends SpringCodegen {
+public class BoatWebhooksCodeGen extends BoatSpringCodeGen {
     public static final String NAME = "boat-webhooks";
 
     public static final String USE_CLASS_LEVEL_BEAN_VALIDATION = "useClassLevelBeanValidation";
@@ -46,46 +26,6 @@ public class BoatWebhooksCodeGen extends SpringCodegen {
     public static final String JAVA_EXTENSION =".java";
 
 
-    /**
-     * Add @Validated to class-level Api interfaces. Defaults to false
-     */
-    @Setter
-    @Getter
-    protected boolean useClassLevelBeanValidation;
-
-    /**
-     * Adds a HttpServletRequest object to the API definition method.
-     */
-    @Setter
-    @Getter
-    protected boolean addServletRequest;
-
-    /**
-     * Adds BindingResult to API interface method if @validate is used
-     */
-    @Setter
-    @Getter
-    protected boolean addBindingResult;
-
-    /**
-     * Add Lombok to class-level Api models. Defaults to false
-     */
-    @Setter
-    @Getter
-    protected boolean useLombokAnnotations;
-
-
-    /**
-     * Whether to use {@code with} prefix for pojos modifiers.
-     */
-    @Setter
-    @Getter
-    protected boolean useWithModifiers;
-
-    @Setter
-    @Getter
-    protected boolean useProtectedFields;
-
     public BoatWebhooksCodeGen() {
         super();
         log.info("BoatWebhooksCodeGen constructor called. NAME: {}", NAME);
@@ -130,27 +70,6 @@ public String toApiName(String name) {
     public void processOpts() {
         super.processOpts();
         log.info("BoatWebhooksCodeGen processOpts called. Adding supporting files and properties.");
-
-        // Whether it's using ApiUtil or not.
-        // cases:
-        // <supportingFilesToGenerate>ApiUtil.java present or not</supportingFilesToGenerate>
-        // <generateSupportingFiles>true or false</generateSupportingFiles>
-        final String supFiles = GlobalSettings.getProperty(CodegenConstants.SUPPORTING_FILES);
-        final boolean useApiUtil = supFiles != null && (supFiles.isEmpty()
-                ? needApiUtil() // set to empty by <generateSuportingFiles>true</generateSuportingFiles>
-                : supFiles.contains("ApiUtil.java")); // set by <supportingFilesToGenerate/>
-
-        if (!useApiUtil) {
-            this.supportingFiles
-                    .removeIf(sf -> "apiUtil.mustache".equals(sf.getTemplateFile()));
-        }
-        writePropertyBack("useApiUtil", useApiUtil);
-        final var serializerTemplate = "BigDecimalCustomSerializer";
-        this.supportingFiles.add(new SupportingFile(
-                serializerTemplate + MUSTACHE_EXTENSION,
-                (sourceFolder + File.separator + modelPackage).replace(".", File.separator),
-                serializerTemplate + JAVA_EXTENSION
-        ));
         final var webhookResponseTemplate = "WebhookResponse";
         this.supportingFiles.add(new SupportingFile(webhookResponseTemplate + MUSTACHE_EXTENSION,
                 (sourceFolder + File.separator + modelPackage).replace(".", File.separator),
@@ -167,153 +86,16 @@ public void processOpts() {
         this.supportingFiles.add(new SupportingFile(prehookRequestTemplate + MUSTACHE_EXTENSION,
                 (sourceFolder + File.separator + modelPackage).replace(".", File.separator),
                 prehookRequestTemplate + JAVA_EXTENSION));
-        this.additionalProperties.put("indent4", new IndentedLambda(4, " ", true, true));
-        this.additionalProperties.put("newLine4", new BoatSpringCodeGen.NewLineIndent(4, " "));
-        this.additionalProperties.put("indent8", new IndentedLambda(8, " ", true, true));
-        this.additionalProperties.put("newLine8", new BoatSpringCodeGen.NewLineIndent(8, " "));
-        this.additionalProperties.put("toOneLine", new BoatSpringCodeGen.FormatToOneLine());
-        this.additionalProperties.put("trimAndIndent4", new BoatSpringCodeGen.TrimAndIndent(4, " "));
-    }
-
-    private boolean needApiUtil() {
-        return this.apiTemplateFiles.containsKey("api.mustache")
-                && this.apiTemplateFiles.containsKey("apiDelegate.mustache");
     }
 
-    /*
-     * Overridden to be able to override the private <code>replaceBeanValidationCollectionType</code> method.
-     */
-    @Override
-    public CodegenParameter fromParameter(Parameter parameter, Set<String> imports) {
-        CodegenParameter codegenParameter = super.fromParameter(parameter, imports);
-        if (!isListOrSet(codegenParameter)) {
-            return new BoatSpringCodegenParameter(codegenParameter);
-        } else {
-            codegenParameter.datatypeWithEnum = replaceBeanValidationCollectionType(codegenParameter.items, codegenParameter.datatypeWithEnum);
-            codegenParameter.dataType = replaceBeanValidationCollectionType(codegenParameter.items, codegenParameter.dataType);
-            return new BoatSpringCodegenParameter(codegenParameter);
-        }
-    }
 
-    /*
-     * Overridden to be able to override the private <code>replaceBeanValidationCollectionType</code> method.
-     */
-    @Override
-    public CodegenProperty fromProperty(String name, Schema p, boolean required, boolean schemaIsFromAdditionalProperties) {
-        CodegenProperty codegenProperty = super.fromProperty(name, p, required, schemaIsFromAdditionalProperties);
-        if (!isListOrSet(codegenProperty)) {
-            return new BoatSpringCodegenProperty(codegenProperty);
-        } else {
-            codegenProperty.datatypeWithEnum = replaceBeanValidationCollectionType(codegenProperty.items, codegenProperty.datatypeWithEnum);
-            codegenProperty.dataType = replaceBeanValidationCollectionType(codegenProperty.items, codegenProperty.dataType);
-            return new BoatSpringCodegenProperty(codegenProperty);
-        }
-    }
-
-    /**
-     * "overridden" to fix invalid code when the data type is a collection of a fully qualified classname.
-     * eg. <code>Set<@Valid com.backbase.dbs.arrangement.commons.model.TranslationItemDto></code>
-     *
-     * @param codegenProperty
-     * @param dataType
-     * @return
-     */
-    String replaceBeanValidationCollectionType(CodegenProperty codegenProperty, String dataType) {
-        if (!useBeanValidation || isEmpty(dataType) || !codegenProperty.isModel || isResponseType(codegenProperty)) {
-            return dataType;
-        }
-        String result = dataType;
-        if (!dataType.contains("@Valid")) {
-            result = dataType.replace("<", "<@Valid ");
-        }
-        // Use a safer regex to avoid catastrophic backtracking
-        Matcher m = Pattern.compile("^([^<]+<)(@Valid) ([a-z\\.]+)([A-Z].*)(>)$").matcher(dataType);
-        if (m.matches()) {
-            // Set<@Valid com.backbase.dbs.arrangement.commons.model.TranslationItemDto>
-            result = m.group(1) + m.group(3) + m.group(2) + " " + m.group(4) + m.group(5);
-        }
-        return result;
-    }
-
-    // Copied, but not modified
-    private static boolean isListOrSet(CodegenProperty codegenProperty) {
-        return codegenProperty.isContainer && !codegenProperty.isMap;
-    }
-
-    // Copied, but not modified
-    private static boolean isListOrSet(CodegenParameter codegenParameter) {
-        return codegenParameter.isContainer && !codegenParameter.isMap;
-    }
-
-    // Copied, but not modified
-    private static boolean isResponseType(CodegenProperty codegenProperty) {
-        return codegenProperty.baseName.toLowerCase(Locale.ROOT).contains("response");
-    }
-
-    /**
-     This method has been overridden in order to add a parameter to codegen operation for adding HttpServletRequest to
-     the service interface. There is a relevant httpServletParam.mustache file.
-     */
     @Override
     public CodegenOperation fromOperation(String path, String httpMethod, Operation operation, List<Server> servers) {
-        if (operation.getExtensions() == null) {
-            operation.setExtensions(new LinkedHashMap<>());
-        }
-        final CodegenOperation codegenOperation = super.fromOperation(path, httpMethod, operation, servers);
+        CodegenOperation codegenOperation = super.fromOperation(path, httpMethod, operation, servers);
         // Remove the standard body parameter (if it exists) ---
         // This prevents the generator's default logic from inserting its own request body.
         codegenOperation.allParams.removeIf(p -> p.isBodyParam);
-        if (this.addServletRequest) {
-            final CodegenParameter codegenParameter = new CodegenParameter();
-            codegenParameter.paramName = "httpServletRequest";
-            codegenOperation.allParams.add(codegenParameter);
-        }
-        if (codegenOperation.returnType != null) {
-            codegenOperation.returnType = codegenOperation.returnType.replace("@Valid", "");
-        }
         return codegenOperation;
     }
 
-    @Override
-    public String toDefaultValue(CodegenProperty cp, Schema schema) {
-        final Schema referencedSchema = ModelUtils.getReferencedSchema(this.openAPI, schema);
-        return getCollectionCodegenValue(cp, referencedSchema, containerDefaultToNull, instantiationTypes())
-                .map(BoatCodeGenUtils.CodegenValueType::getValue)
-                .orElseGet(() -> super.toDefaultValue(cp, referencedSchema));
-    }
-
-    @Override
-    public void postProcessModelProperty(CodegenModel model, CodegenProperty property) {
-
-        super.postProcessModelProperty(model, property);
-
-        if (shouldSerializeBigDecimalAsString(property)) {
-            property.vendorExtensions.put("x-extra-annotation", "@JsonSerialize(using = BigDecimalCustomSerializer.class)");
-            model.imports.add("BigDecimalCustomSerializer");
-            model.imports.add("JsonSerialize");
-        }
-    }
-
-    private boolean shouldSerializeBigDecimalAsString(CodegenProperty property) {
-        return (serializeBigDecimalAsString && ("decimal".equalsIgnoreCase(property.baseType) || "bigdecimal".equalsIgnoreCase(property.baseType)))
-                || (isApiStringFormattedAsNumber(property) && !isDataTypeString(property));
-    }
-
-    private boolean isApiStringFormattedAsNumber(CodegenProperty property) {
-        return "string".equalsIgnoreCase(property.openApiType) && "number".equalsIgnoreCase(property.dataFormat);
-    }
-
-    private boolean isDataTypeString(CodegenProperty property) {
-        return Stream.of(property.baseType, property.dataType, property.datatypeWithEnum)
-                .anyMatch("string"::equalsIgnoreCase);
-    }
-
-    @Override
-    public void postProcessParameter(CodegenParameter p) {
-        super.postProcessParameter(p);
-        if (p.isContainer && !this.reactive) {
-            p.baseType = p.dataType.replaceAll("^([^<]+)<.+>$", "$1");
-        }
-    }
-
 }