如何在运行用于编写Lua的Kong API网关自定义插件时生成和显示覆盖率

一个快捷的方法是通过修改 Pongo 进行操作。

编辑你的 pongo.sh 文件如下：

• 在 busted 命令中添加覆盖率标志 --coverage
• 调用 luacov 生成报告 luacov
• 显示报告 cat luacov.report.out

找到 busted 的调用位置，我在第 959 行：

"/bin/sh" "-c" "bin/busted --coverage --helper=bin/busted_helper.lua ${busted_params[*]} ${busted_files[*]};luacov;cat luacov.report.out"

安装 luacov，在 assets/Dockerfile 中添加如下内容：

在安装 busted 后添加 luacov：

    && luarocks install busted-htest \
    && luarocks install luacov \

运行 pongo run 结果将会显示如下信息：

[...]
==============================================================================
Summary
==============================================================================

File                                                                              Hits  Missed Coverage
-------------------------------------------------------------------------------------------------------
/kong-plugin/kong/plugins/myplugin/schema.lua                                     105   1      99.06%
/kong-plugin/spec/myplugin/01-schema_spec.lua                                     199   5      97.55%
[...]

你可以基于pongo创建一个docker镜像。

spec/unit/docker/Dockerfile

从kong-pongo-test:2.3.2开始
用户根
RUN luarocks install luacov
工作目录/kong-plugin
COPY . .

spec/unit/docker/run.sh

#!/bin/sh
busted --coverage spec/unit
luacov
cat luacov.report.out

运行

docker build -f spec/unit/docker/Dockerfile -t my-coverage .
docker run my-coverage sh spec/unit/docker/run.sh

Pongo已在这方面得到了一些支持（仍然是PR）。需要注意的是，它只涵盖单元测试，而不是集成测试。

请参见https://github.com/Kong/kong-pongo/pull/184

顺便说一句：其他答案在我看来过于复杂，你可以在.pongo/pongo-setup.sh中添加LuaCov的安装，并将.luacov文件从/kong-plugin移动到/kong。这应该就是必要的全部步骤。

通过传递标志简单地运行带有覆盖率的测试，无需编辑pongo或dockerfile。例如，尝试pongo run -- --coverage。