Test summary
test_summaryCounts tests by state, tag, or annotation from test files without running them, with optional grouping by file or tag. Use it to answer how many tests are skipped or where.
Instructions
Counts a project's tests by state (active, skip, fixme, todo, expectedToFail, notLoaded) and by tag and annotation, from the test files, without running them. Use it first, for questions such as how many tests are skipped, or which files or tags have the most skipped tests; use find_tests to list the tests themselves. states, tags and grep count only the tests they match. groupBy "file" or "tag" adds the counts of each file or tag, sorted by name and paged with limit and cursor; a test with no tag is in no tag group. Example: {"states": ["skip", "fixme"], "groupBy": "file"}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| grep | No | Keeps tests whose fullName (describe titles and title joined with " > ") matches this regular expression, ignoring case. | |
| tags | No | Keeps tests with one of these tags, written as in the titles, such as "@smoke". | |
| limit | No | The most items to return. | |
| cursor | No | nextCursor from the previous answer, for the next page. Keep the other arguments the same. | |
| states | No | Keeps tests in one of these states. | |
| groupBy | No | Adds the counts of each file or each tag. | |
| patterns | No | Globs of the test files, relative to `directory`, such as ["tests/**/*.spec.ts"]. Default: the ones the server was started with. | |
| directory | No | A folder inside the project to scan, relative to its root, such as "packages/web". Default: the root. | |
| framework | No | The test runner. Default: the one the server was started with. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hint | Yes | ||
| total | Yes | ||
| groups | Yes | ||
| summary | Yes | Counts over the matching tests; fileCount is every file scanned. | |
| framework | Yes | ||
| nextCursor | Yes | ||
| scanErrors | Yes | Problems of level error in the scan, which may leave tests out of the answer. | |
| frameworkVersion | Yes |