Move to new consent API
This commit is contained in:
@@ -56,6 +56,7 @@ class EnrollmentTestMixin(object):
|
||||
min_mongo_calls=0,
|
||||
max_mongo_calls=0,
|
||||
enterprise_course_consent=None,
|
||||
linked_enterprise_customer=None,
|
||||
):
|
||||
"""
|
||||
Enroll in the course and verify the response's status code. If the expected status is 200, also validates
|
||||
@@ -85,6 +86,9 @@ class EnrollmentTestMixin(object):
|
||||
if enterprise_course_consent is not None:
|
||||
data['enterprise_course_consent'] = enterprise_course_consent
|
||||
|
||||
if linked_enterprise_customer is not None:
|
||||
data['linked_enterprise_customer'] = linked_enterprise_customer
|
||||
|
||||
extra = {}
|
||||
if as_server:
|
||||
extra['HTTP_X_EDX_API_KEY'] = self.API_KEY
|
||||
@@ -961,6 +965,7 @@ class EnrollmentTest(EnrollmentTestMixin, ModuleStoreTestCase, APITestCase, Ente
|
||||
self.assertTrue(is_active)
|
||||
self.assertEqual(course_mode, updated_mode)
|
||||
|
||||
@override_settings(ENABLE_ENTERPRISE_INTEGRATION=True)
|
||||
def test_enterprise_course_enrollment_invalid_consent(self):
|
||||
"""Verify that the enterprise_course_consent must be a boolean. """
|
||||
CourseModeFactory.create(
|
||||
@@ -976,6 +981,7 @@ class EnrollmentTest(EnrollmentTestMixin, ModuleStoreTestCase, APITestCase, Ente
|
||||
|
||||
@httpretty.activate
|
||||
@override_settings(ENTERPRISE_SERVICE_WORKER_USERNAME='enterprise_worker')
|
||||
@override_settings(ENABLE_ENTERPRISE_INTEGRATION=True)
|
||||
def test_enterprise_course_enrollment_api_error(self):
|
||||
"""Verify that enterprise service errors are handled properly. """
|
||||
UserFactory.create(
|
||||
@@ -1003,6 +1009,7 @@ class EnrollmentTest(EnrollmentTestMixin, ModuleStoreTestCase, APITestCase, Ente
|
||||
|
||||
@httpretty.activate
|
||||
@override_settings(ENTERPRISE_SERVICE_WORKER_USERNAME='enterprise_worker')
|
||||
@override_settings(ENABLE_ENTERPRISE_INTEGRATION=True)
|
||||
def test_enterprise_course_enrollment_successful(self):
|
||||
"""Verify that the enrollment completes when the EnterpriseCourseEnrollment creation succeeds. """
|
||||
UserFactory.create(
|
||||
@@ -1028,6 +1035,43 @@ class EnrollmentTest(EnrollmentTestMixin, ModuleStoreTestCase, APITestCase, Ente
|
||||
'No request was made to the mocked enterprise-course-enrollment API'
|
||||
)
|
||||
|
||||
@httpretty.activate
|
||||
@override_settings(ENTERPRISE_SERVICE_WORKER_USERNAME='enterprise_worker')
|
||||
@override_settings(ENABLE_ENTERPRISE_INTEGRATION=True)
|
||||
def test_enterprise_course_enrollment_with_ec_uuid(self):
|
||||
"""Verify that the enrollment completes when the EnterpriseCourseEnrollment creation succeeds. """
|
||||
UserFactory.create(
|
||||
username='enterprise_worker',
|
||||
email=self.EMAIL,
|
||||
password=self.PASSWORD,
|
||||
)
|
||||
CourseModeFactory.create(
|
||||
course_id=self.course.id,
|
||||
mode_slug=CourseMode.DEFAULT_MODE_SLUG,
|
||||
mode_display_name=CourseMode.DEFAULT_MODE_SLUG,
|
||||
)
|
||||
consent_kwargs = {
|
||||
'username': self.user.username,
|
||||
'course_id': unicode(self.course.id),
|
||||
'ec_uuid': 'this-is-a-real-uuid'
|
||||
}
|
||||
self.mock_consent_missing(**consent_kwargs)
|
||||
self.mock_consent_post(**consent_kwargs)
|
||||
self.assert_enrollment_status(
|
||||
expected_status=status.HTTP_200_OK,
|
||||
as_server=True,
|
||||
username='enterprise_worker',
|
||||
linked_enterprise_customer='this-is-a-real-uuid',
|
||||
)
|
||||
self.assertEqual(
|
||||
httpretty.last_request().path,
|
||||
'/consent/api/v1/data_sharing_consent',
|
||||
)
|
||||
self.assertEqual(
|
||||
httpretty.last_request().method,
|
||||
httpretty.POST
|
||||
)
|
||||
|
||||
def test_enrollment_attributes_always_written(self):
|
||||
""" Enrollment attributes should always be written, regardless of whether
|
||||
the enrollment is being created or updated.
|
||||
|
||||
@@ -29,7 +29,12 @@ from openedx.core.lib.api.authentication import (
|
||||
from openedx.core.lib.api.permissions import ApiKeyHeaderPermission, ApiKeyHeaderPermissionIsAuthenticated
|
||||
from openedx.core.lib.exceptions import CourseNotFoundError
|
||||
from openedx.core.lib.log_utils import audit_log
|
||||
from openedx.features.enterprise_support.api import EnterpriseApiClient, EnterpriseApiException, enterprise_enabled
|
||||
from openedx.features.enterprise_support.api import (
|
||||
ConsentApiClient,
|
||||
EnterpriseApiClient,
|
||||
EnterpriseApiException,
|
||||
enterprise_enabled
|
||||
)
|
||||
from student.auth import user_has_role
|
||||
from student.models import User
|
||||
from student.roles import CourseStaffRole, GlobalStaff
|
||||
@@ -591,27 +596,42 @@ class EnrollmentListView(APIView, ApiKeyPermissionMixIn):
|
||||
)
|
||||
|
||||
enterprise_course_consent = request.data.get('enterprise_course_consent')
|
||||
# Check if the enterprise_course_enrollment is a boolean
|
||||
if has_api_key_permissions and enterprise_enabled() and enterprise_course_consent is not None:
|
||||
if not isinstance(enterprise_course_consent, bool):
|
||||
return Response(
|
||||
status=status.HTTP_400_BAD_REQUEST,
|
||||
data={
|
||||
'message': (u"'{value}' is an invalid enterprise course consent value.").format(
|
||||
value=enterprise_course_consent
|
||||
)
|
||||
}
|
||||
)
|
||||
try:
|
||||
EnterpriseApiClient().post_enterprise_course_enrollment(
|
||||
username,
|
||||
unicode(course_id),
|
||||
enterprise_course_consent
|
||||
)
|
||||
except EnterpriseApiException as error:
|
||||
log.exception("An unexpected error occurred while creating the new EnterpriseCourseEnrollment "
|
||||
"for user [%s] in course run [%s]", username, course_id)
|
||||
raise CourseEnrollmentError(error.message)
|
||||
explicit_linked_enterprise = request.data.get('linked_enterprise_customer')
|
||||
if has_api_key_permissions and enterprise_enabled():
|
||||
# We received an explicitly-linked EnterpriseCustomer for the enrollment
|
||||
if explicit_linked_enterprise is not None:
|
||||
kwargs = {
|
||||
'username': username,
|
||||
'course_id': unicode(course_id),
|
||||
'enterprise_customer_uuid': explicit_linked_enterprise,
|
||||
}
|
||||
consent_client = ConsentApiClient()
|
||||
consent_client.provide_consent(**kwargs)
|
||||
|
||||
# We received an implicit "consent granted" parameter from ecommerce
|
||||
# TODO: Once ecommerce has been deployed with explicit enterprise support, remove this
|
||||
# entire chunk of logic, related tests, and any supporting methods no longer required.
|
||||
elif enterprise_course_consent is not None:
|
||||
# Check if the enterprise_course_enrollment is a boolean
|
||||
if not isinstance(enterprise_course_consent, bool):
|
||||
return Response(
|
||||
status=status.HTTP_400_BAD_REQUEST,
|
||||
data={
|
||||
'message': (u"'{value}' is an invalid enterprise course consent value.").format(
|
||||
value=enterprise_course_consent
|
||||
)
|
||||
}
|
||||
)
|
||||
try:
|
||||
EnterpriseApiClient().post_enterprise_course_enrollment(
|
||||
username,
|
||||
unicode(course_id),
|
||||
enterprise_course_consent
|
||||
)
|
||||
except EnterpriseApiException as error:
|
||||
log.exception("An unexpected error occurred while creating the new EnterpriseCourseEnrollment "
|
||||
"for user [%s] in course run [%s]", username, course_id)
|
||||
raise CourseEnrollmentError(error.message)
|
||||
|
||||
enrollment_attributes = request.data.get('enrollment_attributes')
|
||||
enrollment = api.get_enrollment(username, unicode(course_id))
|
||||
|
||||
Reference in New Issue
Block a user