Document session mode

gemini-testing · Apr 14, 2015 · bec1d32 · bec1d32
1 parent 048e483
commit bec1d32
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/doc/config.md b/doc/config.md
@@ -89,6 +89,9 @@ on Selenium Grid.
   limit on a number of browser that can be run once at a time. Use this
   option to limit the number of browsers that `gemini` will try to run in
   parallel.
+* `sessionMode` — allows to choose how to launch new WebDriver sessions:
+  - `perBrowser` (default) — launch 1 session per browser. This session will be reused for all of the suites.
+  - `perSuite` — launch 1 new session for each browser per suite and finish the session when the suite ends.
 * `strictComparison` – test will be considered as failed in case of any kind of error. By default, only noticeable differences are treated
 as test failure.
 * `referenceImageAbsence` – treat reference image as `error` or `warning`. Default value is `error`.

diff --git a/doc/config.ru.md b/doc/config.ru.md
@@ -73,6 +73,9 @@ browsers:
 * `debug` (CLI: `--debug`, env: `GEMINI_DEBUG`) – включить отладочный вывод в терминал.
 * `parallelLimit` – число браузеров запускаемых `Gemini` параллельно.
 По умолчанию запускаются все, но иногда (например, при использовании облачных сервисов вроде Sauce Labs) это число необходимо контролировать.
+* `sessionMode` — позволяет указать, как именно запускать новые сессии WebDriver:
+  - `perBrowser` (по умолчанию) — запуск одной сессии для каждого браузера. Эта сессия будет переиспользована для всех наборов.
+  - `perSuite` — запуск 1 сессия в каждом браузере для каждого набора. Сессия будет закрыта как только набор протестирован.
 * `strictComparison` – считать тест провальным в случае любого рода ошибки. По умолчанию, только заметные различия считаются провалом теста.
 * `referenceImageAbsence` – считать отсутствие эталонного шаблона предупреждением (`warning`) или ошибкой (`error`). По-умолчанию ошибка (`error`).
 * `tolerance` - определяет предельно допустимое различие между цветами по метрике [CIEDE2000](https://ru.wikipedia.org/wiki/%D4%EE%F0%EC%F3%EB%E0_%F6%E2%E5%F2%EE%E2%EE%E3%EE_%EE%F2%EB%E8%F7%E8%FF#CIEDE2000).