RubyUnit Part2 : RubyUnit のススメ

本日のおしながき

• RubyUnitって何？
• RubyUnitの使い方
• Tips of RubyUnit
• RubyUnitの今後

RubyUnitって何？

• XP流に言えば...

  Unit TestをサポートするRuby用のTesting Framework

• Ruby流に言えば...

  クラス単位、モジュール単位、メソッド単位のテストを 支援するためのRubyで書かれたRubyのライブラリ

誰が、いつ、なぜ、作ったの？

• 作者は誰？

  助田 雅紀 （協力者：石井 勝）

• いつできたの？

  1999年10月2日 デビュー

• なぜ作ったの？

  Javaにあって、Rubyに無いのが悔しかったから

RubyUnitって何に使えるの？

• 向く分野は...

  • ある程度の規模の（使い捨てではない）スクリプトのテスト
  • 内部ロジックのテスト
  • 部品（クラス、モジュール、メソッド）のテスト

• 向かない分野は...

  • 使い捨てのプログラム、ワンライナーのテスト
  • ユーザーインターフェースのテスト
  • システム全体のテスト

RubyUnitを使ったテスト

• テストは単独で実行できるRubyのスクリプト
• Rubyの機能をそのまま利用できる
• テストもRubyのプログラミングなので楽しい（？）
• 簡単にテストを実行できる
• テストとプログラミングは交互に（テスト先行）

テストの書き方

1. TestCaseを派生させてテスト用のクラスを宣言する
2. テストとして実行する内容をメソッドとして記述する
3. TestRunnerクラスを使ってテストの実行処理を記述する

単純なスクリプト

• 3行出力する単純なスクリプト

  # foo.rb
  puts "Hello RubyUnit."
  puts "Hello PerlUnit."
  puts "Hello JavaUnit."
  
  Hello RubyUnit.
  Hello PerlUnit.
  Hello JavaUnit.
  

  共通な部分をメソッドにすると ...

メソッドのあるスクリプト

• 共通な部分をunitメソッドで取り出したスクリプト

  # foo.rb
  def unit(lang)
    ???
  end
  
  puts unit("Ruby")
  puts unit("Perl")
  puts unit("Java")
  

  unitメソッドを作ってみよう。まずはテストから。

1. テストクラスの宣言

• テストスクリプトはfoo.rbとは別のファイルに書いていく
• テストクラスの名前に制限はない

• テストを書く = テストクラスを作る

  # testfoo.rb
  require 'runit/testcase'
  class TestUnit < RUNIT::TestCase
  end
  

2. テストメソッドの記述(1)

• TestUnitクラスにテスト本体であるメソッドを書く

• テスト本体のメソッドは、必ず "test" で始める

  # testfoo.rb
  require 'runit/testcase'
  
  class TestUnit < RUNIT::TestCase
    def test_unit
    end
  end
  

2. テストメソッドの記述(2)

• assert_equalを使ってunitメソッドがやるべきことを書く

• unitメソッドを使えるようにfoo.rbをロードする

  # testfoo.rb
  require 'runit/testcase'
  require 'foo'
  
  class TestUnit < RUNIT::TestCase
    def test_unit
      assert_equal("Hello RubyUnit.", unit("Ruby"))
    end
  end
  

3. テストの実行処理

• TestRunnerを使った決り文句

  # testfoo.rb
  require 'runit/testcase'
  require 'runit/cui/testrunner'
  require 'foo'
  
  class TestUnit < RUNIT::TestCase
    def test_unit
      assert_equal("Hello RubyUnit.", unit("Ruby"))
    end
  end
  
  RUNIT::CUI::TestRunner.run(TestUnit.suite)
  

foo.rb側の準備

• foo.rbがロードされるときはメイン処理を実行しないようにする

  # foo.rb
  def unit(lang)
  end
  if $0 == __FILE__
    puts unit("Ruby")
    puts unit("Perl")
    puts unit("Java")
  end
  
  # testfoo.rb
  require 'foo'
  ...(snip)
  

テストの実行

• テストが失敗することを確認するために実行する

  %ruby testfoo.rb
  
  TestUnit#test_unit F.
  Time: 0.097835
  FAILURES!!!
  Test Results:
    Run: 1/1(1 asserts) Failures: 1 Errors: 0
  Failures: 1
    testfoo.rb:7:in `test_unit'(TestUnit): 
    expected:<Hello RubyUnit.> 
    but was:<nil> (RUNIT::AssertionFailedError)
           from testfoo.rb:10
  

Failure と Error

• Failure

  • assert_equalが失敗したとき

    assert_equal("Hello RubyUnit.", unit("Ruby"))
    # ==> RUNIT::AssertionFailedError (= Failure)
    

• Error

  • assert_equal以外のところで予想しない例外が発生したとき

    assert_equal("Hello RubyUnit.", unit)
    # ==> ArgumentError
    

合格を目指して

• 合格を目指してunitメソッドを完成させる

  #foo.rb
  def unit(lang)
    "Hello " + lang + "Unit."
  end
  if $0 == __FILE__
    puts unit("Ruby")
    puts unit("Perl")
    puts unit("Java")
  end
  

• 再度テストを実行すると見事合格！！！

  TestUnit#test_unit .
  Time: 0.085445
  OK (1/1 tests  1 asserts)
  

テストを考えてメソッドを定義

def unit(lang)
  puts "Hello " + lang + "Unit."
end
if $0 == __FILE__ 
  unit("Ruby")
  unit("Perl")
  unit("Java")
end

assert_equalを使ったunitメソッドのテストは？？？

unit メソッドの変更

• Javaのときだけ "Hello JUnit."と出力するようにunitを変更

  • その前にTestUnitを変更

    class TestUnit < RUNIT::TestCase
      def test_unit
        assert_equal("Hello RubyUnit.", unit("Ruby"))
      end
    end
    

    さて、どう書き換える？

assert_equalを追加する方法

class TestUnit < RUNIT::TestCase
  def test_unit
    assert_equal("Hello RubyUnit.", unit("Ruby"))
    assert_equal("Hello JUnit.", unit("Java"))
  end
end

# testfoo.rb の実行結果（抜粋）
TestUnit#test_unit F.
 ...(snip)
Run: 1/1(2 asserts) Failures: 1 Errors: 0
testfoo.rb:8:in `test_unit'(TestUnit): 
expected:<Hello JUnit.> 
but was:<Hello JavaUnit.>

テストメソッドを追加する方法

class TestUnit < RUNIT::TestCase
  def test_unit
    assert_equal("Hello RubyUnit.", unit("Ruby"))
  end
  def test_unit_Java
    assert_equal("Hello JUnit.", unit("Java"))
  end
end

# testfoo.rbの実行結果（抜粋）
TestUnit#test_unit .
TestUnit#test_unit_Java F.
 ...(snip)
Run: 2/2(2 asserts) Failures: 1 Errors: 0
testfoo.rb:10:in `test_unit_Java'(TestUnit): 
expected:<Hello JUnit.> 
but was:<Hello JavaUnit.>

2つの方法の違い

• assert_equalを追加する

  • 手っ取り早い
  • 将来の修正も楽
  • 最初のassert_equalで失敗すると2番目は実行されない
  • 良くも悪くも最初のassert_equalの実行の影響を受ける

• テストメソッドを追加する

  • 元からあるテストメソッドを変更しない
  • 将来の修正は面倒
  • 最初のテストメソッドが失敗しても2番目は実行される
  • お互いのテストメソッドの間の影響度は低い

unitメソッドの変更

• lang が Java のときの処理を追加

  def unit(lang)
    if lang == "Java"
      return "Hello JUnit."
    end
    "Hello " + lang + "Unit."
  end
  

• 今度は合格

  TestUnit#test_unit .
  Time: 0.062706
  OK (1/1 tests  2 asserts)
  

unitメソッドをさらに変更

• よりわかりやすいコードに変更する（リファクタリング）

  • テストに合格する範囲で自由に変更できる

  • テストは修正しない

    def unit(lang)
      flamework = lang + "Unit"
      flamework = "JUnit" if lang == "Java"
      "Hello #{flamework}."
    end
    

Assert メソッド群（一部抜粋）

• assert(condition, msg="")
• assert_equal(expected, actual, msg="")
• assert_instance_of(klass, obj, msg="")
• assert_match(str, regexp, msg="")
• assert_fail(msg)
• assert_exception(ex1, ex2, ...){...}

assert を使うのは最後

• assert_equal(expected, actual) と assert(expected == actual) とでは テストは同じだが、失敗したときの情報量が違う。

  x = 2
  assert_equal(10, x + 7)  
  # ==> expected:<10> but was:<9>
  
  x = 2
  assert(10 == x + 7) 
  # ==> condition is <false:FalseClass>
  

Directoryクラスの開発とテスト

• Directory.new(path)

  • Directoryオブジェクトを生成する

    # directory.rb
    class Directory
      def initialize(path)
        @path = path
      end
    end
    

• Directory#files

  • ディレクトリに含まれるファイル名の配列を返す

Directory#files のテスト

• DirectoryのテストクラスTestDirectory

• Directory#filesのテストメソッドTestDirectory#test_files

  # testdirectory.rb
  require "runit/testcase"
  require "runit/cui/testrunner"
  require "directory"
  class TestDirectory < RUNIT::TestCase
    def test_files
    end
  end
  RUNIT::CUI::TestRunner.run(TestDirectory.suite)
  

テストの準備

• テスト用のディレクトリとファイルの生成

  # testdirectory.rb
  class TestDirectory < RUNIT::TestCase
    def create_file(filename)
      ... # create file
    end
    def test_files
      Dir.mkdir("testdir")
      create_file("testdir/file01")
      create_file("testdir/file02")
      create_file("testdir/file03")
    end
  end
  

テスト対象のオブジェクトの生成

# testdirectory.rb
class TestDirectory < RUNIT::TestCase
  def test_files
    Dir.mkdir("testdir")
    create_file("testdir/file01")
    create_file("testdir/file02")
    create_file("testdir/file03")
    dir = Directory.new("testdir")
  end
end

テスト本体の記述

# testdirectory.rb
class TestDirectory < RUNIT::TestCase
  def test_files
    Dir.mkdir("testdir")
    create_file("testdir/file01")
    create_file("testdir/file02")
    create_file("testdir/file03")
    dir = Directory.new("testdir")
    exp = ["file01", "file02", "file03"]
    assert_equal(exp, dir.files)
  end
end

テストの後始末

• テストで作ったディレクトリとファイルを削除

  # testdirectory.rb
  class TestDirectory < RUNIT::TestCase
    def remove_dir(dir)
      # delete directory and files
    end
    def test_files
      Dir.mkdir("testdir")
      create_file("testdir/file01")
      create_file("testdir/file02")
      create_file("testdir/file03")
      dir = Directory.new("testdir")
      exp = ["file01", "file02", "file03"]
      assert_equal(exp, dir.files)
      remove_dir("testdir")
    end
  end
  

何があろうと後始末を必ず実行

# testdirectory.rb
class TestDirectory < RUNIT::TestCase
  def test_files
    Dir.mkdir("testdir")
    create_file("testdir/file01")
    create_file("testdir/file02")
    create_file("testdir/file03")
    begin
      dir = Directory.new("testdir")
      exp = ["file01", "file02", "file03"]
      assert_equal(exp, dir.files)
    ensure
      remove_dir("testdir")
    end
  end
end

Directory#filesの実装

• 最初にテストに失敗することを確認

• 確認できたらテストに合格するようにfilesメソッドを定義する

  # directory.rb
  class Directory
    def initialize(path)
      @path = path
    end
    def files
      Dir[@path + "/*"].collect {|path|
        File.basename(path)
      }
    end
  end
  

ディレクトリが空のときのテスト

• TestDirectoryにtest_files_emptyメソッドを追加

  # testdirectory.rb
  class TestDirectory < RUNIT::TestCase
    def test_files_empty
      Dir.mkdir("testdir")
      begin
        dir = Directory.new("testdir")
        exp = []
        assert_equal(exp, dir.files)
      ensure
        remove_dir("testdir")
      end
    end
  end
  

test_files と test_files_empty の共通点

• テストの準備

  • テスト用ディレクトリ testdir の作成

    Dir.mkdir("testdir")
    

  • Directoryオブジェクトの生成

    dir = Directory.new("testdir")
    

• テストの後始末

  • テストのためのディレクトリ testdir の削除

    remove_dir("testdir")
    

テストの準備をsetupにまとめる

class TestDirectory < RUNIT::TestCase
  def setup
    Dir.mkdir("testdir")
    @dir = Directory.new("testdir")
  end
  def test_files
    ... (snip)
    assert_equal(exp, @dir.files)
    ... (snip)
  end
  def test_files_empty
    ... (snip)
    assert_equal(exp, @dir.files)
    ... (snip)
  end
end

テストの後始末をteardownにまとめる

class TestDirectory < RUNIT::TestCase
  def setup
    Dir.mkdir("testdir")
    @dir = Directory.new("testdir")
  end
  def teardown
    remove_dir("testdir")
  end
  def test_files
    create_file("testdir/file01")
    create_file("testdir/file02")
    create_file("testdir/file03")
    exp = ["file01", "file02", "file03"]
    assert_equal(exp, @dir.files)
  end
  def test_files_empty
    exp = []
    assert_equal(exp, @dir.files)
  end
end

setup と teardown

• setup

  • テストメソッドを実行する前に毎回必ず実行される
  • setupで例外が発生するとテストメソッドは実行されない
  • テストメソッド共通の準備を定義する

• teardown

  • テストメソッドを実行した後に毎回必ず実行される
  • テストメソッドで例外が発生しても必ず実行される
  • テストメソッド共通の後始末を定義する

• 実行順序

  setup ==> test_files ==> teardown ==>
  setup ==> test_files_empty ==> teardown
  

テストの共通部分をまとめる(1)

• test_filesとtest_files_emptyをよくよく眺めてみれば...

  class TestDirectory < RUNIT::TestCase
    ...(snip)
    def test_files
      create_file("testdir/file01")
      create_file("testdir/file02")
      create_file("testdir/file03")
      exp = ["file01", "file02", "file03"]
      assert_equal(exp, @dir.files)
    end
    def test_files_empty
      exp = []
      assert_equal(exp, @dir.files)
    end
  end
  

テストの共通部分をまとめる(2)

class TestDirectory < RUNIT::TestCase
  ...(snip)
  def test_files
    exp = ["file01", "file02", "file03"]
    exp.each do |file|
      create_file("testdir/" + file)
    end
    assert_equal(exp, @dir.files)
  end
  def test_files_empty
    exp = []
    exp.each do |file|
      create_file("testdir/" + file)
    end
    assert_equal(exp, @dir.files)
  end
end

テストの共通部分をまとめる(3)

class TestDirectory < RUNIT::TestCase
  ...(snip)
  def check_files(files)
    files.each do |file|
      create_file("testdir/" + file)
    end
    assert_equal(files, @dir.files)
  end
  def test_files
    exp = ["file01", "file02", "file03"]
    check_files(exp)
  end
  def test_files_empty
    exp = []
    check_files(exp)
  end
end

Directory.new の改訂

• 存在しないパスを指定したらArgumentError例外

• 存在するパスを指定したときは、そのまま

  Directory.new("err_path") # ArgumentError
  
  Directory.new("normal_path") # OK
  

Directory.new のテストの追加

class TestDirectory < RUNIT::TestCase
  def test_s_new
    assert_exception(ArgumentError) {
      dir = Directory.new("err_path")
    }
  end
  def test_files
  ... (snip)
end

# テストの実行結果（抜粋）
`test_s_new'(TestDirectory): 
expected:<ArgumentError> 
but was:<NO EXCEPTION RAISED>
(RUNIT::AssertionFailedError)

Directory#initialize の実装

class Directory
  def initialize(path)
    if !File.exist?(path)
      raise ArgumentError
    end
    @path = path
  end
  def files
    Dir[@path + "/*"].collect {|path|
      File.basename(path)
    }
  end
end

例外にメッセージをつけてみる

class TestDirectory < RUNIT::TestCase
  def test_s_new
    err = assert_exception(ArgumentError) {
            dir = Directory.new("err_path")
          }
    exp = "Not Found:`err_path'"
    assert_equal(exp, err.message)
  end
  def test_files
  ... (snip)
end

# テストの実行結果（抜粋）
`test_s_new'(TestDirectory): 
expected:<Not Found:`err_path'> 
but was:<ArgumentError>
(RUNIT::AssertionFailedError)

Directory#initialize の修正

class Directory
  def initialize(path)
    if !File.exist?(path)
      raise ArgumentError, "Not Found:`#{path}'"
    end
    @path = path
  end
  def files
    Dir[@path + "/*"].collect {|path|
      File.basename(path)
    }
  end
end

モジュールのテスト

• ダミーのクラスを作ってモジュールの各メソッドを呼び出す

  module ModuleToTest
    def a_method
      ...(snip)
    end
  end
  
  class Dummy
    include ModuleToTest
  end
  
  class TestModuleToTest < RUNIT::TestCase
    def test_a_method
      dummy = Dummy.new
      exp = ...
      assert_equal(exp, dummy.a_method)
    end
  end
  

private メソッドのテスト

• テストは必要ない

  • private メソッドは publicメソッドから利用されているからpublicメソッドだけテストすればいい

• テストは必要

  • すべてのメソッドのテストをすべき
  • テスト用に（派生クラスを作って）メソッドをpublicにする

複数のテストをまとめて実行するための準備

各テストスクリプトの実行部分を

if $0 == __FILE__  〜 end 

で囲っておく

# testfoo.rb
if $0 == __FILE__
  RUNIT::CUI::TestRunner.run(TestUnit.suite)
end

# testdirectory.rb
if $0 == __FILE__
  RUNIT::CUI::TestRunner.run(TestDirectory.suite)
end

複数のテストをまとめて実行する（例１）

# testall.rb
require 'runit/testsuite'
require 'runit/cui/testrunner'

require 'testfoo'
require 'testdirectory'

suite = RUNIT::TestSuite.new

suite.add_test(TestUnit.suite)
suite.add_test(TestDirectory.suite)

RUNIT::CUI::TestRunner.run(suite)

複数のテストをまとめて実行する（例２）

# testall.rb
require 'runit/testsuite'
require 'runit/cui/testrunner'

require 'testfoo'
require 'testdirectory'

suite = RUNIT::TestSuite.new

ObjectSpace.each_object(Class) do |obj|
  if obj.superclass == RUNIT::TestCase
    suite.add_test(obj.suite)
  end
end

RUNIT::CUI::TestRunner.run(suite)

実行例

%ruby testall.rb
TestDirectory#test_files .
TestDirectory#test_files_empty .
TestDirectory#test_s_new .
TestUnit#test_unit .
Time: 0.49818
OK (4/4 tests  6 asserts)

特定のテストメソッドだけ実行する

class TestDirectory < RUNIT::TestCase
  def test_files
  end
  def test_files_empty
  end
  def test_s_new
  end
end

if ARGV.size == 0
  suite = TestDirectory.suite
else
  suite = RUNIT::TestSuite.new
  ARGV.each do |m|
    suite.add_test(TestDirectory.new(m))
  end
end

RUNIT::CUI::TestRunner.run(suite)

実行例

%ruby testdirectory.rb

TestDirectory#test_files .
TestDirectory#test_files_empty .
TestDirectory#test_s_new .
Time: 0.357167
OK (3/3 tests  4 asserts)


%ruby testdirectory.rb test_files_empty

TestDirectory#test_files_empty .
Time: 0.129801
OK (1/1 tests  1 asserts)

c2t.rb テストスクリプトのひな型を生成

%c2t.rb Foo
require 'runit/testcase'
require 'runit/cui/testrunner'

class TestFoo < RUNIT::TestCase

end

if $0 == __FILE__
  if ARGV.size == 0
    suite = TestFoo.suite
  else
    suite = RUNIT::TestSuite.new
    ARGV.each do |testmethod|
      suite.add_test(TestFoo.new(testmethod))
    end
  end
  RUNIT::CUI::TestRunner.run(suite)
end

今後

• GUI版 TestRunner
• テスト結果の永続化、テスト結果の比較
• リファクタリングツール、統合環境
• 埋め込みRubyUnit
• ノウハウのさらなる蓄積、実際の適用例
• ドキュメントの充実
• Acceptance Test のサポート（？）