fix: support autoSetupAcl,autoSetupPolicy config (#32)

* fix: support autoSetupAcl,autoSetupPolicy config

* fix: update deps

* docs: update configure

Author: yugasun

.github/workflows/release.yml

@@ -43,6 +43,6 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
           GIT_AUTHOR_NAME: slsplus
-          GIT_AUTHOR_EMAIL: yuga.sun.bj@gmail.com
+          GIT_AUTHOR_EMAIL: slsplus.sz@gmail.com
           GIT_COMMITTER_NAME: slsplus
-          GIT_COMMITTER_EMAIL: yuga.sun.bj@gmail.com
+          GIT_COMMITTER_EMAIL: slsplus.sz@gmail.com

docs/configure.md

@@ -0,0 +1,14 @@
+const { join } = require('path')
+require('dotenv').config({ path: join(__dirname, '.env.test') })
+
+const config = {
+  verbose: true,
+  silent: false,
+  testTimeout: 300000,
+  testEnvironment: 'node',
+  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.(js|ts)$',
+  testPathIgnorePatterns: ['/node_modules/', '/__tests__/lib/'],
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node']
+}
+
+module.exports = config

jest.config.js

@@ -6,7 +6,7 @@
   },
   "description": "Easily deploy serverless websites (e.g. Vue.js, React, static) to Tencent Cloud with the Serverless Framework",
   "scripts": {
-    "test": "jest ./tests/integration.test.js --testEnvironment node",
+    "test": "jest",
     "commitlint": "commitlint -f HEAD@{15}",
     "lint": "eslint --ext .js,.ts,.tsx .",
     "lint:fix": "eslint --fix --ext .js,.ts,.tsx .",
@@ -46,6 +46,7 @@
     "@semantic-release/release-notes-generator": "^9.0.1",
     "@serverless/platform-client-china": "^1.0.19",
     "@ygkit/secure": "0.0.3",
+    "axios": "^0.21.0",
     "babel-eslint": "^10.1.0",
     "dotenv": "^8.2.0",
     "eslint": "^6.8.0",

package.json

@@ -1,5 +1,5 @@
 name: website
-version: 0.1.0
+version: 0.1.1
 author: 'Tencent Cloud, Inc.'
 org: 'Tencent Cloud, Inc.'
 description: Deploy a static website on Tencent Cloud.

serverless.component.yml

@@ -6,8 +6,34 @@ const CONFIGS = {
   compFullname: 'Website',
   indexPage: 'index.html',
   errorPage: 'error.html',
-  protocol: 'http',
-  description: 'This is a bucket created by serverless component'
+  protocol: 'https',
+  description: 'Created by Serverless Component',
+  acl: {
+    permissions: 'public-read',
+    grantRead: '',
+    grantWrite: '',
+    grantFullControl: ''
+  },
+  getPolicy(region, bucket, appid) {
+    return {
+      Statement: [
+        {
+          Principal: { qcs: ['qcs::cam::anyone:anyone'] },
+          Effect: 'Allow',
+          Action: [
+            'name/cos:HeadBucket',
+            'name/cos:ListMultipartUploads',
+            'name/cos:ListParts',
+            'name/cos:GetObject',
+            'name/cos:HeadObject',
+            'name/cos:OptionsObject'
+          ],
+          Resource: [`qcs::cos:${region}:uid/${appid}:${bucket}-${appid}/*`]
+        }
+      ],
+      version: '2.0'
+    }
+  }
 }
 
 module.exports = CONFIGS

src/config.js

@@ -1,7 +1,7 @@
 {
   "dependencies": {
     "download": "^8.0.0",
-    "tencent-component-toolkit": "^1.17.3",
+    "tencent-component-toolkit": "^1.19.7",
     "type": "^2.1.0"
   }
 }

src/package.json

@@ -58,13 +58,13 @@ const prepareInputs = async (instance, inputs) => {
   if (!code.src) {
     sourceDirectory = `${sourceDirectory}/src`
   }
-  console.log(`Files unzipped into ${sourceDirectory}...`)
+  console.log(`Files unzipped into ${sourceDirectory}`)
 
   const region = inputs.region || CONFIGS.region
   const bucketName =
     removeAppid(inputs.bucketName, appId) || `sls-website-${region}-${generateId()}`
 
-  return {
+  const websiteInputs = {
     replace: inputs.replace,
     useDefault: !code.src,
     code: {
@@ -79,6 +79,18 @@ const prepareInputs = async (instance, inputs) => {
     protocol: inputs.protocol || CONFIGS.protocol,
     cors: inputs.cors
   }
+
+  // auto setup acl for public-read
+  if (inputs.autoSetupAcl !== false) {
+    websiteInputs.acl = CONFIGS.acl
+  }
+
+  // auto setup policy for public read
+  if (inputs.autoSetupPolicy === true) {
+    websiteInputs.policy = CONFIGS.getPolicy(region, bucketName, appId)
+  }
+
+  return websiteInputs
 }
 
 module.exports = {

src/utils.js

@@ -1,19 +1,17 @@
 const path = require('path')
 require('dotenv').config({path: path.join(__dirname, '..', '.env.test')})
-const { generateId, getServerlessSdk } = require('./utils')
-
-// set enough timeout for deployment to finish
-jest.setTimeout(300000)
+const axios = require('axios')
+const { generateId, getServerlessSdk } = require('./lib/utils')
 
 // the yaml file we're testing against
 const instanceYaml = {
   org: 'orgDemo',
   app: 'appDemo',
-  component: 'website',
+  component: 'website@dev',
   name: `website-integration-tests-${generateId()}`,
   stage: 'dev',
   inputs: {
-    src: path.join(__dirname, '..', 'example'),
+    src: path.join(__dirname, '..', 'example/src'),
     bucketName: 'my-bucket',
     region: 'ap-guangzhou'
   }
@@ -26,19 +24,20 @@ const credentials = {
   }
 }
 
-// get serverless construct sdk
 const sdk = getServerlessSdk(instanceYaml.org)
 
-it('should successfully deploy website app', async () => {
+it('should deploy success', async () => {
   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)
+  const content = await axios.get(instance.outputs.website)
+  expect(content.data).toContain('Serverless Framework');
 })
 
-it('should successfully remove website app', async () => {
+it('should remove success', async () => {
   await sdk.remove(instanceYaml, credentials)
   result = await sdk.getInstance(instanceYaml.org, instanceYaml.stage, instanceYaml.app, instanceYaml.name)