ex_spec

BDD-like syntax for ExUnit

Monthly Downloads: 1,344

Programming language: Elixir

License: MIT License

Tags: Testing    

Latest version: v2.0.1

README

ExSpec

ExSpec is a simple wrapper around ExUnit that adds Rspec-style macros. Specifically, it adds context and it.

While it takes inspiration from Rspec, ExSpec is significantly simplier. The context macro has only two functions:

1. Aid test organization
2. Prepend to the message of any it defined within its do blocks

The it macro is identical to ExUnit.Case.test except that it is aware of the messages of its surrounding context blocks. It also works seemlessly with ExUnit's describe function.

Other than the functionality described above, ExSpec is just ExUnit. When useing ExSpec, any options provided will be passed to ExUnit.Case (e.g. async: true).

A simple example is shown below. For more examples, see the tests.

Example

defmodule PersonTest do
  use ExSpec, async: true

  describe "name" do
    context "with first and last name" do
      it "joins the names with a space" do
        drew = %Person{first_name: "Drew", last_name: "Olson"}

        assert Person.name(drew) == "Drew Olson"
      end
    end

    context "with only a first name" do
      it "returns the first name" do
        drew = %Person{first_name: "Drew", last_name: nil}

        assert Person.name(drew) == "Drew"
      end
    end
  end
end

Installation

Add ex_spec to your mix.exs dependencies:

def deps do
  [{:ex_spec, "~> 2.0", only: :test}]
end