.. _gsauto_offline:

Режим offline
=============

.. versionadded:: 1.1.2 Добавлена поддержка режима offline.

- Режим применяется для запуска программ и тестов с ``gs-automation``
  без доступа к сети Интернет (закрытый контур).

- Режим включается установкой значения ``true`` в :ref:`параметре <gsauto_envprops>`
  :java:type:`selenium.offline <ru.bitec.gs.automation.parameters.GsAutoProps.SeleniumOffline>` (:ref:`gsauto_offline_selenium_offline`).

- В режиме offline библиотека использует только установленные в системе веб-браузеры (:ref:`gsauto_offline_select_browser`).

- В режиме offline библиотека использует встроенные версии `веб-драйверов <https://www.selenium.dev/documentation/webdriver/>`__ (:ref:`gsauto_offline_boxed_drivers`).

- Встроенные веб-драйверы поставляются в :ref:`компоненте <gsauto_ug_artifacts>` ``gs-automation-webdrivers-x.x.x.jar`` (:ref:`gsauto_offline_boxed_drivers`).

- Предоставляется возможность использовать сторонний веб-драйвер, указав путь до
  его исполняемого файла в :ref:`параметре <gsauto_envprops>` :java:type:`selenium.driver <ru.bitec.gs.automation.parameters.GsAutoProps.SeleniumDriver>` (:ref:`gsauto_offline_external_drivers`).

.. _gsauto_offline_selenium_offline:

Включение режима offline
------------------------

Параметр включения:

- :java:type:`selenium.offline <ru.bitec.gs.automation.parameters.GsAutoProps.SeleniumOffline>` = ``true``
  (см. :ref:`gsauto_envprops`, :ref:`gsauto_ug_envprops`).

При установке значения ``true`` gs-automation подберет для :ref:`выбранного <gsauto_offline_select_browser>` веб-браузера подходящий
:ref:`встроенный <gsauto_offline_boxed_drivers>` веб-драйвер.

.. _gsauto_offline_boxed_drivers:

Встроенные веб-драйверы
-----------------------

- Встроенные веб-драйверы поставляются в :ref:`компоненте <gsauto_ug_artifacts>` ``gs-automation-webdrivers-x.x.x.jar``.
- При включении режима offline веб-драйверы распаковываются в ``.cache/gs-automation-selenium``
  в домашней папке текущего пользователя.
- Если папка не может быть создана или нет прав на запись, используется системная временная папка.
- Если временная папка также недоступна, библиотека завершает работу с :ref:`ошибкой <gsauto_offline_errors>`.

.. note::

   В режиме offline gs-automation использует только установленные в системе веб-браузеры.

.. caution::

   Веб-драйверы имеют повышенную чувствительность к версии веб-браузера.

   При невозможности использовать установленную
   в системе версию веб-браузера, библиотека gs-automation остановит свою работу с :ref:`ошибкой <gsauto_offline_errors>`.

   В этом случае эксплуатанту нужно самостоятельно скачать доступным способом соответствующую версию веб-драйвера и
   указать путь до него в соответствующем :ref:`параметре <gsauto_offline_external_drivers>`.

.. _gsauto_offline_select_browser:

Выбор используемого веб-браузера
--------------------------------

Параметр выбора браузера:

- :java:type:`browser.name <ru.bitec.gs.automation.parameters.GsAutoProps.Browser>`
  (см. :ref:`gsauto_envprops`, :ref:`gsauto_ug_envprops`).

- Допустимые значения: ``Chrome``, ``Edge``, ``Firefox``, ``Yandex``.
- Значение по умолчанию: ``Chrome``.

.. note::

   При использовании браузера Yandex режим offline включается автоматически.

.. _gsauto_offline_supported_browsers:

Поддерживаемые веб-браузеры и платформы
```````````````````````````````````````

.. list-table:: Веб-браузеры и платформы
   :widths: auto
   :header-rows: 1

   * - Веб-браузер
     - Платформы
   * - Chrome
     - windows x64, linux x64
   * - Edge
     - windows x64, linux x64
   * - Firefox
     - windows x64
   * - Yandex
     - windows x64, linux x64


.. _gsauto_offline_external_drivers:

Назначение стороннего веб-драйвера
----------------------------------

Предоставляется возможность использовать сторонний веб-драйвер.

:ref:`Параметры <gsauto_envprops>`:

- :java:type:`selenium.driver <ru.bitec.gs.automation.parameters.GsAutoProps.SeleniumDriver>` задает путь
  до исполняемого файла веб-драйвера.
- :java:type:`selenium.offline <ru.bitec.gs.automation.parameters.GsAutoProps.SeleniumOffline>` должно быть ``true``.

Ограничения:

- При назначении параметра ``selenium.driver`` библиотека не проверяет совместимость указанного веб-драйвера с ОС, архитектурой CPU
  и установленным браузером.
- Любые ошибки выполнения стороннего веб-драйвера приводят к остановке работы с :ref:`ошибкой <gsauto_offline_errors>`.

.. _gsauto_offline_errors:

Ошибки, причины и рекомендации по исправлению
---------------------------------------------

.. list-table:: Ошибки режима offline
   :widths: auto
   :header-rows: 1

   * - Ситуация
     - Причина
     - Рекомендация
   * - Не удалось создать ``.cache/gs-automation-selenium`` и/или временную папку
     - Нет прав на запись
     - Обеспечить доступ на запись в домашнюю или временную папку
   * - Совместимый встроенный веб-драйвер не найден
     - Для выбранного веб-браузера нет подходящего встроенного веб-драйвера
     - Установить и указать сторонний веб-драйвер через
       :java:type:`selenium.driver <ru.bitec.gs.automation.parameters.GsAutoProps.SeleniumDriver>`
   * - Веб-браузер не обнаружен
     - Выбранный веб-браузер не установлен в системе
     - Установить браузер или использовать сторонний веб-драйвер
   * - Версия установленного веб-браузера несовместима со встроенным веб-драйвером
     - Несоответствие версий браузера и драйвера
     - Установить совместимый браузер или использовать сторонний web-драйвер
   * - Ошибка выполнения стороннего веб-драйвера
     - Несовместимость, повреждение или неверный путь к файлу веб-драйвера
     - Проверить корректность файла и совместимость веб-драйвера

.. seealso::

   - Руководство пользователя: :ref:`gsauto_ug_envprops`
   - Спецификация: :ref:`gsauto_envprops`
   - API: :java:type:`ru.bitec.gs.automation.parameters.GsAutoProps <ru.bitec.gs.automation.parameters.GsAutoProps>`