Merge pull request #2 from swagger-api/master

updatingSelf

Author: Frozenstep

README.md

@@ -229,6 +229,8 @@ docker run --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli generate \
     -o /local/out/go
 ```
 
+(On Windows replace `${PWD}` with `%CD%`)
+
 The generated code will be located under `./out/go` in the current directory.
 
 ## Getting Started

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

@@ -18,7 +18,7 @@ public class CodegenOperation {
             isResponseBinary = false, isResponseFile = false, hasReference = false,
             isRestfulIndex, isRestfulShow, isRestfulCreate, isRestfulUpdate, isRestfulDestroy,
             isRestful, isDeprecated;
-    public String path, operationId, returnType, httpMethod, returnBaseType,
+    public String path, testPath, operationId, returnType, httpMethod, returnBaseType,
             returnContainer, summary, unescapedNotes, notes, baseName, defaultResponse, discriminator;
     public List<Map<String, String>> consumes, produces, prioritizedContentTypes;
     public CodegenParameter bodyParam;

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

@@ -13,6 +13,7 @@ public class CodegenParameter {
           collectionFormat, description, unescapedDescription, baseType, defaultValue, enumName;
 
     public String example; // example value (x-example)
+    public String testExample;
     public String jsonSchema;
     public boolean isString, isNumeric, isInteger, isLong, isNumber, isFloat, isDouble, isByteArray, isBinary, isBoolean, isDate, isDateTime, isUuid;
     public boolean isListContainer, isMapContainer;
@@ -116,6 +117,7 @@ public CodegenParameter copy() {
         output.jsonSchema = this.jsonSchema;
         output.defaultValue = this.defaultValue;
         output.example = this.example;
+        output.testExample = this.testExample;
         output.isEnum = this.isEnum;
         if (this._enum != null) {
             output._enum = new ArrayList<String>(this._enum);

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

@@ -2332,6 +2332,8 @@ public int compare(CodegenParameter one, CodegenParameter another) {
         op.isRestfulDestroy = op.isRestfulDestroy();
         op.isRestful = op.isRestful();
 
+        configureDataForTestTemplate(op);
+
         return op;
     }
 
@@ -3846,4 +3848,54 @@ protected void addSwitch(String key, String description, Boolean defaultValue) {
             option.defaultValue(defaultValue.toString());
         cliOptions.add(option);
     }
+
+    protected void configureDataForTestTemplate(CodegenOperation codegenOperation) {
+        final String httpMethod = codegenOperation.httpMethod;
+        String path = codegenOperation.path;
+        if ("GET".equalsIgnoreCase(httpMethod)) {
+            codegenOperation.vendorExtensions.put("x-is-get-method", Boolean.TRUE);
+        }
+        if ("POST".equalsIgnoreCase(httpMethod)) {
+            codegenOperation.vendorExtensions.put("x-is-post-method", Boolean.TRUE);
+        }
+        if ("PUT".equalsIgnoreCase(httpMethod)) {
+            codegenOperation.vendorExtensions.put("x-is-put-method", Boolean.TRUE);
+        }
+        if ("DELETE".equalsIgnoreCase(httpMethod)) {
+            codegenOperation.vendorExtensions.put("x-is-delete-method", Boolean.TRUE);
+        }
+        if ("HEAD".equalsIgnoreCase(httpMethod)) {
+            codegenOperation.vendorExtensions.put("x-is-head-method", Boolean.TRUE);
+        }
+        if ("TRACE".equalsIgnoreCase(httpMethod)) {
+            codegenOperation.vendorExtensions.put("x-is-trace-method", Boolean.TRUE);
+        }
+        if ("PATCH".equalsIgnoreCase(httpMethod)) {
+            codegenOperation.vendorExtensions.put("x-is-head-method", Boolean.TRUE);
+        }
+        if ("OPTIONS".equalsIgnoreCase(httpMethod)) {
+            codegenOperation.vendorExtensions.put("x-is-options-method", Boolean.TRUE);
+        }
+        if (path.contains("{")) {
+            while(path.contains("{")) {
+                final String pathParam = path.substring(path.indexOf("{"), path.indexOf("}") + 1);
+                final String paramName = pathParam.replace("{", StringUtils.EMPTY).replace("}", StringUtils.EMPTY);
+
+                CodegenParameter codegenParameter = null;
+
+                for (CodegenParameter parameter : codegenOperation.pathParams) {
+                    if (parameter.baseName.equalsIgnoreCase(paramName)) {
+                        codegenParameter = parameter;
+                        break;
+                    }
+                }
+
+                if (codegenParameter == null || codegenParameter.testExample == null) {
+                    return;
+                }
+                path = path.replace(pathParam, codegenParameter.testExample);
+            }
+        }
+        codegenOperation.testPath = path;
+    }
 }

modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractJavaCodegen.java

@@ -779,6 +779,7 @@ public void setParameterExampleValue(CodegenParameter p) {
             if (example == null) {
                 example = p.paramName + "_example";
             }
+            p.testExample = example;
             example = "\"" + escapeText(example) + "\"";
         } else if ("Integer".equals(type) || "Short".equals(type)) {
             if (example == null) {
@@ -788,15 +789,18 @@ public void setParameterExampleValue(CodegenParameter p) {
             if (example == null) {
                 example = "56";
             }
+            p.testExample = example;
             example = example + "L";
         } else if ("Float".equals(type)) {
             if (example == null) {
                 example = "3.4";
             }
+            p.testExample = example;
             example = example + "F";
         } else if ("Double".equals(type)) {
             example = "3.4";
             example = example + "D";
+            p.testExample = example;
         } else if ("Boolean".equals(type)) {
             if (example == null) {
                 example = "true";
@@ -813,6 +817,10 @@ public void setParameterExampleValue(CodegenParameter p) {
             example = "new " + type + "()";
         }
 
+        if (p.testExample == null) {
+            p.testExample = example;
+        }
+
         if (example == null) {
             example = "null";
         } else if (Boolean.TRUE.equals(p.isListContainer)) {

modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/SpringCodegen.java

@@ -53,7 +53,6 @@ public class SpringCodegen extends AbstractJavaCodegen
     public SpringCodegen() {
         super();
         outputFolder = "generated-code/javaSpring";
-        apiTestTemplateFiles.clear(); // TODO: add test template
         embeddedTemplateDir = templateDir = "JavaSpring";
         apiPackage = "io.swagger.api";
         modelPackage = "io.swagger.model";
@@ -254,6 +253,7 @@ public void processOpts() {
                     additionalProperties.put(SINGLE_CONTENT_TYPES, "true");
                     this.setSingleContentTypes(true);
                 }
+                apiTestTemplateFiles.clear();
             } else {
                 apiTemplateFiles.put("apiController.mustache", "Controller.java");
                 supportingFiles.add(new SupportingFile("apiException.mustache",
@@ -557,6 +557,14 @@ public String toApiName(String name) {
         return camelize(name) + "Api";
     }
 
+    @Override
+    public String toApiTestFilename(String name) {
+        if(library.equals(SPRING_MVC_LIBRARY)) {
+            return toApiName(name) + "ControllerIT";
+        }
+        return toApiName(name) + "ControllerIntegrationTest";
+    }
+
     @Override
     public void setParameterExampleValue(CodegenParameter p) {
         String type = p.baseType;

modules/swagger-codegen/src/main/resources/JavaSpring/libraries/spring-boot/api_test.mustache

@@ -0,0 +1,38 @@
+package {{package}};
+{{#imports}}import {{import}};
+{{/imports}}
+import java.util.*;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.junit4.SpringRunner;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+
+import static org.junit.Assert.assertEquals;
+
+@RunWith(SpringRunner.class)
+@SpringBootTest
+public class {{classname}}ControllerIntegrationTest {
+@Autowired
+private {{classname}} api;
+{{#operations}}
+    {{#operation}}
+        @Test
+        public void {{operationId}}Test() throws Exception {
+        {{#allParams}}
+        {{^isFile}}
+            {{{dataType}}} {{paramName}} = {{{example}}};
+        {{/isFile}}
+        {{#isFile}}
+            org.springframework.web.multipart.MultipartFile {{paramName}} = null;
+        {{/isFile}}
+        {{/allParams}}
+            ResponseEntity<{{>returnTypes}}> responseEntity = api.{{operationId}}({{#allParams}}{{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}});
+            assertEquals(HttpStatus.NOT_IMPLEMENTED, responseEntity.getStatusCode());
+        }
+    {{/operation}}
+{{/operations}}
+}

modules/swagger-codegen/src/main/resources/JavaSpring/libraries/spring-boot/pom.mustache

@@ -91,6 +91,11 @@
             <groupId>javax.validation</groupId>
             <artifactId>validation-api</artifactId>
         </dependency>
-{{/useBeanValidation}}        
+{{/useBeanValidation}}
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>

modules/swagger-codegen/src/main/resources/JavaSpring/libraries/spring-mvc/api_test.mustache

@@ -0,0 +1,29 @@
+package {{package}};
+{{#imports}}import {{import}};
+{{/imports}}
+import java.util.*;
+import org.apache.http.HttpResponse;
+import org.apache.http.client.HttpClient;
+import org.apache.http.client.methods.HttpGet;
+import org.apache.http.impl.client.HttpClientBuilder;
+import org.testng.annotations.Test;
+import static org.junit.Assert.assertEquals;
+/**
+* Test class to verify that GET endpoints on generated project are reached.
+*/
+public class {{classname}}ControllerIT {
+
+    {{#operations}}
+    {{#operation}}
+    {{#vendorExtensions.x-is-get-method}}
+    @Test
+        public void {{operationId}}Test() throws Exception {
+            final String requestURL = "http://localhost:8002{{^contextPath}}/{{/contextPath}}{{#contextPath}}{{contextPath}}{{/contextPath}}{{testPath}}{{#hasQueryParams}}?{{/hasQueryParams}}{{#queryParams}}{{paramName}}={{testExample}}{{#hasMore}}&{{/hasMore}}{{/queryParams}}";
+            final HttpClient client = HttpClientBuilder.create().build();
+            final HttpResponse response = client.execute(new HttpGet(requestURL));
+            assertEquals(response.getStatusLine().getStatusCode(), 501);
+        }
+    {{/vendorExtensions.x-is-get-method}}
+    {{/operation}}
+    {{/operations}}
+}

modules/swagger-codegen/src/main/resources/JavaSpring/libraries/spring-mvc/pom.mustache

@@ -160,7 +160,33 @@
         <version>1.1.0.Final</version>
         <scope>provided</scope>
     </dependency>
-{{/useBeanValidation}}        
+{{/useBeanValidation}}
+    <dependency>
+        <groupId>org.testng</groupId>
+        <artifactId>testng</artifactId>
+        <version>6.8.8</version>
+        <scope>test</scope>
+        <exclusions>
+            <exclusion>
+                <artifactId>junit</artifactId>
+                <groupId>junit</groupId>
+            </exclusion>
+            <exclusion>
+                <artifactId>snakeyaml</artifactId>
+                <groupId>org.yaml</groupId>
+            </exclusion>
+            <exclusion>
+                <artifactId>bsh</artifactId>
+                <groupId>org.beanshell</groupId>
+            </exclusion>
+        </exclusions>
+    </dependency>
+    <dependency>
+        <groupId>org.apache.httpcomponents</groupId>
+        <artifactId>httpclient</artifactId>
+        <version>4.5.2</version>
+        <scope>test</scope>
+    </dependency>
     </dependencies>
     <properties>
         <java.version>{{#java8}}1.8{{/java8}}{{^java8}}1.7{{/java8}}</java.version>