メインコンテンツにスキップ

タイムアウト

WebdriverIOの各コマンドは非同期操作です。リクエストがSeleniumサーバー（またはSauce Labsのようなクラウドサービス）に送信され、そのレスポンスには操作が完了または失敗したときの結果が含まれます。

したがって、時間は全体のテストプロセスにおいて重要な要素です。特定のアクションが別のアクションの状態に依存している場合、それらが正しい順序で実行されるようにする必要があります。タイムアウトはこれらの問題に対処する際に重要な役割を果たします。

WebDriverのタイムアウト​

セッションスクリプトタイムアウト​

セッションには、非同期スクリプトの実行を待機する時間を指定するセッションスクリプトタイムアウトが関連付けられています。特に明記されていない限り、30秒です。このタイムアウトは次のように設定できます：

await browser.setTimeout({ 'script': 60000 })
await browser.executeAsync((done) => {
    console.log('this should not fail')
    setTimeout(done, 59000)
})

セッションページロードタイムアウト​

セッションには、ページの読み込みが完了するのを待つ時間を指定するセッションページロードタイムアウトが関連付けられています。特に明記されていない限り、300,000ミリ秒です。

このタイムアウトは次のように設定できます：

await browser.setTimeout({ 'pageLoad': 10000 })

pageLoadキーワードは公式WebDriver仕様の一部ですが、使用しているブラウザではサポートされていないかもしれません（以前の名前はpage loadです）。

セッション暗黙的待機タイムアウト​

セッションには、関連するセッション暗黙的待機タイムアウトがあります。これは、findElementまたはfindElementsコマンド（WebdriverIOをWDIOテストランナーありまたはなしで実行する場合は、それぞれ$または$$）を使用して要素を検索する際に、暗黙的な要素の検索戦略を待機する時間を指定します。特に明記されていない限り、0ミリ秒です。

このタイムアウトは次のように設定できます：

await browser.setTimeout({ 'implicit': 5000 })

WebdriverIO関連のタイムアウト​

WaitFor*タイムアウト​

WebdriverIOは、要素が特定の状態（有効、可視、存在など）に達するのを待機するための複数のコマンドを提供しています。これらのコマンドはセレクタ引数とタイムアウト数値を取り、インスタンスがその要素が状態に達するのをどれだけ待つかを決定します。waitforTimeoutオプションを使用すると、すべてのwaitFor*コマンドに対するグローバルタイムアウトを設定でき、同じタイムアウトを何度も設定する必要がなくなります。(小文字のfに注意してください！)

// wdio.conf.js
export const config = {
    // ...
    waitforTimeout: 5000,
    // ...
}

テストでは、次のように使用できます：

const myElem = await $('#myElem')
await myElem.waitForDisplayed()

// 必要に応じてデフォルトのタイムアウトを上書きすることもできます
await myElem.waitForDisplayed({ timeout: 10000 })

フレームワーク関連のタイムアウト​

WebdriverIOで使用しているテストフレームワークは、特にすべてが非同期であるため、タイムアウトを処理する必要があります。これにより、何か問題が発生した場合にテストプロセスが停止しないことが保証されます。

デフォルトでは、タイムアウトは10秒で、単一のテストがそれ以上かかるべきではないことを意味します。

Mochaでの単一のテストは次のようになります：

it('should login into the application', async () => {
    await browser.url('/login')

    const form = await $('form')
    const username = await $('#username')
    const password = await $('#password')

    await username.setValue('userXY')
    await password.setValue('******')
    await form.submit()

    expect(await browser.getTitle()).to.be.equal('Admin Area')
})

Cucumberでは、タイムアウトは単一のステップ定義に適用されます。ただし、テストがデフォルト値より長くかかるためタイムアウトを増やしたい場合は、フレームワークオプションで設定する必要があります。

// wdio.conf.js
export const config = {
    // ...
    framework: 'mocha',
    mochaOpts: {
        timeout: 20000
    },
    // ...
}

Welcome! How can I help?

WebdriverIO AI Copilot