文档帮助

术语、图标和标签

许多类在使用配置对象创建(实例化)类时具有用于快捷方式的名称。快捷方式名称称为别名(如果类扩展 Ext.Component,则称为xtype)。别名/xtype 列在适用类的类名旁边,以便快速参考。

访问级别

框架类或其成员可以指定为privateprotected。否则,类/成员为publicPublicprotectedprivate是访问描述符,用于传达如何以及何时使用类或类成员。

成员类型

成员语法

下面是一个示例类成员,我们可以对其进行剖析以显示类成员的语法(在这种情况下,从 Ext.button.Button 类中查看的 lookupComponent 方法)。

lookupComponent ( item ) : Ext.Component
protected

在初始化items配置期间或添加新项目时将原始配置对象添加到此容器中时调用,或{@link #insert 插入}。

此方法将传递的对象转换为实例化子组件。

当需要对子创建应用特殊处理时,可以在子类中覆盖此方法。

参数

item :  Object

正在添加的配置对象。

返回
Ext.Component

要添加的组件。

让我们看看成员行中的每一部分

成员标志

API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。

类图标

- 表示框架类

- 单例框架类。*有关详细信息,请参见单例标志

- 组件类型框架类(Ext JS 框架中扩展 Ext.Component 的任何类)

- 表示类、成员或指南在当前查看的版本中是新的

成员图标

- 表示类型为 config 的类成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

- 表示类型为 theme variable 的类成员

- 表示类型为 theme mixin 的类成员

- 表示类、成员或指南在当前查看的版本中是新的

类成员快速导航菜单

在 API 文档页面上类名称正下方是与当前类拥有的成员类型相对应的按钮行。每个按钮按类型显示成员数(此计数在应用筛选器时更新)。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。

Getter 和 Setter 方法

与类配置选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中,它们位于与其一起工作的配置正下方。Getter 和 Setter 方法文档将位于配置行中,以便于参考。

历史记录栏

您的页面历史记录保存在本地存储中,并显示在顶部标题栏正下方(使用可用空间)。默认情况下,仅显示与您当前正在查看的产品/版本匹配的搜索结果。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选按钮来扩展显示内容。这将在历史记录栏中显示所有产品/版本的所有近期页面。

在历史记录配置菜单中,您还将看到最近访问的页面列表。结果按“当前产品/版本”和“全部”单选按钮进行筛选。单击 按钮将清除历史记录栏以及本地存储中保留的历史记录。

如果在历史记录配置菜单中选择了“全部”,则“在历史记录栏中显示产品详细信息”复选框选项将被启用。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。

搜索和筛选器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上,还有一个筛选器输入字段,它使用筛选器字符串筛选成员行。除了按字符串筛选外,您还可以按访问级别、继承和只读筛选类成员。这是使用页面顶部的复选框完成的。

API 类导航树底部的复选框筛选类列表以包括或排除私有类。

单击空的搜索字段将显示您最近的 10 次搜索,以便快速导航。

API 文档类元数据

每个 API 文档页面(除了 Javascript 基本类型页面)都有一个与该类相关的元数据的菜单视图。此元数据视图将包含以下一个或多个

展开和折叠示例和类成员

默认情况下,可运行示例(Fiddle)在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换全部状态将在页面加载之间记住。

默认情况下,类成员在页面上折叠。您可以使用成员行左侧的箭头图标展开和折叠成员,或使用右上角的展开/折叠所有切换按钮全局展开/折叠。

桌面 -vs- 移动视图

在较窄的屏幕或浏览器上查看文档将导致针对较小尺寸优化视图。桌面和“移动”视图之间的主要区别是

查看类源

可以通过单击 API 文档页面顶部的类名来查看类源。可以通过单击成员行右侧的“查看源”链接来查看类成员的源。

WebTestIt


顶部

构建您的页面对象

“如果您的测试方法中包含 WebDriver API,则您做错了。” - Simon Stewart

Selenium 项目的首席提交者 Simon Stewart 在他最初的 Selenium 愿景中分享道,页面对象是 WebDriver 之上的强制层。两者相辅相成,Sencha WebTestIt 正是在考虑这一事实的基础上创建的。

要高效地使用 Sencha WebTestIt,您必须了解页面对象模式。

什么是页面对象?

页面对象模式是封装的经典示例。它使用特定于应用程序的 API 封装了在 GUI 中查找和操作数据所需的机制。页面对象的经验法则应该是它应该允许软件客户端执行和查看人类可以执行和查看的任何操作。

尽管名称如此,但不要为每个页面创建页面对象。而是为页面上的重要组件(例如标题、菜单或内容区域)创建它们。

示例

我们使用我们的 演示商店 作为如何派生页面对象的示例。

我们可以将初始启动页面至少分为三个页面对象

  1. HeaderPo:它可以在每个页面上找到,因此将其作为页面对象提取是有意义的。
  2. ItemsOverviewPo:此组件包含所有可供出售的商品。
  3. ShoppingCartPo:此购物车摘要从标题中展开,但它包含足够的函数和元素,使其成为其自己的页面对象。

页面对象操作

现在我们已将页面划分为页面对象,让我们了解如何在测试中使用它们。

页面对象模式的目的是将应用程序断言 APIWebDriver API 分开。这意味着,测试永远不应该直接使用 HTML 元素或 WebDriver,而只能使用公开(公共)方法,称为操作

这些操作封装了用户交互单元,例如“点击按钮”“登录”“提交表单”,在内部使用 WebDriver API 和与页面对象关联的元素。

因此,在创建操作方法时,请记住以下最佳实践

  1. 切勿直接返回元素,而应
    • 如果您想使用基本类型(字符串、整数、日期等)的值,请返回这些值。
    • 当您仅对元素执行操作时,返回页面对象实例本身(this)。
    • 返回另一个页面对象以指示上下文切换,例如在点击链接或提交表单后。
    • 这允许您将页面对象操作链接在一起,从而得到最终的返回值,然后您可以在断言中使用该值。
  2. 不要在页面对象中使用断言,而应
    • 返回元素的相关属性,例如其文本。
    • 或者,将比较值作为参数传递,并返回布尔值。
    • 在测试文件中对这些结果使用断言。
  3. 良好的页面对象操作是可重用的,可以将它们想象成测试的构建块。

示例

使用上述页面对象,让我们根据我们刚刚学习的规则构建一个简单的测试。该测试应:1. 向购物车添加一个项目,2. 转到购物车,3. 断言总价正确。

注意

此示例使用 Java,但相同的原理适用于 TypeScript 项目。*

  1. 此操作在 ItemsOverviewPo 中执行,并将项目添加到购物车。仅向购物车添加项目不应将我们导航到任何地方,并且您可能希望在其他测试中在 ItemsOverviewPo 中执行更多操作,因此我们返回 this

    public ItemsOverviewPo addItemToCart() {
        this.wait.until(ExpectedConditions.visibilityOfElementLocated(this.addItemToCartButton)).click();
        return this;
    }
    
  2. 在同一页面对象中,当您单击查看购物车按钮时,您希望进入购物车页面,因此您返回相应页面对象类的实例,CartPo

    public CartPo viewCart() {
        this.wait.until(ExpectedConditions.visibilityOfElementLocated(this.viewCartButton)).click();
        return new CartPo(this.driver);
    }
    
  3. 最后,您可以验证价格是否正确显示。不要将断言放入页面对象操作中。相反,创建一个方法来返回包含总价的元素的文本

    public String getTotalPrice() {
        String totalPriceText = this.wait.until(ExpectedConditions.visibilityOfElementLocated(this.totalPrice)).getText();
        return totalPriceText;
    }
    

    现在,您可以在测试中使用这些操作。请注意,由于在操作中返回页面对象实例,您可以像这样链接操作方法,从而提高测试的可读性

    @Test
    public void checkTotalPrice() {
        // 1. Arrange
        WebDriver driver = getDriver();
        ItemsOverviewPo itemsOverviewPo = new ItemsOverviewPo(driver)
                .open("https://demoshop.webtestit.com");
    
        // 2. Act
        String totalPrice = itemsOverviewPo
                .addItemToCart()
                .viewCart()
                .getTotalPrice();
    
        // 3. Assert
        Assert.assertEquals(totalPrice, "€1,500.00");
    }
    

结论

阅读本文后,您已了解页面对象模式、如何将复杂网站划分为各个页面对象,以及如何使用最佳实践构建页面对象操作。

如果您想了解有关页面对象的更多信息,请务必阅读 Martin Fowler 关于页面对象的文章

WebTestIt