Mpanarin

Mpanarin

Hello!

So not so long ago I started learning Elixir (coming from python myself). To ease it up, I started a small project for myself(link). And I am trying to cover the module with tests.
I need an extremely easy thing - mock a function in my module in the tests. So I’ve decided to follow this article

To be more specific:

  1. I need to mock this function
  2. This function is used in function get_config_from_file and i want to test this function.
  3. I define a mock of this module with mox: link
  4. I try to use this mock in a test: link
  5. But when I try to call a function get_config_from_file from this mock, I get an error:
1) test config from file (Spacebrew.Config.Test)
 test/configuration_test.exs:8
 ** (Mox.UnexpectedCallError) no expectation defined for Spacebrew.ConfigMock.get_config_from_file/1 in process #PID<0.193.0>
 code: assert Spacebrew.ConfigMock.get_config_from_file(
 stacktrace:
   (mox) lib/mox.ex:551: Mox.__dispatch__/4
   test/configuration_test.exs:15: (test)

I understand that it says I should write an expect for the function i call. But why? I need it to be an original function from the module and only a paths function to be mocked.

I understand that I am wrong conceptually, I just don’t understand where and when :
Please help, as I am getting frustrated :cry:

Showing Posts 1 to 5

gcauchon

gcauchon

You already have part of the setup to get it to work… In Spacebrew.Config, you define @callback but also provides the implementation which does not make sense.

  • The callbacks should be definde in an “abstract” module
  • The runtime binding (ie module, with @behaviour Spacebrew.Config) should be defined in config.exs
  • You already defined a “virtual” module in test_helper.exs

Since your mock is a virtual module implementing the behaviour, any function required in the scope of a test needs to be mocked.

Mpanarin

Mpanarin OP

Thanks for the answer!

So, basically, mox forces me to make additional abstract modules? Or creating proxy modules for the functions I want to mock? This, to be fair, sounds like a ridiculous overcomplication

LostKobrakai

LostKobrakai

So the issue here is that mox doesn’t use your implementation in lib/configuration.ex. All of the callbacks your behaviour has are expected to be different for your mock and must therefore either be expected to be called or at least stubbed with the functionality mox provides. The mock does not inherit functionality from anywhere it just know’s the contract it needs to apply to.

I hope you’re already aware of the reasons for using behaviours as requirement in mox (if not just ask), but behaviours are the written contract about what different implementing modules need to provide as functions so the system using those modules does work. So think less of it as “switching out a function, which is currently inconvenient”, but more like “switching out one piece of stand-alone functionality for another”. Behaviours make sense for e.g. gen_servers, where boilerplate functionality is provided by otp, but the details are supplied by the user. It also makes sense when using an adapter pattern like in ecto switching out databases or in bamboo/swoosh switching out email providers.

For your paths functionality I’m really wondering if you really need a behaviour (and therefore mock) in there or if your implementation is not flexible enough to get those paths (optionally) passed from a higher level entrypoint, so you can simply pass different values from your test.

peerreynders

peerreynders

Perhaps you are not familiar with Classical (Detroit) vs Mockist (London) Testing.

The classical (pre-mock) approach has been to make test doubles injectable by design, e.g.:

  # in the "API" module
  def get_config_from_file(params),
    do: get_config_from_file(params, &paths/0)

  # perhaps in an "implementation" module
  def get_config_from_file(params, paths) do
    Enum.reduce(paths.(), params, fn x, acc ->
      read_file(x)
      |> case do
           {:ok, content} ->
             Logger.info "\"#{x}\" file found, parsing"
             struct!(acc, parse_data(content))
           {:error, error} ->
             Logger.info "\"#{x}\" file reading error: #{error}"
             acc
         end
    end)
  end
Mpanarin

Mpanarin OP

Thanks a lot for your answer, that is what I needed!

— All posts loaded —

Where Next? Top

Trending in Questions Top

RSP87
I’m working on a project that simulates the bumbl example in the programming phoenix book. It acts almost like an email client. We have a...
New
nseaSeb
Hello, I know there is an approach for handling lists that allows for optimized traversal, but I can’t recall the specific method (somet...
New
brecabral
Documentation While reading the Scoped Routes section, I noticed that the documentation currently refers to a problem without explainin...
New
RemyXRenard
I’m seeing that a list inside a Kino.DataTable will be interpreted as a charlist, even if the Kino.configure() is set to charlists: :as_l...
New
velrest
So my question is quite simple and i have found no conclusive answer on forum, google or AI. Should we use :erlang.float for Integer to ...
New
samoloth
Hi, I’ve just set up an application with ash_authentication. There is only magic link strategy for now, so there is no confirmation add o...
New
asweet-confluent
I recently noticed that Elixir’s Logger defaults its primary log level to :debug when no :logger, :level application configuration is pre...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
marciok
Hi there! We created Gust: A task orchestrator inspired by Airflow. For those who have never heard about Aiflow, it’s a Python-based wor...
New
mhanberg
Hi everyone! The first release candidate for the Expert language server project is now available! We’ve published a press release detai...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Dmk
Xamal is a deployment tool for Elixir apps that deploys native releases to bare metal servers over SSH. It’s a port of GitHub - basecamp/...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews