Kiwi的Python API
项目描述
此包允许连接和访问Kiwi TCMS API。
文档
https://tcms-api.readthedocs.io/en/latest/modules/tcms_api.html
变更日志
v13.3 (2024年6月10日)
更新对strtobool()函数的要求和导入
v13.2 (2024年4月27日)
尊重传递给TCMS()类的配置参数,例如
TCMS("https://kiwitcms.example.com/xml-rpc/", "api-bot", "keep-me-secret")
调整.exec()的使用示例和文档。解决问题#77
与测试和构建此包相关的内部更改
v12.9.1 (2024年1月13日)
重构使用代理类模式进行RPC连接刷新,该模式还负责在刷新时调用.login()
v12.9 (2024年1月12日)
每4分钟刷新内部https传输,以避免在执行非常长的测试时在Python 3.10及更高版本上出现ssl.SSLEOFError: EOF occurred in violation of protocol错误。仅限于非kerberos连接!
在User-Agent标题中包含Python版本
在Referer:标题中发送XML-RPC方法名称,以改进日志
v12.8.2 (2023年12月23日)
再次重构在 __init__ 中调用 .login() 方法,因为整个 Kiwi TCMS 测试套件都依赖于这种行为
v12.8.1 (2023年12月22日)
在使用之前限制 TestPlan.name 和 TestCase.summary 的长度,以避免在过滤和创建操作之间出现记录不匹配
v12.8 (2023年12月17日)
创建 TestPlan 时,限制名称长度为 255 个字符
创建 TestCase 时,限制摘要长度为 255 个字符
v12.7 (2023年12月10日)
使用 Python 3.11 构建 & 测试此包
替换自 Python 3.8 起已弃用的 urllib.parse 函数
重构由较新版本的 pylint 报告的问题
重构由 CodeQL 报告的问题
使用 Black 格式化源代码
启用 ReadTheDocs CI
v12.2 (2023年4月4日)
为 plugin_helpers.Backend.update_test_execution() 方法添加新参数。现在在签名末尾接受 start_date 和 stop_date 参数
开始使用 Python 3.9 测试客户端库
v11.4 (2022年7月15日)
在 Windows 上时回退到 C:tcms.conf
[pre-commit.ci] pre-commit autoupdate
v11.3 (2022年5月17日)
使插件能够打印创建/重用 TP/TR 的信息
创建 TestRun 时指定 start_date
v11.2 (2022年5月15日)
通过 TCMS_PREFIX 环境变量使插件前缀可配置。修复了 问题 #6
如果指定,使用 TCMS_PARENT_PLAN 环境变量。将配置父 TestPlan。修复了 问题 #4
引入 plugin_helpers.Backend.name 和 plugin_helpers.Backend.version 属性
将 plugin_helpers.Backend.default_tester_id 转换为缓存的属性
如果 default_tester_id 为空,则使用发送 API 请求的帐户。这避免了使用大多数用户可能未经授权的 User.filter API 方法
对 URL 配置进行健全性检查和清理。参考 问题 #45
v11.1 (2022年5月13日)
允许环境变量 TCMS_DEFAULT_TESTER_ID 覆盖内部查询,直接指向将创建新测试计划、测试运行和更新测试执行的用戶。
围绕 CI 的内部更新
v11.0 (2021年12月5日)
警告:包含向后不兼容的更改!
现在 plugin_helpers.Backend.add_test_case_to_run() 方法返回一个列表
调整针对即将到来的 Kiwi TCMS v11.0 的内部 API 调用
仍与 Kiwi TCMS v10.x API 兼容
开始使用 f-strings。自 Python 3.6 起可用,这是 tcms-api 的最低要求版本
v10.0 (2021年3月2日)
警告:包含向后不兼容的更改!
与 Kiwi TCMS v10.0 或更高版本兼容
v9.0 (2021年1月12日)
警告:包含向后不兼容的更改!
与 Kiwi TCMS v9.0 或更高版本兼容
方法 Backend.build_id() 不再接收 product_id 作为第一个参数!这与 Kiwi TCMS 问题 #246 相关
v8.6.0 (2020年10月28日)
使用子包安装 gssapi,请参阅安装说明
v8.5.0 (2020年8月4日)
修复 CookieTransport 类中的 super() 调用,使此包与 Python 3.8 兼容(Václav Klikar)
v8.4.0 (2020年6月25日)
添加如何安装 gssapi 的说明,因为它们在 Linux 上不提供二进制包
提供 plugin_helpers.Backend.get_statuses_by_weight() 并在找不到 TestExecutionStatus 时回退到它。这将由 Kiwi TCMS 插件使用(Bryan Mutai)
版本8.3.0 (2020年4月10日)
在Linux和Windows上使用gssapi库进行kerberos通信
Windows需要MIT Kerberos,请参阅安装说明
版本8.2.0 (2020年4月2日)
此版本增加了Python编写的Kiwi TCMS插件可以使用的方法和功能。
修改plugin_helpers.Backend.test_case_get_or_create()使其返回元组(dict, bool)。警告:这将破坏现有的插件
plugin_helpers.Backend将使用指定的TCMS_PLAN_ID环境变量。这允许用户选择一个现有的TestPlan以保存新结果。修复了问题#5
添加plugin_helpers.Backend.finish_test_run(),该函数可以被插件调用以指示TestRun已完成
添加plugin_helpers.Backend.default_tester_id()并在更改状态时更新TestExecution.tested_by
创建新的TestRun时使用default_tester_id()
在创建新的测试运行时始终设置TR.manager := TP.author,并确保TestPlan.create()也会指定作者
版本8.1.1 (2020年3月23日)
在Microsoft Windows平台上使用winkerberos依赖项(@mtg-edmund-tse)
在配置文件中设置重命名:use_mod_kerb -> use_kerberos
错误修复:如果已配置kerberos,则不回退到用户/密码
错误修复:根据RFC-4459发送格式正确的授权请求头
错误修复:如果被要求这样做,则通过kerberos票据正确地通过Kiwi TCMS进行身份验证
对于所有请求开始发送User-Agent: tcms-api/<version>
启用带和不带Kerberos的集成测试
启用Windows上的测试
版本8.0.1 (2020年2月10日)
此版本仅与Kiwi TCMS v8.0或更高版本兼容!
不要在TestCase.create API方法中使用已弃用的字段product
将TestCase.is_automated设置为True
版本8.0 (2020年2月9日)
此版本仅与Kiwi TCMS v8.0或更高版本兼容!
调整plugin_helpers模块以反映在Kiwi TCMS v8.0中引入的不兼容API更改
版本6.7.1 (2020年2月7日)
修复了评估use_mod_kerb设置时的错误,这导致总是优先考虑Kerberos,从而在Windows上引起问题。
版本6.7 (2019年4月10日)
此版本仅与Kiwi TCMS v6.7或更高版本兼容!对于旧服务器版本,请使用tcms-api==5.3!
此版本在plugin_helpers中包含破坏性更改!
从TestCaseRun切换到TestExecution API。修复了问题#7
将plugin_helpers.Backend.update_test_case_run()重命名为plugin_helpers.Backend.update_test_execution()
版权
版权(c)2012 Red Hat,Inc。保留所有权利。
版权(c)2017-2023 Kiwi TCMS项目和其贡献者。保留所有权利。
此库是免费软件;您可以在自由软件基金会发布的GNU Lesser General Public License的条款下重新分发和/或修改它;许可证的第2.1版,或者(根据您的选择)任何更高版本。
项目详情
下载文件
下载适用于您平台文件的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。