alex-bob-lip/ibcmdrunner

Библиотека, упрощающая использование утилит 1С ibcmd и ibsrv

ibcmdrunner

Библиотека для упрощения работы с утилитами ibcmd и ibsrv из oscript.

Позволяет выполнять операции с информационной базой в стиле v8runner.

Пример работы:

УправлениеИБ = Новый УправлениеИБ;
ВременныйКаталог = ОбъединитьПути(КаталогВременныхФайлов(), "tmp_db");
УправлениеИБ.УстановитьПараметрыФайловойИБ(ВременныйКаталог);
ПутьКФайлуКонфигурации = "c:\tmp\1c.cf";
УправлениеИБ.СоздатьИБИзФайлаКонфигурации(ПутьКФайлуКонфигурации);

КонфигФайл = Новый КонфигурационныйФайлАС;
// Задаем параметры автономного сервера - IP-адрес, порт (по умолчанию 8314), имя сервера
КонфигФайл.ПараметрыСервера("127.0.0.1", , "MyFirstServer");
// Задаем параметры информационной базы, к которой подключаемся -
// путь, имя пользователя, пароль
КонфигФайл.ПараметрыФайловойБД("d:\1c_Bases\MyBase", "user", "123");
// Создаем конфигурационный файл c:\tmp\my-config.yml в формате YAML 
КонфигФайл.СоздатьКонфигурационныйФайл("c:\tmp\my-config.yml");

Программный интерфейс

Лицензия

Смотри файл LICENSE.

ibcmdrunner's Issues

Провести исследование новых возможностей платформы 8.3.23 с целью включения в состав библиотеки.

В связи с выходом тестового релиза платформы 8.3.23 провести исследования новых возможностей для последующего включения в библиотеку.

Реализована возможность конвертации клиент-серверной информационной базы в информационную базу, обслуживаемую другой СУБД, минуя процесс выгрузки/загрузки информационной базы в dt-файл. Конвертация из файлового варианта информационной базы не поддерживается.
Для команды infobase утилиты ibcmd реализована команда replicate.

Для автономного сервера реализованы возможности:
Прямого подключения к информационной базе (по протоколу TCP, только для управляемого приложения).
Использование Конфигуратора.
Использования автономного сервера в качестве менеджера тестирования.
Выполнять отладку прикладного решения, используя сервер отладки, встроенный в автономный сервер.

Реализована возможность включать и отключать функциональные возможности автономного сервера. Для этого в конфигурационном файле реализована секция features. Также могут использоваться команды командной строки утилиты ibsrv:
--enable-extended-designer-features, --disable-extended-designer-features - включает/отключает расширенные возможности конфигурирования в автономном сервере.
--enable-http-gate, --disable-http-gate - включает/отключает доступ к информационной базе по протоколу HTTP.
--enable-ssh-gate, --disable-ssh-gate - включает/выключает SSH-шлюз автономного сервера (работа в режиме агента).
--enable-direct-gate, --disable-direct-gate - включает/выключает доступ к информационной базе по протоколу TCP.

Для автономного сервера реализованы:
Режим mobile-app export - запись конфигурации мобильного приложения (доступна только после включения расширенных возможностей конфигурирования).
Режим mobile-client:
export - запись конфигурации мобильного клиента (доступна только после включения расширенных возможностей конфигурирования).
sign - выполнить цифровую подпись конфигурации.
Режим config - является сокращенной записью команды infomase config.
Режим extension - является сокращенной записью команды infomase config extension
infobase config export - выгрузить в XML-файлы внешнюю обработку/отчет или расширение.
infobase config import - загрузить из XML-файлов внешнюю обработку/отчет или расширение..

Для SSH-шлюза автономного сервера реализованы следующие команды:
config mobile-app-write-file - запись конфигурации мобильного приложения.
config mobile-client-write-file - запись конфигурации мобильного клиента.
config sign-cfg - выполнить цифровую подпись конфигурации.
config mobile-client-digi-sign - выполнить цифровую подпись конфигурации мобильного клиента.

Поддержка новых возможностей платформы 8.3.24

Например, добавлен параметр -partial
В процессе обновления конфигурации базы данных автономный сервер выводит в стандартный поток вывода идентификатор нового поколения информационной базы.
В механизме выборочной загрузки объектов метаданных из xml-файлов реализован режим частичной загрузки внешних свойств, при котором не требуется загрузка самих объектов метаданных, которым принадлежат данные свойства. Также реализована поддержка независимой загрузки модулей форм без загрузки самих форм. Реализован параметр partial для следующих команд:

Для команды config load-config-from-files агента конфигуратора и SSH-шлюза автономного сервера.
Для команды /LoadConfigFromFiles пакетного режима запуска Конфигуратора.
Для команды infobase config import утилиты управления автономным сервером (ibcmd).

Источник: https://dl03.1c.ru/content/Platform/8_3_24_1368/1cv8upd_8_3_24_1368.htm#ca31f2cc-9278-11ed-963f-0050569f678a

Еще
Из параметров автономного сервера исключены:
Параметр --debug-server-password утилиты ibsrv.
Параметр password секции debug - server конфигурационного файла автономного сервера.
Указание удаленных параметров не приводят к ошибке. Сами параметры игнорируются.

Источник: https://dl03.1c.ru/content/Platform/8_3_24_1368/1cv8upd_8_3_24_1368.htm#589d6f93-052e-11ee-963f-0050569f678a

При использовании метода частичной загрузки файлов выходит ошибка превышения длины командной строки

При использовании метода ЗагрузитьВыбранныеФайлыКонфигурации() выходит ошибка, что слишком длинная строка для команды cmd (пишу по памяти, сообщение примерное). Пытался загрузить около 50 общих модулей. В итоге падал на том, что в методе используется Команда, построенная на командной строке.
У себя обошел это циклом и передачей модулей порциями по 10 штук в метод ЗагрузитьВыбранныеФайлыКонфигурации(). Возможно целесообразнее цикл сделать внутри метода?
Пример кода

МассивИз10 = Новый Массив;
Для Индекс = 0 По СписокОбъектов.ВГраница() Цикл
	Если МассивИз10.Количество() = 10 Тогда
		УправлениеИБ.ЗагрузитьВыбранныеФайлыКонфигурации(ФС.ПолныйПуть(КаталогФайловКонфигурации), МассивИз10, , Ложь);
		МассивИз10 = Новый Массив;
	КонецЕсли;
	
	МассивИз10.Добавить(СписокОбъектов.Получить(Индекс));
КонецЦикла;

Если МассивИз10.Количество() > 0 Тогда
	УправлениеИБ.ЗагрузитьВыбранныеФайлыКонфигурации(ФС.ПолныйПуть(КаталогФайловКонфигурации), МассивИз10, , Ложь);
КонецЕсли;

Добавить команду создания пустой ИБ

Для целей тестирования в некоторых кейсах требуется создание просто пустой информационной базы (например временной).

Сейчас для этого необходимо вызывать какой-то из методов СоздатьИБИзФайловКонфигурации / СоздатьИБИзФайлаВыгрузки / СоздатьИБИзФайлаКонфигурации - с явным указанием пустого параметра.

Добавить в хаб

Если есть желание добавить в хаб hub.oscript.io - просьба сообщить

Кодировка сообщений об ошибках ibcmd

В случае если ibcmd выдает сообщение об ошибке, кодировка сообщения устанавливается не корректно. Необходимо установить кодировку в процедуре ВыполнитьКоманду()
Команда.УстановитьКодировкуВывода(КодировкаТекста.UTF8)
или сделать PR?

Ошибка при генерации документации

Скрипт генерации документации по классам спотыкается, если в модуле есть переменные, имя которых начинается с Перем.

Если утилита ibcmd не найдена, команды не выполняются с непонятной ошибкой

Как пример:

#Использовать ibcmdrunner
УправлениеИБ = Новый УправлениеИБ;

Такой код вызовет вот такое сообщение:

{Модуль C:\Program Files\OneScript\lib\ibcmdrunner\src\Классы\ibcmdrunner.os / Ошибка в строке: 987 / "--version" не является внутренней или внешней
командой, исполняемой программой или пакетным файлом.
}

Просто утилита не найдена (не установлена на этом компьютере), но пытается запуститься команда проверки версии в методе ПриСозданииОбъекта()

[BUG] Метод Версия() возвращает номер версии с переносом строки в конце

Вызов метода УправлениеИБ.Версия() возвращает номер версии с переносом строки в конце:

Возвращается:

"8.3.20.1613
|"

Ожидается:
"8.3.20.1613"

[BUG] Используется небезопасное указание учетных данных в параметрах командной строки

Используется небезопасное указание учетных данных в параметрах командной строки - учетные данные указываются AS IS, тем самым создается возможность их вывода в лог, служебные файлы и т.п.

Для указания учетных данных общепринятый безопасный механизм - через интерполяцию переменных среды.

КонфигурационныйФайлАС

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

OneScript\lib\ibcmdrunner\src\Классы\configfile_as.os / Ошибка в строке: 394 / Значение не является значением объектного типа}

Замеченные ошибки при использовании различных методов библиотеки

Спасибо за хорошую обертку над ibcmd ! Все достойно. Но в процессе использования нашел несколько замечаний.

1. Нет обертывания в кавычки
   
2. Количество()
   
3. Нет запятой в параметрах
   
4. При использовании Версия() очищаются добавленные ранее параметры
   
   

Обновление конфигурации ИБ после динамического обновления.

Наткнулся на ошибку при реальном использовании, затем воспроизвел в тесте.
Платформа 8.3.18.1483
Суть такая:
Если обновить конфигурацию динамически, затем изменить конфигурацию и попытаться обновить конфигурацию ИБ с помощью ibcmd infobase config apply ...
то такое обновление закончится с ошибкой.
`
[FATAL] Операция не поддерживается

    checkProfConditions

    [ibcli - d:\jenkins\ci_builder2\windowsbuild2_tg4uan6e55fp\platform\src\ib-server-infobase\infobaseBase.h (993)]

}`
Тест лежит в папке tests репозитория - ОбновлениеИБПослеДинамического.os

PS:
Проверил также на платформах 8.3.18.1779, 8.3.19.1522, 8.3.20.1914, 8.3.21.1393. Больше нигде такое не вылезло.

Класс УправлениеАС

Добавить в библиотеку класс управления класс УправлениеАС - управление автономным сервером. Примерный состав методов:

Запустить() - запустить в командной строке
Остановить() - остановить работу ранее запущенного сервера
Запущен() - проверка, что сервер запущен

ЗарегистрироватьСервис()
ЗапуститьСервис()
ОстановитьСервис()
УдалитьСервис()

ПолучитьСписокСессий()
ЗавершитьСессию()
ИнформацияОСессии()

ПолучитьСписокБлокировок()

Сделать PR в библиотеку v8runner

Функционал работы с ibcmd был бы очень полезен в библиотеке v8runner https://github.com/oscript-library/v8runner.

Лицензия

Отсутствует файл лицензии

Ошибка при выгрузке слишком большого количества файлов

Ошибка при выгрузке слишком большого количества файлов, выгружается 184 файла, в моем случае общие модули.
УправлениеИБ.ВыгрузитьОбъектыКонфигурацииВФайлы();

{Модуль C:\Program Files\OneScript\lib\ibcmdrunner\src\Классы\ibcmdrunner.os / Ошибка в строке: 1064 / The command line is too long.

[BUG] Команда СоздатьРасширение не учитывает успешный код возврата 0

Команда СоздатьРасширение помимо непонятного кода 102 может возвращать и обычный код 0.

Текущая реализация при этом вызывает ошибку.

Доработка тестов и класса УправлениеИБ с учетом новых релизов платформы

Тесты должны проходить успешно на платформах 8.3.18.1959, 8.3.19.1726, 8.3.20.2184, 8.3.21.1624, 8.3.22.1704 под Windows и Linux.

Автогенерация документации программного интерфейса.

Написать скрипт для автогенерации документации программного интерфейса библиотеки.
Скрипт должен анализировать файл lib.config, определять из него имена классов и модулей и пути к ним.
В файлах модулей и классов должна быть область ПрограммныйИнтерфейс с экспортными методами.
Методы должны иметь описания, соответствующие стандартам 1С.
Дополнительно, для больших модулей обеспечить возможность разбивки документации методов на подразделы с помощью областей, вложенных в область ПрограммныйИнтерфейс.
Опционально, обеспечить возможность показа раскрашенного кода примеров вызова методов.
Сгенерированная документация должна иметь формат html.

Доработать класс ibcmdrunner с учетом возможностей платформы 1С, начиная с 8.3.20

Добавить методы

СнятьСПоддержки()
ТестированиеИИсправление()
СписокОбщихРеквизитов()
ИДПоколенияДанных()

работа с расширениями

СоздатьРасширение()
ИнформацияОРасширении()
СписокРасширений()
УстановитьСвойстваРасширения()
УдалитьРасширение()

Добавить параметры в методы

ЗагрузитьКонфигурациюИзФайлов()
НеПроверять; (отключить проверку конфигурации после загрузки)
ЭтоАрхив; (загружать из zip-архива)

ОбновитьКонфигурациюБД()
Динамически;
ЗавершатьСеансы;

ВыгрузитьКонфигурациюВФайлы()
ЭтоАрхив;
НеВыгружатьНесуществующиеОбъекты;
КоличествоПотоков;