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
23 changes: 11 additions & 12 deletions docs/basic-guides/browsers-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Testplane runs tests in real browsers and is not tied to specific versions or a

You describe the required browsers in the [`browsers`](../reference/config/browsers.mdx) section, and the [`gridUrl`](../reference/config/browsers.mdx#grid_url) parameter determines where to get them from: locally, from a Docker grid (e.g., Selenoid), or from a remote cloud (BrowserStack, Sauce Labs).

**General workflow:**
**General workflow**

1. Testplane reads the `browsers` section
2. For each browser, it takes the `gridUrl` (common or overridden at the browser level)
Expand Down Expand Up @@ -71,7 +71,7 @@ The browser version is set in `desiredCapabilities.browserVersion`. For local br

The [`headless: true`](../reference/config/browsers.mdx#headless) parameter enables running the browser without a graphical interface.

**Important points:**
**Important points**

- Test behavior is identical: from the test's perspective, a browser with `headless: true` and `headless: false` works exactly the same. For example, when running with `headless: true`, you can still take screenshots, work with the DOM, and execute any commands.

Expand Down Expand Up @@ -140,8 +140,7 @@ TESTPLANE_BROWSERS_PATH=./node_modules/.testplane npx testplane install-deps

#### Removing Browsers

- Delete the .testplane directory in the home folder
- Or delete the directory specified in `TESTPLANE_BROWSERS_PATH`
Delete the .testplane directory in the home folder or the directory specified in `TESTPLANE_BROWSERS_PATH`.

### Browser Support {/* #browser-support */}

Expand All @@ -151,8 +150,8 @@ Below is a table of supported browsers:
| ------- | ------------- | -------------------- | ---------------- |
| Chrome | + | + | + |
| Firefox | + | + | + |
| Edge | - | + | + |
| Safari | - | + | + |
| Edge | | + | + |
| Safari | | + | + |

Supported browser versions depending on OS:

Expand All @@ -161,7 +160,7 @@ Supported browser versions depending on OS:
| Chrome | 73+ | 73+ | 73+ | 73+ | 73+ |
| Firefox | 60+ | 60+ | 60+ | 91+ | 126+ |
| Edge | \* | \* | \* | \* | \* |
| Safari | - | \* | - | - | - |
| Safari | | \* | | | |

> `*` — browser auto-download is not supported, but if the browser is installed by the user, Testplane will use the installed version.

Expand Down Expand Up @@ -212,9 +211,9 @@ Local browsers are suitable for development, quick runs, and debugging, but not

## Browsers in Docker Containers

Docker containers provide an isolated and reproducible environment, convenient for CI/CD. Selenoid is often used — a lightweight implementation of Selenium Grid that runs browsers inside containers.
Docker containers provide an isolated and reproducible environment, convenient for CI/CD. Selenoid is often used — a lightweight implementation of Selenium Grid. It runs browsers inside containers.

**Selenoid:**
**Selenoid**

- Manages browsers in Docker containers
- Automatically scales containers
Expand Down Expand Up @@ -318,7 +317,7 @@ Create a `browsers.json` file describing the required browsers:

#### Starting Selenoid

Start Selenoid, specifying the path to the configuration (in the example, the config is located at `/home/selenoid-config/browsers.json`):
To start Selenoid, specify the path to the configuration (in the example, the config is located at `/home/selenoid-config/browsers.json`):

```bash
docker run --rm -d \
Expand Down Expand Up @@ -432,13 +431,13 @@ Docker is well-suited for CI/CD and screenshot testing where stability and repro

## Remote Grids

Cloud services (BrowserStack, Sauce Labs, etc.) provide a wide range of browsers, OSes, and real devices for cross-browser testing.
Cloud services such as BrowserStack and Sauce Labs provide a wide range of browsers, OSes, and real devices for cross-browser testing.

### Connection and Authentication

To connect, you need to specify the service's `gridUrl` and pass credentials via `user` and `key`. It is recommended to store them in environment variables.

The basic browser configuration remains the same, only the `gridUrl` changes and cloud provider-specific options are added:
The basic browser configuration remains the same, only the `gridUrl` changes, and cloud provider-specific options are added:

```ts title="testplane.config.ts"
export default {
Expand Down
2 changes: 1 addition & 1 deletion docs/basic-guides/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ export default {
} satisfies ConfigInput;
```

In this example, Testplane can run up to 5 parallel Chrome sessions and up to 3 Firefox sessions, distributing tests among 4 worker processes.
In this example, Testplane can run up to 5 parallel Chrome sessions and up to 3 Firefox sessions and distributes tests among 4 worker processes.

## Timeouts {/* #timeouts */}

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ To download the browsers described in the config separately from running Testpla
npx testplane install-deps
```

Without running this command beforehand, missing browsers will be automatically downloaded the first time Testplane is launched.
If you don't run this command beforehand, Testplane will automatically download the missing browsers on the first run.

## First run {/* #first-run */}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Testplane запускает тесты в реальных браузерах

Вы описываете нужные браузеры в секции [`browsers`](../reference/config/browsers.mdx), а параметр [`gridUrl`](../reference/config/browsers.mdx#grid_url) определяет, откуда их брать: локально, из Docker-грида (например, Selenoid) или из удаленного облака (BrowserStack, Sauce Labs).

**Общая схема работы:**
**Общая схема работы**

1. Testplane читает секцию `browsers`
2. Для каждого браузера берет `gridUrl` (общий или переопределенный на уровне браузера)
Expand Down Expand Up @@ -71,7 +71,7 @@ export default {

Параметр [`headless: true`](../reference/config/browsers.mdx#headless) включает запуск браузера без графического интерфейса.

**Важные моменты:**
**Важные моменты**

- Поведение тестов идентично: с точки зрения тестов браузер с `headless: true` и `headless: false` работает полностью одинаково. Например, при запуске с `headless: true` все еще можно делать скриншоты, работать с DOM, выполнять любые команды.

Expand Down Expand Up @@ -140,19 +140,18 @@ TESTPLANE_BROWSERS_PATH=./node_modules/.testplane npx testplane install-deps

#### Удаление браузеров

- Удалите директорию .testplane в домашней папке
- Или удалите каталог, указанный в `TESTPLANE_BROWSERS_PATH`
Удалите директорию .testplane в домашней папке или каталог, указанный в `TESTPLANE_BROWSERS_PATH`.

### Поддержка браузеров {/* #browser-support */}

Ниже представлена таблица поддерживаемых браузеров:

| Браузер | Авто-загрузка | Авто-загрузка драйвера | Запуск webdriver |
| ------- | ------------- | ---------------------- | ---------------- |
| Chrome | + | + | + |
| Firefox | + | + | + |
| Edge | - | + | + |
| Safari | - | + | + |
| Браузер | Автозагрузка | Автозагрузка драйвера | Запуск webdriver |
| ------- | ------------ | --------------------- | ---------------- |
| Chrome | + | + | + |
| Firefox | + | + | + |
| Edge | | + | + |
| Safari | | + | + |

Поддерживаемые версии браузеров в зависимости от ОС:

Expand All @@ -161,9 +160,9 @@ TESTPLANE_BROWSERS_PATH=./node_modules/.testplane npx testplane install-deps
| Chrome | 73+ | 73+ | 73+ | 73+ | 73+ |
| Firefox | 60+ | 60+ | 60+ | 91+ | 126+ |
| Edge | \* | \* | \* | \* | \* |
| Safari | - | \* | - | - | - |
| Safari | | \* | | | |

> `*` — авто-загрузка браузера не поддерживается, но если браузер установлен пользователем, Testplane будет использовать установленную версию.
> `*` — автозагрузка браузера не поддерживается, но если браузер установлен пользователем, Testplane будет использовать установленную версию.

### Запуск тестов

Expand Down Expand Up @@ -212,9 +211,9 @@ export default {

## Браузеры в Docker-контейнерах

Docker-контейнеры дают изолированное и воспроизводимое окружение, удобное для CI/CD. Часто используют Selenoid — легковесную реализацию Selenium Grid, которая запускает браузеры внутри контейнеров.
Docker-контейнеры дают изолированное и воспроизводимое окружение, удобное для CI/CD. Часто используют Selenoid — легковесную реализацию Selenium Grid. Она запускает браузеры внутри контейнеров.

**Selenoid:**
**Selenoid**

- Управляет браузерами в Docker-контейнерах
- Автоматически масштабирует контейнеры
Expand Down Expand Up @@ -318,7 +317,7 @@ export default {

#### Запуск Selenoid

Запустите Selenoid, указав путь к конфигурации (в примере конфиг лежит в `/home/selenoid-config/browsers.json`):
Для запуска Selenoid укажите путь к конфигурации (в примере конфиг лежит в `/home/selenoid-config/browsers.json`):

```bash
docker run --rm -d \
Expand Down Expand Up @@ -432,13 +431,13 @@ Docker хорошо подходит для CI/CD и скриншотного т

## Удаленные гриды

Облачные сервисы (BrowserStack, Sauce Labs и др.) дают широкий набор браузеров, ОС и реальных устройств для кросс-браузерного тестирования.
Облачные сервисы (такие как BrowserStack и Sauce Labs) дают широкий набор браузеров, ОС и реальных устройств для кросс-браузерного тестирования.

### Подключение и аутентификация

Для подключения нужно указать `gridUrl` сервиса и передать учетные данные через `user` и `key`. Рекомендуется хранить их в переменных окружения.

Базовая конфигурация браузеров остается той же, меняется только `gridUrl` и добавляются специфичные опции облачного провайдера:
Базовая конфигурация браузеров остается той же, меняется только `gridUrl`, и добавляются специфичные опции облачного провайдера:

```ts title="testplane.config.ts"
export default {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ export default {
} satisfies ConfigInput;
```

В этом примере Testplane может запустить до 5 параллельных сессий Chrome и до 3 сессий Firefox, распределяя тесты между 4 воркер-процессами.
В этом примере Testplane может запустить до 5 параллельных сессий Chrome и до 3 сессий Firefox и распределяет тесты между 4 воркер-процессами.

## Тайм-ауты {/* #timeouts */}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,13 @@ export default {

Полный список параметров конфигурации ищите в [справочнике по конфигурации](../reference/config/main.mdx).

Чтобы загрузить браузеры, описанные в конфиге, отдельно от запуска самого Testplane, выполните команду:
Чтобы загрузить браузеры, которые описаны в конфиге, отдельно от запуска самого Testplane, выполните команду:

```bash
npx testplane install-deps
```

Без предварительного запуска команды недостающие браузеры будут автоматически загружены с первым запуском Testplane.
Если не запустить команду заранее, Testplane автоматически загрузит при первом запуске браузеры, которых не хватает.

## Первый запуск {/* #first-run */}

Expand Down
Loading