Skip to content
This repository has been archived by the owner on Sep 21, 2022. It is now read-only.

Commit

Permalink
Clarify --noCalibrate option usage
Browse files Browse the repository at this point in the history
Move its description to the description of `browsers` field and
provide example.
  • Loading branch information
Sergey Tatarintsev committed May 15, 2015
1 parent 70e8955 commit 9ea8107
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 27 deletions.
45 changes: 26 additions & 19 deletions doc/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,25 +40,37 @@ Config file options:
* `browsers` – list of browsers to use for testing. Each browser should be available
on Selenium Grid.

`browsers` field format:
`browsers` field format:

```yaml
browsers:
<browser-id>:
browserName: <name>
version: <version>
# ... other browser capabilities as <key>: <value>
```
```yaml
browsers:
<browser-id>:
browserName: <name>
version: <version>
# ... other browser capabilities as <key>: <value>
```

It is possible to use multiple versions of the same browser (if all versions are
available on your Selenium Grid instance).
It is possible to use multiple versions of the same browser (if all versions are
available on your Selenium Grid instance).

If version is omitted, any browsers of the specified name will be used.
If version is omitted, any browsers of the specified name will be used.

`<browser-id>: <name>` is a shortcut for `<browser-id>: {browserName: <name>}`.
`<browser-id>: <name>` is a shortcut for `<browser-id>: {browserName: <name>}`.

`<browser-id>` value is used for browser indentification in test reports and for
constructing screens file names.
`<browser-id>` value is used for browser indentification in test reports and for
constructing screens file names.

gemini supports custom capability option `--noCalibrate`. By default it's false and this enables browser calibration.
It is required for such cases when web driver captures screenshots with some area outside of the browser view.
Calibration makes browser to render a special page which allows to determine html body bounds and crop the screenshot
accordingly. If needed you can disable calibration for particular browser by setting `--noCalibrate` to `true`:

```yaml
browsers:
chrome:
browserName: chrome
--noCalibrate: true
```

* `projectRoot` – root directory of a project. All relative paths in config or options
will be resolved relatively to it. By default it is the directory config file is placed
Expand All @@ -78,11 +90,6 @@ on Selenium Grid.
`browsers` option instead) and `takesScreenshot` (always set to `true`
automatically).

gemini supports custom capability option `--noCalibrate`. By default it's false and this enables browser calibration.
It is required for such cases when web driver captures screenshots with some area outside of the browser view.
Calibration makes browser to render a special page which allows to determine html body bounds and crop the screenshot
accordingly. If needed you can disable calibration for particular browser by setting `--noCalibrate` to `true`.

* `debug` (CLI: `--debug`, env: `GEMINI_DEBUG`) – turn on debug logging to the terminal.
* `parallelLimit` – by default, `gemini` will run all browsers in parallel.
Sometimes (i.e. when using cloud services, such as SauceLabs) you have a
Expand Down
25 changes: 17 additions & 8 deletions doc/config.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,28 @@ browsers:
version: <version>
# ...другие свойства браузера в формате <key>: <value>
```
Допустимо указывать несколько версий одного и того же браузера (только в том случае, если эти версии доступны в вашем экземпляре Selenium Grid). Если версия не указана, будет использована любая доступная версия браузера с указанным именем.
Допустимо указывать несколько версий одного и того же браузера (только в том случае, если эти версии доступны в вашем экземпляре Selenium Grid). Если версия не указана, будет использована любая доступная версия браузера с указанным именем.

Сокращенный вариант записи `<browser-id>: {browserName: <name>}` – `<browser-id>: <name>`.

Значение `<browser-id>` используется для идентификации браузера в отчётах и в именах файлов скриншотов.


В gemini есть спциальный параметр `--noCalibrate`. Его значение равно `false` по умолчанию. Это включает калибровку
браузера. Калибровка нужна для случаев когда веб драйвер делает скриншоты браузера, захватывающие бОльшую область,
чем занимает отрисованный документ (html body). То есть на картинке помимо страницы, могут быть, например, контролы
навигации браузера. Калибровка открывает в браузере специальную страницу, которая позволяет определить границы документа
на скриншоте и отрезать лишнее.

Если необходимо, калибровку можно отключить для конкретного браузера установкой `--noCalibrate` в значение `true`:

```yaml
browsers:
chrome:
browserName: chrome
--noCalibrate: true
```

* `projectRoot` – корневой каталог проекта. Относительно этого каталога будут назначены все относительные
пути в других настройках и опциях. По умолчанию, это каталог, в котором расположен конфигурационный файл.
* `screenshotsDir` (CLI: `--screenshots-dir`, env: `GEMINI_SCREENSHOTS_DIR`) – каталог для хранения файлов со снимками экрана, указанный относительно директории конфигурационного файла. По умолчанию – `gemini/screens`.
Expand All @@ -62,13 +78,6 @@ browsers:
Можно настроить любой параметр за исключением `browserName`/`version` (вместо этого используйте
`browsers`) и `takesScreenshot` (автоматически заявлено как `true`).

В gemini есть спциальный параметр `--noCalibrate`. Его значение равно `false` по умолчанию. Это включает калибровку
браузера. Калибровка нужна для случаев когда веб драйвер делает скриншоты браузера, захватывающие бОльшую область,
чем занимает отрисованный документ (html body). То есть на картинке помимо страницы, могут быть, например, контролы
навигации браузера. Калибровка открывает в браузере специальную страницу, которая позволяет определить границы документа
на скриншоте и отрезать лишнее.

Если необходимо, калибровку можно отключить для конкретного браузера установкой `--noCalibrate` в значение `true`.

* `debug` (CLI: `--debug`, env: `GEMINI_DEBUG`) – включить отладочный вывод в терминал.
* `parallelLimit` – число браузеров запускаемых `Gemini` параллельно.
Expand Down

0 comments on commit 9ea8107

Please sign in to comment.