文档帮助

内容

术语、图标和标签 访问级别 成员类型 成员语法 成员标志 类图标 成员图标 导航和功能 类成员快速导航菜单 Getter 和 Setter 方法 历史记录栏 搜索和过滤器 API 文档类元数据 展开和折叠示例和类成员 桌面 -vs- 移动视图 查看类源代码

术语、图标和标签

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

访问级别

框架类或其成员可以指定为private或protected。否则，该类/成员为public。Public、protected和private是访问描述符，用于传达如何以及何时使用该类或类成员。

成员类型

成员语法

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

Ext.container.Container
查看源代码
lookupComponent ( item ) : Ext.Component
protected

当在items配置的初始化期间或添加新项目时，将原始配置对象添加到此容器中时调用added，或{@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 原语页面）都有一个与该类相关的元数据的菜单视图。此元数据视图将包含以下一个或多个内容

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

Sencha Test 2.4.0


顶部

内容

命令行语法 必需标志 可选标志 代码覆盖率 屏幕截图比较 基于云的浏览器农场选项

Sencha Test CLI (STC)

为了提供与 Jenkins 和 Teamcity 等持续集成 (CI) 服务器的集成，Sencha Test 允许您从命令行执行现有场景的测试。命令行工具不支持启动本地浏览器，这意味着必须为目标场景配置浏览器农场和浏览器池。

让我们逐步了解如何通过 CLI 执行测试。

命令行语法

从命令行执行测试的基本命令行语法如下

stc run -p pool -s scenario

必需标志

以下是必须通过命令行执行传递的必需标志

  • -p <pool> 或 --pool <pool> - 将执行测试的池的名称。这必须与浏览器农场关联的池。您可以将其设置为 embedded 以使用嵌入式浏览器池（Google Chrome）

  • -s <scenario> 或 --scenario <scenario> - 要执行的场景的路径。如果未指定，则默认为当前目录

在以下示例中，要从 Windows 命令行运行，我们正在执行以下测试

  • 位于 test\unit_tests 的场景

  • 在名为 My WebDriver Pool 的浏览器池中 

      stc run -s test\unit_tests -p "My WebDriver Pool"

可选标志

以下是可使用的可选标志

  • -u <username> 或 --user <username> - 浏览器农场（Sauce Labs 和 BrowserStack）的用户名

  • -k <key> 或 --key <key> - 浏览器农场（Sauce Labs 和 BrowserStack）的访问密钥

  • -o <output> - 输出格式。支持的值为 text、teamcity 和 junit。默认值为 text

  • --scenarioName <name> - 要执行的场景名称。如果多个场景共享相同的底层文件夹（但显示名称不同），则可以定义场景的名称

  • -c <callback_address> 或 --callbackAddress <callback_address> - 浏览器连接到本地机器的地址（如果与 localhost 不同）

  • -x <proxy_port> 或 --proxyPort <proxy_port> - 浏览器内代理的端口号（自 Sencha Test 2.2.1 起可用）

  • -S <archive_server> 或 --archiveServer <archive_server> - 归档服务器地址

  • -K <storage_key> 或 --storageKey <storage_key> - 归档服务器中存储区域的密钥

  • -O 或 --overwrite - 覆盖归档服务器中指定构建号的现有结果

  • -n <build_number> 或 --buildnumber <build_number> - 构建号

  • -b <baseline> 或 --baseline <baseline> - 基线目录的路径

  • -C 或 --coverage - 为本次会话启用代码覆盖率（仅适用于浏览器内场景）

  • -a <archive_dir> 或 --archivedir <archive_dir> - 存储报告文件和结果存档的路径

  • -t <timeout> 或 --timeout <timeout> - 浏览器通信超时时间（毫秒）

  • --cmd <cmd> - Sencha Cmd 的路径（如果不在默认位置）

  • --capability <capability> - 添加或覆盖 Selenium Server 的所需功能（键=值）

  • --debug - 将日志级别设置为更高的详细程度

以下部分将进一步讨论上述某些标志。

代码覆盖率

可以为浏览器内场景启用代码覆盖率，如下所示

-C - 为本次会话启用代码覆盖率

要从代码覆盖率报告的范围内排除文件/文件夹，请使用 Sencha Studio 中的项目设置屏幕。例如，应排除 Ext JS SDK 目录，因为您希望将代码覆盖率分析集中在您自己的应用程序代码上。要排除 ext 目录中的所有代码文件，请使用以下代码覆盖率过滤器

^/ext/.*?$

要访问代码覆盖率报告，请使用 Sencha Studio 查看已保存到归档服务器的测试结果。

屏幕截图比较

要执行来自屏幕截图的图像比较，Sencha Test 将使用现有运行作为参考（基线），与之比较每个图像。如果不存在用于比较的基线，则所有比较都将通过，然后可以将生成的存档目录指定为将来比较的基线。

要使用特定结果存档作为基线，必须将其复制或重命名为 ${workspace.dir}/reports/baseline。或者，可以使用 -b 开关指定任何任意结果存档目录。

-b <baseline> - 要用作图像比较基线的結果存档目錄的路径

默认情况下，Sencha Studio 会为每次测试执行分配一个动态生成的构建号。要为给定测试运行指定构建号，可以使用 -n 开关。

-n <build_number> - 测试执行的构建号

通过指定基线目录和构建号，可以控制与测试执行相关的所有目录和文件名。这样，就可以轻松地存档测试结果并在 CI 系统中获取任意基线。

基于云的浏览器农场选项

为了在基于云的浏览器农场（如 SauceLabs 或 BrowserStack）中执行测试，您可以指定凭据和回调地址。以下是可能应用的选项

-u <username> - 浏览器农场的用户名

-k <key> - 浏览器农场的访问密钥

--notunnel - 如果指定，则禁用自动启动和拆除到指定云提供商的隧道。使用此开关时，必须在本地机器或同一网络中的专用主机中为指定的用户名运行隧道。

注意：自动连接隧道功能目前在产品中不可用。所有隧道都需要手动创建，直到内置自动隧道创建功能。

-c <callback_address> - 回调地址 - 农场浏览器可以拨回到 Sencha Test 代理的宿主或 IP 地址。如果未指定，则默认为 localhost。此开关在使用专用隧道时特别有用。在这种情况下，它很可能是本地机器的 LAN IP 地址。

在以下从 Linux 命令行运行的示例中，我们正在执行以下测试：

  • 在 tests\unit-tests 中找到的测试

  • 在名为 SauceLabs pool 的池中

  • 以 Jenkins 格式提供输出

  • 使用凭据 username:xxxxx-xxxx-xxxx-xxxx-xxxxx

  • 不会自动启动 SauceConnect 隧道。这意味着用户负责手动启动一个。

  • 所有浏览器都将尝试连接到 http://192.168.1.42

示例 

stc run -o junit -p "SauceLabs pool" -s tests\unit_tests -u user -k *x-x-x-x-x* --notunnel -c *192.168.1.42*

Sencha Test 2.4.0