moonlunatik

moonlunatik

Compilation error when re-ordering `use Bamboo.Test`

I have a test file that tests some of the emails we send in our app. We had the following use lines:

use MyApp.DataCase, async: true
use Bamboo.Test

We then decided to introduce a credo rule where we order our uses and imports alphabetically. The test was working fine, but if we change the use order we get this error:

== Compilation error in file lib/my_app/event_test.exs ==
** (CompileError) lib/my_app/event_test.exs:2: undefined function setup/2 (there is no such import)
    (bamboo 2.2.0) expanding macro: Bamboo.Test.__using__/1
    lib/my_app/event_test.exs:2: MyApp.EventTest (module)
    (elixir 1.14.0) expanding macro: Kernel.use/1
    lib/my_app/event_test.exs:2: MyApp.EventTest (module)

I imagine that the problem might be something that I’m defining on my DataCase module so here are the contents of the file:

defmodule MyApp.DataCase do
  use ExUnit.CaseTemplate

  alias Ecto.Adapters.SQL.Sandbox
  alias Ecto.Changeset
  alias Ecto.Query
  alias MyApp.DataCase
  alias MyApp.Repo
  alias MyApp.Tracer

  require MyApp.Tracer

  using do
    quote do
      use MyApp.Tracer.TestTracingDecorator

      alias MyApp.Repo

      import Changeset
      import DataCase
      import Ecto
      import Hammox
      import Query

      @moduletag test_case_type: :datacase_test_case
      @decorate_all trace_test(service: :my_app, tags: [test_suite: __MODULE__, test_type: :data_case])
      setup :verify_on_exit!
    end
  end

  setup context do
    Tracer.strict_span "sandbox_checkout" do
      :ok = Sandbox.checkout(Repo)

      unless context[:async] do
        Sandbox.mode(Repo, {:shared, self()})
      end
    end

    # default stubs go here
    Tracer.strict_span "stubbing" do
      # stub datetime so we don't have to mock it everywhere
      Hammox.stub_with(DateTimeMock, MyApp.Utils.DateTime)
      # stub async so we don't have to mock it everywhere
      Hammox.stub(AsyncMock, :cast, fn _function, _opts -> :ok end)

      # this allows us to dynamically stub BankAccountStorageMock
      # by tagging the test with @moduledoc :mock_bank_account_storage
      unless context[:mock_bank_account_storage] do
        # stub BankAccountStorageMock so we don't have to mock it everywhere
        # this mock is only used for cache testing/verification
        Hammox.stub_with(BankAccountStorageMock, MyApp.BankAccount.Storage)
      end

      unless context[:mock_earn_storage] do
        Hammox.stub_with(EarnStorageMock, MyApp.Earn.Storage)
      end

      unless context[:mock_user_storage] do
        Hammox.stub_with(UserStorageMock, MyApp.User.Storage)
      end
    end

    :ok
  end

  @doc """
  A helper that transforms changeset errors into a map of messages.

      assert {:error, changeset} = Accounts.create_user(%{password: "short"})
      assert "password is too short" in errors_on(changeset).password
      assert %{password: ["password is too short"]} = errors_on(changeset)

  """
  def errors_on(changeset) do
    Changeset.traverse_errors(changeset, fn {message, opts} ->
      Regex.replace(~r"%{(\w+)}", message, fn _error_msg, key ->
        opts |> Keyword.get(String.to_existing_atom(key), key) |> to_string()
      end)
    end)
  end
end

Most Liked

benwilson512

benwilson512

Author of Craft GraphQL APIs in Elixir with Absinthe

This is a mistake for use, because order does matter. use injects code, and the sequence of the code injection is semantically significant. I would disable that credo rule and have it only apply to aliases and imports.

Where Next?

Popular in Questions 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
Werner
Hi, I’m using Ubuntu 18.04 and after updating to OTP-24.0 yesterday i have this warning when I run “mix local.hex”: 14:57:30.512 [warn] ...
New
logicmason
Hi there, I'm working through my first release with elixir/phoenix. I've built a release with distillery and found that it crashes when I...
New
lk-geimfari
What is most correct way to open, read and parse JSON file with poison? For example if we have example.json file in root of some projec...
New
hariharasudhan94
I would like to know what is the best IDE for elixir development?
New
lastday4you
I wanted to check elixir version in phoenix because i found that my elixir is 1.5 but when i use Enum.chunk_by it said the function is un...
New
chensan
I have a User schema with a :from_id field set to type :string: defmodule TweetBot.Repo.Migrations.CreateUsers do use Ecto.Migration ...
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
fireproofsocks
Forgive me if this is obvious, but how does one delete a database record WITHOUT selecting it first? https://hexdocs.pm/ecto/Ecto.Repo.h...
New
Patoshizzle
After calling mix ecto.create I get this error: 17:00:32.162 [error] GenServer #PID<0.412.0> terminating ** (Postgrex.Error) FATAL...
New

Other popular topics Top

Qqwy
Update: How to use the Blogs & Podcasts section You can post links to your blog posts or podcasts either in one of the Official Blog...
3268 119930 1237
New
yurko
Here are few pieces of (common) Linux knowledge that we use for reasonably small one server apps. We use Ubuntu but this should work for ...
New
lessless
I believe there are people here who are dealing with CSV files import on the daily basis, and since Excel is a really popular tool there ...
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
AstonJ
You’re a programmer, so you don’t need spoon feeding with the conventional drivel about “this is an integer.” No. You need to know what’s...
New
malloryerik
Hi, this is for people who, like me, have had some friction using .html.heex templates in VSCode. The solution seems to be, in a hyphena...
New
Jim
As a follow up to my earlier question: I have the code compiling and running but not getting a successful login from the rest server. ...
New
polypush135
As many of you may have realized by now (sorry for all the posts here) I’ve been working on a db problem where I’m trying to aggregate a ...
New
minhajuddin
I have seen a lot of code which picks the first element from a list using Enum.at(0) instead of List.first. Is there a reason why people ...
New
ashish173
I am using Ecto timestamps with postgres, I can see the timestamps() use the :naive_dateime but for my use case I wanted to store the ti...
New

We're in Beta

About us Mission Statement