feat: support tags for all resources (#218)

* feat: support tags for all resources

* test: fix vpc test case

Author: yugasun

__tests__/apigw.test.ts

@@ -8,6 +8,12 @@ describe('apigw', () => {
     SecretId: process.env.TENCENT_SECRET_ID,
     SecretKey: process.env.TENCENT_SECRET_KEY,
   };
+  const tags = [
+    {
+      key: 'slstest',
+      value: 'slstest',
+    },
+  ];
   const inputs: ApigwDeployInputs = {
     protocols: ['http', 'https'],
     serviceName: 'serverless_test',
@@ -126,6 +132,7 @@ describe('apigw', () => {
         serviceMockReturnMessage: 'helloworld',
       },
     ],
+    tags,
   };
   const apigw = new Apigw(credentials, process.env.REGION);
   let outputs: ApigwDeployOutputs;
@@ -231,6 +238,7 @@ describe('apigw', () => {
           isBase64Encoded: false,
         },
       ],
+      tags,
     });
   });
 
@@ -349,6 +357,7 @@ describe('apigw', () => {
           isBase64Encoded: false,
         },
       ],
+      tags,
     });
   });
 
@@ -458,6 +467,7 @@ describe('apigw', () => {
           isBase64Encoded: false,
         },
       ],
+      tags,
     });
   });
 

__tests__/cdn.test.ts

@@ -8,6 +8,12 @@ describe('Cdn', () => {
     SecretId: process.env.TENCENT_SECRET_ID,
     SecretKey: process.env.TENCENT_SECRET_KEY,
   };
+  const tags = [
+    {
+      key: 'slstest',
+      value: 'slstest',
+    },
+  ];
   const inputs: CdnDeployInputs = {
     async: false,
     area: 'overseas',
@@ -32,6 +38,7 @@ describe('Cdn', () => {
       redirectType: 'https',
       redirectStatusCode: 301,
     },
+    tags,
   };
   const cdn = new Cdn(credentials);
 
@@ -45,6 +52,7 @@ describe('Cdn', () => {
       cname: `${inputs.domain}.cdn.dnsv1.com`,
       inputCache: JSON.stringify(inputs),
       resourceId: expect.stringContaining('cdn-'),
+      tags,
     });
   });
 
@@ -59,6 +67,7 @@ describe('Cdn', () => {
       cname: `${inputs.domain}.cdn.dnsv1.com`,
       inputCache: JSON.stringify(inputs),
       resourceId: expect.stringContaining('cdn-'),
+      tags,
     });
   });
 

__tests__/cynosdb.test.ts

@@ -16,13 +16,21 @@ describe('Cynosdb', () => {
   const region = 'ap-guangzhou';
   const client = new Cynosdb(credentials, region);
 
+  const tags = [
+    {
+      key: 'slstest',
+      value: 'slstest',
+    },
+  ];
+
   const inputs: CynosdbDeployInputs = {
     region,
     zone: 'ap-guangzhou-4',
     vpcConfig: {
       vpcId: 'vpc-p2dlmlbj',
       subnetId: 'subnet-a1v3k07o',
     },
+    tags,
   };
 
   let clusterId;
@@ -121,6 +129,7 @@ describe('Cynosdb', () => {
           status: 'running',
         },
       ],
+      tags,
     });
 
     expect(isValidPwd(res.adminPassword)).toBe(true);
@@ -160,6 +169,7 @@ describe('Cynosdb', () => {
           status: 'running',
         },
       ],
+      tags,
     });
   });
 
@@ -190,6 +200,7 @@ describe('Cynosdb', () => {
           status: 'running',
         },
       ],
+      tags,
     });
     inputs.clusterId = undefined;
   });

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

@@ -1,4 +1,4 @@
-import { PostgresqlDeployInputs } from './../src/modules/postgresql/interface';
+import { PostgresqlDeployInputs } from '../src/modules/postgresql/interface';
 import { Postgresql } from '../src';
 import { getDbInstanceDetail } from '../src/modules/postgresql/utils';
 import { sleep } from '@ygkit/request';
@@ -10,6 +10,12 @@ describe('Postgresql', () => {
   };
   const pg = new Postgresql(credentials, process.env.REGION);
 
+  const tags = [
+    {
+      key: 'slstest',
+      value: 'slstest',
+    },
+  ];
   const inputs: PostgresqlDeployInputs = {
     region: process.env.REGION,
     zone: process.env.ZONE,
@@ -22,6 +28,7 @@ describe('Postgresql', () => {
       subnetId: process.env.SUBNET_ID,
     },
     extranetAccess: false,
+    tags,
   };
 
   test('should deploy postgresql success', async () => {
@@ -40,6 +47,7 @@ describe('Postgresql', () => {
         password: expect.any(String),
         dbname: expect.stringContaining('tencentdb_'),
       },
+      tags,
     });
     inputs.dBInstanceId = res.dBInstanceId;
   });
@@ -68,6 +76,7 @@ describe('Postgresql', () => {
         password: expect.any(String),
         dbname: expect.stringContaining('tencentdb_'),
       },
+      tags,
     });
   });
   test('should remove postgresql success', async () => {

__tests__/tag.test.ts

@@ -8,7 +8,7 @@ describe('Tag', () => {
     SecretKey: process.env.TENCENT_SECRET_KEY,
   };
   const functionName = 'serverless-unit-test';
-  const tagItem = { TagKey: 'slstest', TagValue: 'slstest' };
+  const tagItem = { TagKey: 'slstest1', TagValue: 'slstest1' };
   const commonInputs: TagDeployInputs = {
     resourceIds: [`default/function/${functionName}`],
     resourcePrefix: 'namespace',

__tests__/vpc.test.ts

@@ -7,12 +7,19 @@ describe('Vpc', () => {
     SecretId: process.env.TENCENT_SECRET_ID,
     SecretKey: process.env.TENCENT_SECRET_KEY,
   };
+  const tags = [
+    {
+      key: 'slstest',
+      value: 'slstest',
+    },
+  ];
   const inputs: VpcDeployInputs = {
     region: process.env.REGION,
     zone: process.env.ZONE,
     vpcName: 'serverless-test',
     subnetName: 'serverless-test',
     cidrBlock: '10.0.0.0/16',
+    tags,
   };
   const vpc = new Vpc(credentials, process.env.REGION);
 
@@ -56,6 +63,7 @@ describe('Vpc', () => {
         vpcName: 'serverless-test',
         subnetId: expect.stringContaining('subnet-'),
         subnetName: 'serverless-test',
+        tags,
       });
 
       inputs.vpcId = res.vpcId;

src/modules/apigw/entities/service.ts

@@ -1,3 +1,4 @@
+import { TagInput } from './../../interface';
 import { Capi } from '@tencent-sdk/capi';
 import {
   ApigwCreateServiceInputs,
@@ -20,6 +21,7 @@ interface Detail {
   ServiceName: string;
   ServiceDesc: string;
   Protocol: string;
+  Tags: TagInput[];
 }
 
 export default class ServiceEntity {

src/modules/apigw/index.ts

@@ -21,6 +21,7 @@ import ApiEntity from './entities/api';
 import UsagePlanEntity from './entities/usage-plan';
 import CustomDomainEntity from './entities/custom-domain';
 import { ApiError } from '../../utils/error';
+import TagClient from '../tag';
 
 export default class Apigw {
   credentials: CapiCredentials;
@@ -31,6 +32,7 @@ export default class Apigw {
   api: ApiEntity;
   customDomain: CustomDomainEntity;
   usagePlan: UsagePlanEntity;
+  tagClient: TagClient;
 
   constructor(credentials: CapiCredentials, region: RegionType = 'ap-guangzhou') {
     this.credentials = credentials;
@@ -48,6 +50,8 @@ export default class Apigw {
     this.api = new ApiEntity(this.capi, this.trigger);
     this.usagePlan = new UsagePlanEntity(this.capi);
     this.customDomain = new CustomDomainEntity(this.capi);
+
+    this.tagClient = new TagClient(this.credentials, this.region);
   }
 
   async request({ Action, ...data }: { Action: ActionType; [key: string]: any }) {
@@ -119,6 +123,21 @@ export default class Apigw {
       outputs.usagePlan = usagePlan;
     }
 
+    const { tags = [] } = inputs;
+    if (tags.length > 0) {
+      const deployedTags = await this.tagClient.deployResourceTags({
+        tags: tags.map(({ key, value }) => ({ TagKey: key, TagValue: value })),
+        resourceId: serviceId,
+        serviceType: ApiServiceType.apigw,
+        resourcePrefix: 'service',
+      });
+
+      outputs.tags = deployedTags.map((item) => ({
+        key: item.TagKey,
+        value: item.TagValue!,
+      }));
+    }
+
     return outputs;
   }
 
@@ -188,6 +207,16 @@ export default class Apigw {
       });
       console.log(`Unrelease service ${serviceId}, environment ${environment} success`);
 
+      // 在删除之前，如果关联了标签，需要先删除标签关联
+      if (detail.Tags && detail.Tags.length > 0) {
+        await this.tagClient.deployResourceTags({
+          tags: [],
+          resourceId: serviceId,
+          serviceType: ApiServiceType.apigw,
+          resourcePrefix: 'service',
+        });
+      }
+
       // delete service
       console.log(`Removing service ${serviceId}`);
       await this.removeRequest({
@@ -233,6 +262,21 @@ export default class Apigw {
         apiList,
       };
 
+      const { tags = [] } = inputs;
+      if (tags.length > 0) {
+        const deployedTags = await this.tagClient.deployResourceTags({
+          tags: tags.map(({ key, value }) => ({ TagKey: key, TagValue: value })),
+          resourceId: serviceId,
+          serviceType: ApiServiceType.apigw,
+          resourcePrefix: 'service',
+        });
+
+        outputs.tags = deployedTags.map((item) => ({
+          key: item.TagKey,
+          value: item.TagValue!,
+        }));
+      }
+
       return outputs;
     }
     throw new ApiError({

src/modules/apigw/interface.ts

@@ -1,4 +1,4 @@
-import { RegionType } from '../interface';
+import { RegionType, TagInput } from '../interface';
 
 export interface Secret {
   AccessKeyId: string;
@@ -113,6 +113,8 @@ export interface ApigwCreateServiceInputs {
 
   usagePlan?: ApigwSetupUsagePlanInputs;
   auth?: ApigwSetupUsagePlanSecretInputs;
+
+  tags?: TagInput[];
 }
 export interface ApigwUpdateServiceInputs {
   environment?: EnviromentType;
@@ -200,6 +202,8 @@ export interface ApigwDeployOutputs {
   apiList: ApiEndpoint[];
   customDomains?: ApigwBindCustomDomainOutputs[];
   usagePlan?: ApigwUsagePlanOutputs;
+
+  tags?: TagInput[];
 }
 
 export interface ApigwRemoveOrUnbindUsagePlanInputs {