Ensure API

概要

Nightwatch 2.0から利用可能な新しい.ensure APIは、Seleniumの既存のuntilモジュールをマッピングしています。

これは、既存の.assertライブラリと同様に動作し、ほぼ同じ機能を提供しますが、より高い柔軟性を提供する可能性があります。また、Seleniumのuntil APIですでに作業しているユーザーには、より馴染みやすいかもしれません。

基本的な例
describe('demo test for .ensure', function() {
  

  it('basic test', function(browser) {
    browser
      .url('https://nightwatch.dokyumento.jp')
      .ensure.titleMatches(/Nightwatch\.js/)
      .ensure.elementIsVisible('#index-container')  
  });
});

利用可能なアサーション

.ableToSwitchToFrame(frame)

Nightwatch WebDriverクライアントが指定されたフレームに切り替えることができることを保証します。

パラメータ
名前 タイプ 説明
frame Number|WebElement|By フレーム識別子。

.alertIsPresent()

アラートが開くまで待機する条件を作成します。

パラメータ
なし

.elementIsDisabled(element)

指定された要素が無効になるまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
element WebElement テストする要素。

.elementIsEnabled(element)

指定された要素が有効になるまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
element WebElement テストする要素。

.elementIsNotSelected(element)

指定された要素が選択解除されるまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
element WebElement テストする要素。

.elementIsNotVisible(element)

指定された要素がDOMに存在するが、ユーザーに表示されないまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
element WebElement テストする要素。

.elementIsNotVisible(element)

指定された要素がDOMに存在するが、ユーザーに表示されないまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
element WebElement テストする要素。

.elementIsSelected(element)

指定された要素が選択されるまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
element WebElement テストする要素。

.elementIsVisible(element)

指定された要素が表示されるまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
element WebElement テストする要素。

.elementLocated(locator)

指定されたロケータを使用して要素が見つかるまでループする条件を作成します。

パラメータ
名前 タイプ 説明
locator By 使用するロケータ。

.elementTextContains(element, substr)

指定された要素のテキストに指定された部分文字列が含まれるまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
element WebElement テストする要素。
substr String 検索する部分文字列。

.elementTextIs(element, text)

指定された要素のテキストが指定されたテキストと等しくなるまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
element WebElement テストする要素。
text String 予期されるテキスト。

.elementTextMatches(element, regex)

指定された要素のテキストが指定された正規表現に一致するまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
element WebElement テストする要素。
regex RegExp テストに使用する正規表現。

.elementsLocated(locator)

指定されたロケータを使用して少なくとも1つの要素が見つかるまでループする条件を作成します。

パラメータ
名前 タイプ 説明
locator By 使用するロケータ。

.stalenessOf(element)

指定された要素が失効するまで待機する条件を作成します。要素は、DOMから削除されるか、新しいページが読み込まれると失効したとみなされます。

パラメータ
名前 タイプ 説明
element WebElement 失効する要素。

.titleContains(substr)

現在のページのタイトルに指定された部分文字列が含まれるまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
substr String ページタイトルに存在する必要がある部分文字列。

.titleIs(substr)

現在のページのタイトルが指定された値と一致するまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
substr String 予期されるページタイトル。

.titleMatches(regex)

現在のページのタイトルが指定された正規表現に一致するまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
regex RegExp テストに使用する正規表現。

.urlContains(substrUrl)

現在のページのURLに指定された部分文字列が含まれるまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
substrUrl String 現在のURLに存在する必要がある部分文字列。

.urlIs(url)

現在のページのURLが指定された値と一致するまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
substrUrl String 予期されるページURL。

.urlMatches(regex)

現在のページのURLが指定された正規表現に一致するまで待機する条件を作成します。

パラメータ
名前 タイプ 説明
regex RegExp テストに使用する正規表現。