Merge pull request #34 from Pearson-Advance/vue/PADV-1190

PADV-1190: Add Deep Linking views.

openedx_lti_tool_plugin/deep_linking/__init__.py

@@ -0,0 +1 @@
+"""LTI Deep Linking."""

openedx_lti_tool_plugin/deep_linking/exceptions.py

@@ -0,0 +1,5 @@
+"""Exceptions."""
+
+
+class DeepLinkingException(Exception):
+    """A exception for Deep Linking errors."""

openedx_lti_tool_plugin/deep_linking/tests/__init__.py

@@ -0,0 +1,3 @@
+"""Test deep_linking module."""
+
+MODULE_PATH = 'openedx_lti_tool_plugin.deep_linking'

openedx_lti_tool_plugin/deep_linking/tests/test_urls.py

@@ -0,0 +1,36 @@
+"""Test urls module."""
+from uuid import uuid4
+
+from django.test import TestCase
+from django.urls import resolve, reverse
+
+from openedx_lti_tool_plugin.deep_linking.views import DeepLinkingFormView, DeepLinkingView
+
+
+class TestDeepLinkingViewUrlPatterns(TestCase):
+    """Test DeepLinkingView Django URL configuration."""
+
+    def test_view_url(self):
+        """Test view URL."""
+        self.assertEqual(
+            resolve(
+                reverse('1.3:deep-linking:root'),
+            ).func.view_class,
+            DeepLinkingView,
+        )
+
+
+class TestDeepLinkingFormViewUrlPatterns(TestCase):
+    """Test DeepLinkingFormView Django URL configuration."""
+
+    def test_view_url(self):
+        """Test view URL."""
+        self.assertEqual(
+            resolve(
+                reverse(
+                    '1.3:deep-linking:form',
+                    kwargs={'launch_id': uuid4()},
+                ),
+            ).func.view_class,
+            DeepLinkingFormView,
+        )

openedx_lti_tool_plugin/deep_linking/tests/test_views.py

@@ -0,0 +1,310 @@
+"""Tests views module."""
+from unittest.mock import MagicMock, PropertyMock, patch
+from uuid import uuid4
+
+from django.test import RequestFactory, TestCase
+from django.urls import reverse
+from pylti1p3.exception import LtiException
+
+from openedx_lti_tool_plugin.apps import OpenEdxLtiToolPluginConfig as app_config
+from openedx_lti_tool_plugin.deep_linking.exceptions import DeepLinkingException
+from openedx_lti_tool_plugin.deep_linking.tests import MODULE_PATH
+from openedx_lti_tool_plugin.deep_linking.views import (
+    DeepLinkingFormView,
+    DeepLinkingView,
+    validate_deep_linking_message,
+)
+
+MODULE_PATH = f'{MODULE_PATH}.views'
+
+
+class TestValidateDeepLinkingMessage(TestCase):
+    """Test validate_deep_linking_message function."""
+
+    def test_validate_deep_linking_message(self: MagicMock):
+        """Test with LtiDeepLinkingRequest message."""
+        message = MagicMock()
+        message.is_deep_link_launch.return_value = True
+
+        validate_deep_linking_message(message)
+
+        message.is_deep_link_launch.assert_called_once_with()
+
+    @patch(f'{MODULE_PATH}._', return_value='')
+    def test_without_deep_linking_request_message(
+        self: MagicMock,
+        gettext_mock: MagicMock,
+    ):
+        """Test without LtiDeepLinkingRequest message."""
+        message = MagicMock()
+        message.is_deep_link_launch.return_value = False
+
+        with self.assertRaises(DeepLinkingException) as ctxm:
+            validate_deep_linking_message(message)
+
+        message.is_deep_link_launch.assert_called_once_with()
+        gettext_mock.assert_called_once_with('Message type is not LtiDeepLinkingRequest.')
+        self.assertEqual(gettext_mock(), str(ctxm.exception))
+
+
+@patch.object(DeepLinkingView, 'tool_config', new_callable=PropertyMock)
+@patch.object(DeepLinkingView, 'tool_storage', new_callable=PropertyMock)
+@patch(f'{MODULE_PATH}.DjangoMessageLaunch')
+@patch(f'{MODULE_PATH}.validate_deep_linking_message')
+@patch(f'{MODULE_PATH}.redirect')
+class TestDeepLinkingViewPost(TestCase):
+    """Test ResourceLinkLaunchView post method."""
+
+    def setUp(self):
+        """Set up test fixtures."""
+        super().setUp()
+        self.view_class = DeepLinkingView
+        self.factory = RequestFactory()
+        self.url = reverse('1.3:deep-linking:root')
+        self.request = self.factory.post(self.url)
+
+    def test_post(
+        self,
+        redirect_mock: MagicMock,
+        validate_deep_linking_message_mock: MagicMock,
+        message_launch_mock: MagicMock,
+        tool_storage_mock: MagicMock,
+        tool_conf_mock: MagicMock,
+    ):
+        """Test `post` method with LtiDeepLinkingRequest (happy path)."""
+        self.assertEqual(
+            self.view_class.as_view()(self.request),
+            redirect_mock.return_value,
+        )
+        message_launch_mock.assert_called_once_with(
+            self.request,
+            tool_conf_mock(),
+            launch_data_storage=tool_storage_mock(),
+        )
+        validate_deep_linking_message_mock.assert_called_once_with(message_launch_mock())
+        message_launch_mock().get_launch_id.assert_called_once_with()
+        message_launch_mock().get_launch_id().replace.assert_called_once_with('lti1p3-launch-', '')
+        redirect_mock.assert_called_once_with(
+            f'{app_config.name}:1.3:deep-linking:form',
+            launch_id=message_launch_mock().get_launch_id().replace(),
+        )
+
+    @patch.object(DeepLinkingView, 'http_response_error')
+    def test_raises_lti_exception(
+        self,
+        http_response_error_mock: MagicMock,
+        redirect_mock: MagicMock,
+        validate_deep_linking_message_mock: MagicMock,
+        message_launch_mock: MagicMock,
+        tool_storage_mock: MagicMock,
+        tool_conf_mock: MagicMock,
+    ):
+        """Test raises LtiException."""
+        exception = LtiException('Error message')
+        message_launch_mock.side_effect = exception
+
+        self.assertEqual(
+            self.view_class.as_view()(self.request),
+            http_response_error_mock.return_value,
+        )
+        message_launch_mock.assert_called_once_with(
+            self.request,
+            tool_conf_mock(),
+            launch_data_storage=tool_storage_mock(),
+        )
+        validate_deep_linking_message_mock.assert_not_called()
+        redirect_mock.assert_not_called()
+        http_response_error_mock.assert_called_once_with(exception)
+
+    @patch.object(DeepLinkingView, 'http_response_error')
+    def test_raises_deep_linking_exception(
+        self,
+        http_response_error_mock: MagicMock,
+        redirect_mock: MagicMock,
+        validate_deep_linking_message_mock: MagicMock,
+        message_launch_mock: MagicMock,
+        tool_storage_mock: MagicMock,
+        tool_conf_mock: MagicMock,
+    ):
+        """Test raises DeepLinkingException."""
+        exception = DeepLinkingException('Error message')
+        validate_deep_linking_message_mock.side_effect = exception
+
+        self.assertEqual(
+            self.view_class.as_view()(self.request),
+            http_response_error_mock.return_value,
+        )
+        message_launch_mock.assert_called_once_with(
+            self.request,
+            tool_conf_mock(),
+            launch_data_storage=tool_storage_mock(),
+        )
+        validate_deep_linking_message_mock.assert_called_once_with(message_launch_mock())
+        redirect_mock.assert_not_called()
+        http_response_error_mock.assert_called_once_with(exception)
+
+
+@patch.object(DeepLinkingFormView, 'get_message_from_cache')
+@patch(f'{MODULE_PATH}.validate_deep_linking_message')
+class TestDeepLinkingFormViewGet(TestCase):
+    """Test DeepLinkingFormView get method."""
+
+    def setUp(self):
+        """Set up test fixtures."""
+        super().setUp()
+        self.view_class = DeepLinkingFormView
+        self.factory = RequestFactory()
+        self.launch_id = uuid4()
+        self.url = reverse('1.3:deep-linking:form', args=[self.launch_id])
+        self.request = self.factory.get(self.url)
+
+    @patch(f'{MODULE_PATH}.HttpResponse')
+    def test_get(
+        self,
+        http_response_mock: MagicMock,
+        validate_deep_linking_message_mock: MagicMock,
+        get_message_from_cache_mock: MagicMock,
+    ):
+        """Test `get` method with valid launch_id (happy path)."""
+        self.assertEqual(
+            self.view_class.as_view()(self.request, self.launch_id),
+            http_response_mock.return_value,
+        )
+        get_message_from_cache_mock.assert_called_once_with(self.request, self.launch_id)
+        validate_deep_linking_message_mock.assert_called_once_with(get_message_from_cache_mock())
+        http_response_mock.assert_called_once_with()
+
+    @patch.object(DeepLinkingFormView, 'http_response_error')
+    def test_raises_lti_exception(
+        self,
+        http_response_error_mock: MagicMock,
+        validate_deep_linking_message_mock: MagicMock,
+        get_message_from_cache_mock: MagicMock,
+    ):
+        """Test raises LtiException."""
+        exception = LtiException('Error message')
+        get_message_from_cache_mock.side_effect = exception
+
+        self.assertEqual(
+            self.view_class.as_view()(self.request, self.launch_id),
+            http_response_error_mock.return_value,
+        )
+        get_message_from_cache_mock.assert_called_once_with(self.request, self.launch_id)
+        validate_deep_linking_message_mock.assert_not_called()
+        http_response_error_mock.assert_called_once_with(exception)
+
+    @patch.object(DeepLinkingFormView, 'http_response_error')
+    def test_raises_deep_linking_exception(
+        self,
+        http_response_error_mock: MagicMock,
+        validate_deep_linking_message_mock: MagicMock,
+        get_message_from_cache_mock: MagicMock,
+    ):
+        """Test raises DeepLinkingException."""
+        exception = DeepLinkingException('Error message')
+        validate_deep_linking_message_mock.side_effect = exception
+
+        self.assertEqual(
+            self.view_class.as_view()(self.request, self.launch_id),
+            http_response_error_mock.return_value,
+        )
+        get_message_from_cache_mock.assert_called_once_with(self.request, self.launch_id)
+        validate_deep_linking_message_mock.assert_called_once_with(get_message_from_cache_mock())
+        http_response_error_mock.assert_called_once_with(exception)
+
+
+@patch.object(DeepLinkingFormView, 'get_message_from_cache')
+@patch(f'{MODULE_PATH}.validate_deep_linking_message')
+class TestDeepLinkingFormViewPost(TestCase):
+    """Test DeepLinkingFormView post method."""
+
+    def setUp(self):
+        """Set up test fixtures."""
+        super().setUp()
+        self.view_class = DeepLinkingFormView
+        self.factory = RequestFactory()
+        self.launch_id = uuid4()
+        self.url = reverse('1.3:deep-linking:form', args=[self.launch_id])
+        self.request = self.factory.post(self.url)
+
+    @patch(f'{MODULE_PATH}.HttpResponse')
+    def test_post(
+        self,
+        http_response_mock: MagicMock,
+        validate_deep_linking_message_mock: MagicMock,
+        get_message_from_cache_mock: MagicMock,
+    ):
+        """Test `post` method with valid launch_id (happy path)."""
+        self.assertEqual(
+            self.view_class.as_view()(self.request, self.launch_id),
+            http_response_mock.return_value,
+        )
+        get_message_from_cache_mock.assert_called_once_with(self.request, self.launch_id)
+        validate_deep_linking_message_mock.assert_called_once_with(get_message_from_cache_mock())
+        http_response_mock.assert_called_once_with()
+
+    @patch.object(DeepLinkingFormView, 'http_response_error')
+    def test_raises_lti_exception(
+        self,
+        http_response_error_mock: MagicMock,
+        validate_deep_linking_message_mock: MagicMock,
+        get_message_from_cache_mock: MagicMock,
+    ):
+        """Test raises LtiException."""
+        exception = LtiException('Error message')
+        get_message_from_cache_mock.side_effect = exception
+
+        self.assertEqual(
+            self.view_class.as_view()(self.request, self.launch_id),
+            http_response_error_mock.return_value,
+        )
+        get_message_from_cache_mock.assert_called_once_with(self.request, self.launch_id)
+        validate_deep_linking_message_mock.assert_not_called()
+        http_response_error_mock.assert_called_once_with(exception)
+
+    @patch.object(DeepLinkingFormView, 'http_response_error')
+    def test_raises_deep_linking_exception(
+        self,
+        http_response_error_mock: MagicMock,
+        validate_deep_linking_message_mock: MagicMock,
+        get_message_from_cache_mock: MagicMock,
+    ):
+        """Test raises DeepLinkingException."""
+        exception = DeepLinkingException('Error message')
+        validate_deep_linking_message_mock.side_effect = exception
+
+        self.assertEqual(
+            self.view_class.as_view()(self.request, self.launch_id),
+            http_response_error_mock.return_value,
+        )
+        get_message_from_cache_mock.assert_called_once_with(self.request, self.launch_id)
+        validate_deep_linking_message_mock.assert_called_once_with(get_message_from_cache_mock())
+        http_response_error_mock.assert_called_once_with(exception)
+
+
+@patch.object(DeepLinkingFormView, 'tool_config', new_callable=PropertyMock)
+@patch.object(DeepLinkingFormView, 'tool_storage', new_callable=PropertyMock)
+@patch(f'{MODULE_PATH}.DjangoMessageLaunch')
+class TestDeepLinkingFormViewGetMessageFromCache(TestCase):
+    """Test DeepLinkingFormView get_message_from_cache method."""
+
+    def test_get_message_from_cache(
+        self,
+        message_launch_mock: MagicMock,
+        tool_storage_mock: MagicMock,
+        tool_conf_mock: MagicMock,
+    ):
+        """Test `get_message_from_cache` method with valid launch_id (happy path)."""
+        request = MagicMock()
+        launch_id = uuid4()
+
+        self.assertEqual(
+            DeepLinkingFormView().get_message_from_cache(request, launch_id),
+            message_launch_mock.from_cache.return_value,
+        )
+        message_launch_mock.from_cache.assert_called_once_with(
+            f'lti1p3-launch-{launch_id}',
+            request,
+            tool_conf_mock(),
+            launch_data_storage=tool_storage_mock(),
+        )

openedx_lti_tool_plugin/deep_linking/urls.py

@@ -0,0 +1,24 @@
+"""Django URL Configuration.
+
+Attributes:
+    app_name (str): URL pattern namespace.
+    urlpatterns (list): URL patterns list.
+
+"""
+from django.urls import path
+
+from openedx_lti_tool_plugin.deep_linking import views
+
+app_name = 'deep-linking'
+urlpatterns = [
+    path(
+        '',
+        views.DeepLinkingView.as_view(),
+        name='root',
+    ),
+    path(
+        '<uuid:launch_id>',
+        views.DeepLinkingFormView.as_view(),
+        name='form',
+    ),
+]