@serverless-devs/s 2.0.96 → 2.0.97-beta.1

package/spec/zh/0.0.1/serverless_user_model/3.user_model.md

@@ -1,218 +0,0 @@
-# 开发者模型
-
-Serverless User Model 部分介绍了 Serverless Application 规范以 Serverless Package Component 使用规范。
-
-- [Serverless Application 模型](#serverless-application-模型)
-    - [元数据](#元数据)
-    - [变量赋值](#变量赋值)
-    - [服务顺序](#服务顺序)
-    - [行为描述](#行为描述)
-- [Serverless Package Component 使用规范](#serverless-package-component-使用规范)
-
-## Serverless Application 模型
-
-Serverless Application 模型的定义，基于Serverless Devs开发者工具可识别的资源/行为描述文件。该文件仅支持`.yaml`和`.yml`两种格式，且需要符合Yaml的标准规范。与此同时，Serverless Application 模型规定，一个Serverless Devs开发者工具可识别的资源/行为描述文件表示一个Serverless应用。
-
-同时，需要注意的是，Serverless Application模型对应的Yaml格式文件默认名称为`s.yaml`与`s.yml`，且`s.yaml`的优先级大于`s.yml`，即在一个Serverless应用下，同时出现`s.yaml`与`s.yml`时，系统会优先识别和使用`s.yaml`，除非用户在使用时指定了其他Yaml格式的文件，作为默认文件。
-
-关于Serverless Application模型对应的Yaml文件格式，也是有着比较严格的要求，其格式为：
-
-```yaml
-edition: 1.0.0          #  命令行YAML规范版本，遵循语义化版本（Semantic Versioning）规范
-name: applicationName   #  应用名称
-access: xxx-account1    #  秘钥别名
-
-vars: # [全局变量，提供给各个服务使用]
-  Key: Value
-
-Service:
-  ServiceName: # 服务名称
-    access: xxx-account1      #  秘钥别名，如果和项目的access相同，可省略
-    component: componentName  #  组件名称
-    props: serviceProp        #  组件的属性值
-    actions: serviceActions   #  自定义执行逻辑
-```
-
-一个完整的符合Serverless Application模型
-
-```yaml
-edition: 1.0.0        #  命令行YAML规范版本，遵循语义化版本（Semantic Versioning）规范
-name: FullStack       #  项目名称
-access: xxx-account1  #  秘钥别名
-
-vars: # [全局变量，提供给各个服务使用]
-  logo: https://image.aliyun.com/xxxx.png
-
-services:
-  nextjs-portal: #  服务名称
-    access: xxx-account1  #  秘钥别名，如果和项目的access相同，可省略
-    component: vue-component  # 组件名称
-    props: #  组件的属性值
-      src: ./frontend_src
-      url: url
-    actions: # 自定义执行逻辑
-      pre-deploy: # 在deploy之前运行
-        - run: s exec -- publish  # 要运行的命令行
-          path: ./backend_src # 命令行运行的路径
-        - run: s build  # 要运行的命令行
-          path: ./backend_src # 命令行运行的路径
-      post-deploy: # 在deploy之后运行
-        - run: s clean
-          path: ./frontend_src
-
-  assets:
-    component: static
-    props:
-      cache-control: "public, max-age=604800, immutable"
-      www: "./public"
-
-  express-blog:
-    component: express
-    props:
-      app: ./express-blog
-      url: ${vars.domain}
-    actions:
-      pre-deploy:
-        - run: npm run build
-          path: ./express-blog
-
-  gateway:
-    component: serverless-gateway # 路由组件：HTTP URL和服务之间的映射规则
-    props:
-      routes:
-        - route: /~assets
-          value: ${assets.output.url}
-        - route: /
-          value: ${nextjs-portal.output.url}
-          index: index.html
-        - route: /~portal
-          value: ${nextjs-portal.output.url}
-          inex: index.html
-        - route: /~blog
-          value: ${express-blog.output.url}
-```
-
-### 元数据
-
-在该格式中：
-
-| 参数名 |  代表含义   | 
-|  ----  | ----  | 
-| edition  | 命令行YAML规范版本，遵循语义化版本（Semantic Versioning）规范 | 
-| name  | 应用名称 | 
-| access  | 秘钥别名 |
-| vars  | 全局变量，提供给各个服务使用，是一个Key-Value的形式 |
-| Service  | 应用所包含的服务，是一个Key-Value的形式 |
-
-关于Service参数：
-
-| 参数名 |  代表含义   | 
-|  ----  | ----  | 
-| access  | 秘钥别名，如果和项目的access相同，可省略 | 
-| component  | 组件名称 | 
-| actions  | 自定义执行逻辑 |
-| props  | 组件的属性值 |
-
-### 变量赋值
-
-Serverless Application模型对应的Yaml文件支持多种变量格式：
-
-- 获取当前机器中的环境变量：${env(环境变量)}，例如${env(secretId)}
-- 获取外部文档的变量：${file(路径)}，例如${file(./path)}
-- 获取全局变量：${vars.*}
-- 获取其他项目的变量：${projectName.props.*}
-- 获取Yaml中其他项目的结果变量：${projectName.output.*}
-
-### 服务顺序
-
-如果一个Serverless Application模型对应的Yaml文件中有过多的服务，系统会默认分析部署顺序，该部署顺序分为两个步骤：
-
-1. 分析项目中的依赖关系
-2. 有依赖关系的按照依赖关系从前到后部署，无依赖关系的按Yaml配置的从上到下部署
-
-### 行为描述
-
-在Serverless Application模型对应的Yaml文件中，可以针对服务，提供对应的行为操作，其基本格式是：
-
-```yaml
-actions: # 自定义执行逻辑
-  pre-命令: # 在命令之前运行
-    - run: command  # 要运行的操作
-      path: ./path # 运行操作的路径
-  post-命令: # 在命令之后运行
-    - run: command  # 要运行的操作
-      path: ./path # 运行操作的路径
-```
-
-例如：
-
-```yaml
-actions: # 自定义执行逻辑
-  pre-deploy: # 在deploy之前运行
-    - run: s exec -- publish  # 要运行的命令行
-      path: ./backend_src # 命令行运行的路径
-    - run: s build  # 要运行的命令行
-      path: ./backend_src # 命令行运行的路径
-  post-deploy: # 在deploy之后运行
-    - run: s clean
-      path: ./frontend_src
-```
-
-当Serverless Devs开发者工具执行到该服务时，会在进行相关的命令之行之前，优先按照顺序执行`pre-命令`的操作，所有内容完成执行之后，再执行`post-命令`的操作。
-
-以下面的Yaml为例：
-
-```yaml
-edition: 1.0.0        #  命令行YAML规范版本，遵循语义化版本（Semantic Versioning）规范
-name: FullStack       #  项目名称
-
-services:
-  nextjs-portal: #  服务名称
-    access: xxx-account1  #  秘钥别名，如果和项目的access相同，可省略
-    component: vue-component  # 组件名称
-    props: #  组件的属性值
-      src: ./frontend_src
-      url: url
-    actions: # 自定义执行逻辑
-      pre-deploy: # 在deploy之前运行
-        - run: s exec -- publish  # 要运行的命令行
-          path: ./backend_src # 命令行运行的路径
-        - run: s build  # 要运行的命令行
-          path: ./backend_src # 命令行运行的路径
-      post-deploy: # 在deploy之后运行
-        - run: s clean
-          path: ./frontend_src
-```
-
-当开发者在当前应用下执行了`deploy`命令，系统将会按照以下顺序进行操作：
-1. 在`./backend_src`目录下执行`s exec -- publish`
-2. 在`./backend_src`目录下执行`s build`
-3. 调用组件`vue-component`的`deploy`方法，并将`props`和项目的基本信息传入到组件`vue-component`的`deploy`方法中
-4. 在`./frontend_src`目录下执行`s clean`
-
-以上顺序仅适用于整个流程没有出错的前提下，如果流程出现错误，系统将会进行报错，并终止后续流程的执行。
-
-## Serverless Package Component 使用规范
-
-Serverless 开发者模型，规定了Serverless Package Component的使用规范。对于一个符合Serverless Application模型的Yaml文件：
-
-```yaml
-edition: 1.0.0          #  命令行YAML规范版本，遵循语义化版本（Semantic Versioning）规范
-name: applicationName   #  应用名称
-access: xxx-account1    #  秘钥别名
-
-vars: # [全局变量，提供给各个服务使用]
-  Key: Value
-
-Service:
-  ServiceName: # 服务名称
-    access: xxx-account1      #  秘钥别名，如果和项目的access相同，可省略
-    component: componentName  #  组件名称
-    props: serviceProp        #  组件的属性值
-    actions: serviceActions   #  自定义执行逻辑
-```
-在规范中，不同的Service都需要明确需要使用的component。此时的component格式将会分为几种：
-- 一个存在与指定registry的组件，例如`fc`组件等；
-- 一个存在Github的仓库，且按照规Serverless Package Component规范发布了Release，例如`devsapp/fc`
-- 一个本地的且符合Serverless Package Component规范的组件路径，例如`./../start-component/`
-

package/spec/zh/0.0.1/serverless_user_model/4.application_scopes.md

@@ -1,4 +0,0 @@
-# 适用范围
-
-以上规范适用于条件仅限于 Serverless Devs 开发者工具 所支持、所识别的Serverless应用。Serverless应用开发者，可以通过上述的规范，快速通过Serverless Devs开发者工具，进行Serverless应用的创建、开发、运维等全生命周期的管理。
- 

package/spec/zh/0.0.1/serverless_user_model/5.design_principles.md

@@ -1,3 +0,0 @@
-# 设计原则
-
-为了给Serverless开发者更加规范和科学的Serverless应用开发流程，可以让Serverless开发者更好的通过Serverless Devs开发者工具对Serverless Devs应用进行全生命周期的管理，Serverless User Model从开发者角度出发，提出Serverless Application规范以及Serverless Package Component规范，可以帮助开发者快速管理和操作Serverless应用。

package/spec/zh/0.0.1/serverless_user_model/readme.md

@@ -1,12 +0,0 @@
-# 用户模型
-
-一个关于 Serverless 应用的开发规范，也是Serverless开发者规范。Serverless developer 需要遵循该规范进行应用开发，通过法规范，可以快速使用Serverless Devs开发者工具，进行相关业务功能的实现。。
-
-- [目的和目标](1.purpose_and_goals.md)
-- [概述和术语](2.overview_and_terminology.md)
-  - [模型概述](2.overview_and_terminology.md#模型概述)
-- [User 模型](./3.user_model.md)
-  - [Serverless Application 模型](./3.user_model.md#serverless-application-模型)
-  - [Serverless Package Component 使用规范](./3.user_model.md##serverless-package-component-使用规范)
-- [适用范围](4.application_scopes.md)
-- [设计原则](5.design_principles.md)

package/test/ci.sh

@@ -1,33 +0,0 @@
-#!/bin/bash
-echo './bin/s -v'
-./bin/s -v
-
-echo './bin/s -h'
-./bin/s -h
-
-echo './bin/s config add --AccountID 12345 --AccessKeyID 12345 --AccessKeySecret 12345 -a test -f'
-./bin/s config add --AccountID 12345 --AccessKeyID 12345 --AccessKeySecret 12345 -a test -f
-
-echo './bin/s config get'
-./bin/s config get
-
-echo './bin/s config delete -a test'
-./bin/s config delete -a test
-
-echo './bin/s cli fc-api listServices'
-./bin/s cli fc-api
-
-echo './bin/s component'
-./bin/s component
-
-echo './bin/s component --component fc-api'
-./bin/s component --component fc-api
-
-echo './bin/s clean --component fc-api'
-./bin/s clean --component fc-api
-
-echo './bin/s clean --cache'
-./bin/s clean --cache
-
-
-

package/test/cli/cli-manager.test.ts

@@ -1,64 +0,0 @@
-/** @format */
-
-import CliManager, { CliParams } from '../../src/cli/cli-manager';
-
-describe('init cli', () => {
-  it('Verify CliManager class initialization', () => {
-    const input: CliParams = {
-      component: 'string',
-      command: 'string',
-      access: 'string',
-      props: 'string',
-    };
-    class myClass extends CliManager {
-      public values: any;
-      constructor(data) {
-        super(data);
-        this.values = this.inputs;
-      }
-    }
-    const v = new myClass(input);
-    expect(v.values).toEqual(input)
-  });
-
-  it('test component inner inputs', async () => {
-    try {
-      const input: CliParams = {
-        component: 's-demo',
-        command: 'test',
-        access: 'default',
-        props: undefined,
-      };
-      const cli = new CliManager(input);
-      let access = process.env['serverless_devs_temp_access'] ? process.env['serverless_devs_temp_access'] : input.access;
-      input.access = access;
-      const result = await cli.init();
-      expect(result).toHaveProperty('props'); // 判断输入到组件的参数是否包含props
-      expect(result).toHaveProperty('credentials'); // 判断输入到组件的参数是否包含credentials
-      expect(result).toHaveProperty('project'); // 判断输入到组件的参数是否包含project
-      expect(result).toHaveProperty('appName'); // 判断输入到组件的参数是否包含appName
-    } catch (e) {
-      expect(e).toMatch('error');
-    }
-  });
-  it('test params as input', async () => {
-    try {
-      const input: CliParams = {
-        component: 's-demo',
-        command: 'test',
-        access: 'default',
-        props: '{"hello":"serverless devs"}',
-      };
-      let access = process.env['serverless_devs_temp_access'] ? process.env['serverless_devs_temp_access'] : input.access;
-      input.access = access;
-      const cli = new CliManager(input);
-      
-      const result = await cli.init();
-      expect(result).toHaveProperty('props')
-      expect(result.props).toHaveProperty('hello');
-      expect(result.props).toMatchObject({ hello: 'serverless devs' }); // 判断经过入参转换后是否为对象
-    } catch (e) {
-      expect(e).toMatch('error');
-    }
-  });
-});

package/test/config/get.test.ts

@@ -1,12 +0,0 @@
-/** @format */
-import { spawnSync } from 'child_process'
-
-describe('module config', () => {
-  it('s config -l', () => {
-    const ls = spawnSync('s', ['config', 'get', '-l'])
-    const v = Buffer.from(ls.stdout)
-    expect(v.toString()).toContain('AccountID')
-    expect(v.toString()).toContain('AccessKeySecret')
-  });
-
-})

package/test/helloworld.test.ts

@@ -1,7 +0,0 @@
-/** @format */
-
-describe('loadComponent', () => {
-  it('should ', () => {
-    expect(1).toEqual(1);
-  });
-});

package/test/start-fc-http-nodejs12/code/index.js

@@ -1,47 +0,0 @@
-var getRawBody = require('raw-body');
-var getFormBody = require('body/form');
-var body = require('body');
-
-
-/*
-To enable the initializer feature (https://help.aliyun.com/document_detail/156876.html)
-please implement the initializer function as below：
-exports.initializer = (context, callback) => {
-  console.log('initializing');
-  callback(null, '');
-};
-*/
-
-exports.handler = (req, resp, context) => {
-    console.log('hello world');
-
-    var params = {
-        path: req.path,
-        queries: req.queries,
-        headers: req.headers,
-        method : req.method,
-        requestURI : req.url,
-        clientIP : req.clientIP,
-    }
-
-    getRawBody(req, function(err, body) {
-        for (var key in req.queries) {
-          var value = req.queries[key];
-          resp.setHeader(key, value);
-        }
-        params.body = body.toString();
-        resp.send(JSON.stringify(params, null, '    '));
-    });
-
-    /*
-    getFormBody(req, function(err, formBody) {
-        for (var key in req.queries) {
-          var value = req.queries[key];
-          resp.setHeader(key, value);
-        }
-        params.body = formBody;
-        console.log(formBody);
-        resp.send(JSON.stringify(params));
-    });
-    */
-}

package/test/start-fc-http-nodejs12/s.yaml

@@ -1,38 +0,0 @@
-edition: 1.0.0          #  命令行YAML规范版本，遵循语义化版本（Semantic Versioning）规范
-name: fcDeployApp       #  项目名称
-access: "default"  #  秘钥别名
-
-services:
-  fc-deploy-test: #  服务名称
-    component: devsapp/fc  # 组件名称
-    props: #  组件的属性值
-      region: cn-hangzhou
-      service:
-        name: fc-deploy-service
-        description: 'demo for fc-deploy component'
-        internetAccess: true
-      function:
-        name: http-trigger-nodejs12
-        description: this is a test
-        runtime: nodejs12
-        codeUri: ./code
-        # ossBucket:
-        # ossKey:  # conflict with codeUri
-        handler: index.handler
-        memorySize: 128
-        timeout: 60
-      triggers:
-        - name: httpTrigger
-          type: http
-          config:
-            authType: anonymous
-            methods:
-              - GET
-      customDomains:
-        - domainName: auto
-          protocol: HTTP
-          routeConfigs:
-            - path: /*
-              methods:
-                - GET
-# 函数计算FC组件文档参考地址：https://github.com/devsapp/fc

package/test/utils/index.test.ts

@@ -1,8 +0,0 @@
-import { getYamlPath } from '../../src/utils/index'
-import os from 'os'
-describe('module utils', () => {
-  it('test getYamlPath methods that get yaml folder', () => {
-    const v = getYamlPath(`${os.homedir()}/.s`, 'access');
-    expect(v).toBeTruthy();
-  });
-});

package/test/utils/storage.test.ts

@@ -1,19 +0,0 @@
-import core from '../../src/utils/core';
-const { fse: fs } = core;
-import os from 'os';
-import { getHomeDir, getHistoryFile } from '../../src/utils/storage';
-
-describe('module storage', () => {
-  it('test getHomeDir methods', () => {
-    const path = getHomeDir();
-    expect(path).toContain('.s');
-    const v = fs.existsSync(`${os.homedir()}/.s`);
-    expect(v).toBeTruthy();
-  });
-  it('test getHistoryFile methods', () => {
-    const path = getHistoryFile();
-    expect(path).toContain('history');
-    const v = fs.existsSync(`${os.homedir()}/.s/history`);
-    expect(v).toBeTruthy();
-  });
-});

package/tsconfig.json

@@ -1,37 +0,0 @@
-{
-  "compileOnSave": true,
-  "compilerOptions": {
-    "esModuleInterop": true,
-    "lib": [
-      "es2015",
-      "dom",
-      "es6"
-    ],
-    "target": "es5",
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "inlineSourceMap": true,
-    "noImplicitThis": true,
-    "noUnusedLocals": true,
-    "stripInternal": true,
-    "pretty": false,
-    "declaration": true,
-    "typeRoots": [
-      "./typings",
-      "./node_modules/@types"
-    ],
-    "rootDir": "src",
-    "outDir": "lib"
-  },
-  "exclude": [
-    "node_modules",
-    "dist",
-    "test"
-  ],
-  "include": [
-    "./src/**/*.ts",
-    "src/**/*.json"
-  ]
-}