1. test-unitはじめの一歩

テストユニットを使ってみましょう。

この文書はsampleというgemパッケージを作成しtest-unitを利用する方法について解説します。

2. bundlerとtest-unitのインストール

• 最初にgemの雛形を生成するbundlerをインストールします。
• 次に、test-unitをインストールします。

gem install bundler
gem install test-unit

gem listコマンドでインストールしたパッケージを確認します。 インストールが成功すると、次のような行が出力されます。

gem list
...
bundler (2.6.3, default: 2.6.2)
...
test-unit (3.6.8, 3.6.7)

3. gemテンプレートの作成

次にbundlerコマンドを使ってgemの雛形を作成します。 このコマンドはテストに必要な雛形も生成できます。

bundle gem -t test-unit sampleを実行すると、test-unitを使用したgemの雛形を生成します。

4. テストの実行

rake testコマンドを実行するとtestディレクトリの下にあるテストを実行します。 二つのテストを実行し、一つは成功、もう一つは失敗します。

$ rake test
Loaded suite /path/to/ruby/lib/ruby/gems/3.4.0/gems/rake-13.2.1/lib/rake/rake_test_loader
Started
F
================================================================================
Failure: test: something useful(SampleTest)
/path/to/sample/test/sample_test.rb:13:in 'block in <class:SampleTest>'
     10:   end
     11:
     12:   test "something useful" do
  => 13:     assert_equal("expected", "actual")
     14:   end
     15: end
<"expected"> expected but was
<"actual">

diff:
? expected
? a     ual
? ????     ??
================================================================================
Finished in 0.013737 seconds.
--------------------------------------------------------------------------------
2 tests, 2 assertions, 1 failures, 0 errors, 0 pendings, 0 omissions, 0 notifications
50% passed
--------------------------------------------------------------------------------
145.59 tests/s, 145.59 assertions/s
rake aborted!
Command failed with status (1)

Tasks: TOP => test
(See full trace by running task with --trace)

5. オリジナルのテストを作る

次のルールに従ってオリジナルのテストを作成します。

• testディレクトリの下にテストを作成します。
• ファイルの名前は、xxx_test.rbのようにします。
• テストはsub/testのようなサブディレクトリに置くこともできます。

ディレクトリレイアウトの例

test
|-- sample_test.rb
|-- sub
|   `-- sample2_test.rb
`-- test_helper.rb

サブディレクトリ内のテスト例

require 'test_helper'

module Sub
  class Sample2Test < Test::Unit::TestCase
    def test_that_it_has_a_version_number
      refute_nil ::Sample::VERSION
    end

    def test_it_does_something_useful
      assert false
    end
  end
end

6. 詳細な情報

公式のドキュメントを参照してください。

• test-unit