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 #2
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: ExUnit.Callbacks — ExUnit v1.20.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:

https://github.com/jbsf2/process-tree

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

vegabook
I’m brand new to Phoenix and I have stripped one of the demo applications to the bone. I just want to get an svg up on the screen. Here i...
New
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 records...
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
PeterCarter
There are pre-rolled solutions for other frameworks that do work. However, Phoenix does not seem to have these. Have people had good expe...
New
aadeshere1
I have a another noob question about loop. Since elixir is immutable, while loop is not directly possible. total = 10 while total != 0 ...
New
jay1
Why is it that the mnesia database isn’t the most preferred database for use in Elixir/Phoenix?
New
vrod
I am using the Starship cross-shell prompt – it seems pretty nice, but I get some errors: [WARN] - (starship::utils): Executing command ...
New

Other popular topics Top

JeremM34
Hello, how can I check the Phoenix version ? Thanks !
New
New
Brian
What is the proper way to load a module from a file in to IEX? In the python world, doing something like this pretty standard: from ....
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
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
WestKeys
Currently suffering from paralysis by [HTTP client] analysis. This is rather unusual in Elixirland as there tends to be consensus on the ...
New

We're in Beta

About us Mission Statement