phtrivier

phtrivier

Using Application.get_env / Application.put_env in ExUnit tests

Should it be safe to use Application put/get env in multiple tests ?
Assuming I “clean” the env at the setup of each tests, is it possible that env “leaks” between tests ?
For example this seems to work, but is there any guarantee that it won’t fail once in a blue moon ?

defmodule SUT do
   def act() do
      x = Application.get_env(:app, :params)[:x]
      # .... Use x for whatever 
   end
end

defmodule Case1 do 
  use ExUnit.Case

  setup do 
    Application.put_env(:app, :params, x: nil)
  end

  test "Code that needs x to be 0" do
    Application.put_env(:app, :params, x: 0)
    SUT.act()
  end

  test "Code that needs x to be 1" do
    Application.put_env(:app, :params, x: 1)
    SUT.act()
  end
end

defmodule Case2 do 
  use ExUnit.Case

  setup do 
    Application.put_env(:app, :params, x: nil)
  end

  test "Code that needs x to be 3" do
    Application.put_env(:app, :params, x: 3)
    SUT.act()
  end
end

(In particular, I’m not clear about whetever a Process is run for each test, for each case, etc… and how it might interact with Application config…)

Most Liked

jtompl

jtompl

If you want a code example for the above, it would be like this:

defmodule MyTest do
  use ExUnit.Case, async: false

  setup do
    put_application_env_for_test(:some_app, :some_key, :some_value)
  end

  defp put_application_env_for_test(app, key, value) do
    previous_value = Application.get_env(app, key)
    Application.put_env(app, key, value)
    on_exit(fn -> Application.put_env(app, key, previous_value) end)
  end
end
12
Post #3
hubertlepicki

hubertlepicki

This will break as soon as you use async: true in your tests. Which may or may not be a problem for you.

You probably also want to do the cleanup after the tests, not before. If the tests run in random order, they will jump to some other test file after these tests are done, and the variables may be affecting the behavior in other tests. If you do the cleanups in setup blocks executed before each test here, you want to do it in other test files as well. Otherwise weird things will happen.

Alternative to this is to clean up in on_exit callback: https://hexdocs.pm/ex_unit/ExUnit.Callbacks.html#on_exit/2

So you can go with what you have provided:

  1. the tests are async: false
  2. the cleanup is done in on_exit block
axelson

axelson

Scenic Core Team

If you use ProcessTree then you can effectively modify the application environment for most processes while keeping the ability to use async: true tests. It works by looking for env first in the process dictionary of the current process, and then the dictionary of all ancestor and caller processes:

I’ve been using it quite a bit and it’s a really nice way to allow using the application environment while still using async: true.

Where Next?

Popular in Questions Top

joaquinalcerro
Hi there, I am working with Ecto-Postgresql and I need to call all of the records from a specific table but the table has 40,000 record...
New
Werner
Hi, I’m using Ubuntu 18.04 and after updating to OTP-24.0 yesterday i have this warning when I run “mix local.hex”: 14:57:30.512 [warn] ...
New
quazar
How to set Jason to encode all fields in ecto schema, I don’t care about security and implementing only is taking long list of attributes...
New
mgjohns61585
Could someone help me? I'm making my first elixir program, number guessing game. I can't figure out how to convert the user's guess from ...
New
makeitrein
Hey all, just started picking up Elixir last week and am writing a scraper as a learning project. Baby step #1 is extracting the number ...
New
minhajuddin
I have seen a lot of code which picks the first element from a list using Enum.at(0) instead of List.first. Is there a reason why people ...
New
alice
Hey, Just curious what are the main benefits of Elixir compared to Clojure? When is Elixir more useful than Clojure and vice versa? Th...
New
ovidiubadita
Hey all, I discovered Elixir and I love it. I always wanted to learn a functional programming and I intended to go for Haskell, but afte...
New
kostonstyle
Hi all I want to have a unix time, from the current time plus 1 hour. DateTime.now + 1 hour How to get it in elixir? Thanks
New
Exadra37
Sometimes I want to check if the input into a function is not a blank string. My first approach: defmodule Example do def do_stuff(s...
New

Other popular topics Top

srinivasu
How to handle excepions in elixir? Suppose i have A, B, C ,D, E modules. and each module has get() function. A.get() method will call th...
New
dotdotdotPaul
Okay, I'm having a heck of a time trying to figure out how to best handle the validation of belongs_to associations in Ecto. I'm sure I'...
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
yawaramin
In the Dialyzer docs ( http://erlang.org/doc/man/dialyzer.html#requesting-or-suppressing-warnings-in-source-files ), there is a way to tu...
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
vac
Hi, I'm quite new in Elixir and I'm trying to format a string to a PEM format. I have the certificate value like MIIDBTCCAe2...... and ...
New
minhajuddin
I have seen a lot of code which picks the first element from a list using Enum.at(0) instead of List.first. Is there a reason why people ...
New
ashish173
I am using Ecto timestamps with postgres, I can see the timestamps() use the :naive_dateime but for my use case I wanted to store the ti...
New
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
Fl4m3Ph03n1x
About me? ( if you have nothing better to do than reading about some random guy in the internet :stuck_out_tongue: ) Hello all, this is ...
New

We're in Beta

About us Mission Statement