跳到主要内容

Suite

Suite 是一组测试用例。在 Playwright Test 中,所有测试用例形成如下层级结构:

  • 根套件(Root suite)为每个 FullProject 拥有一个子套件。
    • 项目套件 #1。该项目中的每个测试文件都有一个子套件。
    • 项目套件 #2
    • < 更多项目套件 ... >

reporter.onBegin() 方法中,Reporter 会接收到根套件(root suite)。


方法

allTests

新增于: v1.10 suite.allTests

返回该套件及其所有子孙套件中的所有测试用例列表,与 suite.tests 不同。

用法

suite.allTests();

返回值


entries

新增于: v1.44 suite.entries

直接在该套件中定义的测试用例和子套件。元素按照声明顺序返回。你可以通过 testCase.typesuite.type 区分不同的条目类型。

用法

suite.entries();

返回值


project

新增于: v1.10 suite.project

该套件所属项目的配置信息,对于根套件(root suite)则为 void

用法

suite.project();

返回值


titlePath

新增于: v1.10 suite.titlePath

返回从根套件到当前套件的标题列表。

用法

suite.titlePath();

返回值


属性

location

新增于: v1.10 suite.location

定义该套件的源码位置。对于根套件和项目套件,该属性不存在。

用法

suite.location

类型


parent

新增于: v1.10 suite.parent

父套件,对于根套件不存在该属性。

用法

suite.parent

类型


suites

新增于: v1.10 suite.suites

子套件。关于套件的层级结构请参见 Suite

用法

suite.suites

类型


tests

新增于: v1.10 suite.tests

该套件中直接定义的测试用例。请注意,只有直接在该套件中定义的测试用例才会包含在列表中。任何在嵌套的 test.describe() 分组中定义的测试用例会列在子 suite.suites 中。

用法

suite.tests

类型


title

新增于: v1.10 suite.title

套件标题。

  • 根套件为空字符串。
  • 项目套件为项目名称。
  • 文件套件为文件路径。
  • 分组套件为传递给 test.describe() 的标题。

用法

suite.title

类型


type

新增于: v1.44 suite.type

返回套件的类型。套件的层级结构如下:root -> project -> file -> describe -> ...describe -> test

用法

suite.type

类型

  • "root" | "project" | "file" | "describe"