对一个在每次运行期间返回不同映射的函数进行文档测试

Question

Let's say that my function returns a map and some of the value may be randomly generated. I'd like to be able to at least test again output type, or in another words - to check from the doctest level weather returned value is a map. Eventually does it contains specific keys. Is it even possible? The function call may look following:

iex> MyApp.function(params, opts)
%{_}

Answer 1

The output can't be a pattern, but you can either use is_map or the match? macro with the pattern %{} , both of which will return true if the value is a map.

iex> is_map MyApp.function(params, opts)
true
iex> match? %{}, MyApp.function(params, opts)
true

Answer 2

While answer by @Dogbert is perfectly correct, it could not be used in all cases. When one needs to check a value that is unpredictable in advance (say, randomly generated,) there is still an ability to do that with ExUnit .

Each run of test suite prints out the Random seed value as the very last line of test run:

Randomized with seed 486290

It might be recorded and passed back to ExUnit.configure/1 . In such a case, random value returned from the function will be the same (it will not change between different runs.)

This trick won't work for data, received from third-party services, of course.