文档帮助

术语、图标和标签

许多类在使用配置对象创建(实例化)时使用简写名称。简写名称称为别名(如果类扩展了 Ext.Component,则称为xtype)。为了便于参考,在适用类的类名旁边列出了别名/xtype。

访问级别

框架类或其成员可以指定为privateprotected。否则,该类/成员为publicPublicprotectedprivate是访问描述符,用于传达类或类成员的使用方式和时间。

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
protected

在初始化items配置期间或添加新项目时,将原始配置对象添加到此容器时调用added), or {@link #insert inserted.

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

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

参数

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 原语页面)都具有与该类相关的元数据的菜单视图。此元数据视图将包含以下一项或多项

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

Sencha Test 2.4.0


顶部

Sencha Test 概述

Sencha Test 是 Sencha 平台的关键组成部分,它帮助开发人员和测试工程师在应用程序中实现新的质量水平,同时在整个测试过程中提供急需的生产力提升。Sencha Test 通过将最佳的开源测试库(如 Jasmine、WebDriver 和 Istanbul)整合在一起,添加缺失的部分并将所有内容集成到一个全面的解决方案中来实现这一点。

产品组件

Sencha Test 包含两个应用程序:Sencha Studio(用于 GUI)和stc 或“Sencha Test 命令”(用于命令行)。这两个应用程序都提供执行测试的能力,但是 Sencha Studio 提供了一个图形化的交互式测试运行器,而 stc 提供了一个可脚本化的测试运行器,适用于在 Jenkins 或 TeamCity 等持续集成 (CI) 系统中无人值守使用。这些应用程序还协同工作以提供强大的测试结果归档和审查功能,这些功能超越了 CI 提供的构建日志和线性视图。

Sencha Studio

Sencha Studio

Sencha Studio 使用项目来组织测试,可以是独立项目(当应用程序代码不可用时),也可以是在工作区中与它们支持的应用程序和包一起使用。Sencha Studio 可以与您的 Sencha Cmd 应用程序以及不使用 Sencha Cmd 的应用程序集成。

您可以使用 Sencha Studio 的内置文本编辑器直接编写测试,也可以使用您自己的首选 IDE 或文本编辑器。Sencha Studio 的文本编辑器提供代码完成和辅助功能,这些功能了解 Jasmine(Sencha Test 中包含的测试框架)和 Sencha Test API。

测试与应用程序文件一样,通常保存在版本控制系统中(如 Git、Subversion 等)。即使在独立测试项目中,出于备份和团队协作的原因,这也是正确的。

交互式/GUI 测试运行器

Sencha Test 的基石是其测试运行器,它使交互式测试运行器成为 Sencha Studio 最重要的组件。测试运行器旨在在开发的所有阶段使用。这种迭代过程帮助开发人员交付健壮的应用程序,因为每个部分在构建时都可以轻松测试。

测试运行器允许开发人员或测试工程师选择特定的测试,在多个浏览器上并行执行它们,并实时查看结果。

无人值守/CLI 测试运行器

一旦测试代码被纳入源代码管理系统,就可以使用 Sencha Test 命令 (stc) 在 CI 系统中无人值守地运行它们。Sencha Studio 显示和编辑的测试配置,可以被命令行测试运行器无缝使用。这种 CI 和 stc 的组合,使测试运行能够轻松地被源代码管理系统中的更改触发,或者以定期循环的方式触发,例如每晚一次。

在命令行中运行的测试使用 WebDriver 来管理所需的浏览器。Sencha Test 支持使用本地 WebDriver 集线器,以及连接到基于云的提供商,例如 Sauce Labs 或 BrowserStack。

CI 使用 stc 的各种输出选项捕获测试结果,也可以将结果上传到 Sencha Test 归档器。使用 Sencha Studio,可以以与交互式测试运行器相同的图形格式查看归档的测试结果。

Sencha Test 归档器

Sencha Test 归档器是一个基于 Node JS 的 Web 服务器,由 stc 提供。归档器(或“归档服务器”)通常安装在 CI 环境中的指定机器上。一个归档服务器可以配置为处理任意数量的团队和项目。或者,可以根据需要安装多个归档服务器。

主要功能

除了测试运行器之外,Sencha Test 还提供了一些重要的功能,旨在使测试变得简单高效。

测试管理和配置

Sencha Studio 简化了开始编写和运行测试所需的设置和配置。这从工作区作为组织根目录开始,并继续配置测试项目测试场景。Sencha Studio 允许开发人员配置测试运行的所有方面,从测试对象的所在位置,到测试清单和各种运行时选项。所有这些设置都可以在交互式测试运行器中进行验证,然后再移至 CI 系统。

浏览器农场集成

维护现实世界测试所需的众多浏览器组合并不总是可行或可取的。Sencha Test 内置支持 Sauce Labs 和 BrowserStack 等浏览器农场,因此开发人员和测试工程师不必成为 IT 专家才能运行测试。这些解决方案还可以大幅缩短测试执行时间,因为测试可以在多个浏览器上同时运行,而无需付出太多努力。

测试 API

Sencha Test 了解 Sencha 框架,如 Ext JS 和 ExtReact,以及非 Sencha Web 应用程序。Sencha Test API 提供了许多功能,可以最大程度地减少测试 Ext JS 和其他 Web 应用程序所需的努力。虽然大多数测试框架(包括 Jasmine)本质上是同步的,但 Sencha Test 提供了一个名为“Futures API”的 API 族,它认识到 GUI 测试的异步性质。

使用 Futures API,可以以简单紧凑的方式表达复杂的 GUI 交互序列。在幕后,Sencha Test 确保测试步骤在典型情况下无需测试作者的帮助即可正确安排。例如

ST.grid('#userGrid').               // locate a grid via component query
    rowWith('firstName', 'Bill').   // and select the row w/matching field
        cell('lastName').           // then select a cell given a column id
            reveal().               // scroll to this cell
            textLike('Preston');    // -> wait for the text to match a pattern

如果单元格在超时时间内(可以设置为 0)没有所需的文本,则测试将失败。

Futures API 提供了更多 Ext JS 和 ExtReact 组件感知方法,以及用于处理原始 DOM 元素的 API。验证逻辑可以轻松地添加到事件序列中,自定义等待条件也可以同样轻松地插入。

事件记录器

使用 Sencha Studio 的内置文本编辑器,用户可以启动事件记录器,以快速记录并将事件序列直接插入到测试中。

事件记录器将启动应用程序,运行当前测试,然后在用户与应用程序交互时记录事件流。这些事件可以在插入到测试之前进行编辑和过滤。

使用事件记录器可以节省大量时间来启动测试用例。录制可以不经修改地运行,以确保没有生成错误,或者可以扩展自定义期望或断言,以确保显示了正确的信息。

检查工具

Sencha Studio 还提供了一种机制来检查正在运行的 Web 应用程序中的组件或元素,并生成稳定的定位器,这些定位器可用于在用户的测试中引用这些组件/元素。

一旦检查工具被用来收集所需的定位器,它们就可以直接插入到测试套件中,以及相应的 Future API,或者可以创建一个页面对象,允许定位器存储和管理在一个中心位置,而不是在多个地方重复定位器字符串。

结果审查

当测试运行结果保存到归档服务器时,Sencha Studio 可以下载这些结果并以与交互式测试运行程序相同的格式显示它们:按文件夹(垂直)和按浏览器(水平)组织。这种格式比通过阅读 CI 构建日志来查找故障模式要高效得多。

然而,除了通过/失败类型的结果之外,Sencha Studio 还允许开发人员和测试工程师审查视觉测试结果以及代码覆盖率。

视觉屏幕比较

Sencha Test 还提供了一种简单的方法来通过捕获屏幕截图并将其与基线进行比较来验证正确的应用程序状态。这与在适当的时间使用 ST.screenshot() API 一样简单。基线(或预期)图像在测试首次运行时自动建立。如果屏幕截图与已建立的基线不匹配,后续测试运行将产生测试失败。

虽然计算测试更快,并且通常在可以使用时优先使用,但视觉测试有时是测试应用程序某些方面的唯一方法。例如,设置颜色或文本对齐等内容的 CSS 规则的结果,以及图表等高度视觉化的组件。

屏幕截图是在无人值守测试运行(通过 stc)期间使用 WebDriver 捕获的。这些与从归档服务器获得的基线进行比较,结果存储在归档服务器中,以便稍后在 Sencha Studio 中进行审查。如果正确答案随着时间的推移而发生变化,Sencha Studio 也能够更新基线。

代码覆盖率

Sencha Test 包含一个集成版本的 Istanbul,这是一个领先的 JavaScript 代码覆盖率工具,您可以使用它来识别您已覆盖和未覆盖的代码量之间的差距。利用这种集成,Sencha Test 以可读的格式提供对语句、分支、函数和行的详细细分,并进行百分比分析。

使用代码覆盖率报告是减少由于关键代码未经适当测试而导致的项目风险的好方法。

Sencha Test Code Coverage

结论

有关安装和开始使用 Sencha Studio 的说明,请参阅 Sencha Studio 安装和设置 指南。如果您有任何其他问题、疑虑或错误报告,请访问 Sencha Test 论坛

Sencha Test 2.4.0