Merge pull request #661 from johnteske/ts-fetch-tests

[typescript-fetch] Add api test generation support

Author: HugoMario

src/main/java/io/swagger/codegen/v3/generators/typescript/TypeScriptFetchClientCodegen.java

@@ -5,7 +5,9 @@
 import java.util.Date;
 
 import io.swagger.codegen.v3.CliOption;
+import io.swagger.codegen.v3.CodegenConstants;
 import io.swagger.codegen.v3.CodegenModel;
+import io.swagger.codegen.v3.CodegenParameter;
 import io.swagger.codegen.v3.SupportingFile;
 import io.swagger.v3.oas.models.media.ArraySchema;
 import io.swagger.v3.oas.models.media.BinarySchema;
@@ -76,6 +78,7 @@ public void processOpts() {
 
         supportingFiles.add(new SupportingFile("index.mustache", "", "index.ts"));
         supportingFiles.add(new SupportingFile("api.mustache", "", "api.ts"));
+        supportingFiles.add(new SupportingFile("api_test.mustache", "", "api_test.spec.ts"));
         supportingFiles.add(new SupportingFile("configuration.mustache", "", "configuration.ts"));
         supportingFiles.add(new SupportingFile("custom.d.mustache", "", "custom.d.ts"));
         supportingFiles.add(new SupportingFile("git_push.sh.mustache", "", "git_push.sh"));
@@ -143,6 +146,15 @@ private boolean isLanguageGenericType(String type) {
         return false;
     }
 
+    @Override
+    public void postProcessParameter(CodegenParameter parameter) {
+        super.postProcessParameter(parameter);
+
+        String type = applyLocalTypeMapping(parameter.dataType);
+        parameter.dataType = type;
+        parameter.getVendorExtensions().put(CodegenConstants.IS_PRIMITIVE_TYPE_EXT_NAME, isLanguagePrimitive(type));
+    }
+
     private void addNpmPackageGeneration() {
         if (additionalProperties.containsKey(NPM_NAME)) {
             this.setNpmName(additionalProperties.get(NPM_NAME).toString());

src/main/resources/handlebars/typescript-fetch/api_test.mustache

@@ -0,0 +1,29 @@
+{{>licenseInfo}}
+
+import * as api from "./api"
+import { Configuration } from "./configuration"
+
+const config: Configuration = {}
+
+{{#apiInfo}}
+{{#apis}}
+{{#operations}}
+describe("{{classname}}", () => {
+  let instance: api.{{classname}}
+  beforeEach(function() {
+    instance = new api.{{classname}}(config)
+  });
+
+{{#operation}}
+  test("{{operationId}}", () => {
+    {{#allParams}}
+    const {{{paramName}}}: {{^isPrimitiveType}}api.{{/isPrimitiveType}}{{{dataType}}} = {{>api_test_default_value}}
+    {{/allParams}}
+    return expect(instance.{{operationId}}({{#allParams}}{{{paramName}}}, {{/allParams}}{})).resolves.toBe(null)
+  })
+{{/operation}}
+})
+
+{{/operations}}
+{{/apis}}
+{{/apiInfo}}

src/main/resources/handlebars/typescript-fetch/api_test_default_value.mustache

@@ -0,0 +1 @@
+{{#example}}{{#isString}}"{{{example}}}"{{/isString}}{{^isString}}{{#isUuid}}"{{{example}}}"{{/isUuid}}{{^isUuid}}{{{example}}}{{/isUuid}}{{/isString}}{{/example}}{{^example}}undefined{{/example}}

src/main/resources/handlebars/typescript-fetch/licenseInfo.mustache

@@ -5,7 +5,7 @@
  * {{#version}}OpenAPI spec version: {{{version}}}{{/version}}
  * {{#infoEmail}}Contact: {{{infoEmail}}}{{/infoEmail}}
  *
- * NOTE: This class is auto generated by the swagger code generator program.
+ * NOTE: This file is auto generated by the swagger code generator program.
  * https://github.com/swagger-api/swagger-codegen.git
- * Do not edit the class manually.
+ * Do not edit the file manually.
  */

src/main/resources/handlebars/typescript-fetch/package.mustache

@@ -14,16 +14,26 @@
   "typings": "./dist/index.d.ts",
   "scripts" : {
     "build": "tsc --outDir dist/",
+    "test": "jest",
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
     "portable-fetch": "^3.0.0"
   },
   "devDependencies": {
-    "@types/node": "^8.0.9",
-    "typescript": "^2.0"
-  }{{#npmRepository}},{{/npmRepository}}
-{{#npmRepository}}
+    "@types/jest": "^25.2.1",
+    "@types/node": "^13.13.0",
+    "jest": "^25.4.0",
+    "ts-jest": "^25.4.0",
+    "typescript": "^3.8.3"
+  },
+  "jest": {
+    "transform": {
+      "^.+\\.tsx?$": "ts-jest"
+    },
+    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$",
+    "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"]
+  }{{#npmRepository}},
   "publishConfig":{
     "registry":"{{npmRepository}}"
   }

src/main/resources/handlebars/typescript-fetch/tsconfig.mustache

@@ -14,6 +14,7 @@
   },
   "exclude": [
     "dist",
-    "node_modules"
+    "node_modules",
+    "**/*.spec.ts"
   ]
 }

src/main/resources/mustache/typescript-fetch/api_test.mustache

@@ -0,0 +1,29 @@
+{{>licenseInfo}}
+
+import * as api from "./api"
+import { Configuration } from "./configuration"
+
+const config: Configuration = {}
+
+{{#apiInfo}}
+{{#apis}}
+{{#operations}}
+describe("{{classname}}", () => {
+  let instance: api.{{classname}}
+  beforeEach(function() {
+    instance = new api.{{classname}}(config)
+  });
+
+{{#operation}}
+  test("{{operationId}}", () => {
+    {{#allParams}}
+    const {{{paramName}}}: {{^isPrimitiveType}}api.{{/isPrimitiveType}}{{{dataType}}} = {{>api_test_default_value}}
+    {{/allParams}}
+    return expect(instance.{{operationId}}({{#allParams}}{{{paramName}}}, {{/allParams}}{})).resolves.toBe(null)
+  })
+{{/operation}}
+})
+
+{{/operations}}
+{{/apis}}
+{{/apiInfo}}

src/main/resources/mustache/typescript-fetch/licenseInfo.mustache

@@ -0,0 +1,11 @@
+/**
+ * {{{appName}}}
+ * {{{appDescription}}}
+ *
+ * {{#version}}OpenAPI spec version: {{{version}}}{{/version}}
+ * {{#infoEmail}}Contact: {{{infoEmail}}}{{/infoEmail}}
+ *
+ * NOTE: This file is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the file manually.
+ */

src/main/resources/mustache/typescript-fetch/package.mustache

@@ -0,0 +1,41 @@
+{
+  "name": "{{npmName}}",
+  "version": "{{npmVersion}}",
+  "description": "swagger client for {{npmName}}",
+  "author": "Swagger Codegen Contributors",
+  "keywords": [
+    "fetch",
+    "typescript",
+    "swagger-client",
+    "{{npmName}}"
+  ],
+  "license": "Unlicense",
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "scripts" : {
+    "build": "tsc --outDir dist/",
+    "test": "jest",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "portable-fetch": "^3.0.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^25.2.1",
+    "@types/node": "^13.13.0",
+    "jest": "^25.4.0",
+    "ts-jest": "^25.4.0",
+    "typescript": "^3.8.3"
+  },
+  "jest": {
+    "transform": {
+      "^.+\\.tsx?$": "ts-jest"
+    },
+    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$",
+    "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"]
+  }{{#npmRepository}},
+  "publishConfig":{
+    "registry":"{{npmRepository}}"
+  }
+{{/npmRepository}}
+}

src/main/resources/mustache/typescript-fetch/tsconfig.mustache

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "target": "{{#supportsES6}}es6{{/supportsES6}}{{^supportsES6}}es5{{/supportsES6}}",
+    "module": "commonjs",
+    "noImplicitAny": true,
+    "outDir": "dist",
+    "rootDir": "."{{^supportsES6}},
+    "lib": [
+      "es6",
+      "dom"
+    ]
+    {{/supportsES6}}
+  },
+  "exclude": [
+    "dist",
+    "node_modules",
+    "**/*.spec.ts"
+  ]
+}