在 doctest 中测试 HashSet

Question

我正在尝试通过 iex 使用 doctest 测试 HashSet。如果我运行下面的行，它会给出相同的结果，但 #HashSet<["rockerboo"]>} 不能在语法中表示。我想不出一种正确表示它的方法，也找不到任何例子。谢谢！

  @doc """
  Adds user to HashSet in state

  ## Examples
      iex> Elirc.Channel.add_user_to_state("rockerboo", %{users: HashSet.new})
      %{users: #HashSet<["rockerboo"]>}
  """
  def add_user_to_state(user, state) do
    %{state | users: HashSet.put(state.users, user) }
  end

运行mix test时，出现以下错误。

 Doctest did not compile, got: (TokenMissingError) lib/elirc/channel.ex:99: missing terminator: } (for "{" starting at line 99)
 code: %{users: #HashSet<["rockerboo"]>}

第 99 行是%{state...

Answer 1

你可以用不同的方式构造你的HashSet，使它成为一个有效的 Elixir 表达式。例如，这对我有用：

## Examples
  iex> Elirc.Channel.add_user_to_state("rockerboo", %{users: HashSet.new})
  %{users: ["rockerboo"] |> Enum.into(HashSet.new)}

这也是ExUnit.DocTest documentation在“不透明类型”下推荐的方法

Answer 2

Paweł 的回答是正确的。另一种选择是“按摩” doctest 中的数据。例如，这会起作用：

  iex> state = Elirc.Channel.add_user_to_state("rockerboo", %{users: HashSet.new})
  iex> state.users
  #HashSet<["rockerboo"]>

或者：

  iex> state = Elirc.Channel.add_user_to_state("rockerboo", %{users: HashSet.new})
  iex> Enum.to_list(state.users)
  ["rockerboo"]

我扩展了 Paweł 链接的 doctest 部分，以包括他和我的示例：https://github.com/elixir-lang/elixir/blob/64e5f4876007d840edee3040c43e8f98095b8e3d/lib/ex_unit/lib/ex_unit/doc_test.ex#L77

Answer 3

你的问题是你试图表示一些不可能的东西，一个没有键或没有值的 HashDict 条目。 HashDict.put(state.users, "rockerboo") 会失败，因为 put 需要 3 个参数、一个 HashDict、一个键和一个值。假设你有类似name: "rockerboo" 的东西：

iex> %{users: Enum.into([name: "rockerboo"], HashDict.new)} %{users: #HashDict<[name: "rockerboo"]>}

上述工作按预期工作。