文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 private(私有)或 protected(受保护)。否则,类/成员为 public(公共)。Publicprotectedprivate 是访问描述符,用于传达类或类成员应如何以及何时使用。

成员类型

成员语法

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

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

  • Expand/Collapse(展开/折叠) - 在成员行的左侧是一个控件,用于展开和折叠每个成员行以显示/隐藏成员详细信息。
  • Member Name(成员名称) - 类成员的名称(本例中为 lookupComponent
  • Method Param(方法参数) - 方法使用的任何必需或可选参数(或传递给事件处理程序方法的参数)都将列在方法名称旁边的括号内(本例中为 ( item )
  • Return type(返回类型) - 方法或属性返回的类实例或 javascript 对象(本例中为 Ext.Component)。对于不返回除 undefined 之外任何内容的方法,可能会省略此项,或者可能会显示为由正斜杠 / 分隔的多个可能值,表示返回的内容可能取决于方法调用的结果(即,如果 get 方法调用成功,则方法可能会返回 Component,如果失败,则返回 false,这将显示为 Ext.Component/Boolean)。
  • Flags(标志) - 适用于成员的任何标志都将显示在接下来(本例中为 PROTECTED - 请参阅下面的标志部分)
  • Member Origin(成员来源) - 在成员行的右侧是最初描述成员的类(本例中为 Ext.container.Container)。如果成员源自当前类,则源类将显示为蓝色链接;如果成员从祖先类或混入类继承,则显示为灰色。
  • Member Source(成员源代码) - 在成员来源类的右侧下方是指向查看成员源代码的链接(示例中的 view source(查看源代码))
  • Params List(参数列表) - 类方法的每个参数都将使用与上面括号中找到的名称相同的名称、预期的类或对象类型以及参数的描述列出(示例中为 item : Object)。
  • Returns(返回值) - 如果类返回 undefined 以外的值,则“Returns”(返回值)部分将注释返回的类或对象类型以及描述(示例中为 Ext.Component
  • Since(自...起) (示例中未显示) - 某些成员将显示该成员首次引入的产品版本(即 Available since 3.4.0(自 3.4.0 版本起可用) - 示例中未显示),紧跟在成员描述之后
  • Default(默认值) (示例中未显示) - 配置通常会显示要应用于类实例的默认配置值(如果未被覆盖)(即 Defaults to: false(默认为:false))

成员标志

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

  • Required(必需) - 实例化类时必需的配置
  • Bindable(可绑定) - 配置具有 setter,允许通过 ViewModel 绑定设置此配置
  • Read Only(只读) - 该属性可以读取,但不能用于在运行时配置/重新配置类实例
  • Singleton(单例) - 单例类在定义后立即实例化,不能手动实例化
  • Static(静态) - 静态方法或属性是类本身的方法或属性,而不是类的实例
  • Chainable(可链式调用) - 指的是在调用时返回类实例的方法。
    这使得可以进行链式方法调用,例如:classInstance.method1().method2().etc();
  • Deprecated(已弃用) - 计划在未来框架版本中删除的类或成员,并在当前版本中提供以实现向后兼容性。
    已弃用的类和成员将包含一条消息,指导您使用首选的类/方法。
  • Removed(已删除) - 已删除的类或成员,仅在文档中作为用户在框架版本之间升级的参考
  • Template(模板) - 在基类中定义的方法,旨在由子类覆盖
  • Abstract(抽象) - 类或成员可以定义为抽象。抽象类和成员建立类结构并提供有限的(如果有的话)代码。特定于类的代码将通过子类中的覆盖来提供。
  • Preventable(可阻止) - 如果从事件处理程序返回 false,则标记为可阻止的事件将不会触发

类图标

- 表示框架类

- 单例框架类。*有关更多信息,请参阅单例标志

- 组件类型框架类(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 原始类型页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

  • Alternate Name(备用名称) - 一个或多个额外的类名同义词(在 Ext JS 6.0.0 中,Ext.button.Button 类具有 Ext.Button 的备用类名)。备用类名通常为了向后兼容性而维护。
  • Hierarchy(层次结构) - 层次结构视图列出了当前类的继承链,从其祖先类一直到根基类。
  • Mixins(混入) - 混入当前类的类列表
  • Inherited Mixins(继承的混入) - 混入当前类的祖先的类列表
  • Requires(需要) - 实例化类所需定义的所有类
  • Uses(使用) - 类在其生命周期中的某个时刻可能使用的类列表,但不一定是类最初实例化所必需的
  • Subclasses(子类) - 扩展当前类的类

展开和折叠示例和类成员

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

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

桌面与移动视图

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

  • 全局导航将位于左侧菜单中,可通过汉堡菜单图标访问。该菜单包含以下内容(在大多数页面上)
    • 当前产品的名称(作为指向产品着陆页的链接)
    • 用于导航回文档主页的 Sencha 图标
    • 产品菜单下拉按钮
    • API 文档和指南的导航树选项卡
  • 当前上下文导航和工具位于右侧,可通过齿轮图标访问。上下文菜单包含以下内容
    • 全局搜索输入字段
    • (API 文档) “过滤器”选项卡,其中包含成员过滤器、展开/折叠所有示例按钮、展开/折叠所有成员行按钮、访问级别过滤器复选框以及每个成员的计数
    • (API 文档) “相关类”选项卡,其中包含与当前类相关的元数据菜单
    • (指南) 指南的目录

查看类源代码

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

WebTestIt


顶部

Python 和 Sencha WebTestIt 入门

Sencha WebTestIt 是一个著名的测试自动化工具集,用于使用 Protractor 和 Selenium 进行测试,支持 Java、TypeScript 和 Python 编程语言。

Sencha WebTestIt 利用 unittest 框架进行 Python 测试。

它是 Python 标准库中的一个模块,其中包含大量工具来支持使用 Python 进行测试自动化。虽然主要用于单元测试,但 unittest 框架也可以用于 Web GUI 测试。最重要的是,您不必担心整个测试和框架设置,因为 Sencha WebTestIt 会为您完成,就像为 Java 和 TypeScript 项目生成 TestNg 和 Protractor 环境一样。

安装 Python

Windows

  1. 导航到 https://pythonlang.cn/ 并下载最新的 Python 版本。
  2. 安装 Python 并确保将 Python 添加到 PATH。

  3. 在命令行窗口中输入 python 以检查安装。

  4. 重启 Webtestit。

macOS

  1. 导航到 https://pythonlang.cn/ 并下载最新的 macOS 版 Python 版本
  2. 安装 Python 并确保 将 Python 添加到 PATH

  3. 在终端中输入 python 以检查安装。

  4. 重启 Webtestit。

Linux

  1. 打开终端。
  2. 输入以下命令

    sudo apt update

    sudo apt install software-properties-common

    sudo add-apt-repository ppa:deadsnakes/ppa

    sudo apt update

    sudo apt install python3.7

  3. 在终端窗口中输入 Python 3.7 以检查安装。

  4. 确保通过在终端中输入以下命令来安装 Pip 包管理系统

    sudo apt install python3-pip

  5. 安装以下内容以获得正确的虚拟环境支持

    sudo apt install python3-venv

  6. 重启 Webtestit。

打开新项目

打开 Sencha WebTestIt 后,按照以下步骤创建一个新项目

  1. 输入项目名称。
  2. 选择 Python 和 unittest 作为语言选项和框架。
  3. 单击 保存。Sencha WebTestIt 为您准备工作环境。

创建页面对象

要使用 Python 测试 Web GUI,您需要使用选择器查找网页元素。Sencha WebTestIt 使用推荐的 页面对象模式 来组织选择器。通过为网页上的重要组件(例如,标题、菜单或内容区域)创建页面对象,您可以更轻松地处理每个组件的 Web 元素,从而使您的测试更易于维护。

在 Sencha WebTestIt 中创建 Python 项目后,下一步是创建页面对象。

使用 demoshop 页面 来演示如何识别和获取页面对象。

在这里,您可以看到我们可以从此页面创建至少三个页面对象,包括标题、项目概览和购物车。查看下图。

现在,为标题组件创建一个页面对象。单击创建 新建页面对象文件 或右键单击 pageobjects 文件夹,然后选择 新建 > 页面对象文件

创建以“Po”为后缀的页面对象类是一个好习惯。由于我们使用 Python,我们建议您使用蛇形命名法,即在命名页面对象时,在字符之间放置下划线,且不留空格。

标题组件的页面对象应命名为 header_po.py

在为 demoshop 页面的其他组件创建页面对象时使用相同的策略,这意味着它们将被命名为 items_overview_po.pyshopping_cart_po.py 等。

但是,对于此演示,我们不会创建这些。我们需要另一个用于 “Super Cool Goo”详细信息页面 的页面对象。让我们创建它并将其命名为 detail_page_po.py

创建页面对象操作

现在我们已经将所有元素添加到我们的页面对象中,我们将对它们启动一些操作。

将元素从 元素 选项卡拖放到页面对象代码中。Sencha WebTestIt 创建一个反映该操作的方法。

首先将 _search_input 拖动到 header_po 代码中。释放鼠标后,将出现下拉菜单,允许您选择要使方法基于的操作。对于此元素,从弹出菜单中选择 执行 > 在元素中键入 以发送文本。

将函数命名为 insert_search_text,您的代码如下所示

def insert_search_text(self, text):
    self.wait.until(EC.visibility_of_element_located(self.search_input)).send_keys(text)

    return self

header_po 中的其余元素重复拖放方法,但这次从弹出菜单中选择 获取 > 元素的文本。您的代码应如下所示

def get_cart_amount(self):
    cart_count_count = self.wait.until(EC.visibility_of_element_located(self._cart_count)).text

    return cart_count_count

def get_cart_count(self):
    cart_count_text = self.wait.until(EC.visibility_of_element_located(self._cart_count)).text

    return cart_count_text

以相同的方式,将所有元素添加到 detail_page_po 代码,并为每个元素选择适当的操作,例如,按钮选择 执行 > 单击元素,文本元素选择 获取 > 元素的文本,等等。

您可以在 Sencha WebTestIt 此处 查看元素上所有可用操作的列表。

最终,您的 detail_page_po 中的方法应如下所示

def get_product_name(self):
    product_name_text = self.wait.until(EC.visibility_of_element_located(self._product_name)).text

    return product_name_text

def get_product_price(self):
    product_price_text = self.wait.until(EC.visibility_of_element_located(self._product_price)).text

    return product_price_text

def add_product_to_cart(self):
    self.wait.until(EC.visibility_of_element_located(self._add_to_cart_button)).click()

    return self

def get_confirmation_message(self):
    cart_confirmation_message_text = self.wait.until(EC.visibility_of_element_located(self._cart_confirmation_message)).text

    return cart_confirmation_message_text

请记住,您可以继续自由编辑所有操作,或将更多元素拖动到新生成的方法中。

编写测试

在添加所有元素并对其启动操作后,就该创建我们的测试了。

  1. 右键单击项目树中的 Tests 文件夹,然后选择 新建 > 测试文件
  2. 将文件命名为 tc1.py。如您所见,您没有对测试文件名使用蛇形命名法,因为测试文件需要不带下划线或空格的驼峰命名法。
  3. 新的测试文件生成一个空存根,指导您如何使用 AAA(Arrange, Act, Assert,安排、执行、断言)模式编写测试,以帮助您保持测试结构良好、清晰且可读。

Sencha WebTestIt 还负责 unittest 框架对编写和执行测试的一些重要要求,例如将测试放入类中作为方法,并在 unittest.TestCase 类中使用特殊的断言方法而不是内置的 assert 语句。

最后,您的测试应如下所示

def test_search_for_item(self):

    driver = self.get_driver()
    """
    1. Arrange
    Create a new Page Object instance by right-clicking into
    the code editor and selecting "Instantiate Page Object"
    at the bottom of the context menu
    """
    header = header_po(driver)
    detail = detail_page_po(driver)

    header.open("https://demoshop.webtestit.com")
    """
    2. Act
    Call an existing action from your Page Object instance
    """
    header.insert_search_text("Super")
    """
    3. Assert
    Use unittest assertions to verify results.
    e.g.:
    self.assertEqual(title, "Test Automation for GUI Testing | Sencha")
    """
    self.assertEqual(detail.get_product_name(), "Super Cool Goo")
    self.assertEqual(detail.get_product_price(), "€1,500.00")

def test_add_item_to_cart(self):

    driver = self.get_driver()

    header = header_po(driver)
    detail = detail_page_po(driver)
    detail.open("https://demoshop.webtestit.com/product/super-cool-goo/")

    detail.add_product_to_cart()

    self.assertTrue(detail.get_confirmation_message in ""Super Cool Goo" has been added to your cart")
    self.assertEqual(header.get_cart_count(), "1 item")
    self.assertEqual(header.get_cart_ammount(), "€1,500.00")

执行测试

要执行我们的测试,您需要创建一个端点。端点是一组关于我们测试的运行时环境的配置,例如要使用的浏览器、操作系统和设备等等。在 Sencha WebTestIt 中,您可以定义本地、远程或自定义端点来运行您的测试。

创建端点

  1. 单击 执行 选项卡中的 添加端点
  2. 在添加所有必需的参数后,单击 保存端点
  3. 单击 运行当前测试文件运行所有测试文件 以执行您的测试。

测试执行完成后,Sencha WebTestIt 会在您的项目中创建一个新文件夹 Reports。您的测试报告将自动在 报告 选项卡中打开,向您显示测试运行的结果。您还可以通过单击 Reports 文件夹中的 XML 文件来打开报告。如果您按照本文中的所有步骤操作,您的测试用例应该可以无错误地执行。但是,您的测试可能会失败。在这种情况下,Sencha WebTestIt 为您提供了创建错误工单并直接从您的测试报告中解决问题的能力,这要归功于与 Jira 的集成

WebTestIt