voger

voger

How to test config options?

I have a library that uses option parser to format the output. The input is a string coming from the code itself, not a shell.

I am using this code to merge the switches given from the user with some predefined switches. The predefined switches are:

  • The default hard coded in the module
  • If are there any coming from config.exs merge them with the hard coded

If the user provides own switches, they will be merged to the predefined switches

defmodule Clouseau.Switches do
  #...
  @predefined_switches [
    file: true,
    full_path: false,
    module: true,
    line: true,
    text: true,
    border: false,
    colors: false
  ]

  #...
  @default_switches Keyword.merge(
                      @predefined_switches,
                      Application.get_env(
                        :clouseau, 
                        :default_switches, 
                        @predefined_switches
                        )
                    )

 #...
  defp apply(switches) do
    Keyword.merge(@default_switches, switches)
  end
end

The @default_switches module attribute is set during compile and Application.put_env(:clouseau, :default_switches, file: false) has no effect.

How can I test that changing the config options changes the behavior of my libray?

So far I came up with this test file.

defmodule SwitchesTest do
  use ClouseauCase

  setup_all  do
    # Save current config if exists
    env_switches = Application.get_env(:clousau, :default_switches)
    # Put new config 
    Application.put_env(:clouseau, :default_switches, file: false)
    # Recompile the file to refresh the @default_switches module attribute
    Kernel.ParallelCompiler.compile(["lib/switches.ex"])

    # On exit revert :default_switches config
    on_exit(fn ->
      # If it existed before put back the old one
      if env_switches do
        Application.put_env(:clouseau, :default_switches, env_switches)
      # if didn't exist before just delete the current one
      else
        Application.delete_env(:clouseau, :default_switches)
      end
      
      # Regenerate the @default_switches module attribute
      Kernel.ParallelCompiler.compile(["lib/switches.ex"])
    end)
  end
end

In the setup_all block I save the current config, recompile the switches module, and on_exit I revert back whatever config was there and recompile once again the switches module.

This works so far but it shows warnings during the test

warning: redefining module Clouseau.Switches (current version loaded from _build/test/lib/clouseau/ebin/Elixir.Clouseau.Switches.beam)
  lib/switches.ex:1

.warning: redefining module Clouseau.Switches (current version defined in memory)
  lib/switches.ex:1

Is there any better way to test the config options? Or maybe a better way to design the switches module but avoiding merging the hard coded switches with the configured every time in runtime?

Most Liked

LostKobrakai

LostKobrakai

LostKobrakai

LostKobrakai

I can see why keeping config in compile time can be desired, but if you can build your library to be configurable at runtime you can test it without being dependent on compile time. If you really want to stay at compile time you might want to look at ex_cldr, which does a bunch of compile time optimazations as well.

OvermindDL1

OvermindDL1

Yeah that’s my issue with the general config style. I still think we need a staged configuration system like I’ve used in other languages. Essentially you have global configuration, which only affects code-gen and acts as defaults for the later stages. Then there is the load-time configs, which should only affect things that happen at load time, in addition to acting as defaults for later stages. Then run-time configuration, which when changed then updates the configuration (users of this should either access it every time they need it, or for something like a database link it should receive an event when it changes so it can update as necessary), which of course acts as defaults for later stages. And finally there is the scoped stage which is where you pass in the configuration overrides to a specific call or instance of something.

This is similar to how I treat my TaskAfter library. I keep meaning to make a StagedConfiguration library for Elixir sometime, it would simplify a lot of my own work…

Where Next?

Popular in Questions Top

sergio
In Ruby, I can go: User.find_by(email: "foobar@email.com").update(email: "hello@email.com") How can I do something similar in Elixir? ...
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
greenz1
I have a phoenix application from which a user can download multiple(5-6) files of size 1MB. I couldn’t find anything related to sending ...
New
JeremM34
Hello, how can I check the Phoenix version ? Thanks !
New
fireproofsocks
Forgive me if this is obvious, but how does one delete a database record WITHOUT selecting it first? Ecto.Repo — Ecto v3.14.0 has exampl...
New
ycv005
I have followed this StackOverflow post to install the specific version of Erlang. And When I am running mix ecto.setup then getting fol...
New
Qqwy
Original source of discussion: This topic on the Pragmatic Programmers’ Functional Web Development with Elixir, OTP, and Phoenix forum. ...
New
dblack
I’ve got an issue with an app and I’ve no idea of how to troubleshoot it. I’m hoping someone here might have seen something similar. I p...
New
romenigld
I am trying to run a deploy with docker and I successfully runned with this command: docker build -t romenigld/blog-prod . but when I t...
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

Other popular topics Top

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
chrismccord
Phoenix 1.4.0 released Phoenix 1.4 is out! This release ships with exciting new features, most notably with HTTP2 support, improved deve...
688 30877 112
New
hariharasudhan94
lets say i have a sample like a = 20; b = 10; if (a > b) do {:ok, "a"} end if (a < b) do {:ok, b} end if (a == b) do {:ok, "equa...
New
jay1
Why is it that the mnesia database isn’t the most preferred database for use in Elixir/Phoenix?
New
pmjoe
I have a relationship of love and hate with Elixir. Lots of things are just absolutely right, but there are some things that are kind of ...
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
freewebwithme
Using vs code and installed ElixirLS: support and debugger. And I got an error popped up on start up says Failed to run ‘elixir’ comma...
New
fayddelight
I tried installing elixir 1.11.2 erlang 23.3.4 via asdf in my zsh shell. Enabled the versions locally and globally. When I list them ...
New
AstonJ
Please see the new poll here: Which code editor or IDE do you use? (Poll) (2022 Edition) It’s been a while since we first asked this, I...
208 31142 143
New
boundedvariable
I am going through the kafka architecture. All the features what the kafka is providing are already in Erlang. I would like hear your opi...
New

We're in Beta

About us Mission Statement