Elixir doctest 对于 returns 随机值的函数失败

Question

我在 Elixir 中有一个函数可以在列表中生成三个随机 RGB 元组。

defmodule Color do



  @doc """
  Create three random r,g,b colors as a list of three tuples

  ## Examples

      iex> colors = Color.pick_color()
      iex> colors
      [{207, 127, 117}, {219, 121, 237}, {109, 101, 206}]

  """
      def pick_color() do
        color = Enum.map((0..2), fn(x)->
          r = Enum.random(0..255)
          g = Enum.random(0..255)
          b = Enum.random(0..255)
          {r, g, b}
        end)
end

当我运行我的测试时，我的 doctests 失败了。生成的元组列表与我的 doctest 中定义的不同。如何为 returns 随机值的函数编写 doctest？

Answer 1

为了使用 doctests 测试函数，您必须能够预测函数的输出。在这种情况下，您无法预测函数的输出。

但是您可以通过常规测试来测试您的功能。

这是一个测试，可以确保 Color.pick_color() 使用模式匹配生成包含 3 个元组的列表：

test "pick color" do
  [{_, _, _}, {_, _, _}, {_, _, _}] = Color.pick_color()
end

您还可以检查每个值是否在 0 和 255 之间，等等

Answer 2

您可以通过设置 :rand 的随机数生成器的种子来使随机函数具有确定性。 This is also how Enum.random/1 is tested in Elixir.

首先，打开iex并将当前进程的种子设置为任意值：

iex> :rand.seed(:exsplus, {101, 102, 103})

然后，运行你的函数在 iex

iex> Color.pick_color()

现在只需将此值与 :rand.seed 调用一起复制到您的 doctest 中。通过显式设置种子，您将从 :rand 模块中的函数获得相同的值，并且 Enum.random/1 在内部使用 :rand。

iex(1)> :rand.seed(:exsplus, {1, 2, 3})
iex(2)> for _ <- 1..10, do: Enum.random(1..10)
[4, 3, 8, 1, 6, 8, 1, 6, 7, 7]
iex(3)> :rand.seed(:exsplus, {1, 2, 3})
iex(4)> for _ <- 1..10, do: Enum.random(1..10)
[4, 3, 8, 1, 6, 8, 1, 6, 7, 7]
iex(5)> :rand.seed(:exsplus, {1, 2, 3})
iex(6)> for _ <- 1..10, do: Enum.random(1..10)
[4, 3, 8, 1, 6, 8, 1, 6, 7, 7]

Elixir doctest 对于 returns 随机值的函数失败

Elixir doctest fails for function that returns random values

elixir

ex-unit