.. _gsauto_envprops:

Параметры окружения
===================


Настройка библиотеки выполняется через параметры окружения.

Параметры окружения можно указать в:

   - Файле свойств ``gs-automation.properties`` в текущей рабочей директории.
   - Переменных окружения операционной системы.
   - Аргументах командной строки программы или тестового фреймворка.

Порядок поиска значения
-----------------------

1. Файл свойств.
2. Переменные окружения операционный системы.
3. Аргументы командной строки.
4. Значение по умолчанию (если оно определено).

Название параметра
------------------

Название параметра формируется на основе базового названия.

В зависимости от источника значений:

- В файле свойств используется базовое название.
- В переменных окружения добавляется префикс ``GSAUTO_``, базовое название приводится
  к верхнему регистру, точки заменяются подчёркиваниями.
- В аргументах командной строки к базовому названию добавляется префикс ``gsauto.``.


Справочник параметров
---------------------

Перечислены допустимые параметры.

.. list-table:: Параметры окружения
   :widths: auto
   :header-rows: 1

   * - Название параметра
     - Тип значения
     - Значение по умолчанию
   * - :java:type:`browser.window.width <ru.bitec.gs.automation.parameters.GsAutoProps.BrowserWindowWidth>`
     - Integer
     - 1280
   * - :java:type:`browser.window.height <ru.bitec.gs.automation.parameters.GsAutoProps.BrowserWindowHeight>`
     - Integer
     - 1024
   * - :java:type:`browser.name <ru.bitec.gs.automation.parameters.GsAutoProps.Browser>`
     - :java:type:`SupportedBrowser <ru.bitec.gs.automation.driverproviders.WebDriverBuilder.SupportedBrowser>`
     - :java:type:`Chrome <ru.bitec.gs.automation.driverproviders.WebDriverBuilder.SupportedBrowser.Chrome>`
   * - :java:type:`browser.headless <ru.bitec.gs.automation.parameters.GsAutoProps.Headless>`
     - Boolean
     - false
   * - :java:type:`browser.locale <ru.bitec.gs.automation.parameters.GsAutoProps.Locale>`
     - String
     - en
   * - :java:type:`dom.colorizable <ru.bitec.gs.automation.parameters.GsAutoProps.Colorizable>`
     - Boolean
     - true
   * - :java:type:`duration.wait.application <ru.bitec.gs.automation.parameters.GsAutoProps.DurationWaitApplication>`
     - Duration
     - 60s
   * - :java:type:`duration.wait.mainform <ru.bitec.gs.automation.parameters.GsAutoProps.DurationWaitMainForm>`
     - Duration
     - 15s
   * - :java:type:`duration.wait.formopen <ru.bitec.gs.automation.parameters.GsAutoProps.DurationWaitFormOpen>`
     - Duration
     - 15s
   * - :java:type:`duration.wait.formclose <ru.bitec.gs.automation.parameters.GsAutoProps.DurationWaitFormClose>`
     - Duration
     - 10s
   * - :java:type:`duration.wait.elementclickable <ru.bitec.gs.automation.parameters.GsAutoProps.DurationWaitElementClickable>`
     - Duration
     - 2s
   * - :java:type:`duration.wait.element <ru.bitec.gs.automation.parameters.GsAutoProps.DurationWaitElement>`
     - Duration
     - 5s
   * - :java:type:`duration.dom.stability <ru.bitec.gs.automation.parameters.GsAutoProps.DurationDomStability>`
     - Duration
     - 500ms
   * - :java:type:`duration.afterall.timeout <ru.bitec.gs.automation.parameters.GsAutoProps.DurationAfterAllTimeout>`
     - Duration
     - 50ms
   * - :java:type:`host.server.address <ru.bitec.gs.automation.parameters.GsAutoProps.ServerAddress>`
     - String
     - null
   * - :java:type:`host.application.name <ru.bitec.gs.automation.parameters.GsAutoProps.ApplicationName>`
     - String
     - null
   * - :java:type:`host.startup.form.name <ru.bitec.gs.automation.parameters.GsAutoProps.StartupFormName>`
     - String
     - null
   * - :java:type:`host.user <ru.bitec.gs.automation.parameters.GsAutoProps.User>`
     - String
     - null
   * - :java:type:`host.password <ru.bitec.gs.automation.parameters.GsAutoProps.Password>`
     - String
     - null
   * - :java:type:`host.solution <ru.bitec.gs.automation.parameters.GsAutoProps.Solution>`
     - String
     - null
   * - :java:type:`host.admin.user <ru.bitec.gs.automation.parameters.GsAutoProps.AdminUser>`
     - String
     - null
   * - :java:type:`host.admin.password <ru.bitec.gs.automation.parameters.GsAutoProps.AdminPassword>`
     - String
     - null


Параметры сгруппированы по назначению:



Группа browser
``````````````

Параметры, относящиеся к выбору и поведению веб-браузера.

Группа dom
``````````

Параметры, влияющие на манипуляции с DOM-структурой страницы.

Группа duration
```````````````

Параметры, определяющие тайминги ожидания и задержки при взаимодействии с элементами страницы.

Группа host
```````````

Параметры, касающиеся подключения к серверу приложений и необходимых данных авторизации.
Это обязательные параметры. 

.. seealso::

   :java:type:`ru.bitec.gs.automation.parameters.GsAutoProps <ru.bitec.gs.automation.parameters.GsAutoProps>`