Runner

Runner

new Runner(suite, optsopt)

ソース

SuiteとTestの階層を表すルートSuiteでRunnerを初期化します。

Parameters
名前型属性説明
suiteSuite

ルートスイート

optsObject<オプション>

設定オブジェクト

プロパティ
名前型属性説明
cleanReferencesAfterRunboolean<オプション>

スイートが完了したときにテスト関数とフックへの参照をクリーンアップするかどうか。

delayboolean<オプション>

準備ができるまでルートスイートの実行を遅延させるかどうか。

dryRunboolean<オプション>

テストを実行せずにレポートするかどうか。

failZeroboolean<オプション>

見つかったテストがゼロの場合、テスト実行を失敗させるかどうか。

拡張

メンバー

(static, readonly) constants :string

ソース
プロパティ
名前型説明
EVENT_HOOK_BEGINstring

Hookの実行開始時に発行されます

EVENT_HOOK_ENDstring

Hookの実行終了時に発行されます

EVENT_RUN_BEGINstring

ルートSuiteの実行開始時に発行されます（すべてのファイルが解析され、フック/テストが実行準備完了です）

EVENT_DELAY_BEGINstring

delayオプションによってルートSuiteの実行が遅延された場合に発行されます

EVENT_DELAY_ENDstring

遅延されたルートSuiteの実行が、ユーザーによって`global.run()`経由でトリガーされた場合に発行されます

EVENT_RUN_ENDstring

ルートSuiteの実行終了時に発行されます

EVENT_SUITE_BEGINstring

Suiteの実行開始時に発行されます

EVENT_SUITE_ENDstring

Suiteの実行終了時に発行されます

EVENT_TEST_BEGINstring

Testの実行開始時に発行されます

EVENT_TEST_ENDstring

Testの実行終了時に発行されます

EVENT_TEST_FAILstring

Testの実行失敗時に発行されます

EVENT_TEST_PASSstring

Testの実行成功時に発行されます

EVENT_TEST_PENDINGstring

Testが保留になったときに発行されます

EVENT_TEST_RETRYstring

Testの実行に失敗したが、再試行する場合に発行されます

STATE_IDLEstring

Runnerの初期状態

STATE_RUNNINGstring

Runnerの実行開始時にこの値に設定される状態

STATE_STOPPEDstring

Runnerの停止時にこの値に設定される状態

Runner関連の定数。

型
  • string

_eventListeners :Map:.<EventEmitter:, Map:.<string:, Set:.<EventListener:>>>

ソース
型

メソッド

abort() → {Runner}

ソース

実行を正常に中止します。

戻り値

Runnerインスタンス。

型
Runner

dispose()

ソース

このインスタンスの実行中に設定されたすべてのイベントハンドラを削除します。
備考:これはテストまたはスイート自体をクリーンアップ/破棄する*ものではありません*。

globals(arr) → {Runner}

ソース

グローバル変数`arr`を許可します。

Parameters
名前型説明
arrArray
戻り値

Runnerインスタンス。

型
Runner

grep(re, invert) → {Runner}

ソース

`re`に一致する完全なタイトルを持つテストを実行します。runner.totalを更新します
一致したテストの数を使用します。

Parameters
名前型説明
reRegExp
invertboolean
戻り値

Runnerインスタンス。

型
Runner

grepTotal(suite) → {number}

ソース

指定されたスイートのgrep検索に一致するテストの数を返します。
与えられたスイート。

Parameters
名前型説明
suiteSuite
戻り値
型
数値

isParallelMode() → {false}

ソース

Mochaが並列モードで実行されている場合は`true`を返します。レポーター用です。

サブクラスは適切な値を返す必要があります。

戻り値
型
false

(abstract) linkPartialObjects(valueopt) → {Runner}

ソース

部分オブジェクトのリンク動作を切り替えます。一意のIDからオブジェクト参照を構築するために使用されます。オブジェクト参照は既に存在するため、シリアルモードでは何も実行されません。
ユニークIDから。
サブクラスはこれを実装できます（例：`ParallelBufferedRunner`）

例
// this reporter needs proper object references when run in parallel mode
class MyReporter() {
  constructor(runner) {
    this.runner.linkPartialObjects(true)
      .on(EVENT_SUITE_BEGIN, suite => {
           // this Suite may be the same object...
      })
      .on(EVENT_TEST_BEGIN, test => {
        // ...as the `test.parent` property
      });
  }
}
Parameters
名前型属性説明
値boolean<オプション>

`true`の場合、部分オブジェクトのリンクを有効にし、そうでない場合は無効にします

戻り値
型
Runner

run(fn, optsopt) → {Runner}

ソース

ルートスイートを実行し、`fn(failures)`を呼び出します
完了時。

Parameters
名前型属性説明
fn関数

完了時のコールバック

optsObject<オプション>

サブクラスの場合

プロパティ
名前型説明
ファイルArray:.<string:>

実行するファイル

オプションオプション

コマンドラインオプション

戻り値

Runnerインスタンス。

型
Runner

(abstract) workerReporter(path) → {Runner}

ソース

ワーカープロセスが使用する代替レポーターを構成します。サブクラス
ワーカープロセスを使用している場合は、これを実装する必要があります。

Parameters
名前型説明
パスstring

ワーカープロセスが使用する代替レポーターの絶対パス

スロー

シリアルモードの場合

戻り値
型
Runner