Asd

Asd

Repatch - Everything you need for mocking and patching

Hi,

I am happy to release the Repatch library for mocking and patching implementation in tests and anywhere else. It brings new possibilities which make it possible to make literally any test async.

You can install it and start trying it out in iex right now, while reading the post!

For example,

iex(1)> Mix.install [repatch: "~> 1.1"]
Resolving Hex dependencies...
Resolution completed in 0.01s
New:
  repatch 1.1.0
* Getting repatch (Hex package)
==> repatch
Compiling 3 files (.ex)
Generated repatch app
:ok
iex(2)> Repatch.setup
:ok
iex(3)> Repatch.patch Range, :new, fn l, r -> Enum.to_list(Repatch.super(Range, :new, [l, r])) end
:ok
iex(4)> Range.new 1, 10
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

Continue in the docs: Repatch — Repatch v1.6.1

Features

  1. Patch any function or macro (except NIF and BIF). Elixir or Erlang, private or public, it can be patched!

  2. Designed to work with async: true. Has 3 isolation levels for testing multi-processes scenarios.

  3. Requires no boilerplate or explicit DI. Though, you are completely free to write in this style with Repatch!

  4. Every patch is consistent and applies to direct or indirect calls and any process you choose.

  5. Powerful call history tracking.

  6. super and real helpers for calling original functions.

  7. Works with other testing frameworks and even in environments like iex or remote shell.

  8. Battle-tested in real world production project. Using Repatch instead of Patch reduced time of the whole test suite by 10-20% (depending on amount of cores on the test runner machine) by reducing the time of sync tests by 2 times.

Quick comparison with other tools

  1. Mox is a great library but it works only with behaviours which is a good approach from the architectural point of view, but fails to work in situations when you’re using 3rd-party library without behaviours, what makes you wrap every function you want to mock into the behaviour. However, Repatch inherits allowances and global mode approaches from Mox, but implements them in more efficient genserver-less way.
  2. Patch is a great library too and it has been a good example and Repatch borrows some code from it. Patch doesn’t work with async: true what has been a problem because test suite was getting slower every time it was using Patch. However, Repatch shares same ideas as Patch does.
  3. Mimic is a library I’ve used and loved too and it shares most of it’s features with Repatch, however Repatch is more efficient in local-only (aka private in Mimic terms) patching and has a shared mode. Also, Repatch performs less amount of module recompilations (every module is recompiled at most once) in runtime.

New horizons

Features I describe here are unique to Repatch and they bring new possibilities to write faster tests. Here is a short list of ideas:

  • Patching Application and :application modules for async-friendly application env. I did this in my production project and I was able to make every sync test in the project I have to become async. I did not finish the work and benchmarking this approach yet, but I expect around 30s speedup in the whole suite, which is a lot.
  • Patching DateTime module for time travelling in timestamps. Yes, it’s possible and works for some tests, but I haven’t figured a way to make it work for functions like :erlang.monotonic_time(), so be careful when using these.
  • Patching System for async-friendly system env. I don’t usually write code which reads from system env in non-config files, but some people do and now you can test system env in async tests
  • Patching Process.sleep and Process.send_after for timeouts manipulation. This is also a risky thing to do, but, as the old Russian saying goes “Those who do not risk, do not drink champagne”!

Afterwords

Don’t be afraid to experiment with Repatch and don’t be afraid to experiment in general. This library was born from understanding that long-lived tools and approaches are limited and there is always a way to move forward.

Most Liked

Asd

Asd

Repatch 1.5.0

This is a big update which adds helpers on top of existing patch logic to support

  1. Mox-style define/expect explicit DI mocking for behaviors.
  2. ProtoMock-style define/expect explicit DI mocking for protocols.

That means that you no longer need to install a bunch of separate libraries, some of which require explicit dependency injection boilerplate, others don’t work with async tests, and so on. You no longer need to keep in mind the different limitations of these libraries with Repatch.

I’ve tried this update on the project of mine, I replaced all TestServer/Bypass, Mox, Patch and ProtoMock code with Repatch, made all of the tests async: true and tests now run 2 times faster, while testing code looks much more cleaner as a bonus.

spicychickensauce

spicychickensauce

Thanks for creating Repatch!
I think this is the best of all the mocking libraries with the least restrictions, and it should deserve a lot more recognition from the community.

Patching DateTime module for time travelling in timestamps

Do you have a helper module / small library that you use for this which you can share?
I needed time travel testing in literally every project at some point and I hate to reinvent it every time.

With Repatch I’m currently just doing this, but it’s probably too simple for most situations:

    {:ok, time} = Agent.start_link(fn -> ~N[1990-01-01 00:00:00] end)
    Repatch.patch(NaiveDateTime, :utc_now, fn ->
      Agent.get(time, fn t -> t end)
    end)
    # ...
    Agent.update(time, fn _ -> ~N[2010-01-01 00:00:00] end)
aifrak

aifrak

Thanks for your answer!

I will improve the documentation about this isolate_env option.

Thank you for that!

Perhaps I can implement some setup in the use Repatch.ExUnit to take the mode from test tag, like


@tag repatch_mode: :shared
test "..." do
  Repatch.patch(DateTime, :utc_now, fn -> :ok end) # <- this patch is shared mode now
end

I think it is fine to keep all options together like you previously wrote:

expect(Date, :utc_today, [mode: :shared, exactly: 2], fn -> ~D[2023-04-06] end)

It is indeed more explicit as you said. I just wish that we could add @tag at the top of describe but I don’t think it is possible to do that.

I was just searching a way to avoid adding mode: :shared to all expect inside a LiveView test, because everything inside a LiveView is in the LiveView process or in its child processes. As result, all tests for LiveView will have all have `mode: :shared`.

The trick that I have done so far to avoid repetition of the options was something like this:

@repatch_options [mode: shared, at_least: :once]

Then inside the test:

expect(Date, :utc_today, @repatch_options, fn -> ~D[2023-04-06] end

But maybe this is an anti-pattern as it is then less explicit.

I will follow your way and make it more explicit when I use expect by adding the options [mode: :shared, …] to all my tests.

Last Post!

Asd

Asd

Mock for a protocol is just a module with defstruct plus the module which implmenets the protocol for this mock.

Consider this example

Mix.install [:repatch]

Repatch.setup()

defprotocol Proto do
  def f(x, y)
end

Repatch.Mock.define(My, protocol: Proto)
# It is essentially just the `defmodule` with `defstruct` and `defimpl Proto` inside

my = struct(My, [])

IO.inspect Proto.f(my, 123)
# raises
# ** (Repatch.Mock.NotImplemented) Not implemented
#     Proto.My."REPATCH-f"/2
#     file.ex:11: (file)

Repatch.patch(Proto.My, :f, fn _x, y -> y * 2 end)
# Note that we patch Proto.My module here. It is the module
# which contains specific implementation and it is automatically
# generated and compiled for every `defimpl` (which was done
# during the `Repatch.Mock.define`)
# It is `local` by deafult. If you want, you can override the scope
# and use allowances just like with any other patch

IO.inspect Proto.f(my, 123)
# prints 246

Repatch does not store the reference to the patch state in the structure, it is intentional.


If you could describe your initial problem, I may be able to come up with the way I’d solve it with Repatch

Where Next?

Popular in Announcing Top

KronicDeth
Elixir plugin for JetBrain’s IntelliJ Platform (including Rubymine) This is a plugin that adds support for Elixir to JetBrains IntelliJ...
289 36654 110
New
mischov
import Meeseeks.CSS html = HTTPoison.get!("https://news.ycombinator.com/").body for story &lt;- Meeseeks.all(html, css("tr.athing")) do...
New
treble37
Just looking for a little feedback on a tiny helper library I built - Sometimes I find the need to convert maps with atom keys to maps w...
New
josevalim
EDIT: since Ecto 3.0 final version is out, this post was amended to use the final versions in the instructions below. Hi everyone, We a...
New
tmbb
I’ve been working on two packages (not on hex.pm yet) to build admin interfaces for phoenix apps: bureaucrat - which contains a bunch ...
New
kevinlang
Hey all, We have made an Ecto3 Adapter for SQLite3, ecto_sqlite3! We have successfully on-boarded the full suite of integration tests (...
New
zachdaniel
Ash Framework What is Ash? Ash Framework is a declarative, resource-oriented application development framework for Elixir. A resource can...
New

Other popular topics Top

Qqwy
Update: How to use the Blogs &amp; Podcasts section You can post links to your blog posts or podcasts either in one of the Official Blog...
3271 130286 1222
New
vertexbuffer
Hello, can anybody help here..? I have a list of players and I what to delete an element, but every for loop the list is reverting to ori...
New
grych
Hi folks, Few months ago I have announced the proof-of-concept of the library to manipulate the browsers DOM objects directly from Elixi...
639 54006 488
New
jononomo
I am trying to figure out how Mix knows whether the environment is test, dev, or prod – where is this set? Thanks.
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
gshaw
What is the idiomatic way of matching for not nil in Elixir? E.g., First way: defp halt_if_not_signed_in(conn, signed_in_account) when...
New

We're in Beta

About us Mission Statement