Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions blog/selectivity.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Селективность запуска тестов
slug: selectivity-intro
hide_table_of_contents: false
date: 2025-12-03T14:00
---

В Testplane добавлена селективность запуска тестов — возможность автоматически запускать только те тесты, для которых изменились файлы, от которых они зависят.

<!-- truncate -->

Селективность позволяет значительно ускорить процесс тестирования, запуская только релевантные тесты вместо всего набора. Testplane отслеживает зависимости каждого теста от файлов проекта — как код самих тестов, так и код, выполняемый в браузере — и при изменении файла запускает только те тесты, которые от него зависят.

### Как использовать

Узнайте больше об этом в нашей документации [Как настроить селективность при запуске тестов](/docs/v8/guides/selectivity).

### Заключение

Обновляйтесь на последнюю версию Testplane и попробуйте селективность в своих проектах! В случае обнаружения проблем приходите в [issue github](https://github.com/gemini-testing/testplane/issues) — мы вам обязательно поможем!
58 changes: 58 additions & 0 deletions docs/config/browsers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1017,6 +1017,64 @@ export = {
};
```

## Selectivity {#selectivity}

This section allows you to configure Testplane's selective test execution, avoiding the launch of tests for which nothing has changed.

The section has the following parameters:

<table>
<thead>
<tr>
<td>**Parameter**</td>
<td>**Type**</td>
<td>**Default**</td>
<td>**Description**</td>
</tr>
</thead>
<tbody>
<tr>
<td>`enabled`</td>
<td>`boolean`</td>
<td>`false`</td>
<td>Enables selective test execution.</td>
</tr>
<tr>
<td>`sourceRoot`</td>
<td>`string`</td>
<td>`""`</td>
<td>Configures the path to the root of the source code files.</td>
</tr>
<tr>
<td>`testDependenciesPath`</td>
<td>`string`</td>
<td>`".testplane/selectivity"`</td>
<td>The path to the directory where test dependency data will be saved.</td>
</tr>
<tr>
<td>`compression`</td>
<td>`"none" | "gz" | "br" | "zstd"`</td>
<td>`"gz"`</td>
<td>The compression type applied to the test dependency data.</td>
</tr>
<tr>
<td>`disableSelectivityPatterns`</td>
<td>`string[]`</td>
<td>`[]`</td>
<td>
A list of patterns. If a file matching one of these patterns is changed, selectivity
will be disabled.
</td>
</tr>
</tbody>
</table>

<Admonition type="info">
You should not specify `node_modules` in `disableSelectivityPatterns`, as this will cause a
significant slowdown. Instead, it is recommended to specify Testplane configuration files and
the application's backend source code.
</Admonition>

[desired-caps]: https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities
[html-reporter]: ../../html-reporter/html-reporter-setup
[got]: https://github.com/sindresorhus/got/
Expand Down
256 changes: 256 additions & 0 deletions docs/guides/selectivity.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,256 @@
import Admonition from "@theme/Admonition";

# How to configure selectivity when running tests

## Introduction

Selectivity allows you to significantly speed up the testing process by running only relevant tests instead of the entire test suite. Testplane tracks each test's dependencies on project files — both the test code itself and the code executed in the browser — and, when a file changes, runs only those tests that depend on it.

## How does it work?

On the first run with selectivity enabled, Testplane collects dependency information for each test:

- which Node.js modules were loaded while the test was running;
- which source files were executed in the browser.

After a file changes, on the next run only those tests that depend on the changed file will be executed. This saves a lot of time, especially in large projects with many tests.

<Admonition type="info">
If at least one test fails, then on the next run all the same tests will be executed again —
Testplane will "remember" the new state only after a fully successful run.
</Admonition>

## Setup

To enable selectivity, just add a [`selectivity`](/docs/v8/config/browsers#selectivity) section with `enabled: true` to your Testplane configuration:

```typescript
// testplane.config.ts
export default {
gridUrl: "local",
baseUrl: "about:blank",
pageLoadTimeout: 20000,
httpTimeout: 20000,
testTimeout: 90000,
resetCursor: false,
sets: {
desktop: {
files: ["testplane-tests/**/*.testplane.(t|j)s"],
browsers: ["chrome", "firefox"],
},
},
browsers: {
chrome: {
headless: true,
desiredCapabilities: {
browserName: "chrome",
},
},
firefox: {
desiredCapabilities: {
browserName: "firefox",
},
},
},
selectivity: {
enabled: true,
},
} satisfies import("testplane").ConfigInput;
```

## Usage example

Let’s enable selectivity in a project with `chrome` and `firefox` browsers. For convenience, we’ll also configure a [devServer][dev-server]:

```ts
// testplane.config.ts
const DEV_SERVER_PORT = 3050;

export default {
baseUrl: `http://127.0.0.1:${DEV_SERVER_PORT}`,
// ... Other settings
devServer: {
command: `npm run dev -- --port=${DEV_SERVER_PORT}`,
reuseExisting: true,
readinessProbe: {
url: `http://127.0.0.1:${DEV_SERVER_PORT}`,
},
},
selectivity: {
enabled: true,
},
} satisfies import("testplane").ConfigInput;
```

We’ll also enable SourceMap generation in the Webpack config used by the project:

```js
// webpack.config.js
module.exports = (env, argv) => {
return {
// ...
// Use multiple entry points
entry: {
main: './js/home.js',
about: './js/about.js',
contact: './js/contact.js',
shared: './js/shared.js'
},
// Enable SourceMap generation
// Both external (`source-map`) and inline (`inline-source-map`) are suitable
devtool: 'source-map',
output: {
// Specify a template that Webpack will use to store paths to source files
// `[resource-path]` or `[absolute-resource-path]` will also work
devtoolModuleFilenameTemplate: "webpack://[resource-path]",
},
```

For the example we’ll use a plain JavaScript project without React, with the following file structure:

```
.
|____css
| |____home.css
| |____shared.css
| |____about.css
|____js
| |____about.js
| |____home.js
| |____main.js
| |____contact.js
| |____shared.js
|____index.html
|____about.html
|____contact.html
|____webpack.config.js
|____testplane.config.ts
|____testplane-tests
| |____example.testplane.ts
| |____tsconfig.json
|____package.json
|____package-lock.json
```

Let’s write the following tests:

```ts
describe("test examples", () => {
it("main page", async ({ browser }) => {
await browser.url("/");
});

it("main page with navigation to about page", async ({ browser }) => {
await browser.url("/");
await browser.$("#about-link").click();
});

it("main page with navigation to contact page", async ({ browser }) => {
await browser.url("/");
await browser.$("#contact-link").click();
});

it("contact page", async ({ browser }) => {
await browser.url("/contact");
});
});
```

And run Testplane. For clarity, we’ll use the `DEBUG=testplane:selectivity` environment variable:

![First run log](/img/docs/guides/selectivity/first-run.png)

Let’s try running it again:

![Log with no changes](/img/docs/guides/selectivity/no-changes.png)

When there are no changes, running all tests is skipped.

Now let’s change a couple of source files that are executed in the browser:

![Single test run log](/img/docs/guides/selectivity/single-test-run.png)

Only one test that depends on the changed files was run. The rest were skipped by selectivity.

The same applies to test code selectivity: let’s create `./testplane-tests/my-module.ts`:

```ts
export const foo = () => {
throw new Error("bar");
};
```

And use it in the test file:

```ts
import { foo } from "./my-module";

describe("test examples", () => {
it("main page", async ({ browser }) => {
foo();
await browser.url("/");
});
// The rest of the tests
});
```

Now run the tests:

![Failed test log](/img/docs/guides/selectivity/test-fail.png)

While processing the test file, Testplane noticed that it now depends on another file, which means the functionality might have changed, so all tests in this file were run.

But since the tests failed, the new state was not saved, so re-running the tests will run the same set of tests again.

## Important details

### Collecting browser dependencies

Testplane records browser dependencies only in the Chrome browser, because dependency collection works via the [Chrome Devtools Protocol](/docs/v8/reference/webdriver-vs-cdp). However, if you have multiple browsers (for example, Chrome and Firefox), Firefox will still be able to use the list of browser dependencies for a test that was collected in Chrome.

### SourceMap requirement

For selectivity to work correctly, **SourceMap generation is required**. Thanks to SourceMaps, the browser can understand which source file the executed code belongs to. If a SourceMap is not generated for a code file, Testplane won’t be able to determine which source file the executed code comes from, and selectivity will not work correctly.

### Server-side code and disableSelectivityPatterns

Testplane cannot track code that runs on your server, regardless of the language it’s written in. Therefore, it’s recommended to add your server-side code to the `disableSelectivityPatterns` option — any change to files matching these patterns will disable selectivity and run all tests.

If you are using the [reactStrictMode](https://nextjs.org/docs/pages/api-reference/config/next-config-js/reactStrictMode) option of the [Next.js](https://nextjs.org/) framework, rendering pages in the browser as well will allow Testplane to account for these files as if this were a regular SPA application. However, code executed exclusively on the server (such as API request handlers) will not be considered by Testplane’s selectivity.

You should also add your Testplane configuration files (for example, `testplane.config.ts`) to `disableSelectivityPatterns`, since changing them can affect the behavior of any test.

<Admonition type="warning">
Do not add `node_modules` to `disableSelectivityPatterns` — this will significantly slow things
down. Testplane tracks the used modules from `node_modules` on its own.
</Admonition>

Example `disableSelectivityPatterns` configuration:

```typescript
selectivity: {
enabled: true,
disableSelectivityPatterns: [
"testplane.config.ts",
"backend/**/*.py", // server-side code in Python
"server/**/*.go", // server-side code in Go
]
}
```

### Manually disabling selectivity

When you use other filtering methods when running Testplane (such as specifying a path to a test file or using the `--grep` and `--set` options), selectivity is automatically disabled.

You can also disable selectivity manually using an environment variable:

```bash
testplane_selectivity_enabled=false # disable
```

## Configuration

Additional information about selectivity configuration is provided in the [browsers-selectivity][selectivity-config] section of the documentation.

[dev-server]: ../../config/dev-server
[selectivity-config]: ../../config/browsers#selectivity
20 changes: 20 additions & 0 deletions i18n/en/docusaurus-plugin-content-blog/selectivity.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Test run selectivity
slug: selectivity-intro
hide_table_of_contents: false
date: 2025-12-03T14:00
---

Testplane now supports test run selectivity — the ability to automatically run only those tests whose dependency files have changed.

<!-- truncate -->

Selectivity allows you to significantly speed up the testing process by running only relevant tests instead of the entire suite. Testplane tracks each test’s dependencies on project files — both the test code itself and the code executed in the browser — and, when a file changes, runs only those tests that depend on it.

### How to use

Learn more in our guide [How to configure selectivity when running tests](/docs/v8/guides/selectivity).

### Conclusion

Upgrade to the latest Testplane version and try selectivity in your projects! If you encounter any issues, feel free to open an [issue on GitHub](https://github.com/gemini-testing/testplane/issues) — we’ll be happy to help!
Loading