wanderanimrod / elixir_mock Goto Github PK

View Code? Open in Web Editor NEW

23.0 1.0 2.0 118 KB

Creates clean, concurrent, inspectable mocks from elixir modules

Home Page: https://hexdocs.pm/elixir_mock/

License: MIT License

Elixir 100.00%

elixir testing mocking metaprogramming exunit mock concurrent

elixir_mock's People

Contributors

Stargazers

Watchers

Forkers

joshrieken mpalmer

elixir_mock's Issues

creating mocks in test setup causes mock module name conflict warnings

Create two tests with a setup method that creates a mock module and passes the module to the tests. The tests will raise a module redefinition warning. Find out why this happens.

Tested using the defmock_of macro

defmock_of doesn't work without importing Mockex

`
defmodule MyTest do
use ExUnit.Case
require Mockex

test "fails to compile" do
   with_mock(mock) = defmock_of GenServer do
      def start, do: {:ok, self()}
   end
end

end

This will fail to compile with error cannot invoke def/2 inside function/macro

Bad messaging when call verification fails for matchers

Test

refute_called mock.some_fn(Mockex.Matchers.any())

Message

Did not expect get({:matches, #Function<0.115935979/1 in Mockex.Matchers.InBuilt.any/1>}) to be called but it was.

Add "was called with any number of arguments" verification

Currently,

if I want to verify that a function with arity 3 was called but I don't care about the number of args, I still have to say

import Mockex.Matchers

assert_called mock.function(any(), any(), any())

Suggestion

import Mockex.Matchers

assert_called mock.function, :any_args

# OR for consistency with other matchers

assert_called mock.function(any_number_of_args())

We can't simply use assert_called mock.function because it means "assert called with no args"

Pattern matching in stubbed functions does not record call args correctly

Current behaviour

All within an exunit test context

with_mock(mock) = defmock_of RealModule do
  def is_age_one?(%{age: 1}) do
     {:ok, "age is one"}
  end

  def is_age_one?(%{age: age}) do
    {:error, "age is not one. it is #{age}"}
  end
end

response = mock.is_age_one? %{age: 1, height: 1.74}
assert response == {:ok, "age is one"} #should pass

assert_called mock.is_age_one?(%{age: 1, height: 1.74})
# this fails, only recording the section of the arg in the 
# function's pattern match which is: %{age: 1}

This could also imply that pattern matching with functions in mock definitions does not work correctly, particularly with maps, and possibly with other data structures.

Enforcement of adherence to original typespecs on stubbed functions?

Is this even possible?

Inject context into mock definitions

Mock definitions do not allow context from the test defining the mocks

test "my test" do
  my_var = 10
  with_mock(my_mock) = defmock_of RealModule do
    def stubbed, do: my_var
  end
  
  my_mock.stubbed() # Will raise 'undefined function my_var'
end

Proposal

test "my test" do
  my_var = 10
  with_mock(my_mock) = defmock_of RealModule, %{injected_var: my_var} do
    def stubbed, do: mockex_context(:injected_var)
  end
  
  my_mock.stubbed() # => 10
end

Private functions on mock modules not accessible by public functions

code

with_mock(mock_elastic) = defmock_of Tirexs.HTTP do
  def get("/sensor_messages/_search" <> anything_else) do
     Store.EventsRepoTest.sensor_events_in_db() |> to_es_response
  end

  defp to_es_response(events) do
    {:ok, 200, %{hits: %{
        hits: events,
        total: length(events)}}
    }
  end
end

raises

  1) test should find sensor messages by sensor id (Store.EventsRepoTest)
     test/lib/events_repo_test.exs:23
     ** (CompileError) test/lib/events_repo_test.exs:10: undefined function to_es_response/1
     stacktrace:
       (stdlib) lists.erl:1338: :lists.foreach/2
       (elixir) src/elixir_module.erl:97: :elixir_module.do_compile/5
       (elixir) src/elixir_lexical.erl:17: :elixir_lexical.run/3
       test/lib/events_repo_test.exs:8: Store.EventsRepoTest.__ex_unit_setup_0/1
       test/lib/events_repo_test.exs:1: Store.EventsRepoTest.__ex_unit__/2

Since mocks are not allowed to define public functions not defined on the original modules, making the to_es_response function public is not a feasible workaround