前言
WordPress 是目前全球使用最广泛的 CMS （内容管理系统），许多网站都基于它来开发。而金丝雀测试（Canary Testing）是一种新兴的软件测试方法，它可以帮助我们更快速地构建和测试应用。
@vitruviantech/wordpress 就是一个将这两种技术结合起来的 npm 包，它可以帮助我们轻松地进行金丝雀测试，并且还提供了其他一些有用的功能。本文将从安装、配置、使用等方面详细介绍该 npm 包的使用教程。
安装
使用 npm 安装 @vitruviantech/wordpress：
npm install @vitruviantech/wordpress --save-dev
以保存开发模式下的依赖。
配置
WordPress API 密钥
在开始使用 @vitruviantech/wordpress 之前，需要先获取一个 WordPress API 密钥。WordPress API 密钥可以在 WordPress 后台的个人资料页面中找到。
将获取到的 WordPress API 密钥添加到环境变量中：
export WPAPIKEY=<WordPress API 密钥>
Canary Tests 配置
在 WordPress 后台中，创建一个自定义字段名为 canary-test，类型为 checkbox，该字段用于标识一个页面是否是金丝雀测试页面。
添加完成后，可以在 WordPress 编辑器页面中勾选该字段，将该页面标记为金丝雀测试页面。
使用
初始化
在使用 @vitruviantech/wordpress 之前，需要先进行初始化，配置 wpapi 和 Canary Tests 相关信息：
-- -------------------- ---- ------- ----- --------- - ------------------------------------ ----- ----- - --- ------------------ ------------ --------- --------------------------------------- --------- ------- --------- ----------- ------- -------------------- --- ----- ----------- - --- ------------------------ ------------------ -------- ------------- ---
获取金丝雀测试页面
const page = await canaryTests.getPage(wpapi);
此时 page 为一个 WordPress 页面对象。
部署金丝雀测试
可以使用 @vitruviantech/wordpress 提供的 deploy 方法来进行部署：
await canaryTests.deploy(wpapi, page);
执行该方法之后，将会在 WordPress 中创建一个新页面，并且把该页面标记为金丝雀测试页面，该页面将被部署到测试环境中。
获取金丝雀测试结果
在金丝雀测试完成后，可以使用 getResult 方法来获取测试结果：
const result = await canaryTests.getResult(wpapi, page);
console.log(result); // { status: 'success' }返回结果为一个 JSON 对象，其中 status 字段表示测试结果。
示例代码
完整的示例代码如下所示：
-- -------------------- ---- -------
----- --------- - ------------------------------------
----- ----- - --- ------------------
------------
--------- ---------------------------------------
--------- -------
--------- -----------
------- --------------------
---
----- ----------- - --- ------------------------
------------------
-------- -------------
---
----- -------- --------------- -
--- -
----- ---- - ----- ---------------------------
---------------- ------- ------
----- ------------------------- ------
--------------------- --- ------ --------
----- ------ - ----- ---------------------------- ------
---------------- --- --------- --------
- ----- ----- -
-------------------
----------------
-
-
----------------结语
通过本文的介绍，相信大家已经掌握了如何使用 @vitruviantech/wordpress 包进行金丝雀测试的方法，同时也了解了其他有用的功能。希望本文可以对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600668e3d9381d61a3540a6c