craigambrose

craigambrose

Unit Testing a GenStage Producer

I’m working on my first GenStage producer, and I want to unit test it as I write the handle demand method. I’m having trouble simplifying the use of GenStage enough to write a simple test. Here’s a very simple producer that when asked for demand, outputs a list of three atoms.

defmodule OutputNonsense do
  use GenStage

  def init(arg) do
    {:producer, :some_kind_of_state}
  end

  def handle_demand(demand, state) when demand > 0 do
    {:noreply, things = [:whatever, :you, :want], state}
  end
end

When it comes to writing a test for this, this is the best I’ve been able to manage. It outputs the three atoms to the console, but never finishes execution.

defmodule OutputNonsenseTest do
  use ExUnit.Case

  test "check the results" do
    {:ok, stage} = GenStage.start_link(OutputNonsense, arg = :unused)

    GenStage.stream([stage])
    |> Stream.each(&IO.inspect/1)
    |> Stream.run()
  end
end

I realise that I’m streaming the results into IO.inspect, rather than collecting them to check in an assert. I’m really not sure how to do that. Would love any pointers.

Marked As Solved

wfgilman

wfgilman

I have a producer which queries tasks from a database table. I test each callback directly.

For example, my handle_demand/2 callback has the following code:

  def handle_demand(demand, state) when demand > 0 do
    limit = demand + state
    get_events(limit)
  end

  ## Helper functions.
  defp get_events(limit) do
    {:ok, {count, events}} = Task.get_waiting_tasks(limit, :requesting)
    {:noreply, events, limit - count}
  end

This is the test I wrote:

test "handle_demand updates state" do
  insert!(:task)
  {:noreply, _tasks, state} = Feeder.handle_demand(50, 100)

  assert state == 149
end

insert!/1 is a factory which inserts a task into the table, so there’s only one event. The callback asks for 50 in addition to the existing 100, but only gets one. So the resulting state is 149.

I dunno whether this is helpful.

Also Liked

vidalraphael

vidalraphael

Usually a create a simple consumer that just forwards every event it receives to the process that started it:

defmodule TestConsumer do
  def start_link(producer) do
    GenStage.start_link(__MODULE__, {producer, self()})
  end

  def init({producer, owner}) do
    {:consumer, owner, subscribe_to: [producer]}
  end

  def handle_events(events, _from, owner) do
    send(owner, {:received, events})
    {:noreply, [], owner}
  end
end

Then I can use it in my tests to assert about the produced events:

defmodule OutputNonsenseTest do
  use ExUnit.Case

  test "check the results" do
    {:ok, stage} = GenStage.start_link(OutputNonsense, arg = :unused)
    {:ok, _cons} = TestConsumer.start_link(stage)

    assert_receive {:received, events}
    # assertions about the events

    # The test consumer will also stop, since it is subscribed to the stage
    GenStage.stop(stage)
  end
end

I hope it helps you somehow

13
Post #3
josevalim

josevalim

Creator of Elixir

This is a good approach. Using GenStage.stream |> Enum.take is also another possibility.

mpl

mpl

GenStage.stream |> Enum.take will return a list, so you can make assertions on it.

Where Next?

Popular in Questions Top

sen
Hi All, I set a environment variables in dev.exs , like below code. when i start server, how can i set the ${enable} value? thanks. d...
New
_russellb
I want to try my hand at web scraping. What tools/libraries do I need to use. I’m hoping to turn this into something professional so don’...
New
Darmani72
If I have a post route which an argument: post /my_post_route/:my_param1, MyController.my_post_handler How would get the post params ...
New
Harrisonl
We have an ECS cluster with 4 services, where each task joins a single cluster, via discovery ECS discovery service. Currently when I de...
New
siddhant3030
Hi, I have to write a raw query for one of my project. But till now I have used ecto queries and don’t have much experience writing raw ...
New
Kurisu
For example for a current url like http://localhost:4000/cosmetic/products?_utf8=✓&query=perfume&page=2, I would like to get: ...
New
lessless
I believe there are people here who are dealing with CSV files import on the daily basis, and since Excel is a really popular tool there ...
New
stefanluptak
Hello everybody, usually, I use a 29" ultra-wide monitor for VSCode which can easily accomodate explorer (files panel) + file with code ...
New
bsollish-terakeet
Credo is smart enough to check for (something like) this: assert length(the_list) == 0 with this response: Checking if an enum is empt...
New
hariharasudhan94
Lets say I have map like this fetching from my database %{"_id" => #BSON.ObjectId<58eb1a7a9ad169198c3dXXXX>, "email" => ...
New

Other popular topics Top

Darmani72
If I have a post route which an argument: post /my_post_route/:my_param1, MyController.my_post_handler How would get the post params ...
New
JeremM34
Hello, how can I check the Phoenix version ? Thanks !
New
vonH
When I run the Plug and I recompile I wind up having to use Ctrl C to quit iex and start again. Witht the help of rlwrap I can use the cu...
New
aalberti333
As the title describes, I’m trying to run Enum.map() over a list of key/value pairs, where the value is a map. My data looks like this: ...
New
grych
Hi folks, Few months ago I have announced the proof-of-concept of the library to manipulate the browsers DOM objects directly from Elixi...
639 52341 488
New
nsuchy
Hi. I’ve noticed that Windows Powershell has it’s own IEX command and you cannot access Elixir’s IEX due to the conflict. This isn’t a cr...
New
klo
Got a question about when to concat vs. prepending items to list then reversing to achieve appending. So i know lists boil down to [1 | ...
New
hariharasudhan94
I would like to know what is the best IDE for elixir development?
New
Qqwy
Update: How to use the Blogs & Podcasts section You can post links to your blog posts or podcasts either in one of the Official Blog...
3271 126479 1222
New
vonH
In asking this question I am more interested about the expressiveness of the language itself and less concerned about the availability of...
New

Latest on Elixir Forum

We're in Beta

About us Mission Statement