Ruby 2.4.0 リファレンスマニュアル > ライブラリ一覧 > rake/testtaskライブラリ > Rake::TestTaskクラス

class Rake::TestTask

クラスの継承リスト: Rake::TestTask < Rake::TaskLib < Rake::Cloneable < Object < Kernel < BasicObject

要約

ユニットテストを実行するためのタスクを作成するクラスです。

例:

Rake::TestTask.new do |t|
  t.libs << "test"
  t.test_files = FileList['test/test*.rb']
  t.verbose = true
end

以下に test ターゲットの使用例を示します。

例:

rake test                           # run tests normally
rake test TEST=just_one_file.rb     # run just one test file.
rake test TESTOPTS="-v"             # run in verbose mode
rake test TESTOPTS="--runner=fox"   # use the fox test runner

目次

特異メソッド
new
インスタンスメソッド
define libs libs= loader loader= name name= options options= pattern pattern= ruby_opts ruby_opts= test_files= verbose verbose= warning warning=

特異メソッド

new(name = :test) {|t| ... } -> Rake::TestTask[permalink][rdoc]

自身を初期化します。

ブロックが与えられた場合は、自身をブロックパラメータとして与えられた ブロックを評価します。

[PARAM] name:
ターゲット名を指定します。

インスタンスメソッド

define -> self[permalink][rdoc]

タスクを定義します。

libs -> Array[permalink][rdoc]

テスト実行前に $LOAD_PATH に追加するパスを返します。

libs=(libs)[permalink][rdoc]

テスト実行前に $LOAD_PATH に追加するパスをセットします。

[PARAM] libs:
$LOAD_PATH に追加するパスを配列で指定します。
loader -> Symbol[permalink][rdoc]

テストをロードする方法を返します。

loader=(style)[permalink][rdoc]

テストをロードする方法を指定します。

指定できる方法は以下の通りです。

rake

Rake が提供する方法でテストをロードします。デフォルトはこれです。

testrb

Ruby が提供する testrb コマンドを用いてテストをロードします。

direct

コマンドラインで指定したファイルをロードします。

[PARAM] style:
シンボルでテストをロードする方法を指定します。
name -> String[permalink][rdoc]

テストタスクの名前を返します。デフォルトは "test" です。

name=(str)[permalink][rdoc]

テストタスクの名前をセットします。

[PARAM] str:
テストタスクの名前を指定します。
options -> String[permalink][rdoc]

テストスイートに渡すパラメータを返します。

コマンドラインで "TESTOPTS=options" が指定されると、この値を上書きします。 デフォルトは何も指定されていません。

options=(option_str)[permalink][rdoc]

テストスイートに渡すパラメータをセットします。

[PARAM] option_str:
テストスイートに渡すパラメータを指定します。
pattern -> String[permalink][rdoc]

テストファイルにマッチする glob パターンを返します。

デフォルトは 'test/test*.rb' です。

pattern=(pattern)[permalink][rdoc]

テストファイルにマッチする glob パターンを指定します。

ruby_opts -> Array[permalink][rdoc]

テスト実行時に Ruby コマンドに渡されるオプションを返します。

ruby_opts=(options)[permalink][rdoc]

テスト実行時に Ruby コマンドに渡されるオプションをセットします。

[PARAM] options:
配列でオプションを指定します。
test_files=(list)[permalink][rdoc]

明示的にテスト対象のファイルを指定します。

Rake::TestTask#pattern=, Rake::TestTask#test_files= の 両方でテスト対象を指定した場合、両者は一つにまとめて使用されます。

[PARAM] list:
配列か Rake::FileList のインスタンスを指定します。
verbose -> bool[permalink][rdoc]

この値が真である場合、テストの実行結果を詳細に表示します。

verbose=(flag)[permalink][rdoc]

テストの実行結果を詳細に表示するかどうかをセットします。

[PARAM] flag:
真または偽を指定します。
warning -> bool[permalink][rdoc]

この値が真である場合、テスト実行時に ruby -w を実行したのと同じ効果が生じます。

warning=(flag)[permalink][rdoc]

テスト実行時に警告を表示させるかどうかをセットします。

[PARAM] flag:
真または偽を指定します。