initial public commit

documentation/connectors/uniform-exchange-service/tests/postman.adoc

@@ -0,0 +1,89 @@
+= Инструкция для работы с шиной через универсальный коннектор
+
+=== Преднастройка окружения
+
+. Скачать и установить postman(https://www.postman.com/downloads/).
+. Импортировать коллекцию запросов и окружение в postman
+
+Далее показано как импортироваться коллекцию запросов и окружение в postman Version 8.11.1, если стоит другая версия и возникли сложности с инструкцией, то обратитесь к документации postman(https://learning.postman.com/docs/getting-started/importing-and-exporting-data/).
+
+=== Импорт коллекции запросов и окружения в postman
+
+* Если вы на домашней странице postman, то нажмите _Import file_, как показано ниже на скрине.
+
+image::img/photo5298499320133302025.jpg[]
+
+* Если вы не на домашней странице postman, то нажмите _File_, _Import..._, как показано ниже на скрине.
+
+image::img/photo5298499320133302031.jpg[]
+
+* Далее откроется окно с импортом файла, где нужно нажать на _Upload Files_ и импортировать файлы, по одному или сразу оба(xref:postman/uniform-connector.postman_environment.json[Окружение], xref:postman/uniform-connector.postman_collection.json[Коллекция запросов])
+
+image::img/photo5298499320133302028.jpg[]
+
+* Или можно импортировать сразу всю папку с файлами(xref:postman/uniform-connector.postman_environment.json[Окружение], xref:postman/uniform-connector.postman_collection.json[Коллекция запросов])
+
+image::img/photo5298499320133302034.jpg[]
+
+image::img/photo5298499320133302035.jpg[]
+
+* Далее мы увидим импортированную коллекцию запросов слева и необходимо выбрать импортированное ранее окружение
+
+image::img/photo5298499320133302038.jpg[]
+image::img/photo5298499320133302039.jpg[]
+
+* Есть возможность настраивать параметры запросов, документация на данную тему(https://learning.postman.com/docs/sending-requests/managing-environments/)
+
+image::img/photo5298499320133302041.jpg[]
+
+* Коллекция запросов и окружение были успешно импортированы в postman и готовы к использованию, можно запустить все запросы в автоматическом режиме или запускать их в ручную по очереди
+
+=== Запуск всех запросов в автоматическом режиме
+
+* Необходимо нажать на _Run Collection_ в меню коллекции, как показано ниже
+
+image::img/photo5298499320133302042.jpg[]
+image::img/photo5298499320133302043.jpg[]
+
+* Можно увидеть успешное прохождение коллекции. При успешном прохождении коллекции тестов шина будет очищена. Если не подразумевалось данное поведение, то необходимо снять выделение с запросов(_Remove profile system1_, _Remove profile system2_, _Remove Account system1_, _Remove Account system2_)
+
+image::img/photo5298499320133302044.jpg[]
+image::img/photo5298499320133302046.jpg[]
+
+=== Запуск запросов в ручную по очереди
+
+* Для запуска конкретного запроса нужно нажать на него в меню слева, затем откроется меню редактирования запроса, где можно посмотреть все параметры запроса и настроить его как необходимо и нажимая на кнопку _Send_ запрос отправляется на шину
+
+image::img/photo5298499320133302047.jpg[]
+
+=== Описание окружения
+
+... _base_url_ - если запросы будут запускаться с машины находящейся с шиной, то данный параметр не нужно менять(http://localhost:8181/cxf), иначе заменить localhost:8181 на необходимый
+... _system1_id_ - имя/идентификатор системы, то как будет представлена система в шине(по умолчанию s1)
+... _system1Login_ - логин системы, то как будет аутентифицироваться система в шине(по умолчанию s1)
+... _system1Password_ - пароль системы, то как будет аутентифицироваться система в шине(по умолчанию s1)
+... _system2_id_ - имя/идентификатор системы, то как будет представлена система в шине(по умолчанию s1)
+... _system2Login_ - логин системы, то как будет аутентифицироваться система в шине(по умолчанию s1)
+... _system2Password_ - пароль системы, то как будет аутентифицироваться система в шине(по умолчанию s1)
+... _adminLogin_ - админская учетная запись, для произведения настроек в шине(по умолчанию admin)
+... _adminPassword_ - админская учетная запись, для произведения настроек в шине(по умолчанию admin)
+
+=== Содержимое тестов
+. Коллекция запросов содержит следующие шаги:
+.. _Create profile system1_ - создание профиля системы 1, которая будет отправлять сообщения в шину
+.. _Create profile system2_ - создание профиля системы 2
+.. _Add Account system1_ - создание учетной записи для системы 1
+.. _Add Account system2_ - создание учетной записи для системы 2
+.. _Create uniform-service-in-connector_ - создание входящего коннектора к универсальному сервису для системы 1
+.. _Create uniform-service-out-connector_ - создание исходящего коннектора к универсальному сервису для системы 1
+.. _Create uniform-service-in-connector_ - создание входящего коннектора к универсальному сервису для системы 2
+.. _Get profile system1_ - запросы для проверки на корректное создания профиля системы1 и коннекторов к нему(uniform-service-in-connector)
+.. _Get profile system2_ - запросы для проверки на корректное создания профиля системы1 и коннекторов к нему(uniform-service-in-connector, uniform-service-out-connector)
+.. _Create permission_ - создание разрешения для отправки сообщений из системы 1 в систему 2
+.. _SEND_ - отправка тестового сообщения из системы 1 в систему 2
+.. _GET_ - получение тестового сообщения из системы 1 системой 2
+.. _ACK_ - отправка подтверждения получения сообщения системы 2(иначе сообщение будет восстановлено)
+.. _Remove profile system1_ - удаление из шины профиля системы 1 и всех связанных с ней коннекторов
+.. _Remove profile system2_ - удаление из шины профиля системы 2 и всех связанных с ней коннекторов
+.. _Remove Account system1_ - удаление учетной записи системы 1 из шины
+.. _Remove Account system2_ - удаление учетной записи системы 2 из шины

documentation/connectors/uniform-exchange-service/tests/postman/uniform-connector.postman_environment.json

@@ -0,0 +1,54 @@
+{
+	"id": "527e5257-25b4-4246-ac5a-26b88e06eec8",
+	"name": "uniform-connector",
+	"values": [
+		{
+			"key": "base_url",
+			"value": "http://localhost:8181/cxf",
+			"enabled": true
+		},
+		{
+			"key": "system1_id",
+			"value": "s1",
+			"enabled": true
+		},
+		{
+			"key": "system2_id",
+			"value": "s2",
+			"enabled": true
+		},
+		{
+			"key": "adminLogin",
+			"value": "admin",
+			"enabled": true
+		},
+		{
+			"key": "adminPassword",
+			"value": "admin",
+			"enabled": true
+		},
+		{
+			"key": "system1Login",
+			"value": "s1",
+			"enabled": true
+		},
+		{
+			"key": "system1Password",
+			"value": "s1",
+			"enabled": true
+		},
+		{
+			"key": "system2Login",
+			"value": "s2",
+			"enabled": true
+		},
+		{
+			"key": "system2Password",
+			"value": "s2",
+			"enabled": true
+		}
+	],
+	"_postman_variable_scope": "environment",
+	"_postman_exported_at": "2021-08-24T14:43:46.375Z",
+	"_postman_exported_using": "Postman/7.36.5"
+}