云压测
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云压测

pts

最近更新时间：2023-04-20 15:30:03

我的收藏

本页目录：

Interfaces（接口）

Metadata

Variables（变量）

default

default: { check: ((name: string, callback: (() => boolean), interrupt?: boolean) => boolean); metadata: (() => Metadata); sleep: ((seconds: number) => void); step: ((name: string, callback: (() => void)) => any) }

Type declaration

check: ((name: string, callback: (() => boolean), interrupt?: boolean) => boolean)

(name: string, callback: (() => boolean), interrupt?: boolean): boolean
check 主要针对请求返回的结果做进一步检查，如果检查失败，则代表测试失败。
import http from 'pts/http';
import { check } from 'pts';

export default function () {
    const resp = http.get('http://httpbin.org/get');
    check('statusCode is 200', () => resp.statusCode === 200);
};
Parameters
name: string
名字
callback: (() => boolean)
函数，返回 boolean 类型
(): boolean
Returns boolean
Optional interrupt: boolean
可选。是否中断函数
Returns booleann 检查结果

metadata: (() => Metadata)

(): Metadata
metadata 返回压测任务的元数据。
import { metadata } from 'pts';

export default function () {
  let md = metadata();
  console.log(md.userID); // 123456
  console.log(md.appID); // 123456
  console.log(md.scenarioID); // scenario-xxxxxxxx
  console.log(md.region); // ap-guangzhou
  console.log(md.jobID); // job-xxxxxxxx
}
Returns Metadata
元数据
sleep: ((seconds: number) => void)
(seconds: number): void
在指定的时间内暂停 VU 执行。
import { sleep } from 'pts';

export default function () {
    sleep(1);
};
Parameters
seconds: number
时间，单位秒
Returns void
step: ((name: string, callback: (() => void)) => any)
(name: string, callback: (() => void)): any
把压测场景分步骤，在压测报告中可以体现。
 import http from 'pts/http';
 import { step } from 'pts';

 export default function () {
     step('get', function () {
         http.get('http://httpbin.org/get');
     })
 };
Parameters
name: stringn 名称
callback: (() => void)
函数
(): void
Returns void
Returns any

Functions

check

check(name: string, callback: (() => boolean), interrupt?: boolean): booleanncheck 主要针对请求返回的结果做进一步检查，如果检查失败，则代表测试失败。
import http from 'pts/http';
import { check } from 'pts';

export default function () {
    const resp = http.get('http://httpbin.org/get');
    check('statusCode is 200', () => resp.statusCode === 200);
};
Parameters
name: string
名字
callback: (() => boolean)
函数，返回 boolean 类型
(): boolean

Returns boolean

Optional interrupt: boolean
可选。是否中断函数

Returns boolean

检查结果

metadata

metadata(): Metadata
metadata 返回压测任务的元数据。
import { metadata } from 'pts';

export default function () {
  let md = metadata();
  console.log(md.userID); // 123456
  console.log(md.appID); // 123456
  console.log(md.scenarioID); // scenario-xxxxxxxx
  console.log(md.region); // ap-guangzhou
  console.log(md.jobID); // job-xxxxxxxx
}
Returns Metadatan 元数据

sleep

sleep(seconds: number): voidn在指定的时间内暂停 VU 执行。
import { sleep } from 'pts';

export default function () {
    sleep(1);
};
Parameters
seconds: number
时间，单位秒
Returns void

step

step(name: string, callback: (() => void)): any
把压测场景分步骤，在压测报告中可以体现。
import http from 'pts/http';
import { step } from 'pts';

export default function () {
    step('get', function () {
        http.get('http://httpbin.org/get');
    })
};
Parameters
name: string
名称
callback: (() => void)
函数
(): void

Returns void

Returns any
中国站