トップページ > Selenium API(逆引き) > 【Ruby】wait/until/text

【Ruby】wait/until/text・・・指定したテキストが表示/非表示されるまで待機する

「wait/until/text」を実行することで、指定したテキストが表示されるまで待機することが出来ます。

下記サンプルではまず初めに、「Wait」コンストラクタの引数に(※1)オプション(ここでは:timeout)と待ち時間(秒数)を指定して、インスタンスを作成しています。

次に作成されたインスタンスに対して「until」メソッドを実行しています。「until」メソッドは、引数に指定された条件が「真」になるまで待機するメソッドです。下記サンプルではfind_elementでid属性から要素を取得し、指定したテキストが表示されているかどうかを確認しています。つまり総合すると、指定したテキストが表示されるまで待つという処理をしています。「wait」コンストラクタで指定した待ち時間を越えても、期待値と一致するテキストが表示されない場合はerrorが発生します。今回のケースでは、HTML内のjavascriptで5秒後に、期待値と一致するテキストが表示されるように設定しています。待ち時間を10秒に設定しているのでerrorは発生しません。

ここで、指定したテキストが非表示になるまで待機したい場合は、equal(==)からnot equal(!=)に書き換える必要があります。
until{driver.find_element(:id, 'preText').text != compText}

(※1)オプションは「:timeout」、「:interval」、「:message」、「:ignore」の4種類あります。「:interval」はポーリング間隔で、値には秒数を指定します。「:message」はタイムアウトが発生した場合に出力するException mesageを指定します。「:ignore」はポーリングしているときにどのExceptionを無視するか指定します。また、複数のオプションを利用する場合は以下のようにカンマで区切って指定します。
Wait.new(:timeout => 3, :message => "Test Failed")

説明

◆メソッド
  ・Wait.new(:timeout => xxx)    :Waitコンストラクタにオプションと秒数を指定
  ・wait.until {true}             :中括弧内の条件が「真」になるまで待機する
  ・element.text                  :テキストを取得する
◆使用形態
  ・wait.until {driver.find_element(:id, 'abc').text == string}
◆備考
  ・指定した要素内の指定したテキストが可視状態になるまで待機する
  ・最大待機時間を越えてもテキストが表示されない場合はErrorが発生する
◆関連項目
  ・
  ・

サンプル

require 'selenium-webdriver'

# Firefoxを起動
driver = Selenium::WebDriver.for(:firefox)
#指定したURLに遷移する<図1>
driver.get('file://D:/AutoTest/textToBePresentInElement.html')
#指定したdriverに対して最大で10秒間待つように設定する
wait = Selenium::WebDriver::Wait.new(:timeout => 10)
#表示確認したいテキストを指定する
compText = '指定したテキストが表示されるまで待機する'
#要素に指定したテキストが表示されるまで待機(5秒後にテキスト表示)
wait.until {driver.find_element(:id, 'preText').text == compText}

実行結果

textToBePresentInElement2

textToBePresentInElement.html<図1>

<!DOCTYPE html>
<html lang="ja">
    <head>
        <title>textToBePresentInElement</title>
    </head>
    <body>
        <p id="preText" style="visibility:hidden">指定したテキストが表示されるまで待機する</p>
        <script>
            function presentTxt(){
                var txtElm = document.getElementById("preText");
                txtElm.style.visibility = "visible";
            }
            setTimeout("presentTxt()", 5000);
        </script>
    </body>
</html>

動画デモ

※字幕をONにすると解説のテロップが表示されます※

カテゴリー

Selenium導入

APIリファレンス

その他

ページ上部へ戻る
トップページ > Selenium API(逆引き) > 【Ruby】wait/until/text
Copyright © 2016- Seleniumクイックリファレンス All Rights Reserved