Pavlov v0.2.3 → Overview → Pavlov → Case

Pavlov.Case

Summary
Macros

Use this module to prepare other modules for testing.

Example

defmodule MySpec do
  use Pavlov.Case
  it "always passes" do
    assert true
  end
end

Source

Summary↑

describe(desc, \\ {:_, [], Pavlov.Case}, pending \\ false, contents)	You can nest your tests under a descriptive name. Tests can be infinitely nested
it(desc, var \\ {:_, [], Pavlov.Case}, contents)	The cornerstone BDD macro, “it” allows your test to be defined via a string
let(name, contents)	Allows lazy initialization of subjects for your tests. Subjects created via “let” will never leak into other contexts (defined via “describe” or “context”), not even those who are children of the context where the lazy subject is defined
subject(contents)	You can use `subject` to explicitly define the value that is returned by the subject method in the example scope. A subject declared in a context will be available in child contexts as well
xdescribe(desc, \\ {:_, [], Pavlov.Case}, contents)	Defines a group of tests as pending. Any other contexts nested within an xdescribe will not run as well
xit(description, var \\ {:_, [], Pavlov.Case}, contents)	Allows you specify a pending test, meaning that it is never run

Macros

describe(desc, \\ {:_, [], Pavlov.Case}, pending \\ false, contents)

(macro) # ↑

You can nest your tests under a descriptive name. Tests can be infinitely nested.

Source

it(desc, var \\ {:_, [], Pavlov.Case}, contents)

(macro) # ↑

The cornerstone BDD macro, “it” allows your test to be defined via a string.

Example

it "is the truth" do
  assert true == true
end

Source

let(name, contents)

(macro) # ↑

Allows lazy initialization of subjects for your tests. Subjects created via “let” will never leak into other contexts (defined via “describe” or “context”), not even those who are children of the context where the lazy subject is defined.

Example:

let :lazy do
  "oh so lazy"
end

it "lazy initializes" do
  assert lazy == "oh so lazy"
end

Source

subject(contents)

(macro) # ↑

You can use subject to explicitly define the value that is returned by the subject method in the example scope. A subject declared in a context will be available in child contexts as well.

Example:

describe "Array" do
  subject do
    [1, 2, 3]
  end

  it "has the prescribed elements" do
    assert subject == [1, 2, 3]
  end

  context "Inner context" do
    it "can use an outer-scope subject" do
      assert subject == [1, 2, 3]
    end
  end
end

Source

xdescribe(desc, \\ {:_, [], Pavlov.Case}, contents)

(macro) # ↑

Defines a group of tests as pending. Any other contexts nested within an xdescribe will not run as well.

Source

xit(description, var \\ {:_, [], Pavlov.Case}, contents)

(macro) # ↑

Allows you specify a pending test, meaning that it is never run.

Example

xit "is the truth" do
  # This will never run
  assert true == true
end

Source