Merge pull request #511 from microsoft/axsuarez/integration-and-skills-tests

Axsuarez/integration and skills tests

Author: axelsrz

libraries/botbuilder-core/tests/skills/test_skill_handler.py

@@ -0,0 +1,368 @@
+import hashlib
+import json
+from uuid import uuid4
+from asyncio import Future
+from typing import Dict, List
+
+from unittest.mock import Mock, MagicMock
+import aiounittest
+
+from botbuilder.core import TurnContext, BotActionNotImplementedError
+from botbuilder.core.skills import ConversationIdFactoryBase, SkillHandler
+from botbuilder.schema import (
+    Activity,
+    ActivityTypes,
+    AttachmentData,
+    ChannelAccount,
+    ConversationAccount,
+    ConversationParameters,
+    ConversationsResult,
+    ConversationResourceResponse,
+    ConversationReference,
+    PagedMembersResult,
+    ResourceResponse,
+    Transcript,
+)
+from botframework.connector.auth import (
+    AuthenticationConfiguration,
+    AuthenticationConstants,
+    ClaimsIdentity,
+)
+
+
+class ConversationIdFactoryForTest(ConversationIdFactoryBase):
+    def __init__(self):
+        self._conversation_refs: Dict[str, str] = {}
+
+    async def create_skill_conversation_id(
+        self, conversation_reference: ConversationReference
+    ) -> str:
+        cr_json = json.dumps(conversation_reference.serialize())
+
+        key = hashlib.md5(
+            f"{conversation_reference.conversation.id}{conversation_reference.service_url}".encode()
+        ).hexdigest()
+
+        if key not in self._conversation_refs:
+            self._conversation_refs[key] = cr_json
+
+        return key
+
+    async def get_conversation_reference(
+        self, skill_conversation_id: str
+    ) -> ConversationReference:
+        conversation_reference = ConversationReference().deserialize(
+            json.loads(self._conversation_refs[skill_conversation_id])
+        )
+        return conversation_reference
+
+    async def delete_conversation_reference(self, skill_conversation_id: str):
+        raise NotImplementedError()
+
+
+class SkillHandlerInstanceForTests(SkillHandler):
+    async def test_on_get_conversations(
+        self, claims_identity: ClaimsIdentity, continuation_token: str = "",
+    ) -> ConversationsResult:
+        return await self.on_get_conversations(claims_identity, continuation_token)
+
+    async def test_on_create_conversation(
+        self, claims_identity: ClaimsIdentity, parameters: ConversationParameters,
+    ) -> ConversationResourceResponse:
+        return await self.on_create_conversation(claims_identity, parameters)
+
+    async def test_on_send_to_conversation(
+        self, claims_identity: ClaimsIdentity, conversation_id: str, activity: Activity,
+    ) -> ResourceResponse:
+        return await self.on_send_to_conversation(
+            claims_identity, conversation_id, activity
+        )
+
+    async def test_on_send_conversation_history(
+        self,
+        claims_identity: ClaimsIdentity,
+        conversation_id: str,
+        transcript: Transcript,
+    ) -> ResourceResponse:
+        return await self.on_send_conversation_history(
+            claims_identity, conversation_id, transcript
+        )
+
+    async def test_on_update_activity(
+        self,
+        claims_identity: ClaimsIdentity,
+        conversation_id: str,
+        activity_id: str,
+        activity: Activity,
+    ) -> ResourceResponse:
+        return await self.on_update_activity(
+            claims_identity, conversation_id, activity_id, activity
+        )
+
+    async def test_on_reply_to_activity(
+        self,
+        claims_identity: ClaimsIdentity,
+        conversation_id: str,
+        activity_id: str,
+        activity: Activity,
+    ) -> ResourceResponse:
+        return await self.on_reply_to_activity(
+            claims_identity, conversation_id, activity_id, activity
+        )
+
+    async def test_on_delete_activity(
+        self, claims_identity: ClaimsIdentity, conversation_id: str, activity_id: str,
+    ):
+        return await self.on_delete_activity(
+            claims_identity, conversation_id, activity_id
+        )
+
+    async def test_on_get_conversation_members(
+        self, claims_identity: ClaimsIdentity, conversation_id: str,
+    ) -> List[ChannelAccount]:
+        return await self.on_get_conversation_members(claims_identity, conversation_id)
+
+    async def test_on_get_conversation_paged_members(
+        self,
+        claims_identity: ClaimsIdentity,
+        conversation_id: str,
+        page_size: int = None,
+        continuation_token: str = "",
+    ) -> PagedMembersResult:
+        return await self.on_get_conversation_paged_members(
+            claims_identity, conversation_id, page_size, continuation_token
+        )
+
+    async def test_on_delete_conversation_member(
+        self, claims_identity: ClaimsIdentity, conversation_id: str, member_id: str,
+    ):
+        return await self.on_delete_conversation_member(
+            claims_identity, conversation_id, member_id
+        )
+
+    async def test_on_get_activity_members(
+        self, claims_identity: ClaimsIdentity, conversation_id: str, activity_id: str,
+    ) -> List[ChannelAccount]:
+        return await self.on_get_activity_members(
+            claims_identity, conversation_id, activity_id
+        )
+
+    async def test_on_upload_attachment(
+        self,
+        claims_identity: ClaimsIdentity,
+        conversation_id: str,
+        attachment_upload: AttachmentData,
+    ) -> ResourceResponse:
+        return await self.on_upload_attachment(
+            claims_identity, conversation_id, attachment_upload
+        )
+
+
+# pylint: disable=invalid-name
+# pylint: disable=attribute-defined-outside-init
+
+
+class TestSkillHandler(aiounittest.AsyncTestCase):
+    @classmethod
+    def setUpClass(cls):
+        bot_id = str(uuid4())
+        skill_id = str(uuid4())
+
+        cls._test_id_factory = ConversationIdFactoryForTest()
+
+        cls._claims_identity = ClaimsIdentity({}, False)
+
+        cls._claims_identity.claims[AuthenticationConstants.AUDIENCE_CLAIM] = bot_id
+        cls._claims_identity.claims[AuthenticationConstants.APP_ID_CLAIM] = skill_id
+        cls._claims_identity.claims[
+            AuthenticationConstants.SERVICE_URL_CLAIM
+        ] = "http://testbot.com/api/messages"
+        cls._conversation_reference = ConversationReference(
+            conversation=ConversationAccount(id=str(uuid4())),
+            service_url="http://testbot.com/api/messages",
+        )
+
+    def create_skill_handler_for_testing(self, adapter) -> SkillHandlerInstanceForTests:
+        return SkillHandlerInstanceForTests(
+            adapter,
+            Mock(),
+            self._test_id_factory,
+            Mock(),
+            AuthenticationConfiguration(),
+        )
+
+    async def test_on_send_to_conversation(self):
+        self._conversation_id = await self._test_id_factory.create_skill_conversation_id(
+            self._conversation_reference
+        )
+
+        mock_adapter = Mock()
+        mock_adapter.continue_conversation = MagicMock(return_value=Future())
+        mock_adapter.continue_conversation.return_value.set_result(Mock())
+
+        sut = self.create_skill_handler_for_testing(mock_adapter)
+
+        activity = Activity(type=ActivityTypes.message, attachments=[], entities=[])
+        TurnContext.apply_conversation_reference(activity, self._conversation_reference)
+
+        await sut.test_on_send_to_conversation(
+            self._claims_identity, self._conversation_id, activity
+        )
+
+        args, kwargs = mock_adapter.continue_conversation.call_args_list[0]
+
+        assert isinstance(args[0], ConversationReference)
+        assert callable(args[1])
+        assert isinstance(kwargs["claims_identity"], ClaimsIdentity)
+
+    async def test_on_reply_to_activity(self):
+        self._conversation_id = await self._test_id_factory.create_skill_conversation_id(
+            self._conversation_reference
+        )
+
+        mock_adapter = Mock()
+        mock_adapter.continue_conversation = MagicMock(return_value=Future())
+        mock_adapter.continue_conversation.return_value.set_result(Mock())
+
+        sut = self.create_skill_handler_for_testing(mock_adapter)
+
+        activity = Activity(type=ActivityTypes.message, attachments=[], entities=[])
+        activity_id = str(uuid4())
+        TurnContext.apply_conversation_reference(activity, self._conversation_reference)
+
+        await sut.test_on_reply_to_activity(
+            self._claims_identity, self._conversation_id, activity_id, activity
+        )
+
+        args, kwargs = mock_adapter.continue_conversation.call_args_list[0]
+
+        assert isinstance(args[0], ConversationReference)
+        assert callable(args[1])
+        assert isinstance(kwargs["claims_identity"], ClaimsIdentity)
+
+    async def test_on_update_activity(self):
+        self._conversation_id = ""
+
+        mock_adapter = Mock()
+
+        sut = self.create_skill_handler_for_testing(mock_adapter)
+
+        activity = Activity(type=ActivityTypes.message, attachments=[], entities=[])
+        activity_id = str(uuid4())
+
+        with self.assertRaises(BotActionNotImplementedError):
+            await sut.test_on_update_activity(
+                self._claims_identity, self._conversation_id, activity_id, activity
+            )
+
+    async def test_on_delete_activity(self):
+        self._conversation_id = ""
+
+        mock_adapter = Mock()
+
+        sut = self.create_skill_handler_for_testing(mock_adapter)
+        activity_id = str(uuid4())
+
+        with self.assertRaises(BotActionNotImplementedError):
+            await sut.test_on_delete_activity(
+                self._claims_identity, self._conversation_id, activity_id
+            )
+
+    async def test_on_get_activity_members(self):
+        self._conversation_id = ""
+
+        mock_adapter = Mock()
+
+        sut = self.create_skill_handler_for_testing(mock_adapter)
+        activity_id = str(uuid4())
+
+        with self.assertRaises(BotActionNotImplementedError):
+            await sut.test_on_get_activity_members(
+                self._claims_identity, self._conversation_id, activity_id
+            )
+
+    async def test_on_create_conversation(self):
+        mock_adapter = Mock()
+
+        sut = self.create_skill_handler_for_testing(mock_adapter)
+        conversation_parameters = ConversationParameters()
+
+        with self.assertRaises(BotActionNotImplementedError):
+            await sut.test_on_create_conversation(
+                self._claims_identity, conversation_parameters
+            )
+
+    async def test_on_get_conversations(self):
+        self._conversation_id = ""
+
+        mock_adapter = Mock()
+
+        sut = self.create_skill_handler_for_testing(mock_adapter)
+
+        with self.assertRaises(BotActionNotImplementedError):
+            await sut.test_on_get_conversations(
+                self._claims_identity, self._conversation_id
+            )
+
+    async def test_on_get_conversation_members(self):
+        self._conversation_id = ""
+
+        mock_adapter = Mock()
+
+        sut = self.create_skill_handler_for_testing(mock_adapter)
+
+        with self.assertRaises(BotActionNotImplementedError):
+            await sut.test_on_get_conversation_members(
+                self._claims_identity, self._conversation_id
+            )
+
+    async def test_on_get_conversation_paged_members(self):
+        self._conversation_id = ""
+
+        mock_adapter = Mock()
+
+        sut = self.create_skill_handler_for_testing(mock_adapter)
+
+        with self.assertRaises(BotActionNotImplementedError):
+            await sut.test_on_get_conversation_paged_members(
+                self._claims_identity, self._conversation_id
+            )
+
+    async def test_on_delete_conversation_member(self):
+        self._conversation_id = ""
+
+        mock_adapter = Mock()
+
+        sut = self.create_skill_handler_for_testing(mock_adapter)
+        member_id = str(uuid4())
+
+        with self.assertRaises(BotActionNotImplementedError):
+            await sut.test_on_delete_conversation_member(
+                self._claims_identity, self._conversation_id, member_id
+            )
+
+    async def test_on_send_conversation_history(self):
+        self._conversation_id = ""
+
+        mock_adapter = Mock()
+
+        sut = self.create_skill_handler_for_testing(mock_adapter)
+        transcript = Transcript()
+
+        with self.assertRaises(BotActionNotImplementedError):
+            await sut.test_on_send_conversation_history(
+                self._claims_identity, self._conversation_id, transcript
+            )
+
+    async def test_on_upload_attachment(self):
+        self._conversation_id = ""
+
+        mock_adapter = Mock()
+
+        sut = self.create_skill_handler_for_testing(mock_adapter)
+        attachment_data = AttachmentData()
+
+        with self.assertRaises(BotActionNotImplementedError):
+            await sut.test_on_upload_attachment(
+                self._claims_identity, self._conversation_id, attachment_data
+            )

libraries/botbuilder-core/tests/test_bot_framework_http_client.py

@@ -0,0 +1,8 @@
+import aiounittest
+from botbuilder.core import BotFrameworkHttpClient
+
+
+class TestBotFrameworkHttpClient(aiounittest.AsyncTestCase):
+    async def test_should_create_connector_client(self):
+        with self.assertRaises(TypeError):
+            BotFrameworkHttpClient(None)

libraries/botframework-connector/setup.py

@@ -11,6 +11,7 @@
     "cryptography==2.8.0",
     "PyJWT==1.5.3",
     "botbuilder-schema>=4.4.0b1",
+    "adal==1.2.1",
 ]
 
 root = os.path.abspath(os.path.dirname(__file__))