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

【Ruby】wait/until/enabled?・・・指定した要素が有効になるまで待機する

【PR】業界トップクラスの「高単価報酬」「低マージン」を実現!レバテックフリーランス

「wait/until/enabled?」を実行することで指定した要素が有効状態になるまで待機することが出来ます。

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

次に作成されたインスタンスに対して「until」メソッドを実行しています。「until」メソッドは、引数に指定された条件が「真」になるまで待機するメソッドです。下記サンプルではfind_elementでid属性から要素を取得し、その要素が有効状態であるかどうかを確認しています。つまり総合すると、要素が有効状態になるまで待つという処理をしています。もし要素が「wait」コンストラクタで指定した待ち時間を越えても、有効にならない場合はerrorが発生します。

ここで「until」メソッドの引数に指定された条件が「偽」になるまで待機するという意味合いを持たせるには、中括弧の直後に感嘆符「!」を入れる必要があります。
until{!find_element(:id, 'ra01').enabled?}

(※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.enabled?          :指定した要素が有効状態か確認
◆使用形態
  ・wait.until {driver.find_element(:id, 'abc').enabled?}
◆備考
  ・要素が表示されてもEnable状態になるまで待機する
  ・最大待機時間を越えても要素がEnable状態にならない場合はerrorが発生する
◆関連項目
  ・要素がチェックON/チェックOFFになるまで待機する
  ・指定したテキストが表示/非表示されるまで待機する

サンプル

require 'selenium-webdriver'

# Firefoxを起動
driver = Selenium::WebDriver.for(:firefox)
#指定したURLに遷移する<図1>
driver.get('file://D:/AutoTest/elementToBeClickable.html')
#指定したdriverに対して最大で10秒間待つように設定する
wait = Selenium::WebDriver::Wait.new(:timeout => 10)
#指定したボタンが有効状態(クリック出来る状態)になるまで待機する
wait.until {driver.find_element(:id, 'disableBtn').enabled?}
※selenium version 4.1.0で動作確認をしています(ブラウザのUIや属性値などが変更された場合、実行結果が異なる可能性があります)

実行結果

wait/until/enabled?

elementToBeClickable.html<図1>

<!DOCTYPE html>
<html lang="ja">
    <head>
        <title>elementToBeClickable</title>
    </head>
    <body>
        <p>
            ボタンがクリック出来るまで状態になるまで待機
        </p>
        <p>
            <input type="button" value="test" id="disableBtn" disabled>
        </p>
        <script>
            function dis_btn(){
                var dBtn = document.getElementById("disableBtn").disabled = false;
            }
            setTimeout("dis_btn()", 8000);        
        </script>
    </body>
</html>

動画デモ

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


Fatal error: Uncaught Google_Service_Exception: Error calling GET https://www.googleapis.com/analytics/v3/data/ga?ids=ga%3A138132118&start-date=7daysAgo&end-date=yesterday&metrics=ga%3Apageviews&dimensions=ga%3ApageTitle%2C+ga%3ApagePath&sort=-ga%3Apageviews&max-results=1000: (403) User does not have sufficient permissions for this profile. in /home/users/1/monda-muki/web/seleniumqref.com/google-api-php-client-1-master/src/Google/Http/REST.php:110 Stack trace: #0 /home/users/1/monda-muki/web/seleniumqref.com/google-api-php-client-1-master/src/Google/Http/REST.php(62): Google_Http_REST::decodeHttpResponse(Object(Google_Http_Request), Object(Google_Client)) #1 /home/users/1/monda-muki/web/seleniumqref.com/google-api-php-client-1-master/src/Google/Task/Runner.php(174): Google_Http_REST::doExecute(Object(Google_Client), Object(Google_Http_Request)) #2 /home/users/1/monda-muki/web/seleniumqref.com/google-api-php-client-1-master/src/Google/Http/REST.php(46): Google_Task_Runner->run() #3 /home/users/1/monda-muki/web/seleniumqref in /home/users/1/monda-muki/web/seleniumqref.com/google-api-php-client-1-master/src/Google/Http/REST.php on line 110