ESpec 使用教程

ESpec 使用教程

espec Elixir Behaviour Driven Development 项目地址: https://gitcode.com/gh_mirrors/es/espec

1. 项目介绍

ESpec 是一个为 Elixir 语言设计的 BDD（行为驱动开发）测试框架。它受到 RSpec 的启发，主要目的是提供一个接近完美的 DSL（领域特定语言）。ESpec 不是 ExUnit 的包装器，而是一个完全从头开始编写的新测试框架。

ESpec 的特点包括：

• 使用 describe、context、it 等块来组织测试。
• 提供熟悉的匹配器，如 eq、be_close_to、raise_exception 等。
• 可以添加自定义匹配器。
• 支持两种期望语法：使用管道操作符的 expect 语法和当定义了 subject 时的 should 语法。
• before 和 finally 块，类似于 RSpec 的 before 和 after。
• let、let! 和 subject。
• 共享示例。
• 生成的示例。
• 异步示例。
• 使用 Meck 的模拟。
• 文档规格。
• HTML 和 JSON 输出等。

2. 项目快速启动

首先，需要在 mix.exs 文件中将 ESpec 添加到依赖中：

def deps do
  [
    {:espec, "~> 1.9.2", only: :test}
  ]
end

mix deps.get

然后运行以下命令初始化 ESpec：

MIX_ENV=test mix espec.init

这将在 spec 目录下创建一个 spec_helper.exs 文件。

接下来，设置 mix.exs 文件中的 preferred_cli_env：

def project do
  [
    preferred_cli_env: [espec: :test]
  ]
end

或者，可以直接使用以下命令运行测试：

MIX_ENV=test mix espec

将你的 _spec.exs 文件放入 spec 目录，并使用 ESpec 编写测试：

defmodule SyntaxExampleSpec do
  use ESpec

  it do:
    expect true |> to(be_true())

  it "Test with description" do
    4.2 |> should(be_close_to(4, 0.5))
  end
end

运行测试：

mix espec

3. 应用案例和最佳实践

在编写测试时，可以使用 describe、context 和 it 等宏来定义不同的测试场景和案例。以下是一个示例：

defmodule ContextSpec do
  use ESpec

  example_group do
    context "Some context" do
      it do:
        expect "abc" |> to(match(~r/b/))
    end

    describe "Some another context with opts" do
      it do:
        5 |> should(be_between(4, 6))
    end
  end
end

使用 before 和 finally 块可以在测试之前和之后执行代码：

defmodule BeforeAndFinallySpec do
  use ESpec

  before do
    {:shared, a: 1}
  end

  context "Context" do
    before do
      {:shared, b: shared[:a] + 1}
    end

    finally do
      "shared[:b] == 2"
    end

    it do:
      shared[:a] |> should(eq(1))

    it do:
      shared[:b] |> should(eq(2))
  end
end

4. 典型生态项目

ESpec 作为 Elixir 社区的一部分，它可以与许多其他项目一起使用，形成完整的生态系统。以下是一些可能的组合：

• 使用 ExUnit 作为单元测试框架，同时使用 ESpec 进行 BDD 测试。
• 集成 Meck 进行模拟。
• 使用 Distillery 或 Relx 进行项目打包和部署。

通过上述内容，你可以快速上手 ESpec 并开始在 Elixir 项目中进行行为驱动开发。

espec Elixir Behaviour Driven Development 项目地址: https://gitcode.com/gh_mirrors/es/espec