bats - 我如何在 bats 脚本中回显文件名以进行报告

Question

我运行了一些bats脚本来测试某些功能，如何在脚本中回显 bats 文件名？

我的蝙蝠脚本看起来像：

#!/usr/bin/env bats
load test_helper
echo $BATS_TEST_FILENAME


@test "run cloned mission" {
blah blah blah
}

为了使我的报告显示为：

 ? run cloned mission
 ? run cloned mission
 ? addition using bc
---- TEST NAME IS xxx
 ? run cloned mission
 ? run cloned mission
 ? addition using bc
---- TEST NAME IS yyy
 ? run cloned mission
 ? run cloned mission
 ? addition using bc

但得到了错误

2: syntax error:
operand expected (error token is ".bats
2")

正确的做法是什么？我不想更改它的集合名称只是为了在不同测试之间回显文件名。

谢谢。

Answer 1

TL; 博士

只需setup使用为消息添加前缀#并将其重定向到 fd3（记录在项目 README 中）的组合从函数中输出文件名。

#!/usr/bin/env bats

setup() {
    if [ "${BATS_TEST_NUMBER}" = 1 ];then
        echo "# --- TEST NAME IS $(basename ${BATS_TEST_FILENAME})" >&3
    fi
}

@test "run cloned mission" {
    blah blah blah
}

你所有的选择

只需使用 BASH

最简单的解决方案是迭代所有测试文件并自己输出文件名：

for file in $(find ./ -name '*.bats');do
    echo "--- TEST NAME IS ${file}"
    bats "${file}"
done

此解决方案的缺点是最后会丢失摘要。相反，将在每个文件后给出摘要。

使用setup功能

最简单的解决方案中BATS是输出从文件名setup功能。我认为这是您所追求的解决方案。

代码如下所示：

setup() {
    if [ "${BATS_TEST_NUMBER}" = 1 ];then
        echo "# --- TEST NAME IS $(basename ${BATS_TEST_FILENAME})" >&3
    fi
}

需要注意的几点：

• 输出必须以散列开头 #
• 必须是散列后的空格
• 输出必须重定向到文件描述符3（即>&3）
• 添加了一个检查以仅输出一次文件名（对于第一次测试） 这里的缺点是输出可能会混淆人们，因为它显示为红色。

使用跳过 @test

下一个解决方案是将以下内容添加为每个文件中的第一个测试：

@test "--- TEST NAME IS $(basename ${BATS_TEST_FILENAME})" {
    skip ''
}

这里的缺点是skipped测试数量会增加......

使用外部辅助函数

我能想到的唯一其他解决方案是创建一个位于全局范围内并跟踪其状态的测试助手。

这样的代码看起来像这样：

output-test-name-helper.bash

#!/usr/bin/env bash

create_tmp_file() {
    local -r fileName="$(basename ${BATS_TEST_FILENAME})"

    if [[ ! -f "${BATS_TMPDIR}/${fileName}" ]];then
        touch "${BATS_TMPDIR}/${fileName}"
        echo "---- TEST NAME IS ${fileName}" >&2
    fi
}

remove_tmp_file() {
    rm "${BATS_TMPDIR}/$(basename ${BATS_TEST_FILENAME})"
}

trap remove_tmp_file EXIT

create_tmp_file

然后可以在每个测试中加载：

#!/usr/bin/env bats

load output-test-name-helper

@test "run cloned mission" {
    return 0
}

将主要在这里缺点是没有保证，其中输出是最有可能结束。

从@test,setup和teardown函数外部添加输出可能会导致意外结果。

此类代码也将（至少）为每个测试调用一次，从而减慢执行速度。

打开拉取请求

作为最后的手段，您可以自己修补 BATS 的代码，在 BATS 存储库上打开拉取请求，并希望 BATS 原生支持此功能。

结论

人生就是一堆取舍。选择最符合您需求的解决方案。