介绍
TestLink 是一款常用的测试管理工具，通过它我们可以方便地管理测试用例和测试结果等信息。而 testlink-api-client-patched 是与 TestLink API 进行交互的 Node.js 库，可以使我们更便捷地通过代码控制 TestLink 服务端。本文将详细介绍 testlink-api-client-patched 的使用教程。
安装
使用 npm 可以很容易安装 testlink-api-client-patched：
npm install testlink-api-client-patched
使用
在安装 testlink-api-client-patched 后，我们首先需要初始化一个 TestLinkClient 对象：
-- -------------------- ---- -------
--- -------------- - ---------------------------------------
--- ---- - -
------- ---------------
------------- ---------------
---------- -----------------------------------------------------
--
--- ------ - --- ---------------------其中，opts 是一个对象，包含以下三个参数：
apiKey（必填）：用于 TestLink API 认证developerKey（可选）：可用于第三方认证serverUrl（必填）：TestLink 服务端接口地址
初始化完成后，我们可以调用 reportTCResult 方法来向 TestLink 提交测试结果。下面是一个示例：
-- -------------------- ---- -------
-----------------------
-------- --------
------- ----
------------------- -----------------
----------- -------
-- -------- ----- --------- -
-- ----- -
-----------------
- ---- -
----------------------
-
---上述示例中的参数解释如下：
tCaseID：测试用例的 ID，通过 TestLink 界面查看status：测试结果，取值为 p/f/b (通过/失败/阻塞)testCaseExternalID：测试用例的外部 ID，可以在 TestLink 界面设置testPlanID：测试计划的 ID，通过 TestLink 界面查看
深入
除了上述基本用法外，testlink-api-client-patched 还提供了一些高级功能和钩子函数，可以更加灵活地控制测试流程。
1. 报告自定义字段
TestLink 可以为测试报告提供自定义字段，以便在报告中添加更多信息。我们可以在调用 reportTCResult 时，将自定义字段的值作为参数传递：
-- -------------------- ---- -------
-----------------------
-------- --------
------- ----
------------- -
---------------- --------
-
-- -------- ----- --------- -
-- ---
---上述示例中的 MY_CUSTOM_FIELD 可以在 TestLink 界面设置，用于表示需要填报的自定义字段。
2. 利用钩子函数控制测试流程
testlink-api-client-patched 提供了若干个钩子函数，可以在测试执行前，执行后，或发生错误时执行自定义的逻辑。
假设我们需要在测试执行前，对一些资源进行初始化。可以通过设置 beforeTestCaseExecution 钩子函数来实现：
client.beforeTestCaseExecution = function (testcase, callback) {
console.log('测试用例 ' + testcase.testcase_name + ' 开始执行');
// 在此处添加初始化代码
callback();
};当我们调用 reportTCResult 时，beforeTestCaseExecution 将会自动被执行。
3. 处理回调错误
在测试执行过程中，如果出现了错误，我们可以通过设置 handleCallbackError 钩子函数来控制错误的处理方式。比如，我们可以将错误统一记录到日志中：
client.handleCallbackError = function (err, callback) {
console.log('ERROR:', err);
callback();
};上述示例中，当出现错误时， handleCallbackError 将会自动被调用，并将错误信息以 console.log 的形式输出。
总结
本文介绍了如何使用 testlink-api-client-patched 很方便地实现与 TestLink API 的交互，并且还介绍了该库的一些高级特性和钩子函数。使用 testlink-api-client-patched 可以在测试过程中提高效率，加快测试报告的生成过程。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055d2f81e8991b448daebc