e1cb10b41d
EnterpriseMiddleware set value of user's enterprise customer in session. In order to get value of enterprise customer it calls `enterprise/api/v1/enterprise-learner` API. Sometimes this middleware is called many times which result in many call to the under lying API and throttling of API causes 429 http errors. We are not removing that middleware and storing value of user's enterprise customer in session inside underlying method. ENT-1849 Removed pdb statement
549 lines
25 KiB
Python
549 lines
25 KiB
Python
"""
|
|
Test the enterprise support APIs.
|
|
"""
|
|
|
|
from __future__ import absolute_import
|
|
|
|
import mock
|
|
|
|
import ddt
|
|
import httpretty
|
|
from six.moves.urllib.parse import parse_qs # pylint: disable=import-error
|
|
|
|
from consent.models import DataSharingConsent
|
|
from django.conf import settings
|
|
from django.contrib.auth.models import User
|
|
from django.core.cache import cache
|
|
from django.http import HttpResponseRedirect
|
|
from django.test.utils import override_settings
|
|
from django.urls import reverse
|
|
from openedx.core.djangoapps.site_configuration.tests.factories import SiteFactory
|
|
from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms
|
|
from openedx.features.enterprise_support.api import (
|
|
ConsentApiClient,
|
|
ConsentApiServiceClient,
|
|
EnterpriseApiClient,
|
|
EnterpriseApiServiceClient,
|
|
consent_needed_for_course,
|
|
data_sharing_consent_required,
|
|
enterprise_customer_for_request,
|
|
enterprise_enabled,
|
|
get_consent_required_courses,
|
|
get_dashboard_consent_notification,
|
|
get_enterprise_consent_url,
|
|
insert_enterprise_pipeline_elements
|
|
)
|
|
from openedx.features.enterprise_support.tests import FEATURES_WITH_ENTERPRISE_ENABLED
|
|
from openedx.features.enterprise_support.tests.factories import EnterpriseCustomerUserFactory
|
|
from openedx.features.enterprise_support.tests.mixins.enterprise import EnterpriseServiceMockMixin
|
|
from openedx.features.enterprise_support.utils import clear_data_consent_share_cache, get_cache_key
|
|
from student.tests.factories import UserFactory
|
|
|
|
|
|
class MockEnrollment(mock.MagicMock):
|
|
"""
|
|
Mock object for an enrollment which has a consistent string representation
|
|
suitable for use in ddt parameters.
|
|
"""
|
|
def __repr__(self):
|
|
return '<MockEnrollment course_id={}>'.format(getattr(self, 'course_id', None))
|
|
|
|
|
|
@ddt.ddt
|
|
@override_settings(FEATURES=FEATURES_WITH_ENTERPRISE_ENABLED)
|
|
@skip_unless_lms
|
|
class TestEnterpriseApi(EnterpriseServiceMockMixin, CacheIsolationTestCase):
|
|
"""
|
|
Test enterprise support APIs.
|
|
"""
|
|
ENABLED_CACHES = ['default']
|
|
|
|
@classmethod
|
|
def setUpTestData(cls):
|
|
cls.user = UserFactory.create(
|
|
username=settings.ENTERPRISE_SERVICE_WORKER_USERNAME,
|
|
email='ent_worker@example.com',
|
|
password='password123',
|
|
)
|
|
super(TestEnterpriseApi, cls).setUpTestData()
|
|
|
|
def _assert_api_service_client(self, api_client, mocked_jwt_builder):
|
|
"""
|
|
Verify that the provided api client uses the enterprise service user to generate
|
|
JWT token for auth.
|
|
"""
|
|
mocked_jwt_builder.return_value = 'test-token'
|
|
enterprise_service_user = User.objects.get(username=settings.ENTERPRISE_SERVICE_WORKER_USERNAME)
|
|
enterprise_api_service_client = api_client()
|
|
|
|
mocked_jwt_builder.assert_called_once_with(enterprise_service_user)
|
|
# pylint: disable=protected-access
|
|
self.assertEqual(enterprise_api_service_client.client._store['session'].auth.token, 'test-token')
|
|
|
|
def _assert_api_client_with_user(self, api_client, mocked_jwt_builder):
|
|
"""
|
|
Verify that the provided api client uses the expected user to generate
|
|
JWT token for auth.
|
|
"""
|
|
mocked_jwt_builder.return_value = 'test-token'
|
|
dummy_enterprise_user = UserFactory.create(
|
|
username='dummy-enterprise-user',
|
|
email='dummy-enterprise-user@example.com',
|
|
password='password123',
|
|
)
|
|
enterprise_api_service_client = api_client(dummy_enterprise_user)
|
|
|
|
mocked_jwt_builder.assert_called_once_with(dummy_enterprise_user)
|
|
# pylint: disable=protected-access
|
|
self.assertEqual(enterprise_api_service_client.client._store['session'].auth.token, 'test-token')
|
|
|
|
def _assert_get_enterprise_customer(self, api_client, enterprise_api_data_for_mock):
|
|
"""
|
|
DRY method to verify caching for get enterprise customer method.
|
|
"""
|
|
cache_key = get_cache_key(
|
|
resource='enterprise-customer',
|
|
resource_id=enterprise_api_data_for_mock['uuid'],
|
|
username=settings.ENTERPRISE_SERVICE_WORKER_USERNAME,
|
|
)
|
|
self.mock_get_enterprise_customer(enterprise_api_data_for_mock['uuid'], enterprise_api_data_for_mock, 200)
|
|
self._assert_get_enterprise_customer_with_cache(api_client, enterprise_api_data_for_mock, cache_key)
|
|
|
|
def _assert_get_enterprise_customer_with_cache(self, api_client, enterprise_customer_data, cache_key):
|
|
"""
|
|
DRY method to verify that get enterprise customer response is cached.
|
|
"""
|
|
cached_enterprise_customer = cache.get(cache_key)
|
|
self.assertIsNone(cached_enterprise_customer)
|
|
|
|
enterprise_customer = api_client.get_enterprise_customer(enterprise_customer_data['uuid'])
|
|
self.assertEqual(enterprise_customer_data, enterprise_customer)
|
|
cached_enterprise_customer = cache.get(cache_key)
|
|
self.assertEqual(cached_enterprise_customer, enterprise_customer)
|
|
|
|
@httpretty.activate
|
|
@mock.patch('openedx.features.enterprise_support.api.create_jwt_for_user')
|
|
def test_enterprise_api_client_with_service_user(self, mock_jwt_builder):
|
|
"""
|
|
Verify that enterprise API service client uses enterprcreate_jwt_for_userise service user
|
|
by default to authenticate and access enterprise API.
|
|
"""
|
|
self._assert_api_service_client(EnterpriseApiServiceClient, mock_jwt_builder)
|
|
|
|
# Verify that enterprise customer data is cached properly for the
|
|
# enterprise api client.
|
|
enterprise_api_client = EnterpriseApiServiceClient()
|
|
enterprise_api_data_for_mock_1 = {'name': 'dummy-enterprise-customer-1', 'uuid': 'enterprise-uuid-1'}
|
|
self._assert_get_enterprise_customer(enterprise_api_client, enterprise_api_data_for_mock_1)
|
|
|
|
# Now try to get enterprise customer for another enterprise and verify
|
|
# that enterprise api client returns data according to the provided
|
|
# enterprise UUID.
|
|
enterprise_api_data_for_mock_2 = {'name': 'dummy-enterprise-customer-2', 'uuid': 'enterprise-uuid-2'}
|
|
self._assert_get_enterprise_customer(enterprise_api_client, enterprise_api_data_for_mock_2)
|
|
|
|
@httpretty.activate
|
|
@mock.patch('openedx.features.enterprise_support.api.create_jwt_for_user')
|
|
def test_enterprise_api_client_with_user(self, mock_jwt_builder):
|
|
"""
|
|
Verify that enterprise API client uses the provided user to
|
|
authenticate and access enterprise API.
|
|
"""
|
|
self._assert_api_client_with_user(EnterpriseApiClient, mock_jwt_builder)
|
|
|
|
@httpretty.activate
|
|
@mock.patch('openedx.features.enterprise_support.api.create_jwt_for_user')
|
|
def test_enterprise_consent_api_client_with_service_user(self, mock_jwt_builder):
|
|
"""
|
|
Verify that enterprise API consent service client uses enterprise
|
|
service user by default to authenticate and access enterprise API.
|
|
"""
|
|
self._assert_api_service_client(ConsentApiServiceClient, mock_jwt_builder)
|
|
|
|
@httpretty.activate
|
|
@mock.patch('openedx.features.enterprise_support.api.create_jwt_for_user')
|
|
def test_enterprise_consent_api_client_with_user(self, mock_jwt_builder):
|
|
"""
|
|
Verify that enterprise API consent service client uses the provided
|
|
user to authenticate and access enterprise API.
|
|
"""
|
|
self._assert_api_client_with_user(ConsentApiClient, mock_jwt_builder)
|
|
|
|
@httpretty.activate
|
|
def test_consent_needed_for_course(self):
|
|
user = UserFactory(username='janedoe')
|
|
request = mock.MagicMock(session={}, user=user, site=SiteFactory(domain="example.com"))
|
|
ec_uuid = 'cf246b88-d5f6-4908-a522-fc307e0b0c59'
|
|
course_id = 'fake-course'
|
|
self.mock_enterprise_learner_api()
|
|
|
|
# test not required consent for example non enterprise customer
|
|
self.mock_consent_not_required(user.username, course_id, ec_uuid)
|
|
self.assertFalse(consent_needed_for_course(request, user, course_id))
|
|
|
|
# test required and missing consent for example now he becomes a enterprise customer
|
|
self.mock_consent_missing(user.username, course_id, ec_uuid)
|
|
# still result should be False as it has been stored in cache "Not to show consent", so it will confirm that
|
|
# cache is working fine
|
|
self.assertFalse(consent_needed_for_course(request, user, course_id))
|
|
# Removing cache
|
|
clear_data_consent_share_cache(user.id, course_id)
|
|
# Now test again
|
|
self.assertTrue(consent_needed_for_course(request, user, course_id))
|
|
|
|
# test after consent permission is granted
|
|
self.mock_consent_get(user.username, course_id, ec_uuid)
|
|
self.assertFalse(consent_needed_for_course(request, user, course_id))
|
|
|
|
@httpretty.activate
|
|
@mock.patch('enterprise.models.EnterpriseCustomer.catalog_contains_course')
|
|
def test_get_consent_required_courses(self, mock_catalog_contains_course):
|
|
mock_catalog_contains_course.return_value = True
|
|
user = UserFactory()
|
|
enterprise_customer_user = EnterpriseCustomerUserFactory(user_id=user.id)
|
|
|
|
course_id = 'fake-course'
|
|
data_sharing_consent = DataSharingConsent(
|
|
course_id=course_id,
|
|
enterprise_customer=enterprise_customer_user.enterprise_customer,
|
|
username=user.username,
|
|
granted=False
|
|
)
|
|
data_sharing_consent.save()
|
|
consent_required = get_consent_required_courses(user, [course_id])
|
|
self.assertTrue(course_id in consent_required)
|
|
|
|
# now grant consent and call our method again
|
|
data_sharing_consent.granted = True
|
|
data_sharing_consent.save()
|
|
consent_required = get_consent_required_courses(user, [course_id])
|
|
self.assertFalse(course_id in consent_required)
|
|
|
|
@httpretty.activate
|
|
@mock.patch('openedx.features.enterprise_support.api.get_enterprise_learner_data')
|
|
@mock.patch('openedx.features.enterprise_support.api.EnterpriseCustomer')
|
|
@mock.patch('openedx.features.enterprise_support.api.get_partial_pipeline')
|
|
@mock.patch('openedx.features.enterprise_support.api.Registry')
|
|
def test_enterprise_customer_for_request(
|
|
self,
|
|
mock_registry,
|
|
mock_partial,
|
|
mock_enterprise_customer_model,
|
|
mock_get_enterprise_learner_data,
|
|
):
|
|
def mock_get_enterprise_customer(**kwargs):
|
|
uuid = kwargs.get('enterprise_customer_identity_provider__provider_id')
|
|
if uuid:
|
|
return mock.MagicMock(uuid=uuid, user=self.user)
|
|
raise Exception
|
|
|
|
dummy_request = mock.MagicMock(session={}, user=self.user)
|
|
mock_enterprise_customer_model.objects.get.side_effect = mock_get_enterprise_customer
|
|
mock_enterprise_customer_model.DoesNotExist = Exception
|
|
mock_partial.return_value = True
|
|
mock_registry.get_from_pipeline.return_value.provider_id = 'real-ent-uuid'
|
|
|
|
# Verify that the method `enterprise_customer_for_request` returns
|
|
# expected enterprise customer against the requesting user.
|
|
self.mock_get_enterprise_customer('real-ent-uuid', {'real': 'enterprisecustomer'}, 200)
|
|
enterprise_customer = enterprise_customer_for_request(dummy_request)
|
|
self.assertEqual(enterprise_customer, {'real': 'enterprisecustomer'})
|
|
|
|
httpretty.reset()
|
|
|
|
# Verify that the method `enterprise_customer_for_request` returns no
|
|
# enterprise customer if the enterprise customer API throws 404.
|
|
del dummy_request.session['enterprise_customer']
|
|
self.mock_get_enterprise_customer('real-ent-uuid', {'detail': 'Not found.'}, 404)
|
|
enterprise_customer = enterprise_customer_for_request(dummy_request)
|
|
self.assertIsNone(enterprise_customer)
|
|
|
|
httpretty.reset()
|
|
|
|
# Verify that the method `enterprise_customer_for_request` returns
|
|
# expected enterprise customer against the requesting user even if
|
|
# the third-party auth pipeline has no `provider_id`.
|
|
mock_registry.get_from_pipeline.return_value.provider_id = None
|
|
self.mock_get_enterprise_customer('real-ent-uuid', {'real': 'enterprisecustomer'}, 200)
|
|
enterprise_customer = enterprise_customer_for_request(
|
|
mock.MagicMock(GET={'enterprise_customer': 'real-ent-uuid'}, user=self.user)
|
|
)
|
|
self.assertEqual(enterprise_customer, {'real': 'enterprisecustomer'})
|
|
|
|
# Verify that the method `enterprise_customer_for_request` returns
|
|
# expected enterprise customer against the requesting user even if
|
|
# the third-party auth pipeline has no `provider_id` but there is
|
|
# enterprise customer UUID in the cookie.
|
|
enterprise_customer = enterprise_customer_for_request(
|
|
mock.MagicMock(GET={}, COOKIES={settings.ENTERPRISE_CUSTOMER_COOKIE_NAME: 'real-ent-uuid'}, user=self.user)
|
|
)
|
|
self.assertEqual(enterprise_customer, {'real': 'enterprisecustomer'})
|
|
|
|
# Verify that we can still get enterprise customer from enterprise
|
|
# learner API even if we are unable to get it from preferred sources,
|
|
# e.g. url query parameters, third-party auth pipeline, enterprise
|
|
# cookie.
|
|
mock_get_enterprise_learner_data.return_value = [{'enterprise_customer': {'uuid': 'real-ent-uuid'}}]
|
|
enterprise_customer = enterprise_customer_for_request(
|
|
mock.MagicMock(GET={}, COOKIES={}, user=self.user, site=1)
|
|
)
|
|
self.assertEqual(enterprise_customer, {'real': 'enterprisecustomer'})
|
|
|
|
def test_enterprise_customer_for_request_with_session(self):
|
|
"""
|
|
Verify enterprise_customer_for_request stores and retrieves data from session appropriately
|
|
"""
|
|
dummy_request = mock.MagicMock(session={}, user=self.user)
|
|
enterprise_data = {'name': 'dummy-enterprise-customer', 'uuid': '8dc65e66-27c9-447b-87ff-ede6d66e3a5d'}
|
|
|
|
# Verify enterprise customer data fetched from API when it is not available in session
|
|
with mock.patch(
|
|
'openedx.features.enterprise_support.api.enterprise_customer_from_api',
|
|
return_value=enterprise_data
|
|
):
|
|
self.assertEqual(dummy_request.session.get('enterprise_customer'), None)
|
|
enterprise_customer = enterprise_customer_for_request(dummy_request)
|
|
self.assertEqual(enterprise_customer, enterprise_data)
|
|
self.assertEqual(dummy_request.session.get('enterprise_customer'), enterprise_data)
|
|
|
|
# Verify enterprise customer data fetched from session for subsequent calls
|
|
with mock.patch(
|
|
'openedx.features.enterprise_support.api.enterprise_customer_from_api',
|
|
return_value=enterprise_data
|
|
) as mock_enterprise_customer_from_api, mock.patch(
|
|
'openedx.features.enterprise_support.api.enterprise_customer_from_cache',
|
|
return_value=enterprise_data
|
|
) as mock_enterprise_customer_from_cache:
|
|
enterprise_customer = enterprise_customer_for_request(dummy_request)
|
|
self.assertEqual(enterprise_customer, enterprise_data)
|
|
self.assertEqual(mock_enterprise_customer_from_api.called, False)
|
|
self.assertEqual(mock_enterprise_customer_from_cache.called, True)
|
|
|
|
def check_data_sharing_consent(self, consent_required=False, consent_url=None):
|
|
"""
|
|
Used to test the data_sharing_consent_required view decorator.
|
|
"""
|
|
|
|
# Test by wrapping a function that has the expected signature
|
|
@data_sharing_consent_required
|
|
def view_func(request, course_id, *args, **kwargs):
|
|
"""
|
|
Return the function arguments, so they can be tested.
|
|
"""
|
|
return ((request, course_id,) + args, kwargs)
|
|
|
|
# Call the wrapped function
|
|
args = (mock.MagicMock(), 'course-id', 'another arg', 'and another')
|
|
kwargs = dict(a=1, b=2, c=3)
|
|
response = view_func(*args, **kwargs)
|
|
|
|
# If consent required, then the response should be a redirect to the consent URL, and the view function would
|
|
# not be called.
|
|
if consent_required:
|
|
self.assertIsInstance(response, HttpResponseRedirect)
|
|
self.assertEquals(response.url, consent_url) # pylint: disable=no-member
|
|
|
|
# Otherwise, the view function should have been called with the expected arguments.
|
|
else:
|
|
self.assertEqual(response, (args, kwargs))
|
|
|
|
@mock.patch('openedx.features.enterprise_support.api.enterprise_enabled')
|
|
@mock.patch('openedx.features.enterprise_support.api.consent_needed_for_course')
|
|
def test_data_consent_required_enterprise_disabled(self,
|
|
mock_consent_necessary,
|
|
mock_enterprise_enabled):
|
|
"""
|
|
Verify that the wrapped view is called directly when enterprise integration is disabled,
|
|
without checking for course consent necessary.
|
|
"""
|
|
mock_enterprise_enabled.return_value = False
|
|
|
|
self.check_data_sharing_consent(consent_required=False)
|
|
|
|
mock_enterprise_enabled.assert_called_once()
|
|
mock_consent_necessary.assert_not_called()
|
|
|
|
@mock.patch('openedx.features.enterprise_support.api.enterprise_enabled')
|
|
@mock.patch('openedx.features.enterprise_support.api.consent_needed_for_course')
|
|
def test_no_course_data_consent_required(self,
|
|
mock_consent_necessary,
|
|
mock_enterprise_enabled):
|
|
|
|
"""
|
|
Verify that the wrapped view is called directly when enterprise integration is enabled,
|
|
and no course consent is required.
|
|
"""
|
|
mock_enterprise_enabled.return_value = True
|
|
mock_consent_necessary.return_value = False
|
|
|
|
self.check_data_sharing_consent(consent_required=False)
|
|
|
|
mock_enterprise_enabled.assert_called_once()
|
|
mock_consent_necessary.assert_called_once()
|
|
|
|
@mock.patch('openedx.features.enterprise_support.api.enterprise_enabled')
|
|
@mock.patch('openedx.features.enterprise_support.api.consent_needed_for_course')
|
|
@mock.patch('openedx.features.enterprise_support.api.get_enterprise_consent_url')
|
|
def test_data_consent_required(self, mock_get_consent_url, mock_consent_necessary, mock_enterprise_enabled):
|
|
"""
|
|
Verify that the wrapped function returns a redirect to the consent URL when enterprise integration is enabled,
|
|
and course consent is required.
|
|
"""
|
|
mock_enterprise_enabled.return_value = True
|
|
mock_consent_necessary.return_value = True
|
|
consent_url = '/abc/def'
|
|
mock_get_consent_url.return_value = consent_url
|
|
|
|
self.check_data_sharing_consent(consent_required=True, consent_url=consent_url)
|
|
|
|
mock_get_consent_url.assert_called_once()
|
|
|
|
@httpretty.activate
|
|
@mock.patch('openedx.features.enterprise_support.api.enterprise_customer_uuid_for_request')
|
|
@mock.patch('openedx.features.enterprise_support.api.reverse')
|
|
@mock.patch('openedx.features.enterprise_support.api.consent_needed_for_course')
|
|
def test_get_enterprise_consent_url(
|
|
self,
|
|
needed_for_course_mock,
|
|
reverse_mock,
|
|
enterprise_customer_uuid_for_request_mock,
|
|
):
|
|
"""
|
|
Verify that get_enterprise_consent_url correctly builds URLs.
|
|
"""
|
|
|
|
def fake_reverse(*args, **kwargs):
|
|
if args[0] == 'grant_data_sharing_permissions':
|
|
return '/enterprise/grant_data_sharing_permissions'
|
|
return reverse(*args, **kwargs)
|
|
|
|
enterprise_customer_uuid_for_request_mock.return_value = 'cf246b88-d5f6-4908-a522-fc307e0b0c59'
|
|
reverse_mock.side_effect = fake_reverse
|
|
needed_for_course_mock.return_value = True
|
|
request_mock = mock.MagicMock(
|
|
user=self.user,
|
|
build_absolute_uri=lambda x: 'http://localhost:8000' + x # Don't do it like this in prod. Ever.
|
|
)
|
|
|
|
course_id = 'course-v1:edX+DemoX+Demo_Course'
|
|
return_to = 'info'
|
|
|
|
expected_url_args = {
|
|
'course_id': ['course-v1:edX+DemoX+Demo_Course'],
|
|
'failure_url': ['http://localhost:8000/dashboard?consent_failed=course-v1%3AedX%2BDemoX%2BDemo_Course'],
|
|
'enterprise_customer_uuid': ['cf246b88-d5f6-4908-a522-fc307e0b0c59'],
|
|
'next': ['http://localhost:8000/courses/course-v1:edX+DemoX+Demo_Course/info']
|
|
}
|
|
|
|
actual_url = get_enterprise_consent_url(request_mock, course_id, return_to=return_to)
|
|
actual_url_args = parse_qs(actual_url.split('/enterprise/grant_data_sharing_permissions?')[1])
|
|
self.assertEqual(actual_url_args, expected_url_args)
|
|
|
|
@ddt.data(
|
|
(False, {'real': 'enterprise', 'uuid': ''}, 'course', [], [], "", ""),
|
|
(True, {}, 'course', [], [], "", ""),
|
|
(True, {'real': 'enterprise'}, None, [], [], "", ""),
|
|
(True, {'name': 'GriffCo', 'uuid': ''}, 'real-course', [], [], "", ""),
|
|
(True, {'name': 'GriffCo', 'uuid': ''}, 'real-course', [MockEnrollment(course_id='other-id')], [], "", ""),
|
|
(
|
|
True,
|
|
{'name': 'GriffCo', 'uuid': 'real-uuid'},
|
|
'real-course',
|
|
[
|
|
MockEnrollment(
|
|
course_id='real-course',
|
|
course_overview=mock.MagicMock(
|
|
display_name='My Cool Course'
|
|
)
|
|
)
|
|
],
|
|
[
|
|
'If you have concerns about sharing your data, please contact your administrator at GriffCo.',
|
|
'Enrollment in My Cool Course was not complete.'
|
|
],
|
|
"", ""
|
|
),
|
|
(
|
|
True,
|
|
{'name': 'GriffCo', 'uuid': 'real-uuid'},
|
|
'real-course',
|
|
[
|
|
MockEnrollment(
|
|
course_id='real-course',
|
|
course_overview=mock.MagicMock(
|
|
display_name='My Cool Course'
|
|
)
|
|
)
|
|
],
|
|
[
|
|
'If you have concerns about sharing your data, please contact your administrator at GriffCo.',
|
|
'Enrollment in My Cool Course was not complete.'
|
|
],
|
|
"Title from DataSharingConsentTextOverrides model in consent app",
|
|
"Message from DataSharingConsentTextOverrides model in consent app"
|
|
),
|
|
|
|
)
|
|
@ddt.unpack
|
|
@mock.patch('openedx.features.enterprise_support.api.ConsentApiClient')
|
|
@mock.patch('openedx.features.enterprise_support.api.enterprise_customer_for_request')
|
|
@mock.patch('openedx.features.enterprise_support.api.get_consent_notification_data')
|
|
def test_get_dashboard_consent_notification(
|
|
self,
|
|
consent_return_value,
|
|
enterprise_customer,
|
|
course_id,
|
|
enrollments,
|
|
expected_substrings,
|
|
notification_title,
|
|
notification_message,
|
|
consent_notification_data,
|
|
ec_for_request,
|
|
consent_client_class
|
|
):
|
|
request = mock.MagicMock(
|
|
GET={'consent_failed': course_id}
|
|
)
|
|
consent_notification_data.return_value = notification_title, notification_message
|
|
consent_client = consent_client_class.return_value
|
|
consent_client.consent_required.return_value = consent_return_value
|
|
|
|
ec_for_request.return_value = enterprise_customer
|
|
|
|
user = mock.MagicMock()
|
|
|
|
notification_string = get_dashboard_consent_notification(
|
|
request, user, enrollments,
|
|
)
|
|
|
|
if notification_message and notification_title:
|
|
self.assertIn(notification_title, notification_string)
|
|
self.assertIn(notification_message, notification_string)
|
|
elif expected_substrings:
|
|
for substr in expected_substrings:
|
|
self.assertIn(substr, notification_string)
|
|
else:
|
|
self.assertEqual(notification_string, '')
|
|
|
|
@override_settings(FEATURES=dict(ENABLE_ENTERPRISE_INTEGRATION=False))
|
|
def test_utils_with_enterprise_disabled(self):
|
|
"""
|
|
Test that disabling the enterprise integration flag causes
|
|
the utilities to return the expected default values.
|
|
"""
|
|
self.assertFalse(enterprise_enabled())
|
|
self.assertEqual(insert_enterprise_pipeline_elements(None), None)
|
|
|
|
def test_utils_with_enterprise_enabled(self):
|
|
"""
|
|
Test that enabling enterprise integration (which is currently on by default) causes the
|
|
the utilities to return the expected values.
|
|
"""
|
|
self.assertTrue(enterprise_enabled())
|
|
pipeline = ['abc', 'social_core.pipeline.social_auth.load_extra_data', 'def']
|
|
insert_enterprise_pipeline_elements(pipeline)
|
|
self.assertEqual(pipeline, ['abc',
|
|
'enterprise.tpa_pipeline.handle_enterprise_logistration',
|
|
'social_core.pipeline.social_auth.load_extra_data',
|
|
'def'])
|