uipath-cli
latest
false
重要 :
请注意,此内容已使用机器翻译进行了本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
UiPath CLI 用户指南
uip tm是 Test Manager 工具:它管理 UiPath Test Manager 租户上的测试项目、测试用例、测试集、执行、结果、报告和附件。使用uip tools install tm安装,或调用uip tm …并运行自动安装。有关管理工具安装的命令,请参阅工具(插件)和UIP 工具。
tm是命令前缀 — 绝不是uip test-manager 。使用commandPrefix中的uip tools list列进行确认。
资源
每个资源都有其自己的参考页面。每个页面上设置的动词与uip tm注册的命令匹配 — 运行uip tm --help以确认安装的完整表面。
| 资源 | 用途 |
|---|---|
| 项目 | 创建、列出、更新、删除 Test Manager 项目;设置或清除默认 Orchestrator 文件夹。 |
| 测试用例 | 创建、列出、更新、删除测试用例;链接或取消链接 Orchestrator 自动化;列出结果历史记录;列出包含测试用例的测试集;在测试集中添加或删除测试用例。 |
| 测试集 | 创建、列出、更新、删除测试集;列出包含的测试用例;运行测试集并返回执行 ID。 |
| 执行 | 列出测试集的执行;列出执行的测试用例日志;重试已完成的执行中失败的测试用例。 |
| 结果 | 将测试执行结果下载为 JUnit XML 报告。 |
| 报告 | 获取已完成的执行的摘要报告(计数、通过率、持续时间、失败的案例)。 |
| 附件 | 下载测试用例日志在执行中捕获的附件(屏幕截图、日志、文件)。 |
| 等待 | 轮询测试执行,直到它达到最终状态;超时时返回非零退出代码。 |
tm testcaselogs list-assertions位于测试用例页面上 — 请参阅测试用例。它在运行时注册为单独的testcaselogs子命令,但与测试用例一起记录,因为它会读取附加到测试用例日志的断言工件。
大纲
uip tm <resource> <verb> [options]
uip tm <resource> <verb> [options]
默认输出为--output json 。所有uip tm动词都遵循四个全局选项( --output 、 --output-filter 、 --log-level和--log-file )。
典型流程
Test Manager 资源形成链。完整的 CI 运行通常会端到端地遍历它:
- project — 一次性设置。创建项目(或重用现有项目),并可以选择固定默认的 Orchestrator 文件夹,以便后续命令可以省略
--folder-key。 - 测试用例— 编写测试用例,并使用
testcases link-automation将每个用例链接到 Orchestrator 包入口点。这是使其可运行的步骤。 - 测试集— 使用
testcases add的testsets create将测试用例分组到可执行套件中。 - 运行测试集— 开始运行。返回每个下游命令用作输入的
ExecutionId。 - 等待— 阻止脚本,直到执行到达终止状态(
Passed、Failed、Cancelled)。使用--timeout来控制等待时间。 - 报告/结果/附件— 运行后:结构化摘要 (
report get)、用于 CI 测试仪表板的 JUnit XML 文件 (result download),以及任何捕获的工件 (attachment download)。 - 执行重试— 可选:如果运行失败且可能不稳定,则仅就地重新运行失败的测试用例日志。
相同的流程在终端上临时运行:每个动词都打印一个独立的 JSON 信封,其中包含下一步需要的 ID。
身份验证和作用域
每个uip tm动词都通过活动会话解析租户和项目上下文。请参阅身份验证以了解登录;每个动词上的--tenant / -t标志都会覆盖该一次调用的会话默认值。项目作用域从--project-key解析(或从接受任一值的执行级别动词的--test-set-key派生)。
退出代码
标准 CLI退出代码适用于每个动词。使用一个动词添加域特定行为:
uip tm testsets run后跟uip tm wait— 请参阅执行时退出代码。wait在超时时退出2,因此脚本可以在超时、失败或清理通过时出现分支,而无需解析 JSON。测试失败检测本身通过report get或result download进行,而不是通过运行命令的退出代码进行。
另请参阅
- 概念:UiPath CLI 的组织方式
- 会话— 如何解析租户和项目上下文。
- 脚本编写模式— 适用于 CI 的退出代码分支和 JSON 筛选。
- 输出格式— JSON 信封和
--output-filter。