Protractor - 核心 API
本章将让您了解对 Protractor 功能至关重要的各种核心 API。
Protractor API 的重要性
Protractor 为我们提供了广泛的 API,这些 API 对于执行以下操作以获取网站的当前状态非常重要 −
- 获取我们要测试的网页的 DOM 元素。
- 与 DOM 元素交互。
- 为它们分配操作。
- 向它们共享信息。
要执行上述任务,了解 Protractor API 非常重要。
各种 Protractor API
众所周知,Protractor 是 Selenium-WebDriver 的包装器这是 Node.js 的 WebDriver 绑定。Protractor 具有以下 API −
浏览器
它是 WebDriver 实例的包装器,用于处理浏览器级命令,如导航、页面范围信息等。例如,browser.get 方法加载页面。
元素
它用于搜索并与我们正在测试的页面上的 DOM 元素交互。为此,它需要一个参数来定位元素。
定位器(by)
它是元素定位器策略的集合。例如,可以通过 CSS 选择器、ID 或与 ng-model 绑定的任何其他属性找到元素。
接下来,我们将详细讨论这些 API 及其功能。
浏览器 API
如上所述,它是 WebDriver 实例的包装器,用于处理浏览器级命令。它执行以下各种功能 −
函数及其描述
ProtractorBrowser API 的功能如下−
browser.angularAppRoot
浏览器 API 的此函数为我们将要查找 Angular 的元素设置 CSS 选择器。通常,此函数位于"body"中,但如果是我们的 ng-app,则它位于页面的子部分;它也可能是子元素。
browser.waitForAngularEnabled
浏览器 API 的此函数可以设置为 true 或 false。顾名思义,如果将此函数设置为 false,则 Protractor 将不会等待 Angular $http 和 $timeout 任务完成后再与浏览器交互。我们还可以通过调用 waitForAngularEnabled() 而不传递值来读取当前状态而不更改它。
browser.getProcessedConfig
借助此浏览器 API 函数,我们可以获取当前正在运行的已处理配置对象,包括规范和功能。
browser.forkNewDriverInstance
顾名思义,此函数将分叉另一个浏览器实例以用于交互式测试。它可以在启用和禁用控制流的情况下运行。下面给出了两种情况的示例 −
示例 1
在启用控制流的情况下运行 browser.forkNewDriverInstance() −
var fork = browser.forkNewDriverInstance(); fork.get('page1');
示例 2
在禁用控制流的情况下运行 browser.forkNewDriverInstance() −
var fork = await browser.forkNewDriverInstance().ready; await forked.get('page1');
browser.restart
顾名思义,它将通过关闭浏览器实例并创建新的浏览器实例来重新启动浏览器。它还可以在启用和禁用控制流的情况下运行。下面给出了两种情况的示例 −
示例 1 − 在启用控制流的情况下运行 browser.restart() −
browser.get(‘page1’); browser.restart(); browser.get(‘page2’);
示例 2 − 在控制流禁用的情况下运行 browser.forkNewDriverInstance() −
await browser.get('page1'); await browser.restart(); await browser.get('page2');
browser.restartSync
它类似于 browser.restart() 函数。唯一的区别是它直接返回新的浏览器实例,而不是返回解析为新浏览器实例的 promise。它只能在控制流启用时运行。
示例 − 在控制流启用的情况下运行 browser.restartSync() −
browser.get('page1'); browser.restartSync(); browser.get('page2');
browser.useAllAngular2AppRoots
顾名思义,它仅与 Angular2 兼容。它将在查找元素或等待稳定性的同时搜索页面上可用的所有 Angular 应用。
browser.waitForAngular
此浏览器 API 函数指示 WebDriver 等到 Angular 完成渲染并且没有未完成的 $http 或 $timeout 调用后再继续。
browser.findElement
顾名思义,此浏览器 API 函数等待 Angular 完成渲染后再搜索元素。
browser.isElementPresent
顾名思义,此浏览器 API 函数将测试元素是否存在于页面上。
browser.addMockModule
每次调用 Protractor.get 方法时,它都会在 Angular 之前添加一个要加载的模块。
示例
browser.addMockModule('modName', function() { angular.module('modName', []).value('foo', 'bar'); });
browser.clearMockModules
与 browser.addMockModule 不同,它将清除已注册的模拟模块列表。
browser.removeMockModule
顾名思义,它将删除已注册的模拟模块。示例:browser.removeMockModule('modName');
browser.getRegisteredMockModules
与 browser.clearMockModule 相反,它将获取已注册的模拟模块列表。
browser.get
我们可以使用 browser.get() 将浏览器导航到特定的网址,并在 Angular 加载之前加载该页面的模拟模块。
示例
browser.get(url); browser.get('http://localhost:3000'); // 这将导航到 localhost:3000 并在需要时加载模拟模块
browser.refresh
顾名思义,这将重新加载当前页面并在 Angular 之前加载模拟模块。
browser.navigate
顾名思义,它用于将导航方法混合回导航对象,以便像以前一样调用它们。示例:driver.navigate().refresh()。
browser.setLocation
它用于使用页内导航浏览到另一个页面。
示例
browser.get('url/ABC'); browser.setLocation('DEF'); expect(browser.getCurrentUrl()) .toBe('url/DEF');
它将从 ABC 导航到 DEF 页面。
browser.debugger
顾名思义,这必须与量角器调试一起使用。此函数基本上向控制流添加了一项任务,以暂停测试并将辅助函数注入浏览器,以便可以在浏览器控制台中进行调试。
browser.pause
它用于调试 WebDriver 测试。我们可以在测试中使用 browser.pause() 从控制流中的该点进入量角器调试器。
示例
element(by.id('foo')).click(); browser.pause(); // 执行将在下一次点击操作之前停止。 element(by.id('bar')).click();
browser.controlFlowEnabled
用于确定控制流是否启用。