Добавил методы для работы со сделками Bitrix24

EvgeniyOst commented 2 months ago

Добавил методы для работы со сделками:

Добавление
Удаление
Изменение
Получение сделки
Получение полей сделки
Получение списка сделок

Bayselonarrend commented 2 months ago

Отлично, спасибо. Если есть время и желание дальше еще что-то добавлять, то могу рассказать, как писать юнит-тесты под все это дело. Было бы тогда вообще огонь)

Можно также посмотреть, как они реализованы в модуле OPI_Тесты для вашего предыдущего PR по лидам

Bayselonarrend commented 2 months ago

Еще поправлю название у метода ПолучитьСтруктуруСделок на ПолучитьСтруктуруСделКИ

EvgeniyOst commented 2 months ago

По тестам - да, было бы интересно попрактиковаться. В теории с yaxunit знаком, напишите, пожалуйста, что нужно поставить и как их запускать.

Bayselonarrend commented 2 months ago

Отлично

что нужно поставить и как их запускать

Нужно в конфигурацию, где ведется разработка, добавить расширение Yaxа. Оно само должно найти тесты и подгрузить их при открытии основной его обработки

Тесты пишутся по особым правилам, ниже объясню зачем они нужны. Для создания тестов под новый раздел нужно:

В модуле OPI_Тесты в области ЗапускаемыеТесты -> Bitrix24 добавить новую экспортную процедуру без параметров. Имя лучше сделать по примеру, чтобы было единообразно

Добавить туда получение тестовых данных в структуру

Данные получаются методом OPI_ПолучениеДанныхТестов.ПараметрВКоллекцию из json файла, где первый параметр это имя поля в файле, а второй - структура. Сам JSON файл можно разместить где угодно, нужно только добавить путь в функцию ПутьКФайлуДанных того же модуля OPI_ПолучениеДанныхТестов

Файл выглядит примерно вот так

Если нужны будут файлы для теста, то можно использовать вот эти (ОПИ сам преобразует в двоичные)

    "GIF": "https://openintegrations.dev/test_data/animation.gif",
    "Video": "https://openintegrations.dev/test_data/video.mp4",
    "Audio": "https://openintegrations.dev/test_data/song.mp3",
    "Audio2": "https://openintegrations.dev/test_data/song.m4a",
    "Document": "https://openintegrations.dev/test_data/document.docx",
    "Picture": "https://openintegrations.dev/test_data/picture.jpg",
    "Picture2": "https://openintegrations.dev/test_data/picture2.jpg",
    "Picture3": "https://openintegrations.dev/test_data/spy2.png",

Далее в созданную процедуру в OPIТесты добавляется вызов процедур под каждую реализованную функцию API. Название должно состоять из имени модуля без префикса OPI, нижнего подчеркивания и имени метода библиотеки. В параметр передается та самая структура с тестовыми данными

Далее создаются сами отдельные тесты под каждую функцию API. В них определяются переменны по параметрам из структуры, а затем идет вызов функции библиотеки.

Из основных моментов здесь:

Закоментированные строки типа // !OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог нужны для сбора ответов при тестировании версии для OneScript. Тут они должны так и быть закомментированы. В первом параметре функции ЗаписатьЛог должен быть Результат, далее идентификатор теста (если их несколько в одном, как здесь, то к дополнительным дописывается какое-нибудь пояснение, например "хук" - т.е в режиме webhook)

После записи лога (чтобы лог записался даже при провале теста) пишется проверка. Проверка это процедура, которая может использоваться в нескольких тестах, если подходит под ответ. Она пишется в области Проверки и выглядит вот так

Начинается с OPI_ПолучениеДанныхТестов.ОжидаетЧто(), где в скобках указывается переменная. Далее, после точки указывается, что проверяем: Заполнено(), ИмеетТип("Массив"), Равно("Такое то значение")

И последнее: END и SKIP. Это служебные комментарии, которыми выделяются всякие служебные, не относящиеся напрямую к функции API вещи, вроде проверок или записи параметров для переноса в следующие функции. SKIP означает, что строка служебная, а после END просто уже не нужно писать SKIP

И в конце тест добавляется в набор в модуле OPI_ПолучениеДанныхТестов. По примеру, как те, которые там уже есть

Это все довольно муторно, но так надо) С большего для автодокументации: доки на https://openintegrations.dev/ полностью автоматические и создаются из вот таких разнообразных правил

Так, например, одиночные тесты под каждую функцию это не только тесты сами по себе, но еще и примеры кода для документации. Для чего и нужны END и SKIP - они отмечают, какие строки кода не должны попасть в документацию. Запись же лога через // !OInt OPI_ПолучениеДанныхТестов.ЗаписатьЛог попадают в пример ответа в тех же доках (при прогоне этих тестов в OneScript (они общие для OS и 1С) в Github Actions, как например здесь https://github.com/Bayselonarrend/OpenIntegrations/actions/runs/10512932585)

Bayselonarrend commented 2 months ago

Cfeху YaxUnit можно тут взять

https://github.com/bia-technologies/yaxunit/releases/tag/24.05

Bayselonarrend / OpenIntegrations

Добавил методы для работы со сделками Bitrix24 #39