feat(boilerplate): add boilerplate, vpc, subnet and tags

Author: Christopher Brandt

README.md

@@ -7,7 +7,6 @@ Use the CloudGraph Tencent Provider to scan and normalize cloud infrastructure u
 - [CloudGraph Tencent Provider](#cloudgraph-tencent-provider)
 - [Install](#install)
 - [Authentication](#authentication)
-- [Multi Account](#multi-account)
 - [Configuration](#configuration)
 - [Supported Services](#supported-services)
 <!-- tocstop -->
@@ -22,9 +21,10 @@ cg init tencent
 
 # Authentication
 
+Authenticate the CloudGraph Tencent Provider using one or more SecretId/SecretKey pair(s). Visit the TencentCloud API Key page to apply for
+security credentials:
 
-# Multi Account
-
+- [TencentCloud API Key](https://console.cloud.tencent.com/capi)
 
 # Configuration
 
@@ -37,9 +37,24 @@ NOTE: CloudGraph will output where it stores the configuration file and provider
 
 CloudGraph will generate this configuration file when you run `cg init tencent`. You may update it manually or by running `cg init tencent` again.
 
+```
+"tencent": {
+  "accounts": [
+    {
+      "secretId": "AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******",
+      "secretKey": "Gu5t9xGARNpq86cd98joQYCN3*******"
+    }
+  ],
+  "regions": "ap-bangkok,ap-jakarta,ap-beijing,ap-chengdu,ap-chongqing,ap-guangzhou,ap-shenzhen-fsi,ap-hongkong,ap-mumbai,ap-nanjing,ap-seoul,ap-tokyo,ap-shanghai,ap-shanghai-fsi,ap-singapore,eu-frankfurt,eu-moscow,na-ashburn,na-siliconvalley,na-toronto,sa-saopaulo",
+  "resources": "subnet,vpc"
+}
+```
+
 CloudGraph Tencent Provider will ask you what regions you would like to crawl and will by default crawl for **all** supported resources in **selected** regions in the **default** account. You can update the `regions` or `resources` fields in the `cloud-graphrc.json` file to change this behavior. You can also select which `resources` to crawl in the `cg init tencent` command by passing the the `-r` flag: `cg init tencent -r`
 
 # Supported Services
 
 | Service | Relations |
 | ------------------- | ------------------- |
+| subnet | vpc |
+| vpc | subnet |

package.json

@@ -36,11 +36,14 @@
     "@graphql-tools/load-files": "^6.3.2",
     "@graphql-tools/merge": "^8.0.1",
     "@sentry/node": "^6.7.2",
+    "@types/long": "^4.0.2",
     "chalk": "^4.1.2",
+    "cuid": "^2.1.8",
     "dotenv": "^10.0.0",
     "graphql": "^16.2.0",
     "lodash": "^4.17.21",
     "pino": "^6.11.3",
+    "tencentcloud-sdk-nodejs": "^4.0.333",
     "typescript": "^4.3.5"
   },
   "devDependencies": {

src/config/constants.ts

@@ -0,0 +1,6 @@
+import { regionMap } from '../enums/regions'
+import services from '../enums/services'
+
+export const GLOBAL_REGION = 'global'
+export const DEFAULT_REGION = regionMap.easternUS
+export const DEFAULT_RESOURCES = Object.values(services).join(',')

src/config/environment.ts

@@ -0,0 +1,8 @@
+import dotenv from 'dotenv'
+
+const { parsed: environment } = dotenv.config()
+
+export default {
+  ...process.env,
+  ...environment,
+}

src/enums/regions.ts

@@ -0,0 +1,71 @@
+export const regionMap = {
+  southeastAsiaPacific1: 'ap-bangkok',
+  southeastAsiaPacific2: 'ap-jakarta',
+  northChina: 'ap-beijing',
+  southwestChina1: 'ap-chengdu',
+  southwestChina2: 'ap-chongqing',
+  southChina1:	'ap-guangzhou',
+  southChina2: 'ap-shenzhen-fsi',
+  hongKong: 'ap-hongkong',
+  southAsiaPacific: 'ap-mumbai',
+  eastChina: 'ap-nanjing',
+  northeastAsiaPacific1:	'ap-seoul',
+  northeastAsiaPacific2: 'ap-tokyo',
+  eastChina1: 'ap-shanghai',
+  eastChina2: 'ap-shanghai-fsi',
+  southeastAsiaPacific: 'ap-singapore',
+  europe1: 'eu-frankfurt',
+  europe2: 'eu-moscow',
+  easternUS: 'na-ashburn',
+  westernUS: 'na-siliconvalley',
+  northAmerica: 'na-toronto',
+  southAmerica: 'sa-saopaulo',
+}
+
+const {
+  southeastAsiaPacific1,
+  southeastAsiaPacific2,
+  northChina,
+  southwestChina1,
+  southwestChina2,
+  southChina1,
+  southChina2,
+  hongKong,
+  southAsiaPacific,
+  eastChina,
+  northeastAsiaPacific1,
+  northeastAsiaPacific2,
+  eastChina1,
+  eastChina2,
+  southeastAsiaPacific,
+  europe1,
+  europe2,
+  easternUS,
+  westernUS,
+  northAmerica,
+  southAmerica,
+} = regionMap
+
+export default [
+  southeastAsiaPacific1,
+  southeastAsiaPacific2,
+  northChina,
+  southwestChina1,
+  southwestChina2,
+  southChina1,
+  southChina2,
+  hongKong,
+  southAsiaPacific,
+  eastChina,
+  northeastAsiaPacific1,
+  northeastAsiaPacific2,
+  eastChina1,
+  eastChina2,
+  southeastAsiaPacific,
+  europe1,
+  europe2,
+  easternUS,
+  westernUS,
+  northAmerica,
+  southAmerica,   
+]

src/enums/relations.ts

@@ -0,0 +1,10 @@
+import services from './services'
+
+/**
+ * Set relations between services to data sharing
+ * The key of the object represents the parent or base service,
+ * it might contain an array of dependant or children that must be executed after the parent
+ */
+export default {
+
+}

src/enums/schemasMap.ts

@@ -0,0 +1,10 @@
+import services from './services'
+
+/**
+ * schemasMap is an object that contains schemas name by resource
+ */
+export default {
+  [services.subnet]: 'tencentSubnet',
+  [services.vpc]: 'tencentVpc',
+  tag: 'tencentTag',
+}

src/enums/serviceAliases.ts

@@ -0,0 +1,4 @@
+export default {
+  subnet: 'subnets',
+  vpc: 'vpcInstances',
+}

src/enums/serviceMap.ts

@@ -0,0 +1,14 @@
+import services from './services'
+import TencentSubnet from '../services/subnet'
+import TencentVpc from '../services/vpc'
+import TencentTag from '../services/tag'
+
+/**
+ * serviceMap is an object that contains all currently supported services
+ * serviceMap is used by the serviceFactory to produce instances of service classes
+ */
+export default {
+  [services.subnet]: TencentSubnet,
+  [services.vpc]: TencentVpc,
+  tag: TencentTag,
+}

src/enums/services.ts

@@ -0,0 +1,4 @@
+export default {
+  subnet: 'subnet',
+  vpc: 'vpc',
+}

src/properties/logger.ts

@@ -0,0 +1,15 @@
+export default {
+  platform: 'Platform: Tencent',
+  fetchingResourceData: (resource: string): string => `Fetching ${resource} data...`,
+  doneFetchingResourceData: (resource: string, num: number): string =>
+    `✅ Done fetching ${resource} data in ${num}s ✅`,
+  foundResources: (resource: string, num: number): string => `Found ${num} ${resource}`,
+  lookingForResourcesAddToRegion: (region: string, resource: string): string =>
+    `Looking for ${resource} to add to Region ${region}...`,
+  addingServiceToRegion: (region: string, resource: string, num: number): string =>
+    `Adding ${num} ${resource} to Region ${region}`,
+  lookingForResourcesAddToProject: (resource: string): string =>
+    `Looking for ${resource} to add to the Project...`,
+  addingServiceToProject: (resource: string, num: number): string =>
+    `Adding ${num} ${resource} to the Project`,
+}

src/services/base/index.ts

@@ -0,0 +1,9 @@
+import { Logger } from '@cloudgraph/sdk'
+
+export default class BaseService {
+  constructor(config: any) {
+    this.logger = config.logger
+  }
+
+  logger: Logger
+}

src/services/base/schema.graphql

@@ -0,0 +1,21 @@
+interface tencentBaseService 
+  @generate(
+    query: { get: true, query: true, aggregate: true }
+    mutation: { add: true, delete: false }
+    subscription: false
+  ) {
+    id: String! @id @search(by: [hash])
+    region: String @search(by: [hash, regexp])
+}
+
+type tencentKeyValue
+  @generate(
+    query: { get: true, query: true, aggregate: true }
+    mutation: { add: true, delete: false }
+    subscription: false
+  ) 
+  @key(fields: "id") {
+    id: String! @id @search(by: [hash])
+    key: String! @search(by: [hash, regexp])
+    value: String @search(by: [hash, regexp])
+}