提交测试任务 | 微信开放文档

# 提交测试任务

# 简要描述

提交测试任务提交前请确认已在项目管理/产品管理为项目绑定小程序AppID

# 请求URL

https://minitest.weixin.qq.com/thirdapi/plan

# 请求方式

POST

# 参数

参数名	必选	类型	说明
token	是	string	可以从页面右上角头像下拉菜单中的 “我的信息”，跳转至我的信息页面，查看“我的Token”
group_en_id	是	string	项目英文ID，可在项目管理/产品管理页面获取
test_type	是	int	测试类型，`1`：monkey `2`：minium `3`：录制回放 `4`：快速Monkey(仅支持服务商项目) `5`：启动性能分析
wx_version	是	int	小程序版本，`1`：线上版本 `2`：体验版本 `3`：开发版本 (若需要提测体验版本或者开发版本任务，请确认小程序已上传体验版或开发版)
platforms	是	string	运行平台，可选平台: android、ios，多个平台可用英文逗号分割，如`android,ios`
selected_android_num	否	int	只适用于`Monkey`和`启动性能分析`任务做兼容性测试，可以指定跑测Monkey或者启动性能分析的安卓机器数量，最大不超过10台
selected_ios_num	否	int	只适用于`Monkey`和`启动性能分析`任务做兼容性测试，可以指定跑测Monkey或者启动性能分析的iOS机器数量，最大不超过10台
wx_id	否	string	小程序AppID，一般无需填写，默认跑测项目绑定的小程序(可前往云测插件项目管理/产品管理查看)，当且仅当服务商项目提测快速Monkey类型时可传入批量提测的小程序AppID(多个AppID用英文逗号分割)，目前单次批量提测AppID不可超过50个
test_plan_id	否	int	测试计划的id，仅在提测自定义Monkey任务、minium任务、录制回放任务或者自定义快速Monkey任务时传入，id可以在测试用例管理/测试计划页面查看
task_run_time	否	int	自定义最长测试时长，单位秒。对不同任务来说，最长测试时长默认值和取值范围不同（详情可参考自定义测试时长说明）
desc	否	string	测试任务的描述、备注等
minium_config	否	dict/object	跑测minium任务时，一些可选的特殊配置：`{"assert_capture": true, "auto_relaunch": true, "auto_authorize": false, "compile_mode": "pages/getOpenId/index?p=1&ampm=2", "audits": false, "teardown_snapshot": false, "enable_tap_capture": false}`，其中assert_capture表示在assert的时候是否截图，auto_relaunch表示启动的时候是否relaunch到启动页面，auto_authorize表示是否启用小程序自动授权，compile_mode表示指定编译模式，格式为将微信开发者工具自定义编译条件中的启动页面和启动参数通过'?'进行拼接，audits表示是否启用体验评分，teardown_snapshot表示在用例结束时, 是否记录当前页面的wxml信息，enable_tap_capture表示在点击操作时是否截图注意，需要传入此参数时，请求头应包含 Content-type: application/json
dev_account_no	否	int	提交开发版时使用的账号编号，例如使用'ci机器人1'，则传入1即可
virtual_accounts	否	string	指定虚拟账号或者真实账号测试，如果指定多个，用英文逗号分割。虚拟账号需要填写虚拟账号的微信号，例如 `vaccount7,vaccount8`,获取微信号参考虚拟账号的使用。真实账号填写账号昵称。
run_mode	否	int	测试模式，默认为1（1：功能性测试，2：兼容性测试）。仅对录制回放和Minium任务生效
special_cloud	否	string	付费能力，如使用快速测试时填写`fast_test`
device_ids	否	string	付费能力，指定机型ID提测，如果指定多个，用英文逗号分割。例如 `755,1783`，机型ID可以从提交测试任务页面的自定义机型选择页面获取。

# 返回示例

{
	"data": {
		"plan_id": 2210
	},
	"msg": "添加成功，等待后台创建任务。",
	"rtn": 0,
	"timestamp": 1649313364.4696019
}

# 查询任务

# 1. 查询任务列表

# 简要描述

查询提交过的测试任务

# 请求URL

https://minitest.weixin.qq.com/thirdapi/plan_list

# 请求方式

# 参数

参数名	必选	类型	说明
token	是	string	可以从页面右上角头像右侧下拉菜单中的 “我的Token” 获取
group_en_id	是	string	项目英文ID，可在项目管理/产品管理页面获取
page_index	是	int	第 n 页，从1开始
page_size	否	int	每页返回数量，默认为10
test_type	否	int	任务类型，`1`Monkey； `2`Minium； `3`录制回放； `4`快速 Monkey； `5`启动性能测试
test_plan_id	否	int	测试计划的id，id可以在测试用例管理/测试计划页面查看，也可以通过查询测试计划接口获取
keyword_in_desc	否	string	任务描述中的关键字，创建任务时可以在描述中加入关键字，这里传入可以快速筛选
create_by_me	否	int	是否只查看由本人创建的任务，默认查看项目所有人创建的任务，如果只看本人创建的，传入`1`
platform	否	string	任务跑测的平台，支持按`ios`或`android`筛选
create_start_day	否	string	任务创建日期筛选的开始日期，格式为`'%Y-%m-%d'`，例如 2023-1-1
create_end_day	否	string	任务创建日期筛选的截止日期，格式为`'%Y-%m-%d'`，例如 2023-12-31

# 返回示例

{
  "data": {
    "plan_list": [{
      "android_num": 1,
      "appid": "wxbb9a805eb4f9533c",
      "case_plan_name": "智能化Monkey",
      "create_time": "2022-03-30 17:53:11",
      "desc": "",
      "end_time": "2022-03-30 18:35:25",
      "id": 31768,
      "ios_num": 0,
      "platforms": "android",
      "start_time": "2022-03-30 18:29:27",
      "status": 12,
      "status_info": "测试结束",
      "success_rate": 1.0,
      "test_type_info": "Monkey",
      "user_name": "user1",
      "wx_version_info": "线上版本"
    }],    // 当前返回的提测任务列表
    "total_num": 10,  // 项目总共提测任务数量
  },
  "msg": "OK",
  "rtn": 0,
  "timestamp": 1614861228.1035924
}

# 2. 查询任务状态

# 简要描述

查询提交的自动化测试任务状态(结果)

# 请求URL

https://minitest.weixin.qq.com/thirdapi/plan

# 请求方式

# 参数

参数名	必选	类型	说明
token	是	string	可以从页面右上角头像右侧下拉菜单中的 “我的信息” 获取
group_en_id	是	string	项目英文ID，可在项目管理/产品管理页面获取
plan_id	是	int	测试任务id，新建任务接口返回的plan_id值，或参见自动化任务管理/测试任务页面中表格ID列
full_info	否	int	是(1)否(0，默认)需要测试结果详情

# 返回示例

{
	"data": {
		"status": 2,
		"status_text": "测试中"
	},
	"msg": "OK",
	"rtn": 0,
	"timestamp": 1614861228.1035924,
	"trace_id": "bb97c56f0b85da64"

}

{
	"data": {
		"status": 1,
		"status_text": "排队中"
	},
	"msg": "OK",
	"rtn": 0,
	"timestamp": 1649313375.3715162,
	"trace_id": "bb97c56f0b85da64"
}

# 备注

任务部分状态码如下：

tips: 状态码大于10时表示任务完成。如果大于10且不为12的，一般是有异常情况出现，可视为未成功

1: 排队中
2: 测试中
11: 未发现Case
12: 测试结束
15: 任务超时

# 获取报告分享链接

# 简要描述

获取任务分享报告链接，请注意有效期30天

# 请求URL

https://minitest.weixin.qq.com/thirdapi/share_url

# 请求方式

# 参数

参数名	必选	类型	说明
token	是	string	可以从页面右上角头像右侧下拉菜单中的 “我的信息” 获取
group_en_id	是	string	项目英文ID，可在项目管理/产品管理页面获取
plan_id	是	int	测试任务id，新建任务接口返回的plan_id值，或参见自动化任务管理/测试任务页面中表格ID列

# 返回示例

{
  "data":{
    "expired_time":"2022-07-06 17:21:49",
    "share_url":"xxx"
  },
  "msg":"ok",
  "rtn":0,
  "timestamp":1654507309.8952177,
  "trace_id":"5f7884d3953a2e18"
}

# 获取测试结果资源

# 简要描述

获取测试结果资源，例如截图、日志等，接口返回打包后zip文件下载链接，解压后以用例名称+设备id归类。注：此接口响应时间受任务结果资源占用空间大小的影响，响应时间会长达数秒，请适当增大请求timeout时长。

# 请求URL

https://minitest.weixin.qq.com/thirdapi/report/static_resource

# 请求方式

# 参数

参数名	必选	类型	说明
token	是	string	可以从页面右上角头像右侧下拉菜单中的 “我的信息” 获取
group_en_id	是	string	项目英文ID，可在项目管理/产品管理页面获取
plan_id	是	int	测试任务id，新建任务接口返回的plan_id值，或参见自动化任务管理/测试任务页面中表格ID列
need_image	否	int	是否下载图片。1:需要下载； 0:无需下载。默认为1（需下载）
need_log	否	int	是否下载日志。1:需要下载； 0:无需下载。默认为0（无需下载）

# 返回示例

{
  "data":{
	  "download_url": "https://minitest.weixin.qq.com/thirdapi/resource/xxxxxxxxxxxxxxxxxxxxxx.zip"
  },
  "msg": null,
  "rtn": 0,
  "timestamp": 1669293003.1537051,
  "trace_id": "b3052d8c5008588f"
}

# 取消测试任务

# 简要描述

取消正在测试中的任务，有以下限制条件：
- 提交创建任务一分钟后才能尝试取消
- 只有“创建中”、“排队中”和“测试中”的任务支持取消
- 为了避免设备资源浪费，创建任务五分钟后不支持取消（采购专有云项目不受此限制）

# 请求URL

https://minitest.weixin.qq.com/thirdapi/plan/cancel

# 请求方式

POST

# 参数

参数名	必选	类型	说明
token	是	string	可以从页面右上角头像右侧下拉菜单中的 “我的信息” 获取
group_en_id	是	string	项目英文ID，可在项目管理/产品管理页面获取
plan_id	是	int	测试任务id，新建任务接口返回的plan_id值，或参见自动化任务管理/测试任务页面

# 返回示例

{
  "data": null,
  "msg": "",
  "rtn": 0,
  "timestamp": 1669293003.1537051,
  "trace_id": "b3052d8c5008588f"
}

# 备注

请关注rtn返回值是否为 0，当且仅当取消成功时返回 0，否则请关注msg字段内容。