.. _gsauto_testdata: Тестовые данные автотестов ========================== .. versionadded:: 1.2.1 Назначение ---------- Сервис тестовых данных :java:type:`TestDataService ` создаёт записи теста в базе данных, показывает в выборке только записи своего теста и ставит их удаление в системное задание очистки сервера. Тест свои данные не удаляет. Сервис решает две задачи. - Изоляция параллельных прогонов. Одновременные прогоны одного теста на одной базе данных (воркеры Gradle, задания CI разных merge request, локальные запуски) работают каждый со своими записями и не видят записи друг друга. - Удаление данных без участия теста. Данные удаляются, даже если прогон упал или был остановлен до конца. Сервис вынесен из библиотеки ``gs-automation`` в отдельный модуль ``gs-automation-service`` для собственных тестов сервера приложений. Чтобы показать записи теста, сервис присваивает маркер переменной выборки и вызывает ``selection.refresh()``. Перечитанная выборка покажет только записи теста, если её ``onRefresh`` переписан под отбор записей по маркеру (см. `Изменения в выборке`_). Со стандартным ``onRefresh`` выборка покажет все записи таблицы. Выборки тестового приложения gs-test переписываются вместе с тестами, а свой ``onRefresh`` ради автотестов в прикладных выборках не пишут, поэтому прикладным тестам сервис не подходит и в библиотеке его нет. Термины ``````` Глава говорит о трёх файлах прикладного кода сущности. Их имена образуются из имени сущности, на примере сущности ``Gs3_HugeSelection``. - :term:`Api` - класс ``<сущность>Api`` (``Gs3_HugeSelectionApi``) с кодом работы с данными сущности. Через него скрипт создаёт записи, а задание очистки их удаляет. Везде в главе "Api" означает этот класс, а не программный интерфейс вообще. - :term:`Avi` - класс ``<сущность>Avi`` (``Gs3_HugeSelectionAvi``) с кодом :term:`выборки <Выборка>` сущности, в нём заводится представление с данными автотестов. - :term:`Avm` - файл ``<сущность>.avm.xml`` (``Gs3_HugeSelection.avm.xml``) с метаданными выборки, в нём объявляется это представление. Маркер ------ Каждая запись теста помечается маркером - началом значения строкового атрибута записи. .. list-table:: :header-rows: 1 * - Что - Вид - Пример * - Маркер - ``gsauto-<время старта процесса тестов UTC>-<случайная часть>-`` - ``gsauto-20261016T101223-1a2b3c4d-`` * - Значение атрибута записи - ``<маркер><собственная часть значения>`` - ``gsauto-20261016T101223-1a2b3c4d-001`` - Маркер всегда оканчивается дефисом. Дефис - часть маркера и его контракта. Скрипт создания приписывает собственную часть значения сразу после маркера, без своего разделителя (``marker + '001'``), а выборка, которая показывает значение без маркера, отрезает от него ровно длину маркера. - Полный маркер свой у каждого экземпляра сервиса. По нему выборка показывает только записи своего теста. - Префикс ``gsauto-`` общий для всех данных автотестов. По нему задание очистки отличает данные автотестов от данных приложения и удаляет только их. Выборка получает маркер в своей строковой переменной и отбирает записи, значение атрибута которых начинается с маркера. Без маркера выборка пуста. Имя переменной передаётся при создании сервиса (:java:meth:`create `) и в сервис не зашито. Если у выборки уже есть переменная с таким именем и другим смыслом, сервису передаётся другое имя, а выборка не переделывается. Атрибут маркера ``````````````` Маркер записывается не в любой строковый атрибут и не во все. Атрибут маркера выбирает автор теста и передаёт при создании сервиса в :java:meth:`create `. Атрибут подходит, если выполнены условия: - значение атрибута задаёт скрипт создания, а не приложение (это не автонумерация и не вычисляемое значение); - в атрибут помещается маркер из 32 символов вместе с собственной частью значения. По атрибуту маркера выборка отбирает записи теста, а задание очистки находит записи автотестов на удаление. Поэтому скрипт создания, выборка и регистрация очистки используют один и тот же атрибут. Настройку очистки сервис создаёт сам при первом создании данных сущности и потом её не меняет, поэтому у сущности один атрибут маркера на все тесты. Сервис с другим атрибутом существующую настройку не меняет, и записи с маркером в другом атрибуте не удаляются. Удаление данных --------------- Данные удаляет системное задание очистки ``CleanupJob`` модуля btk. ``CleanupJob`` - системное имя задания очистки таблиц в менеджере заданий ``Btk_JobGroup``. Это готовое задание сервера приложения, его включает и настраивает администратор стенда. Сервис задание не создаёт, а добавляет в него настройку очистки на каждую сущность, в которой автотесты создают данные. .. list-table:: :header-rows: 1 * - Параметр настройки - Значение * - Класс/Таблица - ``gsauto:<сущность>``, не совпадает с настройками приложения для той же сущности * - Способ удаления - скриптом, записи удаляются через Api сущности * - Отбор записей - значение атрибута маркера начинается с ``gsauto-``, дата создания ``dCreateDate_dz`` старше срока хранения * - Время хранения - 1 день Настройку создаёт метод :java:meth:`createData ` перед выполнением скрипта создания данных. Отдельного метода регистрации нет, поэтому создать данные без регистрации их удаления нельзя. Вручную настройку заводить не нужно. Сущность не передаётся, а вычисляется по полному имени выборки, потому что выборка сущности и её Api носят имя сущности (``Gs3_HugeSelectionAvi``, ``Gs3_HugeSelectionApi``). Поэтому данные создаются в форме выборки той сущности, в которой скрипт создаёт записи. Представление с данными автотестов заводится в выборке самой сущности, а не в отдельной выборке, которая только показывает её записи. - Регистрация хранится в базе данных, поэтому данные прерванного прогона тоже удаляются. - На сущность в базе одна настройка. Проверка существования и вставка выполняются под межсессионной блокировкой btk, поэтому одновременные прогоны не заводят вторую настройку. - Настройка создаётся, только если её ещё нет. Существующая настройка не изменяется, и ручные изменения администратора, например срок хранения, сохраняются. - В пределах процесса тестов наличие настройки проверяется один раз на сущность. - Регистрация проверяет, что задание ``CleanupJob`` (системное имя задания очистки таблиц в менеджере заданий ``Btk_JobGroup``) есть, включено и имеет тип "Очистка данных". Иначе тест падает до создания данных. Задание выполняется по своему расписанию, по умолчанию раз в сутки. Данные идущих прогонов моложе срока хранения и не удаляются. Требования ---------- - На сервере включено выполнение jexl (опция ``jexlExecution``, см. :ref:`gsauto_serverconfig`). - Системное задание ``CleanupJob`` (системное имя задания очистки таблиц в менеджере заданий ``Btk_JobGroup``) включено и имеет тип "Очистка данных". - Планировщик заданий стенда запущен и подключён к базе данных стенда. Планировщик Quartz работает отдельным процессом и настраивается параметром модуля btk "Настройки для Quartz". - У сущности есть Api ``<сущность>Api`` и атрибут ``dCreateDate_dz``. Записи создаются через Api сущности, иначе дата создания не заполняется. - У пользователя автотестов есть права на изменение настроек очистки заданий. - В выборке сделаны изменения из раздела `Изменения в выборке`_. .. warning:: Если планировщик заданий не запущен, регистрация проходит успешно, но данные не удаляются. Сервис этот случай не обнаруживает. .. warning:: Записи без даты создания ``dCreateDate_dz``, например вставленные запросом в обход Api, задание очистки не удаляет. Такие записи удаляются вручную. Изменения в выборке ------------------- Сервис работает только с той выборкой в форме которой тест создаёт, смотрит данные или нужно изменить. Как делать каждое изменение, с примером адаптации существующей выборки и её подводными камнями, описано в руководстве пользователя в разделах :ref:`gsauto_ug_test_data_selection` и :ref:`gsauto_ug_test_data_example`. Обязательные изменения: 1. Выбран атрибут маркера по правилам раздела `Атрибут маркера`_. 2. Для автотестов заведено новое представление в выборке самой сущности, в которой имя выборки совпадает с именем сущности и её Api. Представление объявлено в ``avm.xml`` выборки и в её Avi-классе. Существующие представления не меняются. 3. Представление объявляет строковую переменную для маркера. Её имя передаётся сервису в :java:meth:`create `. 4. Запрос представления: - отбирает только записи, значение атрибута маркера которых начинается с маркера из переменной; - без маркера или с маркером, не прошедшим проверку шаблоном, возвращает пустой набор, а не всю таблицу; - проверяет маркер шаблоном перед подстановкой в текст запроса; - возвращает те же колонки, что и стандартный запрос выборки, включая служебные ``id``, ``idClass``, ``gid``. 5. Тест не вызывает унаследованные операции, которые создают записи в обход Api или меняют всю таблицу. 6. Операции представления, которые создают или меняют записи для теста, берут маркер из той же переменной и создают записи через Api сущности. Необязательные изменения: - атрибут маркера показывается без маркера, для этого запрос отрезает от значения ровно длину маркера; - число читаемых записей ограничено, если таблица сущности общая с другими проверками и может быть большой. Для тестов в проекте ``library-test`` дополнительно нужны пункт главного меню, открывающий представление, и мета-описание выборки с представлением, реализующим ``TestDataRepresentation``. .. seealso:: - :java:type:`ru.bitec.gs.automation.service.testdata.TestDataService` - :ref:`gsauto_ug_test_data`