Fork me on GitHub

测试

测试是软件开发重要的一部分,这节课我们会讲一下如何使用 ExUnit 测试 Elixir 代码,以及测试中的最佳实践方法。

目录

ExUnit

Elixir 自带的测试框架是 ExUnit,它包括的功能足够我们充分测试自己的代码。在继续讲解之前,有一点要注意:测试是通过 Elixir 脚本来执行的,所以测试文件的后缀名必须是 .exs。在运行测试之前,我们要先用 ExUnit.start() 来启动 ExUnit,这一般在 test/test_helper.exs 已经帮我们做了。

上节课我们自动生成的示例项目中,mix 已经帮我们创建了一个简单的测试,你可以在 test/example_test.exs 文件中看到:

defmodule ExampleTest do
  use ExUnit.Case
  doctest Example

  test "the truth" do
    assert 1 + 1 == 2
  end
end

执行 mix test 命令,我们就能运行项目的测试了,执行之后会看到类似下面的输出:

Finished in 0.03 seconds (0.02s on load, 0.01s on tests)
1 tests, 0 failures

断言(assert)

如果你之前写过测试,那对 assert 已经很熟悉了,在有些测试框架中, should 或者 expect 的功能和 assert 一样。

我们在测试文件中使用 assert 宏来检查表达式为真,如果表达式不为真,就会抛出异常,测试也就失败了。为了看看失败的情况,我们修改一下项目的测试,然后运行 mix test:

defmodule ExampleTest do
  use ExUnit.Case
  doctest Example

  test "the truth" do
    assert 1 + 1 == 3
  end
end

这次看到的输出和之前大不相同:

  1) test the truth (ExampleTest)
     test/example_test.exs:5
     Assertion with == failed
     code: 1 + 1 == 3
     lhs:  2
     rhs:  3
     stacktrace:
       test/example_test.exs:6

......

Finished in 0.03 seconds (0.02s on load, 0.01s on tests)
1 tests, 1 failures

ExUnit 会告诉我们错误断言出现的行数,期望的值是什么,实际运行的值是什么。

refute

refuteassert 的关系就像 unlessif 的关系一样,如果要保证某个表达式一定是假的,请使用 refute

assert_raise

有时候会断言某个错误被抛出,我们可以使用 assert_raise 做这件事,我们会在后面 Plug 的课程中看到 assert_raise 的例子。

assert_receive

在 Elixir 语言中,会有很多 actors/processes 之间互相发送消息,因此有时候需要测试某些消息是否被发送。因为 ExUnit 是运行在自己的 process 的,因此可以像其他 process 那样接受消息。你可以使用 assert_received 来断言消息:

defmodule SendingProcess do
  def run(pid) do
    send pid, :ping
  end
end

defmodule TestReceive do
  use ExUnit.Case

  test "receives ping" do
    SendingProcess.run(self)
    assert_received :ping
  end
end

assert_reveived 并不会等待消息,如果需要,你可以使用 assert_reveive 并指定超时时间。

capture_io 和 capture_log

使用 ExUnit.captureIO 可以在不改变原来应用的情况下,捕获应用的输出。只要把生成输出的函数作为参数传进去就行:

defmodule OutputTest do
  use ExUnit.Case
  import ExUnit.CaptureIO

  test "outputs Hello World" do
    assert capture_io(fn -> IO.puts "Hello World" end) == "Hello World\n"
  end
end

ExUnit.CaptureLog 就是捕获 Logger 的输出。

Test 配置

有时候我们需要在执行真正的测试之前做一下配置工作,我们可以使用 setupsetup_all 这两个宏。setup 在某个测试用例之前都会被运行,setup_all 只会在整套测试之前运行一次。它们两个的返回值是元组:{:ok, state},其中 state 可以再后续的测试中被使用。

为了方便举例子,我们把测试代码修改一下,添加上 setup_all

defmodule ExampleTest do
  use ExUnit.Case
  doctest Example

  setup_all do
    {:ok, number: 2}
  end

  test "the truth", state do
    assert 1 + 1 == state[:number]
  end
end

Mocking

Elixir 对 mocking 的建议是:不要使用 mocking。你可能不自觉地想使用 mock,但是它不被 Elixir 社区推荐是有充分理由的。如果你代码遵循良好的设计原则,它们会很容易测试。


分享本页面