test: refactor with typescript (#181)

* fix: fix some typings

* refactor(ts): all test are now in typescript 🎉

* test: add babel.config.js for jest running typescript test

* fix: fix build error

Author: wwwzbwcom

__tests__/apigw.test.js renamed to __tests__/apigw.test.ts

@@ -1,4 +1,4 @@
-const { Apigw } = require('../lib');
+import { Apigw } from '../src';
 
 const deepClone = (obj) => {
   return JSON.parse(JSON.stringify(obj));

__tests__/cam.test.js renamed to __tests__/cam.test.ts

@@ -1,4 +1,4 @@
-const { Cam } = require('../lib');
+import { Cam } from '../src';
 
 describe('Cam', () => {
   const credentials = {
@@ -23,13 +23,13 @@ describe('Cam', () => {
   test('should create role success', async () => {
     await cam.CreateRole(roleName, policy);
     const { RoleInfo } = await cam.GetRole(roleName);
-    const exist = await cam.isRoleExist(roleName, {});
+    const exist = await cam.isRoleExist(roleName);
     expect(RoleInfo.RoleName).toBe(roleName);
     expect(exist).toBe(true);
   });
 
   test('should delete role success', async () => {
-    await cam.DeleteRole(roleName, {});
+    await cam.DeleteRole(roleName);
     try {
       await cam.GetRole(roleName);
     } catch (e) {

__tests__/cdn.test.js renamed to __tests__/cdn.test.ts

@@ -1,13 +1,14 @@
-const { Cdn } = require('../lib');
-const { getCdnByDomain } = require('../lib/modules/cdn/utils');
+import { CdnDeployInputs } from './../src/modules/cdn/interface';
+import { Cdn } from '../src';
+import { getCdnByDomain } from '../src/modules/cdn/utils';
 
 describe('Cdn', () => {
   jest.setTimeout(600000);
   const credentials = {
     SecretId: process.env.TENCENT_SECRET_ID,
     SecretKey: process.env.TENCENT_SECRET_KEY,
   };
-  const inputs = {
+  const inputs: CdnDeployInputs = {
     async: false,
     area: 'overseas',
     domain: process.env.SUB_DOMAIN,
@@ -32,7 +33,7 @@ describe('Cdn', () => {
       redirectStatusCode: 301,
     },
   };
-  const cdn = new Cdn(credentials, process.env.REGION);
+  const cdn = new Cdn(credentials);
 
   test('should deploy CDN success with originType = cos', async () => {
     const res = await cdn.deploy(inputs);

__tests__/cfs.test.js renamed to __tests__/cfs.test.ts

@@ -1,14 +1,17 @@
-const { sleep } = require('@ygkit/request');
-const { Cfs } = require('../lib');
-const utils = require('../lib/modules/cfs/utils').default;
+import { CFSDeployInputs } from './../src/modules/cfs/interface';
+import { sleep } from '@ygkit/request';
+import { Cfs } from '../src';
+import utils from '../src/modules/cfs/utils';
 
 describe('Cfs', () => {
   const credentials = {
     SecretId: process.env.TENCENT_SECRET_ID,
     SecretKey: process.env.TENCENT_SECRET_KEY,
   };
 
-  const inputs = {
+  let fsId: string;
+
+  const inputs: CFSDeployInputs = {
     fsName: 'cfs-test',
     region: 'ap-guangzhou',
     zone: 'ap-guangzhou-3',
@@ -38,12 +41,15 @@ describe('Cfs', () => {
       fileSystemId: expect.stringContaining('cfs-'),
       tags: inputs.tags,
     });
-    inputs.fileSystemId = res.fileSystemId;
+    fsId = res.fileSystemId;
   });
 
   test('should remove CFS success', async () => {
     await sleep(1000);
-    const res = await cfs.remove(inputs);
+    const res = await cfs.remove({
+      fsName: inputs.fsName,
+      fileSystemId: fsId,
+    });
     const detail = await utils.getCfs(cfs.capi, inputs.fileSystemId);
     expect(res).toEqual({});
     expect(detail).toBeUndefined();

__tests__/cls.test.js renamed to __tests__/cls.test.ts

@@ -1,5 +1,6 @@
-const { Cls } = require('../lib');
-const { sleep } = require('@ygkit/request');
+import { ClsDeployInputs, ClsDeployOutputs } from './../src/modules/cls/interface';
+import { Cls } from '../src';
+import { sleep } from '@ygkit/request';
 
 describe('Cls', () => {
   const credentials = {
@@ -8,9 +9,9 @@ describe('Cls', () => {
   };
   const client = new Cls(credentials, process.env.REGION);
 
-  let outputs = {};
+  let outputs: ClsDeployOutputs;
 
-  const inputs = {
+  const inputs: ClsDeployInputs = {
     region: 'ap-guangzhou',
     name: 'cls-test',
     topic: 'cls-topic-test',

__tests__/cns.test.js renamed to __tests__/cns.test.ts

@@ -1,11 +1,12 @@
-const { Cns } = require('../lib');
+import { CnsDeployInputs, CnsDeployOutputs } from './../src/modules/cns/interface';
+import { Cns } from '../src';
 
 describe('Cns', () => {
   const credentials = {
     SecretId: process.env.TENCENT_SECRET_ID,
     SecretKey: process.env.TENCENT_SECRET_KEY,
   };
-  const inputs = {
+  const inputs: CnsDeployInputs = {
     domain: process.env.DOMAIN,
     records: [
       {
@@ -30,7 +31,7 @@ describe('Cns', () => {
   };
   const cns = new Cns(credentials, process.env.REGION);
 
-  let recordList;
+  let recordList: CnsDeployOutputs;
   test('should deploy Cns success', async () => {
     recordList = await cns.deploy(inputs);
     expect(recordList).toEqual({

__tests__/cos.test.js renamed to __tests__/cos.test.ts

@@ -1,7 +1,8 @@
-const { Cos } = require('../lib');
-const path = require('path');
-const axios = require('axios');
-const { sleep } = require('@ygkit/request');
+import { CosDeployInputs, CosWebsiteInputs } from './../src/modules/cos/interface';
+import { Cos } from '../src';
+import path from 'path';
+import axios from 'axios';
+import { sleep } from '@ygkit/request';
 
 describe('Cos', () => {
   const credentials = {
@@ -28,7 +29,7 @@ describe('Cos', () => {
     ],
     version: '2.0',
   };
-  const inputs = {
+  const inputs: CosDeployInputs = {
     bucket: bucket,
     src: staticPath,
     force: true,
@@ -52,7 +53,7 @@ describe('Cos', () => {
     ],
   };
 
-  const websiteInputs = {
+  const websiteInputs: CosWebsiteInputs = {
     code: {
       src: staticPath,
       index: 'index.html',

__tests__/cynosdb.test.js renamed to __tests__/cynosdb.test.ts

@@ -1,10 +1,6 @@
-const { Cynosdb } = require('../lib');
-const {
-  getClusterDetail,
-  sleep,
-  generatePwd,
-  isValidPwd,
-} = require('../lib/modules/cynosdb/utils');
+import { CynosdbDeployInputs } from './../src/modules/cynosdb/interface';
+import { Cynosdb } from '../src';
+import { getClusterDetail, sleep, generatePwd, isValidPwd } from '../src/modules/cynosdb/utils';
 
 describe('Cynosdb', () => {
   jest.setTimeout(600000);
@@ -15,7 +11,7 @@ describe('Cynosdb', () => {
   const region = 'ap-shanghai';
   const client = new Cynosdb(credentials, region);
 
-  const inputs = {
+  const inputs: CynosdbDeployInputs = {
     region,
     zone: 'ap-shanghai-2',
     vpcConfig: {

__tests__/domain.test.js renamed to __tests__/domain.test.ts

@@ -1,4 +1,4 @@
-const { Domain } = require('../lib');
+import { Domain } from '../src';
 
 describe('Domain', () => {
   const credentials = {

__tests__/error.test.js renamed to __tests__/error.test.ts

@@ -1,4 +1,4 @@
-const { ApiTypeError, ApiError } = require('../lib/utils/error');
+import { ApiTypeError, ApiError } from '../src/utils/error';
 
 describe('Custom Error', () => {
   test('TypeError', async () => {

__tests__/layer.test.js renamed to __tests__/layer.test.ts

@@ -1,5 +1,6 @@
-const { sleep } = require('@ygkit/request');
-const { Layer } = require('../lib');
+import { LayerDeployInputs } from './../src/modules/layer/interface';
+import { sleep } from '@ygkit/request';
+import { Layer } from '../src';
 
 describe('Layer', () => {
   const credentials = {
@@ -8,7 +9,7 @@ describe('Layer', () => {
   };
   const layer = new Layer(credentials, process.env.REGION);
 
-  const inputs = {
+  const inputs: LayerDeployInputs = {
     region: 'ap-guangzhou',
     name: 'layer-test',
     bucket: process.env.BUCKET,

__tests__/metrics.test.js renamed to __tests__/metrics.test.ts

@@ -1,4 +1,4 @@
-const { Metrics } = require('../lib');
+import { Metrics } from '../src';
 
 describe('Metrics', () => {
   const credentials = {

__tests__/pg.test.js renamed to __tests__/pg.test.ts

@@ -1,6 +1,7 @@
-const { Postgresql } = require('../lib');
-const { getDbInstanceDetail } = require('../lib/modules/postgresql/utils');
-const { sleep } = require('@ygkit/request');
+import { PostgresqlDeployInputs } from './../src/modules/postgresql/interface';
+import { Postgresql } from '../src';
+import { getDbInstanceDetail } from '../src/modules/postgresql/utils';
+import { sleep } from '@ygkit/request';
 
 describe('Postgresql', () => {
   const credentials = {
@@ -9,7 +10,7 @@ describe('Postgresql', () => {
   };
   const pg = new Postgresql(credentials, process.env.REGION);
 
-  const inputs = {
+  const inputs: PostgresqlDeployInputs = {
     region: process.env.REGION,
     zone: process.env.ZONE,
     dBInstanceName: 'serverless-test',

__tests__/scf.test.js renamed to __tests__/scf.test.ts

@@ -1,5 +1,6 @@
-const { sleep } = require('@ygkit/request');
-const { Scf, Cfs, Layer } = require('../lib');
+import { ScfDeployInputs } from './../src/modules/scf/interface';
+import { sleep } from '@ygkit/request';
+import { Scf, Cfs, Layer } from '../src';
 
 describe('Scf', () => {
   const credentials = {
@@ -72,7 +73,7 @@ describe('Scf', () => {
     },
   };
 
-  const inputs = {
+  const inputs: ScfDeployInputs = {
     name: `serverless-test-${Date.now()}`,
     code: {
       bucket: process.env.BUCKET,

__tests__/tag.test.js renamed to __tests__/tag.test.ts

@@ -1,4 +1,6 @@
-const { Tag } = require('../lib');
+import { TagDeployInputs } from './../src/modules/tag/interface';
+import { Tag } from '../src';
+import { ApiServiceType } from '../src/modules/interface';
 
 describe('Tag', () => {
   const credentials = {
@@ -7,15 +9,15 @@ describe('Tag', () => {
   };
   const functionName = 'serverless-unit-test';
   const tagItem = { TagKey: 'slstest', TagValue: 'slstest' };
-  const commonInputs = {
+  const commonInputs: TagDeployInputs = {
     resourceIds: [`default/function/${functionName}`],
     resourcePrefix: 'namespace',
-    serviceType: 'scf',
+    serviceType: ApiServiceType.scf,
   };
   const tag = new Tag(credentials, process.env.REGION);
 
   test('attach tags', async () => {
-    delete commonInputs.addTags;
+    // delete commonInputs.addTags;
     commonInputs.attachTags = [tagItem];
 
     const res = await tag.deploy(commonInputs);
@@ -30,7 +32,7 @@ describe('Tag', () => {
   });
 
   test('detach tags', async () => {
-    delete commonInputs.addTags;
+    // delete commonInputs.addTags;
     delete commonInputs.attachTags;
     commonInputs.detachTags = [tagItem];
 

__tests__/triggers/cls.test.js renamed to __tests__/triggers/cls.test.ts

@@ -1,6 +1,7 @@
-const { Cls, Scf } = require('../../lib');
-const ClsTrigger = require('../../lib/modules/triggers/cls').default;
-const { sleep } = require('@ygkit/request');
+import { ClsTriggerInputsParams } from './../../src/modules/triggers/interface';
+import { Cls, Scf } from '../../src';
+import ClsTrigger from '../../src/modules/triggers/cls';
+import { sleep } from '@ygkit/request';
 
 describe('Cls', () => {
   const credentials = {
@@ -11,7 +12,7 @@ describe('Cls', () => {
   const cls = new Cls(credentials, process.env.REGION);
   const scf = new Scf(credentials, process.env.REGION);
 
-  const data = {
+  const data: ClsTriggerInputsParams = {
     qualifier: '$DEFAULT',
     maxWait: 60,
     maxSize: 100,

__tests__/triggers/mps.test.js renamed to __tests__/triggers/mps.test.ts

@@ -1,5 +1,6 @@
-const { Scf } = require('../../lib');
-const MpsTrigger = require('../../lib/modules/triggers/mps').default;
+import { MpsTriggerInputsParams } from './../../src/modules/triggers/interface';
+import { Scf } from '../../src';
+import MpsTrigger from '../../src/modules/triggers/mps';
 
 // FIXME: all mps trigger bind fail
 describe('Mps', () => {
@@ -10,7 +11,7 @@ describe('Mps', () => {
   const client = new MpsTrigger({ credentials, region: process.env.REGION });
   const scfClient = new Scf(credentials, process.env.REGION);
 
-  const data = {
+  const data: MpsTriggerInputsParams = {
     qualifier: '$DEFAULT',
     type: 'EditMediaTask',
   };

__tests__/vpc.test.js renamed to __tests__/vpc.test.ts

@@ -1,12 +1,13 @@
-const { Vpc } = require('../lib');
-const vpcUtils = require('../lib/modules/vpc/utils').default;
+import { VpcDeployInputs } from './../src/modules/vpc/interface';
+import { Vpc } from '../src';
+import vpcUtils from '../src/modules/vpc/utils';
 
 describe('Vpc', () => {
   const credentials = {
     SecretId: process.env.TENCENT_SECRET_ID,
     SecretKey: process.env.TENCENT_SECRET_KEY,
   };
-  const inputs = {
+  const inputs: VpcDeployInputs = {
     region: process.env.REGION,
     zone: process.env.ZONE,
     vpcName: 'serverless-test',
@@ -38,7 +39,10 @@ describe('Vpc', () => {
 
   test('should success remove a vpc', async () => {
     if (inputs.vpcId) {
-      await vpc.remove(inputs);
+      await vpc.remove({
+        vpcId: inputs.vpcId,
+        subnetId: inputs.subnetId,
+      });
       const vpcDetail = await vpcUtils.getVpcDetail(vpc.capi, inputs.vpcId);
       const subnetDetail = await vpcUtils.getSubnetDetail(vpc.capi, inputs.subnetId);
 

babel.config.js

@@ -0,0 +1,4 @@
+// babel.config.js
+module.exports = {
+  presets: [['@babel/preset-env', { targets: { node: 'current' } }], '@babel/preset-typescript'],
+};

package.json

@@ -57,6 +57,8 @@
   },
   "homepage": "https://github.com/serverless-tencent/tencent-component-toolkit#readme",
   "devDependencies": {
+    "@babel/preset-env": "^7.12.11",
+    "@babel/preset-typescript": "^7.12.7",
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^8.3.4",
     "@semantic-release/changelog": "^5.0.0",
@@ -83,6 +85,7 @@
   "dependencies": {
     "@tencent-sdk/capi": "^1.1.8",
     "@tencent-sdk/cls": "^0.1.7",
+    "@types/jest": "^26.0.20",
     "@types/lodash": "^4.14.167",
     "@types/node": "^14.14.20",
     "@ygkit/request": "^0.1.8",