Обзор

Назначение

Командная утилита предназначена для автоматизации работы разработчика.

Gsf-cli позволяет:

• Подготовить прикладной проект к работе

• Обновить зависимости необходимые для работы проекта

• Собрать прикладные JAR-файлы в applib и исходные артефакты в appsrc

• Опубликовать артефакты комплекта сборки

CLI написан на Python. Сборкой прикладного кода управляет SBT;

Для первого запуска выберите Linux или Windows. Там собраны все шаги, включая закрытые репозитории и headless. Для CI сначала подготовьте GitLab Runner или Jenkins Agent.

Требования

Для работы утилиты требуется

• python начиная с версии 3.9.2

• JDK 21

• sbt только версий 1.x, начиная с версии 1.8.2

• git

Linux-дистрибутив содержит offline wheels для CPython версий 3.9.2–3.13 на архитектуре x86_64.

Необходимые библиотеки:

Прописаны в requirements.txt:

• bcrypt==4.0.1

• certifi==2023.7.22

• cffi==2.0.0

• charset-normalizer==3.2.0

• cryptography==46.0.5

• debugpy==1.8.16

• decorator==5.1.1

• defusedxml==0.7.1

• fabric==3.1.0

• idna==3.4

• invoke==2.2.0

• Jinja2==3.1.6

• MarkupSafe==3.0.3

• paramiko==4.0.0

• prompt-toolkit==3.0.39

• psutil==5.9.5

• pycparser==2.21

• PyNaCl==1.5.0

• PyYAML==6.0.3

• requests==2.32.5

• ruamel.yaml==0.17.32

• ruamel.yaml.clib==0.2.15

• setuptools==81.0.0

• tqdm==4.67.3

• urllib3==2.6.3

• wcwidth==0.2.6

Дополнительный пакет для Linux

• python3-venv

Готовый Windows-дистрибутив включает Python. Linux-окружение создаётся при установке.

Установка

Ниже — краткая установка рабочего места Windows с IDEA. Для настройки закрытых источников до первого добавления проекта используйте полную главу Windows, указанную выше.

1. Скачайте дистрибутив gsf-cli

   curl https://repo.global-system.ru/artifactory/common/ru/bitec/gsf-cli-windows/SNAPSHOT/gsf-cli-windows-SNAPSHOT.zip --output gsf-cli.zip
   

   Для ручного обновления утилиты можно в каталоге с:\programs\ сделать cmd файл следующего содержания (пути подправить по необходимости)

   curl https://repo.global-system.ru/artifactory/common/ru/bitec/gsf-cli-windows/SNAPSHOT/gsf-cli-windows-SNAPSHOT.zip --output gsf-cli.zip
   "C:\Program Files\7-Zip\7z.exe" x gsf-cli.zip -aoa -ogsf-cli
   pause
   

2. Распакуйте архив
   Рекомендуемый путь для установки: C:\programs\gsf-cli

3. Установите JDK 21
   Установленные jdk будут искаться по адресу C:\Program Files\Java

4. Установите Intellij Idea
   Установленные среды будут искаться по адресу C:\Program Files\JetBrains

   Внимание

   В IDEA должен быть установлен плагин Scala. Подробности корректной установки смотрите в
   руководстве прикладного разработчика GlobalERP Framework.

5. Установите sbt версии 1.x, начиная с 1.8.2

   Внимание

   Sbt должен быть установлен по адресу c:\programs\sbt\.

6. Установите Git, если он ещё не установлен

Добавление проекта в рабочее пространство

Внимание

Если перед началом работы открыта среда разработки в общем окружении ее необходимо закрыть.

Для добавления проекта запустите скрипт gsf-cli\links\add_project.cmd и следуйте инструкциям мастера.
Мастер запросит необходимые параметры и предложит подготовить проект к работе. Учётные данные закрытых источников и переменные SBT должны быть настроены заранее.

Внимание

Внимательно читайте запросы мастера.

Внимание

При возникновении ошибки загрузки модулей из GitLab fatal: Unencrypted HTTP is not supported for GitHub. Ensure the repository remote URL is using HTTPS. следует выполнить команду git config --global credential.extgit.global-system.ru.provider generic и повторить добавление проекта.

Результат выполнения всех шагов мастера:

• gsf-cli\workspace\dists\{project_name}\Global3se\
  Актуальный дистрибутив сервера приложения

• gsf-cli\workspace\sources\{project_name}\application\
  Полностью готовый к работе проект с исходным кодом

• gsf-cli\workspace\links\{project_name}\
  Ярлыки быстрого запуска

• Добавленный проект становится активным, если вы подтвердили активацию в мастере

Источник проекта

Мастер конфигурации запрашивает источник определяющий откуда будет получен исходный код проекта. Формат источников:

• GIT

  https://{path}.git
  

• LXC

  lxc://{host}
  

  LXC является контейнером в котором собирается проект в системе CI

LXC предусмотрен в интерактивном мастере. Загрузка такого источника через config load_config пока не реализована; инструкции сборки через config.json используют Git.

Работа с активным проектом

Активный проект - это проект, который будет использоваться по умолчанию в случае если он не указан явно.
Регулярные команды по работе с активным проектом смотрите в gsf-cli\links\

В автоматической сборке указывайте проект явно: manage.cmd -p <project_name> build или ./manage.sh -p <project_name> build. При загрузке config.json проект автоматически не активируется.

Обновление активного проекта

Для обновления зависимостей активного проекта запустите gsf-cli\links\active_project_refresh.cmd

Конфигурирование сервера приложения

Сервер приложения конфигурируется автоматически, для этого используется профиль конфигурации.

Изменения настроек проекта

• Удалите проект командой gsf-cli\links\delete_project.cmd
  При вопросе об удалении файлов ответьте нет, что бы не выкачивать данные повторно.

• Добавьте проект с тем же именем и новыми параметрами.

Примечание

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

Изменения глобальных настроек

Для изменения глобальных cli запустите в консоли команду gsf-cli\config.cmd configure

Хранения паролей

Пароли сохраняются в зашифрованном виде по мастер ключу.
Мастер предлагает зарегистрировать ключ при первом добавлении проекта. Для настройки без мастера используется config register_private_key -c <каталог> — примеры для обеих ОС есть в главах установки. Мастер добавления проекта запрашивает необходимые для дальнейшей работы пароли. Для изменения паролей смотри менеджер учётных данных.

Горячие клавиши

• вверх, вниз
  Используется для выбора разных вариантов.

• вправо
  Используется для автоматического завершения команд.