Merge pull request #8454 from john-french/addOutputFileNameOption

frantuma · web-flow · commit 33b2e1efcba5 · 2018-07-20T11:38:32.000+02:00
add output file options for swagger codegen
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/SwaggerGenerator.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/SwaggerGenerator.java
@@ -2,7 +2,9 @@
 
 import java.io.File;
 
+import io.swagger.codegen.CliOption;
 import org.apache.commons.io.FileUtils;
+import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -17,11 +19,20 @@ public class SwaggerGenerator extends DefaultCodegen implements CodegenConfig {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(SwaggerGenerator.class);
 
+    public static final String OUTPUT_NAME = "outputFile";
+
+    public static final String SWAGGER_FILENAME_DEFAULT_JSON = "swagger.json";
+
+    protected String outputFile = SWAGGER_FILENAME_DEFAULT_JSON;
+
     public SwaggerGenerator() {
         super();
         embeddedTemplateDir = templateDir = "swagger";
         outputFolder = "generated-code/swagger";
 
+        cliOptions.add(new CliOption(OUTPUT_NAME,
+                "output filename")
+                .defaultValue(SWAGGER_FILENAME_DEFAULT_JSON));
         supportingFiles.add(new SupportingFile("README.md", "", "README.md"));
     }
 
@@ -45,14 +56,27 @@ public void processSwagger(Swagger swagger) {
         String swaggerString = Json.pretty(swagger);
 
         try {
-            String outputFile = outputFolder + File.separator + "swagger.json";
+            String outputFile = outputFolder + File.separator + this.outputFile;
             FileUtils.writeStringToFile(new File(outputFile), swaggerString);
             LOGGER.debug("wrote file to " + outputFile);
         } catch (Exception e) {
             LOGGER.error(e.getMessage(), e);
         }
     }
 
+    @Override
+    public void processOpts() {
+        super.processOpts();
+
+        if (additionalProperties.containsKey(OUTPUT_NAME) && !StringUtils.isBlank((String) additionalProperties.get(OUTPUT_NAME))) {
+            setOutputFile((String) additionalProperties.get(OUTPUT_NAME));
+        }
+    }
+
+    public void setOutputFile(String outputFile) {
+        this.outputFile = outputFile;
+    }
+
     @Override
     public String escapeQuotationMark(String input) { 
         // just return the original string
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/SwaggerYamlGenerator.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/SwaggerYamlGenerator.java
@@ -14,24 +14,31 @@
 import io.swagger.util.DeserializationModule;
 import io.swagger.util.Yaml;
 import org.apache.commons.io.FileUtils;
+import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.File;
 
 public class SwaggerYamlGenerator extends DefaultCodegen implements CodegenConfig {
-    public static final String OUTPUT_NAME = "outputFile";
 
     private static final Logger LOGGER = LoggerFactory.getLogger(SwaggerYamlGenerator.class);
 
-    protected String outputFile = "swagger.yaml";
+    public static final String OUTPUT_NAME = "outputFile";
+
+    public static final String SWAGGER_FILENAME_DEFAULT_YAML = "swagger.yaml";
+
+    protected String outputFile = SWAGGER_FILENAME_DEFAULT_YAML;
+
 
     public SwaggerYamlGenerator() {
         super();
         embeddedTemplateDir = templateDir = "swagger";
         outputFolder = "generated-code/swagger";
 
-        cliOptions.add(new CliOption(OUTPUT_NAME, "output filename"));
+        cliOptions.add(new CliOption(OUTPUT_NAME,
+                "output filename")
+                .defaultValue(SWAGGER_FILENAME_DEFAULT_YAML));
 
         supportingFiles.add(new SupportingFile("README.md", "", "README.md"));
     }
@@ -51,15 +58,19 @@ public String getHelp() {
         return "Creates a static swagger.yaml file.";
     }
 
-
     @Override
     public void processOpts() {
         super.processOpts();
-        if(additionalProperties.containsKey(OUTPUT_NAME)) {
-            this.outputFile = additionalProperties.get(OUTPUT_NAME).toString();
+
+        if (additionalProperties.containsKey(OUTPUT_NAME) && !StringUtils.isBlank((String) additionalProperties.get(OUTPUT_NAME))) {
+            setOutputFile((String) additionalProperties.get(OUTPUT_NAME));
         }
     }
 
+    public void setOutputFile(String outputFile) {
+        this.outputFile = outputFile;
+    }
+
     @Override
     public void processSwagger(Swagger swagger) {
         try {
diff --git a/modules/swagger-codegen/src/test/java/io/swagger/codegen/options/SwaggerOptionsProvider.java b/modules/swagger-codegen/src/test/java/io/swagger/codegen/options/SwaggerOptionsProvider.java
@@ -3,12 +3,14 @@
 import io.swagger.codegen.CodegenConstants;
 
 import com.google.common.collect.ImmutableMap;
+import io.swagger.codegen.languages.SwaggerGenerator;
 
 import java.util.Map;
 
 public class SwaggerOptionsProvider implements OptionsProvider {
     public static final String SORT_PARAMS_VALUE = "false";
     public static final String ENSURE_UNIQUE_PARAMS_VALUE = "true";
+    public static final String OUTPUT_NAME = "swagger.json";
     public static final String ALLOW_UNICODE_IDENTIFIERS_VALUE = "false";
 
 
@@ -22,6 +24,7 @@ public Map<String, String> createOptions() {
         ImmutableMap.Builder<String, String> builder = new ImmutableMap.Builder<String, String>();
         return builder.put(CodegenConstants.SORT_PARAMS_BY_REQUIRED_FLAG, SORT_PARAMS_VALUE)
                 .put(CodegenConstants.ENSURE_UNIQUE_PARAMS, ENSURE_UNIQUE_PARAMS_VALUE)
+                .put(SwaggerGenerator.OUTPUT_NAME, OUTPUT_NAME)
                 .put(CodegenConstants.ALLOW_UNICODE_IDENTIFIERS, ALLOW_UNICODE_IDENTIFIERS_VALUE)
                 .build();
     }
diff --git a/modules/swagger-codegen/src/test/java/io/swagger/codegen/options/SwaggerYamlOptionsProvider.java b/modules/swagger-codegen/src/test/java/io/swagger/codegen/options/SwaggerYamlOptionsProvider.java
@@ -3,12 +3,14 @@
 import io.swagger.codegen.CodegenConstants;
 
 import com.google.common.collect.ImmutableMap;
+import io.swagger.codegen.languages.SwaggerYamlGenerator;
 
 import java.util.Map;
 
 public class SwaggerYamlOptionsProvider implements OptionsProvider {
     public static final String SORT_PARAMS_VALUE = "false";
     public static final String ENSURE_UNIQUE_PARAMS_VALUE = "true";
+    public static final String OUTPUT_NAME = "swagger.yaml";
     public static final String ALLOW_UNICODE_IDENTIFIERS_VALUE = "false";
 
     @Override
@@ -21,7 +23,7 @@ public Map<String, String> createOptions() {
         ImmutableMap.Builder<String, String> builder = new ImmutableMap.Builder<String, String>();
         return builder.put(CodegenConstants.SORT_PARAMS_BY_REQUIRED_FLAG, SORT_PARAMS_VALUE)
                 .put(CodegenConstants.ENSURE_UNIQUE_PARAMS, ENSURE_UNIQUE_PARAMS_VALUE)
-                .put("outputFile", "swagger.yaml")
+                .put(SwaggerYamlGenerator.OUTPUT_NAME, OUTPUT_NAME)
                 .put(CodegenConstants.ALLOW_UNICODE_IDENTIFIERS, ALLOW_UNICODE_IDENTIFIERS_VALUE)
                 .build();
     }
diff --git a/modules/swagger-codegen/src/test/java/io/swagger/codegen/swagger/SwaggerOptionsTest.java b/modules/swagger-codegen/src/test/java/io/swagger/codegen/swagger/SwaggerOptionsTest.java
@@ -28,6 +28,8 @@ protected void setExpectations() {
         new Expectations(clientCodegen) {{
             clientCodegen.setSortParamsByRequiredFlag(Boolean.valueOf(SwaggerOptionsProvider.SORT_PARAMS_VALUE));
             times = 1;
+            clientCodegen.setOutputFile(SwaggerOptionsProvider.OUTPUT_NAME);
+            times = 1;
         }};
     }
 }
diff --git a/modules/swagger-codegen/src/test/java/io/swagger/codegen/swaggeryaml/SwaggerYamlOptionsTest.java b/modules/swagger-codegen/src/test/java/io/swagger/codegen/swaggeryaml/SwaggerYamlOptionsTest.java
@@ -28,6 +28,8 @@ protected void setExpectations() {
         new Expectations(clientCodegen) {{
             clientCodegen.setSortParamsByRequiredFlag(Boolean.valueOf(SwaggerYamlOptionsProvider.SORT_PARAMS_VALUE));
             times = 1;
+            clientCodegen.setOutputFile(SwaggerYamlOptionsProvider.OUTPUT_NAME);
+            times = 1;
         }};
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,8 @@ protected void setExpectations() {`
`28`	`28`	`new Expectations(clientCodegen) {{`
`29`	`29`	`clientCodegen.setSortParamsByRequiredFlag(Boolean.valueOf(SwaggerOptionsProvider.SORT_PARAMS_VALUE));`
`30`	`30`	`times = 1;`
	`31`	`+ clientCodegen.setOutputFile(SwaggerOptionsProvider.OUTPUT_NAME);`
	`32`	`+ times = 1;`
`31`	`33`	`}};`
`32`	`34`	`}`
`33`	`35`	`}`