yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
playwright/docs/src/test-reporter-api/class-suite.md

66 lines
1.9 KiB
Markdown
Raw Normal View History

docs(test runner): api reference for reporter api (#7811)
2021-07-22 19:56:36 -07:00
# class: Suite
* langs: js
`Suite` is a group of tests. All tests in Playwright Test form the following hierarchy:
* Root suite has a child suite for each [TestProject].
* Project suite #1. Has a child suite for each test file in the project.
* File suite #1
* [TestCase] #1
* [TestCase] #2
* Suite corresponding to a [`method: Test.describe`] group
* [TestCase] #1 in a group
* [TestCase] #2 in a group
* < more test cases ... >
* File suite #2
* < more file suites ... >
* Project suite #2
* < more project suites ... >
Reporter is given a root suite in the [`method: Reporter.onBegin`] method.
## method: Suite.allTests
- returns: <[Array]<[TestCase]>>
Returns the list of all test cases in this suite and its descendants, as opposite to [`property: Suite.tests`].
## property: Suite.location
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?".
2022-04-06 19:02:10 -07:00
- type: ?<[Location]>
docs(test runner): api reference for reporter api (#7811)
2021-07-22 19:56:36 -07:00
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?".
2022-04-06 19:02:10 -07:00
Location in the source where the suite is defined. Missing for root and project suites.
docs(test runner): api reference for reporter api (#7811)
2021-07-22 19:56:36 -07:00
feat(reporter): expose more apis (#9603)
2021-10-19 08:38:04 -07:00
## property: Suite.parent
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?".
2022-04-06 19:02:10 -07:00
- type: ?<[Suite]>
feat(reporter): expose more apis (#9603)
2021-10-19 08:38:04 -07:00
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?".
2022-04-06 19:02:10 -07:00
Parent suite, missing for the root suite.
feat(reporter): expose more apis (#9603)
2021-10-19 08:38:04 -07:00
docs: Suite.project is a method, not a property (#10135)
2021-11-08 10:08:46 -08:00
## method: Suite.project
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?".
2022-04-06 19:02:10 -07:00
- returns: ?<[TestProject]>
feat(reporter): expose more apis (#9603)
2021-10-19 08:38:04 -07:00
Configuration of the project this suite belongs to, or [void] for the root suite.
docs(test runner): api reference for reporter api (#7811)
2021-07-22 19:56:36 -07:00
## property: Suite.suites
- type: <[Array]<[Suite]>>
Child suites. See [Suite] for the hierarchy of suites.
## property: Suite.tests
- type: <[Array]<[TestCase]>>
Test cases in the suite. Note that only test cases defined directly in this suite are in the list. Any test cases defined in nested [`method: Test.describe`] groups are listed
in the child [`property: Suite.suites`].
## property: Suite.title
- type: <[string]>
Suite title.
* Empty for root suite.
* Project name for project suite.
* File path for file suite.
* Title passed to [`method: Test.describe`] for a group suite.
## method: Suite.titlePath
- returns: <[Array]<[string]>>
Returns a list of titles from the root down to this suite.
Reference in New Issue Copy Permalink