stephanos

stephanos

Hi everyone,

I wanted to share rewire with you, a dependency injection library I’ve been working on over the last few weeks. It aims to keep your production code free from testing concerns, works with async tests and any mock.


Example

Given a module such as this:

# this module has a hard-wired dependency on the `English` module
defmodule Conversation do
  def start(), do: English.greet()
end

If you define a mox mock EnglishMock you can rewire the dependency in your unit test:

defmodule MyTest do
  use ExUnit.Case
  use Rewire                                     # (1) activate `rewire`
  import Mox

  rewire Conversation, English: EnglishMock      # (2) rewire `English` to `EnglishMock`

  test "start/0" do
    stub(EnglishMock, :greet, fn -> "g'day" end)
    assert Conversation.start() == "g'day"       # (3) test using the mock
  end
end

Check out all the details at:
https://github.com/stephanos/rewire

And let me know what you think!

Showing Posts 1 to 8

hauleth

hauleth

Looks nice except one thing - why use use instead just plain import? It should work without problems.

marcin

marcin

That’s cool! I’ve been struggling in how to organise a callback mechanism (eg. after creating the record send an email and also generate a receipt), but keep it decoupled enough to be able to test well.
Rewire could help here! Will check it out.

edisonywh

edisonywh

Very interesting. Since it works by aliasing, does that mean it can only be used for unit testing the module directly? For example, if I have a module called Discord, and Discord calls Conversation.start/0, there’s no way to rewire the English reference, is that right?

hauleth

hauleth

From what I see in the code - yes, it works only for modules called directly.

stephanos

stephanos OP

you’re absolutely right! I originally had some compiler hooks in there to update the module attributes but never went back to require after I realized I didn’t need that.

Just updated the docs and shipped a new version to reflect that.

stephanos

stephanos OP

actually, you could stack them:

rewire Conversation, English: EnglishMock
rewire Discord, Conversation: Conversation

You can find a working test case here: rewire/test/rewire_alias_test.exs at master · stephanos/rewire · GitHub

But I’m not sure whether that’s a good testing etiquette. Reaching deeply into module’s might be a smell, depending on the use case.

ruhshan

ruhshan

Hi, very cool!

Is there any way to use it with like… where I declare dependency using compile_env

For example:

@queue Application.compile_env(
          :task_processor,
          :events_queue
        )

def enqueue_create_event(event_id) when is_integer(event_id) and event_id > 0 do
    @queue.enqueue_create_event(event_id)
  end

hauleth

hauleth

It should work just fine if you will mock module that is defined as comp-time config.

— All posts loaded —

Where Next? Top

Trending in Announcing Top

wojtekmach
Hey everyone! Req is an HTTP client for Elixir that I’ve been working on for quite some time. There is already a lot of HTTP clients out...
New
handnot2
Samly can be used to enable SAML 2.0 Single Sign On in a Plug/Phoenix application. This library uses Erlang esaml to provide plug enabl...
New
woylie
Flop is an Elixir library that applies filtering, ordering and pagination parameters to your Ecto queries. offset-based pagination with...
New
restlessronin
The repo is at GitHub - cyberchitta/openai_ex: Community maintained Elixir library for OpenAI API · GitHub. Docs are at OpenaiEx User Gu...
152 11030 135
New
shahryarjb
The Chelekom project is a library of Phoenix and LiveView components generated via Mix tasks to fit developer needs seamlessly. One of i...
New
garrison
Hobbes is a low-level distributed database for the Elixir programming language. Hobbes provides a simple, safe, and scalable storage lay...
New
fuelen
Hi all! I want to present a small library which provides a mix task for generating an Entity-Relationship Diagram for Ecto schemas. You...
New

Other Trending Topics Top

mudasobwa
I am seeing a lot of aplications of Argumentum ad Vericundiam in software discussions. They do link some piece of writing and point us to...
New
bartblast
Hey folks, I just published a post about Hologram’s funding and where the project goes next - the short version: Curiosum as Main Spons...
New
alexslade
Fly’s CEO posted this recently - Turn And Face The Strange · The Fly Blog It says that Fly is going all-in on sprites, which is a worry ...
New
Herve37
We’re evaluating API mocking tools for OpenAPI-based projects and would love to hear what other teams are using. We’re particularly inte...
New
sorenone
Today we’re releasing Oban for Python. Not an Oban client in Python. Not a pythonx wrapper embedded in Elixir. Nope, it’s a fully operati...
New
lawik
I was thinking since Goatmire Elixir turned out pretty good I should maybe do another one. 30th of Sep - 2nd of Oct this year./ The firs...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews