测试未导出的函数

发布于 2024-10-19 13:12:59 字数 283 浏览 0 评论 0原文

我想使用 rebar 和 common_test 测试一些未导出的函数。什么是干净有效的方法来做到这一点？

我的倾向是在编译/测试时设置一个宏，并以这种方式打开/关闭模块中的export_all，具体取决于它是生产还是测试构建。我希望它很简单 - 例如，我不想在从生产切换到测试之前编辑配置文件，反之亦然。但是，我没有找到使用 rebar 将参数传递给 erl 编译器的方法。我错过了吗？

我知道 eunit 可以轻松测试未导出的函数，但我已经让 common_test 的基础设施运行良好，我现在不想改变我的工作流程。

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

睫毛溺水了 2024-10-26 13:12:59

当您为测试运行构建模块时，您只需将 +export_all 添加到您的 erlc 选项即可。您可以使用 rebar.config 文件中的 {erl_opts, [export_all]}. 来执行此操作。我认为您不能在运行时向 rebar 传递额外的 erlc 参数（例如，您不能执行 rebarcompile +export_all）。

回复收藏 0 原文

又怨 2024-10-26 13:12:59

编辑：刚刚意识到您使用了common_test。如果不适用请忽略此回复！

我有一种稍微更先进的方法来测试未导出的函数，其优点是不导出它们，从而使生产代码尽可能完整（只有在某些函数未导出但未检测到时才可能出现错误）测试期间是否导出所有函数）。

这就是使用 Rebar 和 EUnit 的工作原理。

在源文件中，添加以下行：

-ifdef(TEST).
-include("yourmodule_tests.hrl").
-endif.

在 test 文件夹中，添加一个名为 yourmodule_tests.hrl 的文件（例如，与 yourmodule_tests.erl< /code> 在正常情况下）并添加以下内容：

-include_lib("eunit/include/eunit.hrl").

some_test() ->
    ?assertEqual(ok, internal_function()).

将以下配置添加到 rebar.config （如果您已经有 erl_opts，只需将新元组添加到其中list）：

{erl_opts, [{i, "test"}]}.

当您运行rebar eunit时，Rebar将定义TEST环境变量，并且您的代码将被“测试编译”。也就是说，将您的测试包含到模块中，并且测试将能够访问内部函数。

如果您使用除 Rebar 以外的任何其他内容，只需确保在编译测试时使用 erlc -DTEST ... 编译代码即可。

EDIT: Just realised you used common_test. Please ignore this reply if it doesn't apply!

I have a slightly more advanced way of testing un-exported functions that has the benefit of not exporting them, thus keeping the production code as intact as possible (there might be faults that only occur if some functions are not exported, but is not detected during testing if all functions are exported).

This is how it works using Rebar and EUnit.

In your source file, add these lines:

-ifdef(TEST).
-include("yourmodule_tests.hrl").
-endif.

In your test folder, add a file called yourmodule_tests.hrl (in contrast to, for example, yourmodule_tests.erl in the normal case) and add the following contents:

-include_lib("eunit/include/eunit.hrl").

some_test() ->
    ?assertEqual(ok, internal_function()).

Add the following configuration to rebar.config (if you already have erl_opts, just add the new tuple to that list):

{erl_opts, [{i, "test"}]}.

When you run rebar eunit Rebar will define the TEST environment variable and your code will be "test compiled". That is, including your tests into your module and the tests will be able to access internal functions.

If you use anything else than Rebar, just make sure you compile your code with erlc -DTEST ... when your compiling for tests.

回复收藏 0 原文

别把无礼当个性 2024-10-26 13:12:59

您可以添加 rebar 在编译 eunit 时使用的其他编译选项。正如 archaelus 所指出的，您需要 erlc 的 +export_all 选项。将该行添加

{eunit_compile_opts, [export_all]}.

到您的 rebar.config 文件中。 rebar.config.sample 文件中提到了这一点。

You can add additional compile options that are used by rebar when compiling for eunit. As noted by archaelus, you need the +export_all option to erlc. Add the line