Using Application.get_env / Application.put_env in ExUnit tests

Questions / Help
1

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…)

2

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
2 Likes
3

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
4 Likes