test_run

引数

module

文字列の配列. この入力引数には以下のどれかを指定します

• Scilab内部モジュール名 ("core", "time", ...)またはサブモジュール名 (例: "optimization|neldermead").

• ATOMSモジュールの名前("module_lycee", "nisp", ...). 処理を行うには,このモジュールはtest_run()をコールする前に ロードしておく必要があります.

• モジュールの絶対ディレクトリパス.

test_name

文字列配列

options

文字列配列

no_check_ref

the .dia と .dia.ref が等しい場合, チェックを行いません

no_check_error_output

エラー出力ストリームはチェックされません. Scilabがローカライズされたものが利用できないとエラーを発生する 場合,このオプションを利用できます.

create_ref

.dia.refファイルを作成し, .dia と .dia.refが等しいかどうかをチェックしません.

show_error

エラーが発生した場合直近の10行分の実行行を表示します

show_diff

差異がみつかった場合,diff -uコマンドの結果を 表示します.

list

テストを実行しませんが, 利用可能なテストの一覧を表示します

help

このコマンドの使用方法に関するいくつかの例を表示します

mode_nw

実行時に "-nw" オプションを追加します

mode_nwni

実行時に "-nwni"オプションを追加します

nonreg_tests

回帰的でないテストのみを実行し, ユニットテストをスキップします

unit_tests

ユニットテストのみを実行し,回帰的でないテストをスキップします

skip_tests

テストをスキップします

enable_lt

テストの長時間実行を許可します

short_summary

実行後に統計または実行時間を表示しません (実行回数,成功/失敗/スキップしたテストの回数のみを1行に表示します).

exportToFile

テストの結果をXMLファイルにエクスポートします. このファイルはXUnit形式となります. このオプションの使用により, show_diff および show_error が有効となることに注意してください.

exportToFileで指定したファイルが既に存在する場合, 新規結果は既存のファイルに追加されます.

status

論理値で,エラーが検出されなかった場合に %t, エラーが検出された場合に %f を返します.

説明

ユニットテストおよび非回帰テストライブラリで .tstファイルを探して実行し,成功/失敗に関するレポートを表示します. .tst ファイルはディレクトリ SCI+"/modules/*/tests/unit_tests" およびSCI+"/modules/*/tests/nonreg_tests"で探されます. テストが実行される度に, .diaファイルが生成され, 実行された全コマンドとコンソールに表示されたメッセージのリストが 出力されます. スクリプトが実行された後, この.dia ファイルは, .tst ファイルと同じディレクトリに置かれた.dia.refファイルで と比較されます. 2つのファイルが異なる場合,そのテストは失敗となります.

テストの処理を制御できるように.tstファイルに特殊なタグを挿入できます. これらのタグはScilabコメントとして記述します.

以下に利用可能なタグを示します:

• <-- INTERACTIVE TEST --> このテストは対話的なものであるため,スキップされます.

• <-- LONG TIME EXECUTION --> このテストは長い時間を要するためスキップされます. このテストを有効にするには,以下のオプションを指定してtest_runを コールします: "enable_lt"

• <-- NOT FIXED --> このテストは,既知ではあるが,未修正のバグであるため,スキップされます.

• <-- TEST WITH GRAPHIC --> このテストはオプション "mode_nwni" が使用された場合は実行されません.

• <-- NO TRY CATCH -->

• <-- NO CHECK ERROR OUTPUT --> エラー出力ファイルはチェックされません

• <-- NO CHECK REF --> .dia および.dia.refファイルの比較が行われません.

• <-- ENGLISH IMPOSED --> このテストは-l en_USオプションを指定した場合のみ実行されます.

• <-- FRENCH IMPOSED --> このテストは-l fr_FRオプションを指定した場合のみ実行されます.

• <-- CLI SHELL MODE --> (was: <-- JVM NOT MANDATORY -->) このテストはデフォルトでscilab-cli (nwniモード)でのみ実行されます.

• <-- WINDOWS ONLY --> オペレーティング・システムがWindowsでない場合, このテストはスキップされます.

• <-- UNIX ONLY --> オペレーティング・システムがUnix OSでない場合, このテストはスキップされます.

• <-- LINUX ONLY --> オペレーティング・システムがGNU/Linuxでない場合, このテストはスキップされます.

• <-- MACOSX ONLY --> オペレーティング・システムがMac OS Xでない場合, このテストはスキップされます.

• <-- XCOS TEST --> このテストは全ての必要なXcosライブラリを実行します. このテストはnwモードで実行されます.

各テストは"host"コマンドで生成された別のプロセスで実行されます. これにより,テストにより不安定な環境となる場合でも, カレントのコマンドの実行を継続できます. また,テストは他のテストと独立して実行可能となります.

プラットフォーム毎のテスト

テストの出力が実行されるプラットフォームに依存している場合があります. この場合,.refを全てのプラットフォーム用で同じとならず, いくつかのプラットフォームではユニットテストが失敗する可能性があります. この場合, デフォルトの.refと共に 各プラットフォーム用の.refを作成することができます.

プラットフォーム毎の .refには以下のような拡張子の どれかを付ける必要があります.

• .unix.dia.refはUnixプラットフォーム用,

• .linux.dia.refはGNU/Linuxプラットフォーム用,

• .win.dia.refはWindowsプラットフォーム用,

• .macosx.dia.refはMac OS Xプラットフォーム用.

アルゴリズムは以下のようになります. まず, .ref が探されます. このファイルが存在しない場合, 現在のプラットフォームに応じた以下の プラットフォーム毎の.refファイルが実行されます.

• Windowsプラットフォームの場合: .win.dia.ref,

• Max OS X プラットフォームの場合: .unix.dia.ref, .macosx.dia.ref,

• GNU/Linuxプラットフォームの場合: .unix.dia.ref, .linux.dia.ref.

例

// 全てのテストを実行
// =============================================

test_run();
test_run([]);
test_run([],[]);

// 1つまたは複数のモジュールをテスト
// =============================================

// 1つのモジュールをテスト
test_run('time');

// 複数のモジュールをテスト
test_run(['time','string']);

// サブモジュールをテスト
test_run('optimization|neldermead');

// パスで指定したモジュールを参照
test_run(SCI+'/modules/core');

// 指定したテストを実行
// =============================================

// テストを1つ指定
test_run('time','datenum');

// 複数のテストを指定
test_run('time',['datenum';'calendar']);

// いくつかのテストをスキップ
// =============================================

test_run('time',['datenum';'calendar'],'skip_tests');

// オプション
// =============================================

// .dia と .dia.ref が等しいかどうかをチェックしません
test_run('time','datenum','no_check_ref');

// .dia.refファイルを作成しますが,.diaと.dia.refが等しいかどうかをチェックしません
test_run([],[],'create_ref');

// テストを実行しないが,利用可能なテストの一覧を表示します
test_run([],[],'list');

// このコマンドの使用法に関するいくつかの例を表示します
test_run([],[],'help');

// 非回帰テストのみを実行し,ユニットテストをスキップします
test_run([],[],'nonreg_test');

// ユニットテストのみを実行し,非回帰テストをスキップします
test_run([],[],'unit_test');

// エラー出力 (std err)をチェックしません
test_run('boolean','bug_2799','no_check_error_output');

// 複数のオプションを同時に指定
test_run([],[],['no_check_ref','mode_nw']);

//  (パスで指定した)外部モジュールのユニットテストを実行
test_run('SCI/contrib/toolbox_skeleton')

// XML Xunitファイルにエクスポート
test_run('boolean',[],[],TMPDIR+"/boolean_test_run.xml");
test_run('time','datenum',[],TMPDIR+"/time_datenum_test_run.xml");

内部設計

テストは, テストファイルが置かれたディレクトリではなく, テンポラリディレクトリで実行されます. .tstファイルはテンポラリディレクトリにコピーされた後, テストが実行され,.dia.ref が元の位置にコピーされます.

.tstスクリプトはそのまま実行されません. かわりに,テンポラリディレクトリにコピーされる際に ヘッダとフッタが.tstの先頭と終端に挿入されます. この修正の理由は,出力メッセージを.diaファイルにリダイレクトし, テストが実行された後に,ユーザがログファイルを取得できるように するためです.

履歴