add auto generated test cases

Author: tokuhirom

generate-code.py

@@ -61,13 +61,14 @@ def generate_webhook():
                     -cp ./tools/openapi-generator-cli.jar:./generator/target/line-bot-sdk-nodejs-generator-openapi-generator-1.0.0.jar \\
                     org.openapitools.codegen.OpenAPIGenerator \\
                     generate \\
-                    --global-property modelDocs=false,apiDocs=false \\
+                    --global-property apiTest=false,modelDocs=false,apiDocs=false \\
                     -g line-bot-sdk-nodejs-generator \\
                     -o {output_path} \\
                     -i line-openapi/{source_yaml} \\
                   '''
     run_command(command)
     run_command(f'rm -rf lib/webhook/api/')
+    run_command(f'rm -rf lib/webhook/tests/')
 
     with open('lib/webhook/api.ts', 'w') as wfp:
         wfp.write("""export * from './model/models';""")

generator/src/main/java/line/bot/generator/LineBotSdkNodejsGeneratorGenerator.java

@@ -10,6 +10,7 @@
 import org.openapitools.codegen.CodegenDiscriminator;
 import org.openapitools.codegen.CodegenModel;
 import org.openapitools.codegen.CodegenOperation;
+import org.openapitools.codegen.CodegenParameter;
 import org.openapitools.codegen.CodegenType;
 import org.openapitools.codegen.languages.TypeScriptNodeClientCodegen;
 import org.openapitools.codegen.model.ModelMap;
@@ -77,6 +78,12 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap operations, L
 //        formParam.isFile
 //      }
 //      if (op.getHasFormParams())
+            for (CodegenParameter allParam : op.allParams) {
+//                allParam.isModel
+//                allParam.isNumber
+//                allParam.isLong
+//                allParam.isEnum
+            }
         }
 
         return operations;
@@ -174,7 +181,11 @@ protected ImmutableMap.Builder<String, Mustache.Lambda> addMustacheLambdas() {
                 })
                 .put("pathReplace", ((fragment, writer) -> {
                     String text = fragment.execute();
-                    writer.write(pathReplacer(text));
+                    writer.write(pathReplacer(text, true));
+                }))
+                .put("pathReplaceDUMMY", ((fragment, writer) -> {
+                    String text = fragment.execute();
+                    writer.write(pathReplacer(text, false));
                 }));
     }
 
@@ -188,14 +199,20 @@ private String getEndpointFromClassName(String className) {
         }
     }
 
-    public static String pathReplacer(String template) {
+    public static String pathReplacer(String template, boolean useVariable) {
         Pattern pattern = Pattern.compile("\\{(\\w+)\\}");
         Matcher matcher = pattern.matcher(template);
 
         StringBuilder codeBuilder = new StringBuilder();
         while (matcher.find()) {
             String key = matcher.group(1);
-            codeBuilder.append(".replace(\"{").append(key).append("}\", String(").append(key).append("))");
+            codeBuilder.append(".replace(\"{").append(key).append("}\", String(");
+            if (useVariable) {
+                codeBuilder.append(key);
+            } else {
+                codeBuilder.append("\"DUMMY\"");
+            }
+            codeBuilder.append("))");
         }
 
         return codeBuilder.toString();

generator/src/main/resources/line-bot-sdk-nodejs-generator/api-single.mustache

@@ -61,6 +61,13 @@ export class {{classname}} {
      {{#allParams}}
      * @param {{paramName}} {{description}}
      {{/allParams}}
+     {{#isDeprecated}}
+     * @deprecated
+     {{/isDeprecated}}
+{{#externalDocs}}
+     * {{description}}
+     * @see <a href="{{url}}">{{summary}} Documentation</a>
+{{/externalDocs}}
      */
     public async {{nickname}}({{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}, {{/allParams}}) : Promise<{{#returnType}}{{{.}}}{{/returnType}}{{^returnType}}Types.MessageAPIResponseBase{{/returnType}}> {
         {{>apiBody/multipart}}

generator/src/main/resources/line-bot-sdk-nodejs-generator/api_test.mustache

@@ -1 +1,101 @@
-// write test case here...
+{{#operations}}
+import { {{classname}} } from "../../api";
+{{/operations}}
+
+{{#imports}}
+import { {{classname}} } from '../{{filename}}';
+{{/imports}}
+
+import * as nock from "nock";
+import { deepEqual, equal } from "assert";
+
+const pkg = require("../../../../package.json");
+
+const channel_access_token = "test_channel_access_token";
+
+{{#operations}}
+describe("{{classname}}", () => {
+  before(() => nock.disableNetConnect());
+  afterEach(() => nock.cleanAll());
+  after(() => nock.enableNetConnect());
+
+  const client = new {{classname}}({
+    channelAccessToken: channel_access_token,
+  });
+
+{{#operation}}
+  it("{{nickname}}", async () => {
+    const scope = nock("{{#lambda.endpoint}}{{classname}}{{/lambda.endpoint}}", {
+      reqheaders: {
+        Authorization: `Bearer ${channel_access_token}`,
+        "User-Agent": `${pkg.name}/${pkg.version}`,
+      },
+    })
+      .{{#lambda.lower}}{{{httpMethod}}}{{/lambda.lower}}((u) => u.includes("{{{path}}}"
+        {{#allParams}}
+        {{#isNumber}}
+        {{=<% %>=}}
+            .replace("{<% paramName %>}", "0") // number
+        <%={{ }}=%>
+        {{/isNumber}}
+        {{#isInteger}}
+        {{=<% %>=}}
+            .replace("{<% paramName %>}", "0") // int
+        <%={{ }}=%>
+        {{/isInteger}}
+        {{#isLong}}
+        {{=<% %>=}}
+            .replace("{<% paramName %>}", "0") // long
+        <%={{ }}=%>
+        {{/isLong}}
+        {{#isString}}
+        {{=<% %>=}}
+            .replace("{<% paramName %>}", "DUMMY") // string
+        <%={{ }}=%>
+        {{/isString}}
+        {{/allParams}}
+      ))
+      .reply(200, {});
+
+    const res = await client.{{nickname}}(
+        {{#allParams}}
+        // {{paramName}}: {{dataType}}
+        {{#isFile}}
+            new Blob([]), // paramName={{paramName}}
+        {{/isFile}}
+        {{#isModel}}
+            {} as unknown as {{{dataType}}}, // paramName={{paramName}}
+        {{/isModel}}
+        {{#isEnum}}
+            "DUMMY" as unknown as {{{dataType}}}, // paramName={{paramName}}(enum)
+        {{/isEnum}}
+        {{^isEnum}}
+        {{#isExplode}}
+            "DUMMY" as unknown as {{{dataType}}}, // paramName={{paramName}}(enum)
+        {{/isExplode}}
+        {{^isExplode}}
+        {{#isString}}
+            "DUMMY", // {{paramName}}(string)
+        {{/isString}}
+        {{#isNumber}}
+            0, // paramName={{paramName}}(number)
+        {{/isNumber}}
+        {{#isInteger}}
+            0, // paramName={{paramName}}(integer)
+        {{/isInteger}}
+        {{#isLong}}
+            0, // paramName={{paramName}}(long)
+        {{/isLong}}
+        {{#isBoolean}}
+            true, // paramName={{paramName}}
+        {{/isBoolean}}
+        {{/isExplode}}
+        {{/isEnum}}
+        {{/allParams}}
+    );
+    equal(scope.isDone(), true);
+  });
+
+{{/operation}}
+});
+{{/operations}}

lib/channel-access-token/.openapi-generator/FILES

@@ -11,3 +11,4 @@ model/issueShortLivedChannelAccessTokenResponse.ts
 model/issueStatelessChannelAccessTokenResponse.ts
 model/models.ts
 model/verifyChannelAccessTokenResponse.ts
+tests/api/ChannelAccessTokenClientTest.spec.ts

lib/channel-access-token/api/channelAccessTokenClient.ts

@@ -68,6 +68,8 @@ export class ChannelAccessTokenClient {
      * Gets all valid channel access token key IDs.
      * @param clientAssertionType `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`
      * @param clientAssertion A JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key.
+     * 
+     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-all-valid-channel-access-token-key-ids-v2-1"> Documentation</a>
      */
     public async getsAllValidChannelAccessTokenKeyIds(clientAssertionType: string, clientAssertion: string, ) : Promise<ChannelAccessTokenKeyIdsResponse> {
 
@@ -94,6 +96,8 @@ export class ChannelAccessTokenClient {
      * @param grantType &#x60;client_credentials&#x60;
      * @param clientId Channel ID.
      * @param clientSecret Channel secret.
+     * 
+     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#issue-shortlived-channel-access-token"> Documentation</a>
      */
     public async issueChannelToken(grantType?: string, clientId?: string, clientSecret?: string, ) : Promise<IssueShortLivedChannelAccessTokenResponse> {
 
@@ -121,6 +125,8 @@ export class ChannelAccessTokenClient {
      * @param grantType client_credentials
      * @param clientAssertionType urn:ietf:params:oauth:client-assertion-type:jwt-bearer
      * @param clientAssertion A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
+     * 
+     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#issue-channel-access-token-v2-1"> Documentation</a>
      */
     public async issueChannelTokenByJWT(grantType?: string, clientAssertionType?: string, clientAssertion?: string, ) : Promise<IssueChannelAccessTokenResponse> {
 
@@ -150,6 +156,8 @@ export class ChannelAccessTokenClient {
      * @param clientAssertion A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key.
      * @param clientId Channel ID.
      * @param clientSecret Channel secret.
+     * 
+     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token"> Documentation</a>
      */
     public async issueStatelessChannelToken(grantType?: string, clientAssertionType?: string, clientAssertion?: string, clientId?: string, clientSecret?: string, ) : Promise<IssueStatelessChannelAccessTokenResponse> {
 
@@ -177,6 +185,8 @@ export class ChannelAccessTokenClient {
     /**
      * Revoke short-lived or long-lived channel access token
      * @param accessToken Channel access token
+     * 
+     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#revoke-longlived-or-shortlived-channel-access-token"> Documentation</a>
      */
     public async revokeChannelToken(accessToken?: string, ) : Promise<Types.MessageAPIResponseBase> {
 
@@ -202,6 +212,8 @@ export class ChannelAccessTokenClient {
      * @param clientId Channel ID
      * @param clientSecret Channel Secret
      * @param accessToken Channel access token
+     * 
+     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#revoke-channel-access-token-v2-1"> Documentation</a>
      */
     public async revokeChannelTokenByJWT(clientId?: string, clientSecret?: string, accessToken?: string, ) : Promise<Types.MessageAPIResponseBase> {
 
@@ -227,6 +239,8 @@ export class ChannelAccessTokenClient {
     /**
      * Verify the validity of short-lived and long-lived channel access tokens
      * @param accessToken A short-lived or long-lived channel access token.
+     * 
+     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#verfiy-channel-access-token"> Documentation</a>
      */
     public async verifyChannelToken(accessToken?: string, ) : Promise<VerifyChannelAccessTokenResponse> {
 
@@ -250,6 +264,8 @@ export class ChannelAccessTokenClient {
     /**
      * You can verify whether a Channel access token with a user-specified expiration (Channel Access Token v2.1) is valid.
      * @param accessToken Channel access token with a user-specified expiration (Channel Access Token v2.1).
+     * 
+     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#verfiy-channel-access-token-v2-1"> Documentation</a>
      */
     public async verifyChannelTokenByJWT(accessToken: string, ) : Promise<VerifyChannelAccessTokenResponse> {