Giter Club home page Giter Club logo

defmock's Introduction

defmock Build Status codebeat badge

Easy mock generation for Elixir.

Installation

Add defmock to your list of dependencies in mix.exs:

def deps do
  [
    {:defmock, github: "thau/defmock", tag: "v0.2.1"}
  ]
end

Usage

defmodule TestedModule do
  def function_with_external_api(external_api) do
    case external_api.call_me() do
      %{status_code: 200} -> :ok
      %{status_code: 404} -> :not_found
    end
  end

  def function_with_external_api_and_args(external_api) do
    case external_api.call_me(:foo, :bar, baz: 2, qux: 4) do
      %{status_code: 200} -> :ok
      %{status_code: 404} -> :not_found
    end
  end
end

defmodule Test do
  use ExUnit.Case
  import Defmock

  test "returns :ok if the external API returns status_code 200" do
    external_api = defmock(call_me: %{status_code: 200})
    assert TestedModule.function_with_external_api(external_api) == :ok
  end

  test "returns :not_found if the external API returns status_code 404" do
    external_api = defmock(call_me: %{status_code: 404})
    assert TestedModule.function_with_external_api(external_api) == :not_found
  end

  test "ensure that external API is being called" do
    external_api = defmock(call_me: %{status_code: 200})
    TestedModule.function_with_external_api(external_api)
    assert external_api.called?(:call_me)
  end

  test "ensure that external API is called with the right arguments" do
    external_api = defmock(call_me: %{status_code: 200})
    TestedModule.function_with_external_api_and_args(external_api)
    assert external_api.called_with?(:call_me, [:foo, :bar, baz: 2, qux: 4])
  end

  test "ensure that external API is called with some matching arguments" do
    external_api = defmock(call_me: %{status_code: 200})
    TestedModule.function_with_external_api_and_args(external_api)
    assert external_api.called_with_match?(:call_me, [:foo, :'_', [baz: :'_', qux: 4])
  end
end

defmock's People

Stargazers

 avatar

Watchers

 avatar

Forkers

zorbash

defmock's Issues

Add called_with?

Make it so that we can pattern match against the return.

Problems:

  • What about multiple calls? How to pattern match them?
  • What to do so that we can check ordered multiple calls?

[idea] Add Defmock.called_with?

A user of the library might want to assert that the mock was called with some arguments.

defmodule TestedModule do
    def function_with_external_api(external_api) do
      case external_api.call_me(%{url: "https://google.com", 
                                                     params: %{q: "tesla model 3"},
                                                     method: :get}) do
        %{status_code: 200} -> :ok
        %{status_code: 404} -> :not_found
      end
    end
end

defmodule Test do
  use ExUnit.Case
  import Defmock

  test "ensure that external API is being called" do
    external_api = defmock(call_me: %{status_code: 200})
    TestedModule.function_with_external_api(external_api)

    assert external_api.called_with?(%{url: "https://google." <> _tld, params: _, method: :get})
  end 
end

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.