文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护的

当原始配置对象添加到此容器时调用,无论是在 items 配置的初始化期间,还是在 added) 或 {@link #insert inserted} 新项时。

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

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

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

展开和折叠示例和类成员

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

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

桌面与移动视图

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

查看类源代码

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

WebTestIt


顶部

目录

结论

Java 示例中的数据驱动测试

有时您会遇到想要使用各种输入进行测试的功能 - 以查看系统的行为方式、测试预期结果,或者查看系统是否以奇怪的方式崩溃。

将所有这些排列组合连接到一组自动化测试中可能是一项相当艰巨的任务,并且这些测试往往难以长期维护。幸运的是,在这种情况下,有一种方法可以使事情变得更容易(正如您在 Sencha WebTestIt 中已经习惯的那样)。

数据驱动测试

这种简洁的测试设计策略允许您创建测试脚本,这些脚本从 Excel 表格、CSV 文件、数据库等数据源读取和导入测试数据,而不是使用硬编码的值。在本文中,我们将描述我们的数据驱动示例项目,该项目使用精美的 @DataProvider 从 CSV 文件中读取测试数据。基本上,我们将使用存储在 CSV 文件中的 3 组凭据测试此登录表单。目标是从 CSV 文件中读取数据并在实际测试中使用它。

  • 首先,在项目树中创建一个名为 data 的文件夹,您可以在其中存储实际的 CSV 文件并创建数据提供程序类文件。

注意

您经常会在互联网上找到一些示例,告诉您将 DataProvider 放入实际的测试文件中。这对于快速演示来说是可以的,但应避免这样做,而应支持关注点和多个测试文件中的可重用性的清晰分离。

根据测试要求,每个测试的 CSV 文件格式可能略有不同。文件可能包含也可能不包含标题记录,值可以放在单引号或双引号下,因此可能需要一些额外的操作才能获取实际数据。在我们的例子中,我们逐行读取数据,并使用索引将其保存到 ArrayList 中。

  • 创建 CredentialsDataProvider.java 类:让我们继续并在我们的数据文件夹中创建 CredentialsDataProvider.java` 类文件。
    使用 CSVReader,我们将从 CSV 文件中读取数据。文件的每一行代表一个凭据组合。

由于 DataProvider 需要二维 Object[][], 我们必须转换从 CSVReader 获取的 ArrayList<Object[]>。

现在我们已经完成了 CSVReader 和实际 @DataProvider 的设置,我们将在测试中使用我们的 CSV 数据来填充用户名和密码字段,并断言登录成功/失败消息。

数据提供程序将二维对象返回到测试方法,并且测试方法将在 M * N 类型的对象数组中调用 M 次。例如,如果 DataProvider 返回一个 3*3 对象数组,则相应的测试用例将使用三个参数调用三次。

  • 创建测试文件 - 对于实际测试,我们创建了一个新的测试文件,并在 @Test 注释中,我们指定了我们的数据提供程序,该数据提供程序被命名为“Credentials”,以及 dataProviderClass 的类型 (CredentialsDataProvider.class)。

  • 在报告中显示测试用例名称 使用实现的 ITest 接口,并使用以下方法在 @BeforeMethod 注释下格式化测试名称

      public void BeforeMethod(Method method, Object[] testData) {
      testName.set(String.format("%s [Username: '%s'; Pass: '%s']", method.getName(), testData[0], testData[1]));
    }
    

    当然可以自定义,我们将在报告中提供测试用例名称。不要忘记添加 @Override 注释,以便完成您的自定义测试用例名称。

    @Override
      public String getTestName() {
          return testName.get();
      }
    

    由于我们的 CSV 文件包含三组凭据,因此此测试将执行三次。第一个凭据是正确的,另外两个是错误的。我们将通过尝试所有凭据并断言显示正确的消息来测试登录表单。

  • 创建自定义断言消息:使用 org.testng.Assert.assertEquals(String actual, String expected, String message) 方法并创建自定义消息(迭代指示器)以防测试失败。该消息将在报告中可见,为您提供有关哪一组凭据在登录时导致该测试运行的登录确认消息不正确的信息。

结论

有三个测试场景:第一个场景,其中将正确的凭据提交到表单并断言成功消息,另外两个场景,其中提交了不正确的凭据并断言了登录失败消息。

此外,测试报告中显示的自定义断言消息可帮助您识别哪一组凭据导致测试失败。

注意

直接从应用程序的欢迎屏幕的“示例”类别下下载此示例项目。此示例项目也可用于从我们的 Git 存储库下载。

WebTestIt