Использование SoapUi для работы с веб-сервисами. Часть1

Опубликовал Иван Коротеев (kiv1c) в раздел Программирование - Практика программирования

Как работать с SoapUi для тестирования веб-сервисов .

Здравствуйте! 

В нескольких статьях я расскажу о возможностях протестировать с помощью SoapUI, как работают веб-сервисы 1С. Также приведу примеры возврата из 1С документов в формате PDF и сложных xml-файлов. Некоторые вещи сходны с вот с этой статьей, однако я рассмотрю более сложные примеры работы с веб-сервисами. Но для начала я по шагам рассмотрю процесс запуска веб-сервисов и работы с SoapUI, чтобы легче было разобраться в их функционировании с нуля.

UPD: а вот и вторая статья

1. Простой веб-сервис

Для начала возьмем каркасную конфигурацию без веб-сервисов и пройдем по шагам процесс их создания.

Добавим новый веб-сервис с именем test1 и создадим в нем операцию hello с возвращаемым типом string. Имена веб-сервисов и операций лучше всегда задавать на латинице.

Также нужно задать URI пространства имен и имя файла публикации:

При нажатии на лупу в поле "Имя процедуры" будет открыт модуль веб-сервиса и можно будет реализовать функцию hello.

Функция hello()
	возврат "строка из веб-сервиса 1с";
КонецФункции

2. Публикация веб-сервиса.

Теперь, чтобы получившаяся функция была доступна по http, нужно опубликовать наш сервис на веб-сервере. Для этого подойдет Apache 2.2. Я почитал статьи о том, как можно настроить работу с IIS и мне это показалось гораздо сложнее. После установки и запуска Apache 2.2 нужно зайти в меню Администрирование - Публикация на веб-сервере. Поле "каталог" должно быть заполнено и содержать каталог установки Apache. Запомните поля "имя" и "адрес" веб-сервиса, они нам пригодятся на следующем шаге.

3. Тестирование с помощью SoapUI

Для тестирования создадим отдельного пользователя WsUser, с простым паролем и дадим ему полные права.

После этого устанавливаем и запускаем SoapUI. Эта программа очень удобна для тестирования веб-сервисов, она может получать их описание и делать post-запросы к сервисам.

Заходим в меню File - New SOAP project, задаем имя проекта hellotest а в поле Initial WSDL пропишем вот такую ссылку:

http://localhost/test_ws/ws/test1.1cws?wsdl

В ней часть "test_ws" была задана на прошлом этапе в поле "имя" а test1.1cws в поле "адрес".

Нажимаем ОК и на этом этапе нужно будет авторизоваться, войдя под тестовым пользователем WsUser. Будет создан проект и два элемента binding.

Soap12Binding отличается тем, что работает по новой версии стандарта SOAP 1.2. Откроем в test1Soap12Binding элемент Request1 и увидим вот что:

SoapUI показывает, какой xml будет передано в нашу функцию. Перед запуском теста есть еще один нюанс, по умолчанию SoapUI будет требовать авторизацию для каждого отдельного элемента Request. Поэтому, чтобы не задавать ее каждый раз, нужно кликнуть правой кнопкой мышки на testSoap12Binding, выбрать Show interface view и в открывшемся окне на вкладке "Service Endpoint" задать имя и пароль пользователя веб-сервисов:

Если этого не сделать, то для каждого Request нужно будет задавать авторизацию, в нижней панели по кнопке Auth.

Теперь можно наконец-то выполнить запрос к функции hello и посмотреть ответ:

Отлично, все заработало!

4. Передача простых параметров в функцию.

Теперь сделаем новую функцию с параметрами, например проверим работу с датами, сделаем функцию getSaleDocNumbersByDate, которая будет принимать дату документа (расходной накладной) и возвращать номера документов за эту дату строкой. Добавим к операции параметр date с типом dateTime:

код такой:

Функция getSaleDocNumbersByDate(date)
	//
	датаНачала = началоДня(date);
	датаКонца = конецДня(date);
	выборкаДокументов = документы.Расходная.Выбрать(датаНачала, датаКонца);
	номера="";
	пока выборкаДокументов.Следующий() цикл
		номера = номера+" №"+выборкаДокументов.Номер+";";
	конеццикла;
	возврат номера;
КонецФункции

Теперь в SoapUI правой кнопкой мыши нужно кликнуть на элемент testSoap12Binding и выбрать пункт Update Definition. После этого в проекте появится функция getSaleDocNumbersByDate и готовый Request к ней. Для заполнения даты нужно использовать формат "YYYY-MM-DDThh:mm:ss" (можно посмотреть на w3schools и ОЧЕНЬ рекомендую пользоваться этим сайтом для понимания работы с xml)

Тогда получатся вот такие запрос и ответ:

5. Пакеты XDTO

Если необходимо передавать в функции более сложные параметры (например, xml с несколькими полями), или получать в ответ сложные по структуре xml, то нам не обойтись без пакетов XDTO.

Очень подробно работа с XDTO рассмотрена в цикле статей XDTO это просто. По сути, пакет определяет структуру и тип полей используемых xml-файлов. 

Я рассмотрю пример передачи и получение xml-файла, тип которого определен в пакете

А также в следующих статьях я рассмотрю примеры:

  • передача в 1с xml-файла, не описанного в пакете, в формате base64
  • получение из 1с документа pdf в формате base64 и его декодирование
  • получение из 1с xml-файла со вложенной структурой элементов и определение их количества

6. Передача в 1с в параметре xml-файла, тип которого определен в пакете.

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

Создадим пакет packet1 с пространством имен packet1_ns. Для входящего xml-файла определим тип объекта InDocSaleQuery с полем number типа string и полем date типа dateTime. Для выходного файла определим сначала тип для одной строки табличной части товаров: SaleItem с полями name типа string, price sum, quantity типа decimal. А сам документ SaleDoc будет у нас составного типа: поля number, date, partnerName и поле SaleItems у которого будет тип SaleItem и максимальное количество -1. Именно такое поле обозначает, что в нем может присутствовать массив из нескольких элементов. Вот так всё это выглядит в конфигураторе:

Далее в свойствах веб-сервиса нужно задать использование пакета XDTO packet1_ns. getSaleDoc с типом возвращаемого значения SaleDoc и входным параметром incomingXML типа InDocSaleQuery. 

Сначала продемонстрирую код функции, а уже затем объясню что происходит

Код:

Функция getSaleDoc(incomingXML)
	НомерДок = incomingXML.number;
	ДатаДок = incomingXML.date;
	запрос = новый запрос;
	запрос.Текст = "ВЫБРАТЬ
	               |	РасходнаяТовары.Номенклатура.Наименование как name,
	               |	РасходнаяТовары.Цена как price,
	               |	РасходнаяТовары.Количество как quantity,
	               |	РасходнаяТовары.Сумма как sum,
	               |	РасходнаяТовары.Ссылка
	               |ИЗ
	               |	Документ.Расходная.Товары КАК РасходнаяТовары
	               |ГДЕ
	               |	РасходнаяТовары.Ссылка.Номер = &Номер
	               |	И РасходнаяТовары.Ссылка.Дата = &ДатаДок";
	запрос.УстановитьПараметр("Номер",номерДок);
	запрос.УстановитьПараметр("ДатаДок",ДатаДок);
	выборка = запрос.Выполнить().Выбрать();
	если выборка.Количество()=0 тогда
		//вернем ошибку 
		ТипДокумента = ФабрикаXDTO.Тип("packet1_ns", "SaleDoc");
		ПакетДокумента = ФабрикаXDTO.Создать(ТипДокумента);
		ПакетДокумента.number = "Документов Не найдено!";
		Возврат ПакетДокумента;
	иначе
		//создаем типы
		ТипДокумента = ФабрикаXDTO.Тип("packet1_ns", "SaleDoc");
		ТипТабличнойЧасти = ФабрикаXDTO.Тип("packet1_ns", "SaleItem");
 		ПакетДокумента = ФабрикаXDTO.Создать(ТипДокумента);
		
		//выбираем из табличной части
		сч=0;
		пока выборка.Следующий() цикл
			если сч=0 тогда
				//заполним реквизиты документа
				док = выборка.ссылка;
				ПакетДокумента.number = док.Номер;
				ПакетДокумента.date = док.Дата;
				ПакетДокумента.partnerName = строка(док.Контрагент);
			конецесли;
			//заполняем табличную часть
			ПакетТабличнойЧасти = ФабрикаXDTO.Создать(ТипТабличнойЧасти);
			ЗаполнитьЗначенияСвойств(ПакетТабличнойЧасти,выборка);
			//добавляем ее в документ
			ПакетДокумента.SaleItems.Добавить(ПакетТабличнойЧасти);
			сч=сч+1;
		конеццикла;		
		Возврат ПакетДокумента;
	конецесли; 
КонецФункции

Здесь два основных нюанса. Первый: так как был задан тип входящего параметра incomingXML и он был описан этот тип в пакете, то сразу возможно обращаться к полям этого входящего xml. Второй: работа с фабрикой XDTO. Из нее был получен тип для результирующих выходных параметров и создано ЗначениеXDTO этого типа, у которого были заполнены необходимые поля. Также стоит заметить, что в типе SaleDoc следует ввести отдельное поле для ошибки, но для тестовых целей ошибки будут записаны в поле number.

Вот как выглядит результат этого запроса в SoapUI:

Как видно, все работает, но еще есть что улучшить - например, хотелось бы знать какое количество элементов SaleItems у нас в документе.

Об этом и о более сложных примерах я расскажу уже в следующей статье.

В приложенном архиве - выгрузка информационной базы и проект SoapUI.

Скачать файлы

Наименование Файл Версия Размер
Архив Базы и проекта SoapUI
.zip 188,10Kb
29.09.16
9
.zip 188,10Kb 9 Скачать

См. также

Комментарии
1. Александр Савостин (savostin.alex) 17 01.10.16 02:23 Сейчас в теме
2. Петр Базелюк (pbazeliuk) 1229 01.10.16 09:55 Сейчас в теме
(1) savostin.alex, а есть ли смысл в использования расширения?
SoapUI позволяет использовать автоматизированные, регрессионные и нагрузочные тесты. Зачем проверять руками если можно написать тест.
Есть еще хороший инструмент для анализа трафика Fiddler.
softcreator; artbear; nixel; Di-dog; kraynev-navi; +5 Ответить 1
3. Danil (Danila-Master) 72 03.10.16 08:27 Сейчас в теме
Пользуюсь SoapUI давно, но вот про это: "...чтобы не задавать ее каждый раз, нужно кликнуть правой кнопкой мышки на testSoap12Binding, выбрать Show interface view и в открывшемся окне на вкладке "Service Endpoint" задать имя и пароль..." не знал.
Блин... как же я мучался... Спасибо огромное!
4. Sergey Andreev (starik-2005) 854 03.10.16 10:27 Сейчас в теме
ИМХО, большинство разработчиков подобные решения используют только для того, чтобы дернуть сервис и проверить, работает он или нет; возвращает он то, что нужно или нет. Для этого данные программы особо не нужны - достаточно расширения для хрома или файрфокса.

Хотелось бы в статье прочитать именно применение решения, т.е. не ответ на вопрос: "как это сделать", а ответ на вопрос: "зачем это делать". Мне было бы интересно.
5. Артур Аюханов (artbear) 857 03.10.16 12:08 Сейчас в теме
(2) pbazeliuk,
SoapUI позволяет использовать автоматизированные, регрессионные и нагрузочные тесты. Зачем проверять руками если можно написать тест.

есть описание где-нибудь?
я сабжем очень редко пользуюсь, а про автоматизированные тесты и регресс вообще не знаю.
Подскажешь?
6. Петр Базелюк (pbazeliuk) 1229 03.10.16 14:28 Сейчас в теме
7. Евгений Сосна (pumbaE) 521 03.10.16 15:05 Сейчас в теме
У меня так web сервис для отправки sms эмулируется, в erp указал настройки прокси на ip и порт soapui, а в soapui сконвертировал сервис в mock объект и запустил в виде сервера.
8. Maxim Goncharov (maxx) 600 04.10.16 08:55 Сейчас в теме
Несколько лет уже пользуюсь этим инструментом, спасибо за статью.

9. Иван Коротеев (kiv1c) 310 04.10.16 13:37 Сейчас в теме
(4) starik-2005, если говорить "зачем" - часто встречается вопрос обмена с сайтом или с другими программами через XML. Я счел полезным написать про свой опыт, сам долго с этим разбирался.
10. Sergey Andreev (starik-2005) 854 04.10.16 14:12 Сейчас в теме
(9) kiv1c, ну ради обмена с сайтом, то в этом особого смысла нет. Вот есть сайт, у него есть какой-то механизм, дергающий сервис 1С. Для отладки сервиса 1С можно дернуть его с помощью расширения, ибо тут разовые манипуляции для того, чтобы посмотреть результат запроса. Если же 1С дергает сайт, то тут уже проще сделать внешнюю обработку и на ней отладить код, после чего воткнуть данную обработку в конфигурацию - здесь вообще не нужна система дергания веб-сервиса, а если вдруг и нужно дернуть для проверки - браузерный плагин с этим справится.

А вот если тест нагрузочный замутить - тут подобные системы вполне могут подойти, но не совсем понятно, что будет результатом их деятельности. Если просто куча запросов, то это можно организовать и той же внешней обработкой, стартующей фоновые задания в нудном количестве, каждое из которых дернет сервис. Но при обмене с сайтом обычно используется оффлайн-схемы, когда информация о товарах и прочем передается на сайт раз в час, например, а информация о заказах забирается раз в минуту...
11. Евгений Сосна (pumbaE) 521 04.10.16 14:34 Сейчас в теме
Если просто куча запросов, то это можно организовать и той же внешней обработкой, стартующей фоновые задания в нудном количестве, каждое из которых дернет сервис

Зачем, если soapui умеет это из коробки, взырвная нагрузка, нарастающая по количеству и т.д.?
12. Петр Базелюк (pbazeliuk) 1229 04.10.16 14:36 Сейчас в теме
(10) starik-2005, в высококонкуретном ритейле информация об товарах на сайте обновляется на протяжении 0.5-2 секунд. Хотелось бы посмотреть на количество отказов при обновлении остатков раз в час на сайте. Уже закончились времена когда магазины могут себе позволить вести себя так, конкуренты не спят.
По заказам, впечатление пользователя лучше когда после заказа клиент уже видит, что процесс пошел.
Трактор; +1 Ответить 1
13. Sergey Andreev (starik-2005) 854 04.10.16 15:09 Сейчас в теме
(12) pbazeliuk, видимо все пока спят, ибо не раз сталкивался с тем, что после оформления заказа в интернет-магазине мне отзванивались и говорили, что товар будет, например, в пятницу после семи, хотя на сайте товар числился в наличии.

В действительности, если я сижу на сайте и складываю что-то в корзину, то момент помещения товара в корзину и момент акцепта корзины с моей стороны - это достаточно различающиеся по времени действия. И либо система должна блокировать товары, помещенные в корзину, что влечет за собой проблемы с доступностью данного товара для других клиентов, ибо далеко не каждая корзина станет заказом. Либо система не должна блокировать товары, а у менеджеров должны быть отмазки для случаев коллизий - и это то, что сейчас всюду есть (кроме может быть продажи авиа- и жд билетов, денежных транзакций и еще пары-тройки других мест). А подобная схема без блокирования замечательно работает с интервалами раз в 10 минут для корзины и раз в час для каталога. И делать тут какой-то онлайн обмен бессмысленно и беспощадно, соответственно и инструменты подобные не нужны.

С другой стороны, у меня на прошлом месте работы была как раз система, которая в режиме онлайн бегала в 1С (разумеется, не за данными о товарах, а за другими данными). И данная программка стояла у разработчика веб-сервисов со стороны 1С. Так дергал он ее крайне редко и в случаях, когда система работала не так, как должно было работать. И каждый раз искались запросы в логе, открывалась эта монструозная SoapUI, там искался нужный запрос, запускался, смотрелись результаты, возвращаемые сервисом, потом раздавалось: "а... ясно..." и программа закрывалась на очередной месяц.
14. Петр Базелюк (pbazeliuk) 1229 04.10.16 16:24 Сейчас в теме
(13) starik-2005, глупо ограничиваться только своими остатками, необходимо еще показывать на сайте остатки надежных поставщиков. Так можно сгладить влияние вымывания товаров пока корзина покупателя не превратилась в документ "Заказ клиента". Далее, сообщать точную дату, когда товар будет в точке выдачи определенного города (обычно 1-3 дня). Да незачем клиенту информация есть ли у вас товар, клиенту важно знать где и когда забрать.

Зачем бегать по 1С, если можно подписаться на событие изменения остатков и онлайн оповещать, но это уже другая история и никак не связана с веб-сервисами.

С другой стороны, у меня на прошлом месте работы была как раз система, которая в режиме онлайн бегала в 1С (разумеется, не за данными о товарах, а за другими данными). И данная программка стояла у разработчика веб-сервисов со стороны 1С. Так дергал он ее крайне редко и в случаях, когда система работала не так, как должно было работать. И каждый раз искались запросы в логе, открывалась эта монструозная SoapUI, там искался нужный запрос, запускался, смотрелись результаты, возвращаемые сервисом, потом раздавалось: "а... ясно..." и программа закрывалась на очередной месяц.

Что бы написать тест :) и не возвращаться к ошибке в дальнейшем.
15. Sergey Andreev (starik-2005) 854 04.10.16 16:39 Сейчас в теме
(14) pbazeliuk, какой тест? Если это неменяющийся сервис - это одно. тут можно какой-то тест запилить и юзать его как юнит-тест, сверяя результат с нужным. Но странно писать юнит-тест на чем-то отличном от языка разработки, тем более что язык разработки (в данном случае 1С) обеспечивает возможность написать такой тест в одной из вызываемых для тестирования процедур, которые какой-то менеджер тестирования будет вызывать в нужном ему порядке. Если система работает вся с ног до головы на веб-сервисах (что для 1С крайне редко является правилом), то такой тест на данной софтинке может быть имеет смысл создать. Но если все тесты сводятся к дерганию того сервиса, который в настоящее время почему-то работает не так, как ожидалось, то достаточно браузера, ибо браузер уже есть и плагин к нему весит куда меньше данной программы.

Т.е. в части 1С данный функционал нужен куда реже, чем просто возможность обратиться к вебсервису и посмотреть на возвращаемые данные. Бумеранг, например, для хрома вполне позволяет поглядеть на результат обращения к вебсервису, и его в 90% случаях будет достаточно. Ставить SoapUI при этом смысла нет.
16. Роман С (Dach) 89 04.10.16 21:41 Сейчас в теме
Статья полезная. Прошу автора в следующей статье добавить пример обмена между мобильным приложением и базой 1С через веб-сервис.
17. Евгений (le_) 170 05.10.16 09:56 Сейчас в теме
Немного OffTop, но может, кто подскажет... Есть сторонний WS, заточенный под работу с ним через браузер (IE, FF, etc). WS требует аутентификации. Для аутентификации есть спец. метод. После аутентификации сервер шлет и устанавливает куки. Вот после этого можно делать запросы для получения нужных данных...
В 1С-ке для работы с этим сервером приходится использовать MSXML2.ServerXMLHTTP. Это работает, но отлаживать не оч. удобно.
Вопрос: как работать с таким сервером в SoapUI? Как сделать, чтобы куки установились и использовались SoapUI?
18. Евгений Сосна (pumbaE) 521 05.10.16 10:16 Сейчас в теме
19. Maxim Goncharov (maxx) 600 14.10.16 10:46 Сейчас в теме
(9) Немного непонятно про пользователя WsUser. Если его параметры не указать в файле публикации devault.vrd , то при импорте wsdl возникает ошибка у SoapUI. Это как-то обходиться, чтобы можно было именно в SoapUI указать имя пользователя и пароль базы 1С?
20. Иван Коротеев (kiv1c) 310 14.10.16 11:17 Сейчас в теме
(19) maxx, в default.vrd параметры пользователя обычно не указываются. при импорте wsdl возникает не ошибка, а запрос имени пользователя и пароля, и его можно не вводить каждый раз - посмотрите в 3 части этой статьи.
21. Maxim Goncharov (maxx) 600 14.10.16 11:55 Сейчас в теме
(20) Спасибо, то что нужно. Прикол заключается в том, что у меня при импорте wsdl возникает ошибка похоже из-за авторизации, а у вас похоже нет. А не импортировав wsdl указать пароль нельзя.
22. Maxim Goncharov (maxx) 600 26.12.16 23:05 Сейчас в теме
В SoapUI на платформе 8.3.9.1850 и 8.3.9.2033 перестали импортировать схемы wsdl веб-сервисов, на 8.3.8 всё ОК. Странно,сама схема wsdl в браузере отображается.
a.terentev; +1 Ответить 2
23. Анатолий Андреев (tiger12) 3 14.03.17 15:26 Сейчас в теме
После создания проекта в SoapUI и нажатия на кнопку ОК

https://hostingkartinok.com/show-image.php?id=b0925b353b238f8deebc21aa07cf86e7
Прикрепленные файлы:
24. Александр Терентьев (a.terentev) 19.04.17 01:25 Сейчас в теме
(22) точно такая же проблема. платформа 8.3.9.2033
25. Иван Берездецкий (berezdetsky) 357 27.04.17 17:28 Сейчас в теме
(22) (24) У 1С сломался заголовок WWW-Authenticate - оно теперь не отдаёт realm (область действия данных авторизации). Раньше было:

WWW-Authenticate: Basic realm="1C:Enterprise 8.3"


сейчас:

WWW-Authenticate: Basic


Собственно, старый вариант тоже неправильный, но хотя бы SoapUI работал.

Починить можно добавив заголовок ответа в настройках веб-сервера. Ну или сохранять wsdl в файл и загружать файл в SoapUI.