com.htmlhifive.pitalium.core.rules

クラス AssertionView

java.lang.Object

org.junit.rules.TestWatcher

com.htmlhifive.pitalium.core.rules.AssertionView

すべての実装されたインタフェース:

org.junit.rules.TestRule

public class AssertionView
extends org.junit.rules.TestWatcher

スクリーンショットのassert機能を持ちます。
また、テストメソッド毎に以下の共通処理を行う@Rule用クラスです。

• テスト成功時：期待結果IDの更新
• テスト終了時：WebDriverのquit

PtlTestBaseを拡張した場合は、既に定義済みのため指定する必要はありません。

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected PtlWebDriver	driver スクリーンショット撮影に用いるWebDriver
protected PtlWebDriverManager.WebDriverContainer	webDriverContainer PtlWebDriverのコンテナ。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
AssertionView()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	assertExist(java.awt.image.BufferedImage image) 画面全体のスクリーンショットを撮影し、指定の画像が現在のページ上に存在するかどうか検証します。
void	assertExist(java.lang.String message, java.awt.image.BufferedImage image) 画面全体のスクリーンショットを撮影し、指定の画像が現在のページ上に存在するかどうか検証します。
void	assertScreenshot(ScreenshotResult screenshotResult) すでに取得したスクリーンショットについて、期待画像と一致するか検証します。
void	assertScreenshot(java.lang.String message, ScreenshotResult screenshotResult) すでに取得したスクリーンショットについて、期待画像と一致するか検証します。
void	assertView(ScreenshotArgument arg) 指定の条件でスクリーンショットを撮影します。
void	assertView(java.lang.String screenshotId) 指定の条件でスクリーンショットを撮影します。
void	assertView(java.lang.String screenshotId, CompareTarget[] compareTargets) 指定の条件でスクリーンショットを撮影します。
void	assertView(java.lang.String screenshotId, CompareTarget[] compareTargets, DomSelector[] hiddenElementsSelectors) 指定の条件でスクリーンショットを撮影します。
void	assertView(java.lang.String screenshotId, java.util.List<CompareTarget> compareTargets) 指定の条件でスクリーンショットを撮影します。
void	assertView(java.lang.String screenshotId, java.util.List<CompareTarget> compareTargets, java.util.List<DomSelector> hiddenElementsSelectors) 指定の条件でスクリーンショットを撮影します。
void	assertView(java.lang.String message, ScreenshotArgument arg) 指定の条件でスクリーンショットを撮影します。
void	assertView(java.lang.String message, java.lang.String screenshotId) 指定の条件でスクリーンショットを撮影します。
void	assertView(java.lang.String message, java.lang.String screenshotId, java.util.List<CompareTarget> compareTargets) 指定の条件でスクリーンショットを撮影します。
void	assertView(java.lang.String message, java.lang.String screenshotId, java.util.List<CompareTarget> compareTargets, java.util.List<DomSelector> hiddenElementsSelectors) 指定の条件でスクリーンショットを撮影します。
PtlWebDriver	createDriver(PtlCapabilities cap) Capabilitiesに応じたPtlWebDriverを作成して返します。
protected void	failed(java.lang.Throwable e, org.junit.runner.Description desc)
protected void	finished(org.junit.runner.Description desc)
protected void	starting(org.junit.runner.Description desc)
protected void	succeeded(org.junit.runner.Description desc)
void	verifyExists(java.awt.image.BufferedImage image) 画面全体のスクリーンショットを撮影し、指定の画像が現在のページ上に存在するかどうか検証します。
void	verifyExists(java.lang.String message, java.awt.image.BufferedImage image) 画面全体のスクリーンショットを撮影し、指定の画像が現在のページ上に存在するかどうか検証します。
void	verifyScreenshot(ScreenshotResult screenshotResult) すでに取得したスクリーンショットについて、期待画像と一致するか検証します。
void	verifyScreenshot(java.lang.String message, ScreenshotResult screenshotResult) すでに取得したスクリーンショットについて、期待画像と一致するか検証します。
void	verifyView(ScreenshotArgument arg) 指定の条件でスクリーンショットを撮影します。
void	verifyView(java.lang.String message, ScreenshotArgument arg) 指定の条件でスクリーンショットを撮影します。

クラスから継承されたメソッド org.junit.rules.TestWatcher

apply, skipped, skipped

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

webDriverContainer

protected PtlWebDriverManager.WebDriverContainer webDriverContainer

PtlWebDriverのコンテナ。
WebDriverの生成と、適切なタイミングでのquitを実行します。

driver

protected PtlWebDriver driver

スクリーンショット撮影に用いるWebDriver

コンストラクタの詳細

AssertionView

public AssertionView()

メソッドの詳細

starting

protected void starting(org.junit.runner.Description desc)

オーバーライド:

starting クラス内 org.junit.rules.TestWatcher

failed

protected void failed(java.lang.Throwable e,
                      org.junit.runner.Description desc)

オーバーライド:

failed クラス内 org.junit.rules.TestWatcher

succeeded

protected void succeeded(org.junit.runner.Description desc)

オーバーライド:

succeeded クラス内 org.junit.rules.TestWatcher

finished

protected void finished(org.junit.runner.Description desc)

オーバーライド:

finished クラス内 org.junit.rules.TestWatcher

createDriver

public PtlWebDriver createDriver(PtlCapabilities cap)

Capabilitiesに応じたPtlWebDriverを作成して返します。

パラメータ:

cap - ブラウザスペック情報

戻り値:

ブラウザに対応するWebDriver

assertView

public void assertView(java.lang.String screenshotId)

指定の条件でスクリーンショットを撮影します。テスト実行モードがExecMode.SET_EXPECTEDの時は 正解状態としてスクリーンショットの画像と座標を保存します。 テスト実行モードが ExecMode.RUN_TESTの時は、 ExecMode.SET_EXPECTEDで撮影した状態と比較します。

パラメータ:

screenshotId - スクリーンショットを識別するID

assertView

public void assertView(java.lang.String message,
                       java.lang.String screenshotId)

指定の条件でスクリーンショットを撮影します。テスト実行モードがExecMode.SET_EXPECTEDの時は 正解状態としてスクリーンショットの画像と座標を保存します。 テスト実行モードが ExecMode.RUN_TESTの時は、 ExecMode.SET_EXPECTEDで撮影した状態と比較します。

パラメータ:

message - AssertionErrorを識別する文字列

screenshotId - スクリーンショットを識別するID

assertView

public void assertView(java.lang.String screenshotId,
                       CompareTarget[] compareTargets)

指定の条件でスクリーンショットを撮影します。テスト実行モードがExecMode.SET_EXPECTEDの時は 正解状態としてスクリーンショットの画像と座標を保存します。 テスト実行モードが ExecMode.RUN_TESTの時は、 ExecMode.SET_EXPECTEDで撮影した状態と比較します。

パラメータ:

screenshotId - スクリーンショットを識別するID

compareTargets - スクリーンショットの撮影、比較条件

assertView

public void assertView(java.lang.String screenshotId,
                       java.util.List<CompareTarget> compareTargets)

指定の条件でスクリーンショットを撮影します。テスト実行モードがExecMode.SET_EXPECTEDの時は 正解状態としてスクリーンショットの画像と座標を保存します。 テスト実行モードが ExecMode.RUN_TESTの時は、 ExecMode.SET_EXPECTEDで撮影した状態と比較します。

パラメータ:

screenshotId - スクリーンショットを識別するID

compareTargets - スクリーンショットの撮影、比較条件

assertView

public void assertView(java.lang.String message,
                       java.lang.String screenshotId,
                       java.util.List<CompareTarget> compareTargets)

指定の条件でスクリーンショットを撮影します。テスト実行モードがExecMode.SET_EXPECTEDの時は 正解状態としてスクリーンショットの画像と座標を保存します。 テスト実行モードが ExecMode.RUN_TESTの時は、 ExecMode.SET_EXPECTEDで撮影した状態と比較します。

パラメータ:

message - AssertionErrorを識別する文字列

screenshotId - スクリーンショットを識別するID

compareTargets - スクリーンショットの撮影、比較条件

assertView

public void assertView(java.lang.String screenshotId,
                       CompareTarget[] compareTargets,
                       DomSelector[] hiddenElementsSelectors)

指定の条件でスクリーンショットを撮影します。テスト実行モードがExecMode.SET_EXPECTEDの時は 正解状態としてスクリーンショットの画像と座標を保存します。 テスト実行モードが ExecMode.RUN_TESTの時は、 ExecMode.SET_EXPECTEDで撮影した状態と比較します。

パラメータ:

screenshotId - スクリーンショットを識別するID

compareTargets - スクリーンショットの撮影、比較条件

hiddenElementsSelectors - スクリーンショット撮影時に非表示にするDOMを表すセレクターのコレクション

assertView

public void assertView(java.lang.String screenshotId,
                       java.util.List<CompareTarget> compareTargets,
                       java.util.List<DomSelector> hiddenElementsSelectors)

指定の条件でスクリーンショットを撮影します。テスト実行モードがExecMode.SET_EXPECTEDの時は 正解状態としてスクリーンショットの画像と座標を保存します。 テスト実行モードが ExecMode.RUN_TESTの時は、 ExecMode.SET_EXPECTEDで撮影した状態と比較します。

パラメータ:

screenshotId - スクリーンショットを識別するID

compareTargets - スクリーンショットの撮影、比較条件

hiddenElementsSelectors - スクリーンショット撮影時に非表示にするDOMを表すセレクターのコレクション

assertView

public void assertView(ScreenshotArgument arg)

指定の条件でスクリーンショットを撮影します。テスト実行モードがExecMode.SET_EXPECTEDの時は 正解状態としてスクリーンショットの画像と座標を保存します。 テスト実行モードが ExecMode.RUN_TESTの時は、 ExecMode.SET_EXPECTEDで撮影した状態と比較します。

パラメータ:

arg - スクリーンショットを撮影するための条件

assertView

public void assertView(java.lang.String message,
                       ScreenshotArgument arg)

指定の条件でスクリーンショットを撮影します。テスト実行モードがExecMode.SET_EXPECTEDの時は 正解状態としてスクリーンショットの画像と座標を保存します。 テスト実行モードが ExecMode.RUN_TESTの時は、 ExecMode.SET_EXPECTEDで撮影した状態と比較します。

パラメータ:

message - AssertionErrorを識別する文字列

arg - スクリーンショットを撮影するための条件

assertView

public void assertView(java.lang.String message,
                       java.lang.String screenshotId,
                       java.util.List<CompareTarget> compareTargets,
                       java.util.List<DomSelector> hiddenElementsSelectors)

指定の条件でスクリーンショットを撮影します。テスト実行モードがExecMode.SET_EXPECTEDの時は 正解状態としてスクリーンショットの画像と座標を保存します。 テスト実行モードが ExecMode.RUN_TESTの時は、 ExecMode.SET_EXPECTEDで撮影した状態と比較します。

パラメータ:

message - AssertionErrorを識別する文字列

screenshotId - スクリーンショットを識別するID

compareTargets - スクリーンショットの撮影、比較条件

hiddenElementsSelectors - スクリーンショット撮影時に非表示にするDOMを表すセレクターのコレクション

verifyView

public void verifyView(ScreenshotArgument arg)

指定の条件でスクリーンショットを撮影します。テスト実行モードがExecMode.SET_EXPECTEDの時は 正解状態としてスクリーンショットの画像と座標を保存します。 テスト実行モードが ExecMode.RUN_TESTの時は、 ExecMode.SET_EXPECTEDで撮影した状態と比較します。

assertView(ScreenshotArgument)との違いはRUN_TEST時に比較が失敗してもテストの実行を止めず、テストを最後まで実行します。

パラメータ:

arg - スクリーンショットを撮影するための条件

verifyView

public void verifyView(java.lang.String message,
                       ScreenshotArgument arg)

指定の条件でスクリーンショットを撮影します。テスト実行モードがExecMode.SET_EXPECTEDの時は 正解状態としてスクリーンショットの画像と座標を保存します。 テスト実行モードが ExecMode.RUN_TESTの時は、 ExecMode.SET_EXPECTEDで撮影した状態と比較します。

assertView(ScreenshotArgument)との違いはRUN_TEST時に比較が失敗してもテストの実行を止めず、テストを最後まで実行します。

パラメータ:

message - AssertionErrorを識別する文字列

arg - スクリーンショットを撮影するための条件

assertScreenshot

public void assertScreenshot(ScreenshotResult screenshotResult)

すでに取得したスクリーンショットについて、期待画像と一致するか検証します。一致しなければdiff画像を生成し、テストを失敗として中断します。

パラメータ:

screenshotResult - takeScreenshotを実行して取得した結果オブジェクト

assertScreenshot

public void assertScreenshot(java.lang.String message,
                             ScreenshotResult screenshotResult)

すでに取得したスクリーンショットについて、期待画像と一致するか検証します。一致しなければdiff画像を生成し、テストを失敗として中断します。

パラメータ:

message - 失敗時に表示するメッセージ

screenshotResult - takeScreenshotを実行して取得した結果オブジェクト

verifyScreenshot

public void verifyScreenshot(ScreenshotResult screenshotResult)

すでに取得したスクリーンショットについて、期待画像と一致するか検証します。一致しなければdiff画像を生成し、テストを失敗とします。

assertScreenshot(ScreenshotResult)との違いは比較が失敗してもテストの実行を止めず、テストを最後まで実行します。

パラメータ:

screenshotResult - takeScreenshotを実行して取得した結果オブジェクト

verifyScreenshot

public void verifyScreenshot(java.lang.String message,
                             ScreenshotResult screenshotResult)

すでに取得したスクリーンショットについて、期待画像と一致するか検証します。一致しなければdiff画像を生成し、テストを失敗とします。

assertScreenshot(ScreenshotResult)との違いは比較が失敗してもテストの実行を止めず、テストを最後まで実行します。

パラメータ:

message - 失敗時に表示するメッセージ

screenshotResult - takeScreenshotを実行して取得した結果オブジェクト

assertExist

public void assertExist(java.awt.image.BufferedImage image)

画面全体のスクリーンショットを撮影し、指定の画像が現在のページ上に存在するかどうか検証します。
ただし、テスト実行モードがExecMode.SET_EXPECTEDの場合、検証は行われません。

パラメータ:

image - 検証に使用する画像

assertExist

public void assertExist(java.lang.String message,
                        java.awt.image.BufferedImage image)

画面全体のスクリーンショットを撮影し、指定の画像が現在のページ上に存在するかどうか検証します。
ただし、テスト実行モードがExecMode.SET_EXPECTEDの場合、検証は行われません。

パラメータ:

message - AssertionErrorを識別する文字列

image - 検証に使用する画像

verifyExists

public void verifyExists(java.awt.image.BufferedImage image)

画面全体のスクリーンショットを撮影し、指定の画像が現在のページ上に存在するかどうか検証します。
ただし、テスト実行モードがExecMode.SET_EXPECTEDの場合、検証は行われません。

assertExist(BufferedImage)との違いは比較が失敗してもテストの実行を止めず、テストを最後まで実行します。

パラメータ:

image - 検証に使用する画像

verifyExists

public void verifyExists(java.lang.String message,
                         java.awt.image.BufferedImage image)

画面全体のスクリーンショットを撮影し、指定の画像が現在のページ上に存在するかどうか検証します。
ただし、テスト実行モードがExecMode.SET_EXPECTEDの場合、検証は行われません。

assertExist(BufferedImage)との違いは比較が失敗してもテストの実行を止めず、テストを最後まで実行します。

パラメータ:

message - AssertionErrorを識別する文字列

image - 検証に使用する画像