通过 REST API 调用为 Jira Test Management (tm4j) Cloud 提供功能的 python 包
项目描述
项目总结
提供用于测试自动化集成的 TM4J Cloud REST API 的包。
安装
如何建造
python setup.py sdist
如何安装
# PyPi
pip install tm4j-reporter-api
# Git
pip install git+https://github.com/Klika-Tech/tm4j_reporter_api.git
配置
要使用 TM4J Cloud REST API，您需要先为 TM4J 报告器配置tm4j_api.configure_tm4j_api功能：
from tm4j_reporter_api import tm4j_api
def my_test_run_setup(my_access_key, my_project_key):
tm4j_api.configure_tm4j_api(
api_access_key=my_access_key,
project_key=my_project_key
)
| 参数 | 强制的 | 描述 | 类型 | 例子 |
|---|---|---|---|---|
| api_access_key | 是的 | 用于访问 TM4j 的 API 密钥。要获得它，请参阅说明 | 字符串 | |
| 项目密钥 | 是的 | Jira / TM4J 项目前缀没有尾随破折号 | 字符串 | QT |
用法
测试周期
您需要在TM4J 测试周期中提交测试执行结果。您可以在您的测试运行设置中创建新的 TM4J 测试循环，以便使用它的密钥来提交测试执行结果并使用以下tm4_api.create_test_cycle功能：
from tm4j_reporter_api import tm4j_api
def my_test_run_setup():
tm4j_test_cycle_key = tm4j_api.create_test_cycle(
test_cycle_name="My TM4J test cycle"
)
return tm4j_test_cycle_key
| 参数 | 强制的 | 描述 | 类型 | 例子 |
|---|---|---|---|---|
| test_cycle_name | 是的 | 测试周期的名称 | 字符串 | 我的 TM4J 测试周期 |
| 描述 | 不 | 概述范围的测试周期描述 | 字符串 | 一些功能测试运行 |
| 计划开始日期 | 不 | 测试周期的计划开始日期。格式：yyyy-MM-dd'T'HH:mm:ss'Z' | 字符串 | 2020-07-15'T'12:00:00'Z' |
| 计划结束日期 | 不 | 测试周期的计划结束日期。格式：yyyy-MM-dd'T'HH:mm:ss'Z' | 字符串 | 2020-07-15'T'12:30:00'Z' |
| jira_project_version | 不 | 来自 Jira 的版本 ID | 整数 | 1000 |
| 状态名称 | 不 | 为项目配置的状态名称 | 字符串 | 完毕 |
| 文件夹 ID | 不 | 放置测试周期的文件夹的 ID | 整数 | 10001 |
| owner_id | 不 | 测试周期所有者的 Atlassian Account ID | 字符串 | 377441B7-835D-4B08-B7F4-219E9E62C015 |
测试执行结果
使用 TM4J 测试周期密钥，您现在可以提交测试执行结果。如果需要，您还可以使用现有 TM4J 测试周期的测试周期密钥。将测试周期密钥和测试执行结果传递给tm4j_api.create_test_execution_result函数：
from tm4j_reporter_api import tm4j_api
def my_test_teardown(tm4_test_cycle_key, tm4j_test_case_key, execution_status):
tm4j_api.create_test_execution_result(
test_cycle_key=tm4_test_cycle_key,
test_case_key=tm4j_test_case_key,
execution_status=execution_status
)
| 参数 | 强制的 | 描述 | 类型 | 例子 |
|---|---|---|---|---|
| test_cycle_key | 是的 | 将测试执行放到 TM4J 测试周期的关键 | 字符串 | 信息系统 |
| test_case_key | 是的 | 执行适用的测试用例的键 | 字符串 | SA-T10 |
| 执行状态 | 是的 | 测试执行状态名称 | 字符串 | 经过 |
| test_script_results | 不 | 具有测试步骤结果的对象列表：statusName (str)、actualEndDate (str, yyyy-MM-dd'T'HH:mm:ss'Z')、actualResult (str)。对象数应与 TM4J 测试脚本中的步骤数相匹配。 | 列表 | [{“statusName”：“通过”，“actualEndDate”：“2020-07-15'T'12:30:00'Z'”，“actualResult”：“这一步通过了”}，{“statusName”：“ Fail", "actualEndDate": "2020-07-15'T'12:30:10'Z'", "actualResult": "这一步失败"}] |
| 实际结束日期 | 不 | 执行日期测试。格式：yyyy-MM-dd'T'HH:mm:ss'Z' | 字符串 | 2020-07-15'T'12:30:00'Z' |
| 环境名称 | 不 | 分配给测试用例的环境 | 字符串 | 分期 |
| 执行时间处理时间 | 不 | 实际执行时间（毫秒） | 整数 | 121000 |
| 执行的_by_id | 不 | 执行测试的用户的 Atlassian Account ID | 字符串 | 377441B7-835D-4B08-B7F4-219E9E62C015 |
| 分配给ID | 不 | 分配给测试的用户的 Atlassian 帐户 ID | 字符串 | 377441B7-835D-4B08-B7F4-219E9E62C015 |
| 评论 | 不 | 评论整体测试执行 | 字符串 | 第 2 步测试失败，请咨询开发团队 |
例外
TM4JConfigurationException
如果之前未调用函数，则由tm4j_api.configure_tm4j_api和函数引发：tm4j_api.create_test_execution_resulttm4j_api.configure_tm4j_api
tm4j_reporter_api.tm4j_exceptions.tm4j_configuration_exceptions.TM4JConfigurationException: You must configure TM4J reporter API before calling TM4J, call tm4j_api.configure_tm4j_api method first
TM4JResponseException
如果TM4J Cloud 响应tm4j_api.configure_tm4j_api的tm4j_api.create_test_execution_result响应状态代码不同于201 Created：
tm4j_reporter_api.tm4j_exceptions.tm4j_response_exceptions.TM4JResponseException: Response status code: 400, response message: Bad Request
关
tm4j_reporter_api -0.1.2-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 14d1948b5b3d13e872a0d2247ca18946df4f98ab9e7ff50ce6eac09a955f8322 |
|
| MD5 | 7a7eb0705e6bd9cda4b7519cda8cf439 |
|
| 布莱克2-256 | 58f2671b9583bb1f3550facf42f96c57e39e1e28db762c25e22a419ee0f942a8 |