feat: support policy and optimize deploy flow (#11)

* feat: support policy and optimize deploy flow

* chore: remove unuse tests folder

Author: yugasun

.eslintignore

@@ -2,5 +2,3 @@ coverage
 dist
 node_modules
 example
-*.test.js
-src/_src

.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: Release
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    env:
+      GH_TOKEN: ${{ secrets.GH_TOKEN }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+
+      - name: Install Node.js and npm
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14.x
+          registry-url: https://registry.npmjs.org
+
+      - name: Retrieve dependencies from cache
+        id: cacheNpm
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.npm
+            node_modules
+          key: npm-v14-${{ runner.os }}-refs/heads/master-${{ hashFiles('package.json') }}
+          restore-keys: npm-v14-${{ runner.os }}-refs/heads/master-
+
+      - name: Install dependencies
+        if: steps.cacheNpm.outputs.cache-hit != 'true'
+        run: |
+          npm update --no-save
+          npm update --save-dev --no-save
+      - name: Releasing
+        run: |
+          npm run release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          GIT_AUTHOR_NAME: slsplus
+          GIT_AUTHOR_EMAIL: slsplus.sz@gmail.com
+          GIT_COMMITTER_NAME: slsplus
+          GIT_COMMITTER_EMAIL: slsplus.sz@gmail.com

.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: Test
+
+on:
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          # Ensure connection with 'master' branch
+          fetch-depth: 2
+
+      - name: Install Node.js and npm
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14.x
+          registry-url: https://registry.npmjs.org
+
+      - name: Retrieve dependencies from cache
+        id: cacheNpm
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.npm
+            node_modules
+          key: npm-v14-${{ runner.os }}-${{ github.ref }}-${{ hashFiles('package.json') }}
+          restore-keys: |
+            npm-v14-${{ runner.os }}-${{ github.ref }}-
+            npm-v14-${{ runner.os }}-refs/heads/master-
+
+      - name: Install dependencies
+        if: steps.cacheNpm.outputs.cache-hit != 'true'
+        run: |
+          npm update --no-save
+          npm update --save-dev --no-save
+      - name: Running integration tests
+        run: npm run test
+        env:
+          SERVERLESS_PLATFORM_VENDOR: tencent
+          GLOBAL_ACCELERATOR_NA: true
+          TENCENT_APP_ID: ${{ secrets.TENCENT_APP_ID }}
+          TENCENT_SECRET_ID: ${{ secrets.TENCENT_SECRET_ID }}
+          TENCENT_SECRET_KEY: ${{ secrets.TENCENT_SECRET_KEY }}

.github/workflows/validate.yml

@@ -0,0 +1,45 @@
+name: Validate
+
+on:
+  pull_request:
+    branches: [master]
+
+jobs:
+  lintAndFormatting:
+    name: Lint & Formatting
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          # Ensure connection with 'master' branch
+          fetch-depth: 2
+
+      - name: Install Node.js and npm
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14.x
+          registry-url: https://registry.npmjs.org
+
+      - name: Retrieve dependencies from cache
+        id: cacheNpm
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.npm
+            node_modules
+          key: npm-v14-${{ runner.os }}-${{ github.ref }}-${{ hashFiles('package.json') }}
+          restore-keys: |
+            npm-v14-${{ runner.os }}-${{ github.ref }}-
+            npm-v14-${{ runner.os }}-refs/heads/master-
+
+      - name: Install dependencies
+        if: steps.cacheNpm.outputs.cache-hit != 'true'
+        run: |
+          npm update --no-save
+          npm update --save-dev --no-save
+
+      - name: Validate Formatting
+        run: npm run prettier:fix
+      - name: Validate Lint rules
+        run: npm run lint:fix

.prettierignore

@@ -2,4 +2,3 @@ coverage
 dist
 node_modules
 CHANGELOG.md
-*.test.js

.travis.yml

@@ -1,7 +1,5 @@
 # 腾讯云对象存储 COS 组件
 
-简体中文 | [English](https://github.com/serverless-components/tencent-cos/tree/master/README.en.md)
-
 ## 简介
 
 通过对象存储 COS 组件，可以快速，方便的创建，配置和管理腾讯云的 COS 存储桶
@@ -34,14 +32,14 @@ $ touch serverless.yml
 ```yml
 # serverless.yml
 
-org: orgDemo
 app: appDemo
 stage: dev
+
 component: cos
 name: cosDemo
 
 inputs:
-  bucket: my-bucket
+  bucket: bucket-demo
   region: ap-guangzhou
 ```
 
@@ -85,9 +83,9 @@ TENCENT_SECRET_KEY=123
 
 > 如果没有腾讯云账号，请先 [注册新账号](https://cloud.tencent.com/register)。如果已有腾讯云账号，可以在 [API 密钥管理](https://console.cloud.tencent.com/cam/capi) 中获取 SecretId 和 SecretKey。
 
-### 还支持哪些组件？
+### 使用文档
 
-可以在 [Serverless Components](https://github.com/serverless/components) repo 中查询更多组件的信息。
+[使用文档](./docs/README.md)
 
 ## License
 

README.en.md

@@ -0,0 +1,70 @@
+const path = require('path')
+const axios = require('axios')
+const { generateId, getServerlessSdk } = require('./lib/utils')
+
+const appId = process.env.TENCENT_APP_ID
+const credentials = {
+  tencent: {
+    SecretId: process.env.TENCENT_SECRET_ID,
+    SecretKey: process.env.TENCENT_SECRET_KEY
+  }
+}
+
+const instanceYaml = {
+  org: 'orgDemo',
+  app: 'appDemo',
+  component: 'cos@dev',
+  name: `cos-integration-tests-${generateId()}`,
+  stage: 'dev',
+  inputs: {
+    src: {
+      src: path.join(__dirname, '..', 'example/src')
+    },
+    bucket: 'cos-integration-test',
+    region: 'ap-guangzhou',
+    acl: {
+      permissions: 'public-read'
+    }
+  }
+}
+
+const sdk = getServerlessSdk(instanceYaml.org, appId)
+
+describe('COS', () => {
+  it('deploy cos', async () => {
+    const instance = await sdk.deploy(instanceYaml, credentials)
+
+    expect(instance).toBeDefined()
+    expect(instance.instanceName).toEqual(instanceYaml.name)
+    expect(instance.outputs.url).toBeDefined()
+    expect(instance.outputs.region).toEqual(instanceYaml.inputs.region)
+    // exist page
+    const { data } = await axios.get(`${instance.outputs.url}/index.html`)
+    expect(data).toContain('Serverless')
+  })
+
+  it('deploy website', async () => {
+    instanceYaml.inputs.website = true
+    const instance = await sdk.deploy(instanceYaml, credentials)
+
+    expect(instance).toBeDefined()
+    expect(instance.instanceName).toEqual(instanceYaml.name)
+    expect(instance.outputs.website).toBeDefined()
+    expect(instance.outputs.region).toEqual(instanceYaml.inputs.region)
+    // exist page
+    const { data } = await axios.get(instance.outputs.website)
+    expect(data).toContain('Serverless')
+  })
+
+  it('remove success', async () => {
+    await sdk.remove(instanceYaml, credentials)
+    const result = await sdk.getInstance(
+      instanceYaml.org,
+      instanceYaml.stage,
+      instanceYaml.app,
+      instanceYaml.name
+    )
+
+    expect(result.instance.instanceStatus).toEqual('inactive')
+  })
+})

README.md

@@ -0,0 +1,26 @@
+const { ServerlessSDK } = require('@serverless/platform-client-china')
+
+const generateId = () =>
+  Math.random()
+    .toString(36)
+    .substring(6)
+
+function sleep(ms) {
+  return new Promise((resolve) => {
+    setTimeout(() => {
+      resolve(true)
+    }, ms)
+  })
+}
+
+function getServerlessSdk(orgName, orgUid) {
+  const sdk = new ServerlessSDK({
+    context: {
+      orgUid,
+      orgName
+    }
+  })
+  return sdk
+}
+
+module.exports = { sleep, generateId, getServerlessSdk }