使用JavaScript+Selenium玩转Web应用自动化测试之等待(Waits)

原文地址:https://juejin.im/post/6868578613416067085

由于WebDriver和浏览器分别运行在自己的进程中,所以WebDriver无法实时追踪到浏览器中页面DOM树的渲染情况,也就是在WebDriver的执行和浏览器的渲染间存在一个竞争问题race condition)。

Waits

问题实例

我们将用一个实例来展示WebDriver和浏览器间存在的竞争问题,用到的测试html文件内容如下(race_condition.html):

<!doctype html>
<meta charset=utf-8>
<title>Race Condition Example</title>

<script>
    window.addEventListener("load", function () {
        setTimeout(() => {
            var newElement = document.createElement("p");
            newElement.textContent = "Hello from JavaScript!";
            document.body.appendChild(newElement);
        }, 1000); // 模拟元素的延迟加载
        setTimeout(() => {
            var newElement = document.createElement("a");
            newElement.textContent = "Hello from JavaScript again!";
            document.body.appendChild(newElement);
        }, 3000);
    });
</script>

代码如下:

const { Builder, By} = require('selenium-webdriver');
const assert = require('assert');

(async function myFunction() {
  // 创建一个driver实例
  let driver = await new Builder().forBrowser('chrome').build();
  try {
    let url = `file://${__dirname}/race_condition.html`;
    await driver.get(url);
    const element = await driver.findElement(By.css('p'));
    assert.strictEqual(await element.getText(), 'Hello from JavaScript!');
  } catch (error) {
    console.error(error.message);
  } finally {
    // 关闭浏览器
    await driver.quit();
  }
})()

代码看起来没什么问题,但是运行起来会报元素未找到错误:

no such element: Unable to locate element: {"method":"css selector","selector":"p"}

为什么呢?首先需要弄清楚代码和浏览器的执行流程,如下:

[图片上传失败...(image-8127e3-1599215770109)]

关于Selenium的工作原理,可以参考:使用JavaScript+Selenium玩转Web应用自动化测试

关于页面加载策略,可以参考:Page loading strategy

如何解决上述竞争问题呢?Selenium提供了一个种方案-等待Waits),共分为三种:

  • 显性等待(Explicit wait):在设置条件和等待时长后,会暂停WebDriver后续代码的执行,不断轮询直到条件满足或等待超时,然后继续执行后续代码。
  • 隐性等待(Implicit wait):默认查找元素的等待时长,在元素找不到时默认不断轮询直到找到元素或超时,后再执行后续代码,作用于整个session生命周期。
  • 流畅等待(Fluent wait):跟显性等待类似,不同的是可以设置轮询间隔和超时后的错误消息,更加友好。

下面对上述三种等待方法进行详细介绍。

显性等待(Explicit wait)

语法:

this.wait<T>( condition, timeout, message ) → (IThenable<T>|WebElementPromise)

支持的条件包括:元素是否存在,元素的属性检查以及自定义条件等。

Selenium的JavaScript库中的提供的until模块包含各种常用的条件,具体参考:Module selenium-webdriver/lib/until

如下示例:

// 自定义的条件
const customizedCondtion= () =>false;
await driver.wait(customizedCondtion, 10000);
// 检测元素是否存在
await driver.wait(until.elementLocated(By.css('p')), 10000);

因此针对刚开始时元素未找到的问题,使用显性等待来解决的代码如下:

const { Builder, By, until } = require('selenium-webdriver');
const assert = require('assert');

(async function myFunction() {
  // 创建一个driver实例
  let driver = await new Builder().forBrowser('chrome').build();
  try {
    let url = `file://${__dirname}/race_condition.html`;
    await driver.get(url);
    let element = await driver.wait(until.elementLocated(By.css('p')), 10000); // 使用显性等待,超时时间为10秒
    assert.strictEqual(await element.getText(), 'Hello from JavaScript!');
  } catch (error) {
    console.error(error.message);
  } finally {
    // 关闭浏览器
    await driver.quit();
  }
})()

隐性等待(Implicit wait)

隐性等待的设置方法如下示例:

// 设置10秒超时时间
await driver.manage().setTimeouts( { implicit: 10000 } );

await driver.get('http://somedomain/url_that_delays_loading');

// 会暂停代码直到元素被找到或超时
let webElement = driver.findElement(By.id("myDynamicElement"));

针对刚开始时元素未找到的问题,使用隐性等待来解决的代码如下:

const { Builder, By, until } = require('selenium-webdriver');
const assert = require('assert');

(async function myFunction() {
  // 创建一个driver实例
  let driver = await new Builder().forBrowser('chrome').build();
  try {
    let url = `file://${__dirname}/race_condition.html`;
    await driver.get(url);

    // 设置10秒超时时间
    await driver.manage().setTimeouts({ implicit: 10000 });

    // 用普通的方式定位元素
    // 要等待1秒左右才能找到元素
    let pElement = await driver.findElement(By.css('p'));
    assert.strictEqual(await pElement.getText(), 'Hello from JavaScript!')

    // 要等待2秒左右才能找到元素(前面已经等待了1秒)
    let aElement= await driver.findElement(By.css('a'));
    assert.strictEqual(await aElement.getText(), 'Hello from JavaScript again!')
  } catch (error) {
    console.error(error.message);
  } finally {
    // 关闭浏览器
    await driver.quit();
  }
})()

流畅等待(Fluent wait)

在JavaScript版本的类库中,流畅等待的语法和显性等待是一样的,不同的是方法签名中多了两个参数,如下示例:

// 前两个参数和显性等待一致
// 后两个参数分别为超时后的错误消息和轮询的间隔时间
let foo = await driver.wait(until.elementLocated(By.id('foo')), 30000, 'Timed out after 30 seconds', 5000);

针对刚开始时元素未找到的问题,使用流畅等待来解决的代码如下:

const { Builder, By, until } = require('selenium-webdriver');
const assert = require('assert');

(async function myFunction() {
  // 创建一个driver实例
  let driver = await new Builder().forBrowser('chrome').build();
  try {
    let url = `file://${__dirname}/race_condition.html`;
    await driver.get(url);
    // 设置30秒的超时时间和5秒的轮询间隔时间
    // 要等待5秒左右才能找到元素
    let element = await driver.wait(until.elementLocated(By.css('p')), 30000, 'Timed out after 30 seconds', 5000);
    assert.strictEqual(await element.getText(), 'Hello from JavaScript!')
  } catch (error) {
    console.error(error.message);
  } finally {
    // 关闭浏览器
    await driver.quit();
  }
})()

总结

本文先介绍了使用Selenium进行Web自动化测试中WebDriver和浏览器间因为执行机制的不同而存在的竞争问题(race condition), 从而导致的可能的元素找不到问题。

接着用一个实例问题引入Selenium提供的该问题的解决方案-Waits,包括显性等待,隐性等待以及流畅等待三个具体方法,并分别用代码展示如何用这些方法来解决前文提到实例问题。

当然,该问题还有其它的解决方案,比如各语言自带的等待方法,如Python和Java的sleep函数等。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,511评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,495评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,595评论 0 225
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,558评论 0 190
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,715评论 3 270
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,672评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,112评论 2 291
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,837评论 0 181
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,417评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,928评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,316评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,773评论 2 234
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,253评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,827评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,440评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,523评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,583评论 2 249