[Java] Add support of 'x-obfuscated' property allowing for generated model classes an obfuscation of sensitive data (e.g. password) in toString() output (#2662)

bin/java-petstore-all.sh

@@ -1,19 +1,5 @@
 #!/bin/sh
 # update java petstore for all supported http libraries
 
-./bin/java-petstore-jersey1.sh
-./bin/java-petstore-jersey2.sh
-./bin/java-petstore-feign.sh
-./bin/java-petstore-okhttp-gson.sh
-./bin/java-petstore-okhttp-gson-parcelable.sh
-./bin/java-petstore-retrofit.sh
-./bin/java-petstore-retrofit2.sh
-./bin/java-petstore-retrofit2rx.sh
-./bin/java-petstore-retrofit2rx2.sh
-./bin/java8-petstore-jersey2.sh
-./bin/java-petstore-retrofit2-play24.sh
-./bin/java-petstore-jersey2-java6.sh
-./bin/java-petstore-resttemplate.sh
-./bin/java-petstore-resttemplate-withxml.sh
-./bin/java-petstore-resteasy.sh
-./bin/java-petstore-google-api-client.sh
+./bin/java-petstore-server-all.sh
+./bin/java-petstore-client-all.sh

bin/java-petstore-client-all.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+# update java petstore for all supported http client libraries
+
+./bin/java-petstore-jersey1.sh
+./bin/java-petstore-jersey2.sh
+./bin/java-petstore-feign.sh
+./bin/java-petstore-okhttp-gson.sh
+./bin/java-petstore-okhttp-gson-parcelable.sh
+./bin/java-petstore-retrofit.sh
+./bin/java-petstore-retrofit2.sh
+./bin/java-petstore-retrofit2rx.sh
+./bin/java-petstore-retrofit2rx2.sh
+./bin/java8-petstore-jersey2.sh
+./bin/java-petstore-retrofit2-play24.sh
+./bin/java-petstore-retrofit2-play25.sh
+./bin/java-petstore-jersey2-java6.sh
+./bin/java-petstore-resttemplate.sh
+./bin/java-petstore-resttemplate-withxml.sh
+./bin/java-petstore-resteasy.sh
+./bin/java-petstore-google-api-client.sh
+./bin/java-petstore-vertx.sh

bin/java-petstore-server-all.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+# update java petstore for all supported http server libraries
+
+./bin/java-inflector-petstore-server.sh
+./bin/java-msf4j-petstore-server.sh
+./bin/java-play-framework-petstore-server-all.sh
+./bin/java-undertow-petstore-server.sh
+./bin/java-vertx-async-petstore-server.sh
+./bin/java-vertx-rx-petstore-server.sh
+./bin/jaxrs-cxf-cdi-petstore-server.sh
+./bin/jaxrs-cxf-petstore-server.sh
+./bin/jaxrs-cxf-petstore-server-annotated-base-path.sh
+./bin/jaxrs-cxf-petstore-server-non-spring-application.sh
+./bin/jaxrs-jersey1-petstore-server.sh
+./bin/jaxrs-jersey1-usetags-petstore-server.sh
+./bin/jaxrs-petstore-server.sh
+./bin/jaxrs-resteasy-eap-java8-petstore-server.sh
+./bin/jaxrs-resteasy-eap-joda-petstore-server.sh
+./bin/jaxrs-resteasy-eap-petstore-server.sh
+./bin/jaxrs-resteasy-joda-petstore-server.sh
+./bin/jaxrs-resteasy-petstore-server.sh
+./bin/jaxrs-spec-petstore-server.sh
+./bin/jaxrs-spec-petstore-server-interface.sh
+./bin/jaxrs-usetags-petstore-server.sh
+./bin/spring-mvc-petstore-j8-async-server.sh
+./bin/spring-mvc-petstore-server.sh
+./bin/springboot-petstore-server.sh
+./bin/springboot-petstore-server-beanvalidation.sh
+./bin/springboot-petstore-server-implicitHeaders.sh
+./bin/springboot-petstore-server-useOptional.sh

bin/utils/maven/java-petstore-client-all-build.sh

@@ -0,0 +1,49 @@
+#!/bin/sh
+# build client projects generated by java-petstore-client-all.sh 
+# run it from swagger-codegen base directory
+
+red=`tput setaf 1`
+green=`tput setaf 2`
+reset_clr=`tput sgr0`
+
+declare -a projects=( \
+ feign \
+ google-api-client \
+ jersey1 \
+ jersey2 \
+ jersey2-java6 \
+ jersey2-java8 \
+ okhttp-gson \
+ okhttp-gson-parcelableModel \
+ resteasy \
+ resttemplate \
+ resttemplate-withXml \
+ retrofit \
+ retrofit2 \
+ retrofit2-play24 \
+ retrofit2-play25 \
+ retrofit2rx \
+ retrofit2rx2 \
+ vertx \
+)
+
+echo Build java petstore client projects..
+
+base_dir=`pwd`
+
+for i in "${projects[@]}"
+do
+  proj_dir=$base_dir/samples/client/petstore/java/$i
+  if [ -d "$proj_dir" ]; then
+    cd $proj_dir
+       mvn package > ./build.log
+    if [ $? = 0 ]; then
+      echo "  $i - ${green}SUCCEED${reset_clr}"
+    else
+      echo "  $i - ${red}FAILED${reset_clr}"
+    fi
+    mvn clean &>/dev/null
+  else 
+     echo ${red}project not found:${reset_clr} $proj_dir
+  fi
+done

bin/utils/maven/java-petstore-server-all-build.sh

@@ -0,0 +1,49 @@
+#!/bin/sh
+# build server projects generated by java-petstore-server-all.sh 
+# run it from swagger-codegen base directory
+
+red=`tput setaf 1`
+green=`tput setaf 2`
+reset_clr=`tput sgr0`
+
+declare -a projects=( \
+ java-inflector \
+ java-msf4j \
+ java-vertx/async java-vertx/rx \
+ jaxrs/jersey1 jaxrs/jersey1-useTags jaxrs/jersey2 jaxrs/jersey2-useTags \
+ jaxrs-cxf \
+ jaxrs-cxf-annotated-base-path \
+ jaxrs-cxf-cdi \
+ jaxrs-cxf-non-spring-app \
+ jaxrs-resteasy/eap jaxrs-resteasy/eap-java8 jaxrs-resteasy/eap-joda jaxrs-resteasy/joda jaxrs-resteasy/default \
+ jaxrs-spec \
+ jaxrs-spec-interface \
+ spring-mvc \
+ spring-mvc-j8-async \
+ springboot \
+ springboot-beanvalidation \
+ springboot-implicitHeaders \
+ springboot-useoptional \
+ undertow \
+)
+
+echo Build java petstore server projects..
+
+base_dir=`pwd`
+
+for i in "${projects[@]}"
+do
+  proj_dir=$base_dir/samples/server/petstore/$i
+  if [ -d "$proj_dir" ]; then
+    cd $proj_dir
+       mvn package > ./build.log
+    if [ $? = 0 ]; then
+      echo "  $i - ${green}SUCCEED${reset_clr}"
+    else
+      echo "  $i - ${red}FAILED${reset_clr}"
+    fi
+    mvn clean &>/dev/null
+  else 
+     echo ${red}project not found:${reset_clr} $proj_dir
+  fi
+done

modules/swagger-codegen/src/main/java/io/swagger/codegen/CodegenConfig.java

@@ -113,6 +113,8 @@ public interface CodegenConfig {
 
     Map<String, String> modelTestTemplateFiles();
 
+    Map<String, String> modelTestResourceTemplateFiles();
+
     Map<String, String> apiDocTemplateFiles();
 
     Map<String, String> modelDocTemplateFiles();
@@ -135,6 +137,8 @@ public interface CodegenConfig {
 
     String toApiTestFilename(String name);
 
+    String toModelTestResourceFilename(String name);
+
     String toModelTestFilename(String name);
 
     String toApiDocFilename(String name);

modules/swagger-codegen/src/main/java/io/swagger/codegen/CodegenConstants.java

@@ -4,6 +4,9 @@
  * A class for storing constants that are used throughout the project.
  */
 public class CodegenConstants {
+    public static final String TEMPLATE_EXTENSION = "mustache";
+    public static final String DOT_TEMPLATE_EXTENSION = "." + TEMPLATE_EXTENSION;
+
     public static final String APIS = "apis";
     public static final String MODELS = "models";
     public static final String SUPPORTING_FILES = "supportingFiles";

modules/swagger-codegen/src/main/java/io/swagger/codegen/DefaultCodegen.java

@@ -80,6 +80,7 @@ public class DefaultCodegen {
     protected Map<String, String> modelTemplateFiles = new HashMap<String, String>();
     protected Map<String, String> apiTestTemplateFiles = new HashMap<String, String>();
     protected Map<String, String> modelTestTemplateFiles = new HashMap<String, String>();
+    protected Map<String, String> modelTestResourceTemplateFiles = new HashMap<String, String>();
     protected Map<String, String> apiDocTemplateFiles = new HashMap<String, String>();
     protected Map<String, String> modelDocTemplateFiles = new HashMap<String, String>();
     protected Map<String, String> reservedWordsMappings = new HashMap<String, String>();
@@ -499,6 +500,10 @@ public Map<String, String> modelTestTemplateFiles() {
         return modelTestTemplateFiles;
     }
 
+    public Map<String, String> modelTestResourceTemplateFiles() {
+        return modelTestResourceTemplateFiles;
+    }
+
     public Map<String, String> apiTemplateFiles() {
         return apiTemplateFiles;
     }
@@ -665,6 +670,13 @@ public String toModelTestFilename(String name) {
         return initialCaps(name) + "Test";
     }
 
+    /**
+     * Return the name of static resource for model test
+     */
+    public String toModelTestResourceFilename(String name) {
+        return name;
+    }
+
     /**
      * Return the capitalized file name of the model documentation
      *

modules/swagger-codegen/src/main/java/io/swagger/codegen/DefaultGenerator.java

@@ -1,6 +1,7 @@
 package io.swagger.codegen;
 
 import com.samskivert.mustache.Mustache;
+import com.samskivert.mustache.MustacheException;
 import com.samskivert.mustache.Template;
 import io.swagger.codegen.ignore.CodegenIgnoreProcessor;
 import io.swagger.codegen.languages.AbstractJavaCodegen;
@@ -19,6 +20,7 @@
 
 import java.io.*;
 import java.util.*;
+import java.util.regex.Matcher;
 
 public class DefaultGenerator extends AbstractGenerator implements Generator {
     protected final Logger LOGGER = LoggerFactory.getLogger(DefaultGenerator.class);
@@ -257,6 +259,28 @@ private void generateModelTests(List<File> files, Map<String, Object> models, St
         }
     }
 
+    /**
+     * Add resource files (either java or any other type) for test model.
+     */
+    private void generateModelTestsResourceFiles(List<File> files) {
+        Map<String, String> templates = config.modelTestResourceTemplateFiles();
+        if (templates != null && !templates.isEmpty()) {
+            Map<String, Object> properties = new HashMap<>(config.additionalProperties());
+            properties.put("package", config.modelPackage());
+            for (String templateName : templates.keySet()) {
+                String suffix = templates.get(templateName);
+                String templateFile = getFullTemplateFile(config, templateName);
+                String outputFileName = config.modelTestFileFolder() + File.separator + config.toModelTestResourceFilename(templateName) + suffix;
+                outputFileName = outputFileName.replaceAll("[/|\\\\]", Matcher.quoteReplacement(File.separator));
+                try {
+                    processTemplateResourceFile(files, properties, templateFile , outputFileName);
+                } catch (Exception e) {
+                    LOGGER.error("Could not generate model test resource file: '" + templateName + "'", e);
+                }
+            }
+        }
+    }
+
     private void generateModelDocumentation(List<File> files, Map<String, Object> models, String modelName) throws IOException {
         for (String templateName : config.modelDocTemplateFiles().keySet()) {
             String suffix = config.modelDocTemplateFiles().get(templateName);
@@ -417,6 +441,11 @@ private Model getParent(Model model) {
                 throw new RuntimeException("Could not generate model '" + modelName + "'", e);
             }
         }
+
+        if (generateModelTests) {
+            generateModelTestsResourceFiles(files);
+        }
+
         if (System.getProperty("debugModels") != null) {
             LOGGER.info("############ Model info ############");
             Json.prettyPrint(allModels);
@@ -586,44 +615,7 @@ private void generateSupportingFiles(List<File> files, Map<String, Object> bundl
                 }
 
                 if (ignoreProcessor.allowsFile(new File(outputFilename))) {
-                    if (templateFile.endsWith("mustache")) {
-                        String template = readTemplate(templateFile);
-                        Mustache.Compiler compiler = Mustache.compiler();
-                        compiler = config.processCompiler(compiler);
-                        Template tmpl = compiler
-                                .withLoader(new Mustache.TemplateLoader() {
-                                    @Override
-                                    public Reader getTemplate(String name) {
-                                        return getTemplateReader(getFullTemplateFile(config, name + ".mustache"));
-                                    }
-                                })
-                                .defaultValue("")
-                                .compile(template);
-
-                        writeToFile(outputFilename, tmpl.execute(bundle));
-                        files.add(new File(outputFilename));
-                    } else {
-                        InputStream in = null;
-
-                        try {
-                            in = new FileInputStream(templateFile);
-                        } catch (Exception e) {
-                            // continue
-                        }
-                        if (in == null) {
-                            in = this.getClass().getClassLoader().getResourceAsStream(getCPResourcePath(templateFile));
-                        }
-                        File outputFile = new File(outputFilename);
-                        OutputStream out = new FileOutputStream(outputFile, false);
-                        if (in != null) {
-                            LOGGER.info("writing file " + outputFile);
-                            IOUtils.copy(in, out);
-                            out.close();
-                        } else {
-                            LOGGER.error("can't open " + templateFile + " for input");
-                        }
-                        files.add(outputFile);
-                    }
+                    processTemplateResourceFile(files, bundle, templateFile, outputFilename);
                 } else {
                     LOGGER.info("Skipped generation of " + outputFilename + " due to rule in .swagger-codegen-ignore");
                 }
@@ -679,6 +671,47 @@ public Reader getTemplate(String name) {
 
     }
 
+    private void processTemplateResourceFile(List<File> files, Map<String, Object> bundle, String templateFile, String outputFilename) throws MustacheException, IOException {
+        if (templateFile.endsWith("mustache")) {
+            String template = readTemplate(templateFile);
+            Mustache.Compiler compiler = Mustache.compiler();
+            compiler = config.processCompiler(compiler);
+            Template tmpl = compiler
+                    .withLoader(new Mustache.TemplateLoader() {
+                        @Override
+                        public Reader getTemplate(String name) {
+                            return getTemplateReader(getFullTemplateFile(config, name + ".mustache"));
+                        }
+                    })
+                    .defaultValue("")
+                    .compile(template);
+
+            writeToFile(outputFilename, tmpl.execute(bundle));
+            files.add(new File(outputFilename));
+        } else {
+            InputStream in = null;
+
+            try {
+                in = new FileInputStream(templateFile);
+            } catch (Exception e) {
+                // continue
+            }
+            if (in == null) {
+                in = this.getClass().getClassLoader().getResourceAsStream(getCPResourcePath(templateFile));
+            }
+            File outputFile = new File(outputFilename);
+            OutputStream out = new FileOutputStream(outputFile, false);
+            if (in != null) {
+                LOGGER.info("writing file " + outputFile);
+                IOUtils.copy(in, out);
+                out.close();
+            } else {
+                LOGGER.error("can't open " + templateFile + " for input");
+            }
+            files.add(outputFile);
+        }
+    }
+
     private Map<String, Object> buildSupportFileBundle(List<Object> allOperations, List<Object> allModels) {
 
         Map<String, Object> bundle = new HashMap<String, Object>();