Asd

Asd

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.

First 10 of 18 Posts Switch mode

axelson

axelson

Scenic Core Team

Thank you for the library, it looks quite interesting. I like how it’s functionality builds upon other Elixir mocking libraries. Can you talk a bit about how it’s implemented? I’m really curious how it’s able to safely override any call to external modules.

Asd

Asd OP

Sure, here it is: How it works — Repatch v1.6.1
Codebase is really small, around 1.5k lines, so you can read it in half an hour

Asd

Asd OP

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.

dimitarvp

dimitarvp

Oh, I would love examples! Any links to PRs / commits to demonstrate a before/after?

mudasobwa

mudasobwa

Creator of Cure

The library looks great. For those who are more of self-controlled code, there is also Bex library to generate behaviours for whatever to be mox’ed.

Asd

Asd OP

Unfortunately, I can’t show the project, but I can give the numbers. It used to be 3 minutes sync tests + 1 minute async tests and now it is just 2 minutes async tests + a couple of seconds of sync tests. My goal is to make it possible to rewrite all tests with async: true.

The only tests I can’t make async are those which perform series of DDL transactions in postgres. Well, I mean, I can make them async by using unique database in each test, but it would consume more time to setup then time saved by async

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)
Asd

Asd OP

Hi, uhh, I mentioned it in “New horizons” because it was worth exploring. And I did some exploration and found out that

  1. DateTime.utc_now uses System.os_time which uses :os.system_time. And :os.system_time can’t be patched
  2. We can patch DateTime.utc_now but it will only replace this call, since, for example, erlang dependencies will use :os.system_time which will always return unpatched, real values
  3. And there are also other functions like :erlang.monotonic_time which return different kinds of time

So my conclusion is that it’s not possible to use Repatch for 100% compatible time traveling. And it is not possible to use anything else, since erts implementation calls posix gettime directly, without any way to change it on erlang side only for some specific process.

My suggestion for you is to try to approach the problem another way: instead of travelling in time in order to make sure that some timers are triggered, you should try to make timeouts for these timers configurable and then set them up in tests accordingly.

spicychickensauce

spicychickensauce

Hmm, ok, thanks for digging.

However, so far, all my use cases of time traveling were possible by patching just NaiveDateTime and similar.
In my projects it mostly comes up with logic that involves ecto timestamps, and for those it is enough.
So I’d be happy with a good enough solution that only patches what’s possible.

But yeah, ideally we’d have travel_to like in rails that just works across the whole ecosystem..

Asd

Asd OP

Well, only thing that I can suggest to improve then is to use Repatch.patch(NaiveDateTime, :utc_now, fn -> ~N[1990-01-01 00:00:00] end) without an agent. You can then overwrite this patch with [force: true] option in the third argument.

But to be honest, I’d have a O_O look on my face if saw a test code like this.

Where Next? Top

Trending in Announcing Top

bluzky
You may know https://ui.shadcn.com/, a UI component library for React. I really love it’s design style and components. I’ve built some co...
387 15136 120
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
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
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
woylie
Phoenix components for pagination, sortable tables and filter forms with Flop and (optionally) Ecto. pagination cursor pagination sorta...
New
kip
Please say hi to a new lib, Astro that aims to deliver easy-to-consume astronomy calculations of practical use. For now it only calculat...
New

Other Trending Topics Top

akoutmos
@hugobarauna and I (Alex Koutmos) have been hard at work on writing a book on Nerves that takes you from simply blinking LEDs to building...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
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
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
matt-savvy
Is there a word for the ~> symbol used in Version strings? Do you also just call it a Squiggle Arrow™ ?!
New

We're in Beta

About us Mission Statement