[DAY16] Data Access Layer 测试

准备工作

在开始介绍如何测试 repository 之前，要先带过有使用的一些套件
本系列文章以 Rspec 作为测试用的框架，并且有使用 FactoryBot 来建立测资。

关於 Rspec 可以阅读下列文章

• 写测试让你更有信心 Part 2 - 为你自己学 Ruby on Rails
• The Definitive RSpec Tutorial With Examples

关於 FactoryBot 可以阅读下列文章

• 规划 FactoryBot 小技巧，你的测试可以做得更好 - 五倍红宝石
• Working Effectively with Data Factories Using FactoryBot

测试概念

1. 透过 FactoryBot 建立测试资料的 aggregate
2. 利用 Repository 中的 save 来存进 DB 中
3. 利用 Repository 中的 find_by_identity 来拿 aggregate
4. 预期从 Repository 拿出来的 aggregate 与 FactoryBot 建立的 aggregate 要一样
5. 利用 Repository 中的 destroy 删除 aggregate
6. 预期 DB 中没有此笔 record

如此专案中的 repository 测试可以通用化成

# repository_spec.rb
RSpec.shared_examples 'a repository' do
  describe '.save' do
    it 'create record by entity' do
      repo.save(entity)
      actual_entity = repo.find_by_identity(identity)
      expect(actual_entity.to_h).to include(entity.to_h)
    end
  end

  describe '.destroy' do
    it 'destroy record by identity' do
      repo.save(entity)
      repo.destroy(entity)
      actual_entity = repo.find_by_identity(identity)
      expect(actual_entity).to be_nil
    end
  end
end

而 domain 内的 repository 测试则写成

# user_repository_spec.rb
require 'rails_helper'

RSpec.describe Repositories::Order do
  it_behaves_like 'a repository' do
    let(:entity) { build_entity }
    let(:identity) { build_identity }
    let(:repo) { described_class.new }
  end

  private

  def build_entity
    create(
      :entity_order,
      serial_number: 'ABC-1234567890',
			status: :refunded,
			puchased_at: Time.zone.now,
			comment: '测试',
    )
  end

  def build_identity
    {
      serial_number: 'ABC-1234567890',
    }
  end
end

# factory/order.rb
FactoryBot.define do
  factory :entity_order, class: 'Entities::Order' do
    serial_number { nil }
    statu s{ nil }
    puchased_at { nil }
    comment { nil }

    skip_create
    initialize_with { new(attributes) }
  end

这样一来，只需要定义好 entity 测资，便可以快速地建立测试，降低建立基础建设的时间。

下一篇将分享团队讨论过关於 DAL 的问题，以及目前的结论。