文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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

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

成员标志

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

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

类图标

- 表示框架类

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

- 组件类型的框架类(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) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

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

桌面 -vs- 移动视图

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

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

查看类源代码

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

Sencha Test 2.4.0


顶部

Sencha Test 归档服务器

Sencha Test 提供了一个名为“结果归档服务器”的组件。这是可以存储测试结果以供稍后通过 Sencha Test Studio GUI 查看的区域。

设置结果归档服务器

要设置归档服务器,必须创建一个名为 storage.json 的配置文件。此文件必须包含一个或多个存储区域定义。

存储区域定义为一个属性,其名称是用户需要知道的键,以便存储结果。该值是一个对象,其中包含其归档文件将存储在相对于服务器根目录的物理路径。

这是一个示例存储区域。

{
    "my_storage_key": {
        "path": "/mystoragearea"
    }
}

注意:用户必须知道键 my_storage_key,才能在指定服务器上的 /mystoragearea 下的归档文件中存储测试结果。键本身可以是任何值。

这些路径可能包含多个目录级别。这些路径不包含任何特殊含义。服务器管理员可以查看这些路径,以便组织测试结果归档和/或提供跨团队和项目的隔离。键是自由格式的字符串。

在以下示例中,存储区域按团队分隔。每个团队(在本例中为开发人员和 QA)都需要知道他们的密钥,以便将结果存储在各自的存储区域中。

{
    "889jwx093jr8wuwer": {
        "path": "/developers"
    },

    "sccmnn840394843": {
        "path": "/qa"
    }
}

在下一个示例中,团队为他们的每个项目隔离了存储区域。

{
    "879fnas9d8jf70sd": {
        "path": "/TeamA/project1"
    },

    "mx348r343mr34cj": {
        "path": "/TeamA/project2"
    },

    "sdnaaa090ilss": {
        "path": "/TeamB/project1"
    }
}

启动归档服务器

要启动结果归档服务器,请在专用目录中创建一个 storage.json 文件,并从那里,从您的 CLI 运行以下命令

stc server

然后您应该看到成功消息

Archive server listening on port 1903

这是一个关于如何在机器上设置归档服务器的示例

mkdir archiveserver
cd archiveserver
vim storage.json #configure storage areas - see examples above
stc server

归档服务器连接选项

为了将结果归档发送到配置的归档结果服务器,您可以将以下开关与 stc run 一起使用。

-S <server_address> - 归档服务器地址。例如,如果归档服务器主机 IP 地址为 192.168.1.42,则该值将为 http://192.168.1.42:1903(包括端口号)。

-K <key> - 存储区域的密钥。要在 /TeamA/project2 中存储结果(以上示例),该值将为 mx348r343mr34cj

在以下示例中,我们正在

  • 存储 tests\unit_tests 的结果
  • 输出类型为 teamcity
  • 在名为 My WebDriver Pool 的池中
  • 在托管在 192.168.1.42:1903 上的归档服务器上,端口为 1903
  • 使用密钥 mx348r343mr34cj

示例

stc run -o teamcity -p "My WebDriver Pool" -s tests\unit_tests -S http://192.168.1.42:1903 -K mx348r343mr34cj

预期输出

在服务器上成功存储结果后,预计输出类似于以下内容


Uploading archive to https://127.0.0.1:1903
Server response: 200 - Archive received
user:~$
Client: successfully uploaded test result archive

Receiving archive 28ea1080-a2a5-11e5-ac7d-51ab7d509196.zip
Archive 28ea1080-a2a5-11e5-ac7d-51ab7d509196.zip extracted to /home/user/archiveserver/TeamA/project2/foo/orion/28ea1080-a2a5-11e5-ac7d-51ab7d509196
Server: successfully received test result archive

将多个场景作为单个构建运行

单个测试项目通常具有多个场景。在这些情况下,您可能希望将多个场景作为 CI 系统中的单个“构建”的一部分运行。这使您可以在 Sencha Studio 中将所有场景结果视为单个结果集。

例如,您可能具有场景 A 和场景 B,并且您希望在每次合并代码时都运行这两个场景。

一旦所有场景完成,归档服务器将合并来自场景 A 和 B 的结果,然后 Sencha Studio 可以将聚合结果显示为一个逻辑构建或测试运行编号。

结果合并

Sencha Test 使您能够以两种不同的方式合并测试结果。

归档服务器配置

在此方法中,您需要将 allowOverwrite 键添加到您的配置中。例如

{
    "multiscenario": {
        "path": "/multiscenario",
        "allowOverwrite": true
    }
}

STC 命令

您还可以将 overwrite 标志添加到您的 STC 命令中。例如

stc run -s Dashboard -p embedded -S https://127.0.0.1:1903 -K multiscenario -n 6 --overwrite

Sencha Test 2.4.0