How to test module?

30 March, 2015

Rails 很早就引入了 Concern 层，存放一些跨类的 Module，如何为这些 module 写测试是使用 Rails 的同学共同面对的问题，大家的写法也各有千秋。

一个场景

# Module
module Printable
  def print_pdf
    "I will be exported to be a pdf file"
  end
end

# Class
class Word
  include Printable
end

Printable 被 Class Word 引入，如何为这个 Module 写测试呢？

测试思路1：为 Word 的实例方法写测试，从而间接的测试 Printable

既然 Word 已经 mixin Printable, Word 必然存在 print_pdf 这个实例方法，只需要在 Word 的 test case 中再添加一个 test 既可。

require 'test_helper'

class WordTest < ActiveSupport::TestCase
  #...
  #...

  # test print to pdf method
  # use factory girl to setup data
  test "print pdf" do
    word = create :word
    assert_equal @document.print_pdf, "I will be exported to be a pdf file"
  end
end

很多人会选用这种测试思路，但是缺陷也很明显:

Printable 被多个类 mixin 时，无法在「DRY」和覆盖率之间取舍。

假如 Class Txt 也引入了 Printable，你还要继续在 TxtTest 中补一个测试吗？
Unit 不够小。

Vincent 以前经常提醒我，测试的粒度要小，每个 test 要简洁，方法之间要用 Mock/Stub 解耦合。我深以为然。

测试目标是 Printable, 却间接的通过 Word 去写测试。两者揉合在一起，不像是一个 Unit。
Review 代码时特别难受。

print_pdf 本身并不是 Word 中定义的方法，review 代码的同学可能会犯迷糊:测试文件中怎么莫名其妙出现了这个方法，是继承的？还是 mixin？我要去哪个 Module 中去找这个方法？

测试思路2: just write test for module

require 'test_helper'

class PrintableTest < ActiveSupport::TestCase
  def setup
    @document = Object.new
    @document.extend Printable
  end
  #...
  #...

  # test print to pdf method
  test "print pdf" do
    assert_equal @document.print_pdf, "I will be exported to be a pdf file"
  end
end

这是我在《The Minitest Cookbook》中看到的另外一种测试写作思路。先创建一个对象，然后 extend Printable，然后对这个对象写测试。

这里用到了元编程的一个技巧。当一个对象 extend Printable 时，其实打开了它的 eigenclass, 并且 include 这个模块。这个对象就有了 print_pdf 这个方法，可以十分干净的写一个测试。

这样写测试的好处: Module 的测试非常纯粹，不依赖其他类，像一个真正的 unit。review 代码时看起来比较清爽，不用被绕晕。

如果能把测试代码组织好，力争间接、DRY、更语义化，写测试也是一件十分有趣的事情。