Эта статья описывает общий порядок запуска API2API-миграции из сторонней TMS в ТестОпс с помощью миграционного скрипта.
Миграционный инструмент поддерживает два основных варианта переноса данных: API2API и миграцию из файлов.
Рекомендуемый вариант - API2API-миграция, так как в этом сценарии скрипт подключается к сторонней TMS через API, получает данные проекта и переносит их в ТестОпс через API. Такой вариант обычно является наиболее удобным для переноса тестовой документации, в то время как миграция из файлов не поддерживает перенос вложений.
Для API2API-миграции доступны следующие системы: Allure TestOps, Azure TFS, Cucumber Studio, HP ALM, Qase, TestIT, TestRail, XRay Cloud, XRay for Jira Server, Zephyr Scale for Jira Cloud, Zephyr Scale for Jira Server, Zephyr Squad Cloud, Zephyr Squad for Jira Server.
В этой статье рассматривается только общий порядок запуска API2API-миграции. Полный список параметров конфигурационного файла, а также описание других типов миграций необходимо смотреть в локальной документации миграционного инструмента.
Порядок действий:
В первую очередь рекомендуем скачать архив с локальной документацией миграционного инструмента и открыть её в браузере. В документации можно посмотреть доступные типы миграций, параметры конфигурационного файла и примеры конфигурации для конкретной TMS.
Скачать можно по ссылке - dl.qatools.ru/service/rest/repository/browse/public/3p-tms-migration/
Архив для скачивания - 3p-tms-migration-manual.zip
Распакуйте архив, откройте терминал или командную строку, перейдите в папку с распакованным архивом и выполните команду:
./run-server.sh
После этого сможете посмотреть документацию локально в вашем браузере.
Важно:run-server.sh не запускает миграцию и не переносит данные. Эта команда нужна только для просмотра документации по параметрам миграционного инструмента.
Перед запуском миграции убедитесь, что выполнены следующие условия:
1.На машине, с которой будет выполняться миграция, установлена Java 21 или выше.
Проверить установленную версию Java можно командой: java -version
Если Java не установлена или установлена версия ниже 21, перед запуском миграционного скрипта необходимо установить Java 21 или более новую версию.
2.Версия ТестОпс выше 4.26.0.
3.Выпущен и сохранён API-токен в ТестОпс. Токен должен быть выписан пользователем с достаточными правами на проект, в который будет выполняться миграция. Рекомендуется использовать токен пользователя с правами администратора или владельца проекта.
4.Выпущен и сохранён API-токен в сторонней TMS. Токен должен быть выписан пользователем, у которого есть доступ к проекту и данным, которые необходимо перенести.
5.На машине, с которой будет выполняться миграция есть сетевой доступ до ТестОпс и сторонней TMS.
Скачайте миграционный скрипт:
Миграционный скрипт - это .jar файл, который выполняет перенос данных из сторонней TMS в ТестОпс.
Скачайте последний доступный tom-файл из каталога: dl.qatools.ru/service/rest/repository/browse/public/3p-tms-migration/
После скачивания положите .jar файл в отдельную папку, из которой затем будет выполняться запуск миграции.
Создайте конфигурационный файл:
В этой же папке(где находится скрипт) создайте конфигурационный .json файл, например: config_file.json(название может быть любое).
Конфигурационный файл нужен для того, чтобы указать миграционному скрипту, откуда забирать данные, какие именно данные и куда их переносить.
В конфигурационном файле необходимо указать данные подключения к ТестОпс и сторонней TMS: ендпоинты, API-токены, ID проекта ТестОпс, ID проекта в сторонней TMS и дополнительные параметры выбранного сценария миграции.
Полный список параметров и примеры конфигурационных файлов смотрите в локальной документации миграционного инструмента.
Пример минимального конфигурацинного файла для миграции из TestIT:
Выполните тестовый перенос одного тест-кейса:
Перед полной миграцией рекомендуем сначала выполнить тестовый перенос одного-двух простых тест-кейсов с минимальным набором данных.
Для этого в конфигурационном файле необходимо указать ID Тест-кейсов для миграции.
Например, для TestIT можно добавить параметр: "testCaseIds": [312,715,642]
Запустите миграционный скрипт:
-Убедитесь, что .jar файл миграционного скрипта и .json конфигурационный файл находятся в одной папке.
-Откройте терминал или командную строку, перейдите в эту папку и выполните команду:
java -jar <имя_jar_файла>.jar <имя_конфиг_файла>.json
Пример:
java -jar tom-1.2.4-all.jar config_file.json
Если в конфигурационном файле включено логирование или debug-режим, процесс миграции будет отображаться в консоли.
Проверьте результат в ТестОпс:
После тестового запуска проверьте в ТестОпс, что тест-кейс создался и данные перенеслись ожидаемо: название, описание, шаги, кастомные поля, вложения и так далее.
Если в процессе миграции произошла ошибка или результат отличается от ожидаемого, пожалуйста, сохраните логи выполнения миграционного скрипта, создайте обращение на сайте help.qatools.ru/knowledge_base/ и приложите к нему логи миграции, конфигурационный файл, а также укажите, из какой TMS выполняется миграция и какую версию миграционного скрипта вы используете.