.. _gsauto_ug_artifacts:

Состав библиотеки
=================

Полный комплект библиотеки состоит из нескольких файлов (артефактов):

+----------------------------------------------+------------------------------------+
| Файл (артефакт)                              | Назначение                         |
+==============================================+====================================+
| gs-automation-x.x.x.jar                      | Основная библиотека автоматизации  |
+----------------------------------------------+------------------------------------+
| gs-automation-x.x.x-sources.jar              | Исходные коды основной библиотеки  |
+----------------------------------------------+------------------------------------+
| gs-automation-x.x.x-javadoc.jar              | Документация основной библиотеки   |
+----------------------------------------------+------------------------------------+
| gs-automation-environments-x.x.x.jar         | Окружения выполнения               |
+----------------------------------------------+------------------------------------+
| gs-automation-environments-x.x.x-sources.jar | Исходные коды окружений выполнения |
+----------------------------------------------+------------------------------------+
| gs-automation-environments-x.x.x-javadoc.jar | Документация окружений выполнения  |
+----------------------------------------------+------------------------------------+
| gs-automation-junit-x.x.x.jar                | Интеграция с JUnit                 |
+----------------------------------------------+------------------------------------+
| gs-automation-junit-x.x.x-sources.jar        | Исходные коды интеграции с JUnit   |
+----------------------------------------------+------------------------------------+
| gs-automation-junit-x.x.x-javadoc.jar        | Документация интеграции с JUnit    |
+----------------------------------------------+------------------------------------+
| gs-automation-test-x.x.x.jar                 | Собственные тесты библиотеки       |
+----------------------------------------------+------------------------------------+
| gs-automation-test-x.x.x-sources.jar         | Исходные коды собственных тестов   |
+----------------------------------------------+------------------------------------+
| gs-automation-examples-x.x.x.zip             | Примеры использования библиотеки   |
+----------------------------------------------+------------------------------------+

.. note::
   Символы x.x.x обозначают номер версии библиотеки.

Все указанные файлы доступны в публичном репозитории `https://repo.global-system.ru <https://repo.global-system.ru/ui/repos/tree/General/common/ru/bitec/gs-automation/>`__.

В зависимости от целей проекта вы определяете, какие именно файлы нужны 
вашему проекту и подключаете их в виде зависимостей.

.. seealso::

   - Спецификация: :ref:`gsauto_repository`
   - Руководство пользователя: :ref:`gsauto_ug_project`

Основные артефакты
------------------

1. **gs-automation-x.x.x.jar**
   
   Библиотека автоматизации. Обязательный артефакт для проекта, 
   использующего библиотеку.

2. **gs-automation-environments-x.x.x.jar**

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

3. **gs-automation-junit-x.x.x.jar**

   Инструменты интеграции с фреймворком JUnit. Упрощают разработку 
   модульных, UI- и интеграционных тестов.

.. seealso::

   - Спецификация: :ref:`gsauto_repository`
   - Руководство пользователя: :ref:`gsauto_ug_usage`
   - Руководство пользователя: :ref:`gsauto_ug_envprops`

Вспомогательные артефакты
-------------------------

1. Артефакты с суффиксом "-sources" содержат исходный код библиотеки и компонент.

2. Артефакты с суффиксом "-javadoc" содержат документацию (формат: javadoc)
   на API библиотеки и компонент.

.. seealso::

   - Спецификация: :ref:`gsauto_repository`

Собственные тесты библиотеки
----------------------------

Собственные тесты предназначены для проверки базовых функций 
библиотеки. Дополнительно, они являются примерами практического использования. 

Демонстрационные проекты
------------------------

Архив ``gs-automation-examples-x.x.x.zip`` содержит проекты,
иллюстрирующие материал руководства пользователя.

.. seealso::

   - Руководство пользователя: :ref:`gsauto_ug_appendix`