sodapopcan

sodapopcan

How to test that a function is called just once

Perhaps oddly, this is the first time I’ve hit this situation in Elixir: I would like to test that a function has only been called once. My use-case is that I’m writing a wrapper around Ecto’s preload and I want to test that when given a list of structs, the implementation looks something like this:

def my_wrapper(structs, preloads) do
  MyApp.Repo.preload(structs, preloads)
end

and not this:

def my_wrapper(structs, preloads) do
  for struct <- struct do
    MyApp.Repo.preload(struct, preloads)
  end
end

My only idea so far is to create a mock for MyApp.Repo.preload (which is generally considered a no-no) and have it update a count stored in a gen_server every time it’s called. This is certainly a solution, but does anyone have any better ideas? I have looked at the tests for preload itself and did not come away with anything (although perhaps I didn’t look hard enough?)

Asking here before I resort to asking the robots.

Marked As Solved

Asd

Asd

Its can be done in a very ergonomic way with Repatch

First, initialize Repatch in test/test_helper.exs

ExUnit.start()
Repatch.setup()

Second, in test do something like

defmodule WrapperTest do
  use ExUnit.Case, async: true
  use Repatch.ExUnit
  import Repatch, only: [private: 1]
  
  setup do
    Repatch.spy(MyApp.Repo)
  end

  test "my_wrapper/2 preloads once" do
    Wrapper.my_wrapper(structs, preloads)
    assert Repatch.called?(MyApp.Repo.preload(_, _), exactly: :once)
  end
end

Also Liked

jhogberg

jhogberg

Erlang Core Team

trace — OTP 29.0.2 (kernel 11.0.2) ought to do it, just trace it from your test case and make sure you get exactly one message saying it’s been called.

12
Post #2
jstimps

jstimps

Hi, I do this exactly in one of my projects with the trace module! The approach has been a huge help across multiple refactors, to keep performance solid. I love it so much that I wrote a blog post about it.

sodapopcan

sodapopcan

I had a very “duh me” moment last night as I was falling asleep when I realized I asked this question while following along in in almost real time with this thread which mentions Repatch for spying.

That’s a great write-up @jstimps, thanks! I really need to start dipping into Erlang libs as these are things I’m aware of but never think to use.

I’m giving @Asd the check as even though it means adding a dependency, I’ve been meaning to give Repatch a try since it was announced and that API is so nice.

Thanks for the answers, all!

Last Post!

sodapopcan

sodapopcan

I had a very “duh me” moment last night as I was falling asleep when I realized I asked this question while following along in in almost real time with this thread which mentions Repatch for spying.

That’s a great write-up @jstimps, thanks! I really need to start dipping into Erlang libs as these are things I’m aware of but never think to use.

I’m giving @Asd the check as even though it means adding a dependency, I’ve been meaning to give Repatch a try since it was announced and that API is so nice.

Thanks for the answers, all!

Where Next?

Popular in Questions Top

rms.mrcs
Hi, I need to transform a list of numbers into a map where the keys are the indexes and the values are the original values of the list. ...
New
jononomo
I am trying to figure out how Mix knows whether the environment is test, dev, or prod – where is this set? Thanks.
New
Qqwy
Original source of discussion: This topic on the Pragmatic Programmers’ Functional Web Development with Elixir, OTP, and Phoenix forum. ...
New
Lily
In templates/appointment/index.html.eex: &lt;%= for appointment &lt;- @appointments do %&gt; &lt;tr&gt; &lt;td&gt;&lt;%= appoi...
New
WestKeys
Currently suffering from paralysis by [HTTP client] analysis. This is rather unusual in Elixirland as there tends to be consensus on the ...
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
jason.o
In the code below, if the create action is not set to accept “extra_key” as an input, it errors out with a message shown above. Is there ...
New

Other popular topics Top

electic
Hi, I am new to Elixir. I am trying to use the DateTime component to insert a date into MySQL however the there seems to be no way to fo...
New
stefanchrobot
What’s the safe way to decode a JSON string into a struct? I want to avoid calling String.to_atom. Jason.decode can give me a map with st...
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
joeerl
Hello again - after a longish gap I’ve decided I really must dig into Elixir and see what’s been happening here - so I have a few questio...
New
gshaw
What is the idiomatic way of matching for not nil in Elixir? E.g., First way: defp halt_if_not_signed_in(conn, signed_in_account) when...
New
AstonJ
Posting this to see if we can make things easier for people to get into Neovim. If you use Neovim and have a favourite distro please let ...
New

We're in Beta

About us Mission Statement