275 lines
11 KiB
Python
275 lines
11 KiB
Python
""" Tests for commerce views. """
|
|
|
|
import json
|
|
from uuid import uuid4
|
|
|
|
from ddt import ddt, data
|
|
from django.core.urlresolvers import reverse
|
|
from django.test.utils import override_settings
|
|
from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
|
|
from xmodule.modulestore.tests.factories import CourseFactory
|
|
|
|
from commerce.constants import OrderStatus, Messages
|
|
from commerce.exceptions import TimeoutError, ApiError
|
|
from commerce.tests import EcommerceApiTestMixin
|
|
from course_modes.models import CourseMode
|
|
from enrollment.api import get_enrollment
|
|
from student.models import CourseEnrollment
|
|
from student.tests.factories import UserFactory, CourseModeFactory
|
|
from student.tests.tests import EnrollmentEventTestMixin
|
|
|
|
|
|
@ddt
|
|
@override_settings(ECOMMERCE_API_URL=EcommerceApiTestMixin.ECOMMERCE_API_URL,
|
|
ECOMMERCE_API_SIGNING_KEY=EcommerceApiTestMixin.ECOMMERCE_API_SIGNING_KEY)
|
|
class OrdersViewTests(EnrollmentEventTestMixin, EcommerceApiTestMixin, ModuleStoreTestCase):
|
|
"""
|
|
Tests for the commerce orders view.
|
|
"""
|
|
|
|
def _login(self):
|
|
""" Log into LMS. """
|
|
self.client.login(username=self.user.username, password='test')
|
|
|
|
def _post_to_view(self, course_id=None):
|
|
"""
|
|
POST to the view being tested.
|
|
|
|
Arguments
|
|
course_id (str) -- ID of course for which a seat should be ordered.
|
|
|
|
:return: Response
|
|
"""
|
|
course_id = unicode(course_id or self.course.id)
|
|
return self.client.post(self.url, {'course_id': course_id})
|
|
|
|
def assertResponseMessage(self, response, expected_msg):
|
|
""" Asserts the detail field in the response's JSON body equals the expected message. """
|
|
actual = json.loads(response.content)['detail']
|
|
self.assertEqual(actual, expected_msg)
|
|
|
|
def assertValidEcommerceInternalRequestErrorResponse(self, response):
|
|
""" Asserts the response is a valid response sent when the E-Commerce API is unavailable. """
|
|
self.assertEqual(response.status_code, 500)
|
|
actual = json.loads(response.content)['detail']
|
|
self.assertIn('Call to E-Commerce API failed', actual)
|
|
|
|
def assertUserNotEnrolled(self):
|
|
""" Asserts that the user is NOT enrolled in the course, and that an enrollment event was NOT fired. """
|
|
self.assertFalse(CourseEnrollment.is_enrolled(self.user, self.course.id))
|
|
self.assert_no_events_were_emitted()
|
|
|
|
def setUp(self):
|
|
super(OrdersViewTests, self).setUp()
|
|
self.url = reverse('commerce:orders')
|
|
self.user = UserFactory()
|
|
self._login()
|
|
|
|
self.course = CourseFactory.create()
|
|
|
|
# TODO Verify this is the best method to create CourseMode objects.
|
|
# TODO Find/create constants for the modes.
|
|
for mode in [CourseMode.HONOR, CourseMode.VERIFIED, CourseMode.AUDIT]:
|
|
CourseModeFactory.create(
|
|
course_id=self.course.id,
|
|
mode_slug=mode,
|
|
mode_display_name=mode,
|
|
sku=uuid4().hex.decode('ascii')
|
|
)
|
|
|
|
def test_login_required(self):
|
|
"""
|
|
The view should return HTTP 403 status if the user is not logged in.
|
|
"""
|
|
self.client.logout()
|
|
self.assertEqual(403, self._post_to_view().status_code)
|
|
|
|
@data('delete', 'get', 'put')
|
|
def test_post_required(self, method):
|
|
"""
|
|
Verify that the view only responds to POST operations.
|
|
"""
|
|
response = getattr(self.client, method)(self.url)
|
|
self.assertEqual(405, response.status_code)
|
|
|
|
def test_invalid_course(self):
|
|
"""
|
|
If the course does not exist, the view should return HTTP 406.
|
|
"""
|
|
# TODO Test inactive courses, and those not open for enrollment.
|
|
self.assertEqual(406, self._post_to_view('aaa/bbb/ccc').status_code)
|
|
|
|
def test_invalid_request_data(self):
|
|
"""
|
|
If invalid data is supplied with the request, the view should return HTTP 406.
|
|
"""
|
|
self.assertEqual(406, self.client.post(self.url, {}).status_code)
|
|
self.assertEqual(406, self.client.post(self.url, {'not_course_id': ''}).status_code)
|
|
|
|
def test_ecommerce_api_timeout(self):
|
|
"""
|
|
If the call to the E-Commerce API times out, the view should log an error and return an HTTP 503 status.
|
|
"""
|
|
with self.mock_create_order(side_effect=TimeoutError):
|
|
response = self._post_to_view()
|
|
|
|
self.assertValidEcommerceInternalRequestErrorResponse(response)
|
|
self.assertUserNotEnrolled()
|
|
|
|
def test_ecommerce_api_error(self):
|
|
"""
|
|
If the E-Commerce API raises an error, the view should return an HTTP 503 status.
|
|
"""
|
|
with self.mock_create_order(side_effect=ApiError):
|
|
response = self._post_to_view()
|
|
|
|
self.assertValidEcommerceInternalRequestErrorResponse(response)
|
|
self.assertUserNotEnrolled()
|
|
|
|
def _test_successful_ecommerce_api_call(self):
|
|
"""
|
|
Verifies that the view contacts the E-Commerce API with the correct data and headers.
|
|
"""
|
|
with self.mock_create_order():
|
|
response = self._post_to_view()
|
|
|
|
# Validate the response content
|
|
msg = Messages.ORDER_COMPLETED.format(order_number=self.ORDER_NUMBER)
|
|
self.assertResponseMessage(response, msg)
|
|
|
|
@data(True, False)
|
|
def test_course_with_honor_seat_sku(self, user_is_active):
|
|
"""
|
|
If the course has a SKU, the view should get authorization from the E-Commerce API before enrolling
|
|
the user in the course. If authorization is approved, the user should be redirected to the user dashboard.
|
|
"""
|
|
|
|
# Set user's active flag
|
|
self.user.is_active = user_is_active
|
|
self.user.save() # pylint: disable=no-member
|
|
|
|
self._test_successful_ecommerce_api_call()
|
|
|
|
def test_order_not_complete(self):
|
|
with self.mock_create_order(return_value=(self.ORDER_NUMBER,
|
|
OrderStatus.OPEN,
|
|
self.ECOMMERCE_API_SUCCESSFUL_BODY)):
|
|
response = self._post_to_view()
|
|
self.assertEqual(response.status_code, 202)
|
|
msg = Messages.ORDER_INCOMPLETE_ENROLLED.format(order_number=self.ORDER_NUMBER)
|
|
self.assertResponseMessage(response, msg)
|
|
|
|
# TODO Eventually we should NOT be enrolling users directly from this view.
|
|
self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course.id))
|
|
|
|
def _test_course_without_sku(self):
|
|
"""
|
|
Validates the view bypasses the E-Commerce API when the course has no CourseModes with SKUs.
|
|
"""
|
|
# Place an order
|
|
with self.mock_create_order() as api_mock:
|
|
response = self._post_to_view()
|
|
|
|
# Validate the response content
|
|
self.assertEqual(response.status_code, 200)
|
|
msg = Messages.NO_SKU_ENROLLED.format(enrollment_mode='honor', course_id=self.course.id,
|
|
username=self.user.username)
|
|
self.assertResponseMessage(response, msg)
|
|
|
|
# No calls made to the E-Commerce API
|
|
self.assertFalse(api_mock.called)
|
|
|
|
def test_course_without_sku(self):
|
|
"""
|
|
If the course does NOT have a SKU, the user should be enrolled in the course (under the honor mode) and
|
|
redirected to the user dashboard.
|
|
"""
|
|
# Remove SKU from all course modes
|
|
for course_mode in CourseMode.objects.filter(course_id=self.course.id):
|
|
course_mode.sku = None
|
|
course_mode.save()
|
|
|
|
self._test_course_without_sku()
|
|
|
|
@override_settings(ECOMMERCE_API_URL=None, ECOMMERCE_API_SIGNING_KEY=None)
|
|
def test_ecommerce_service_not_configured(self):
|
|
"""
|
|
If the E-Commerce Service is not configured, the view should enroll the user.
|
|
"""
|
|
with self.mock_create_order() as api_mock:
|
|
response = self._post_to_view()
|
|
|
|
# Validate the response
|
|
self.assertEqual(response.status_code, 200)
|
|
msg = Messages.NO_ECOM_API.format(username=self.user.username, course_id=self.course.id)
|
|
self.assertResponseMessage(response, msg)
|
|
|
|
# Ensure that the user is not enrolled and that no calls were made to the E-Commerce API
|
|
self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course.id))
|
|
self.assertFalse(api_mock.called)
|
|
|
|
def assertProfessionalModeBypassed(self):
|
|
""" Verifies that the view returns HTTP 406 when a course with no honor mode is encountered. """
|
|
|
|
CourseMode.objects.filter(course_id=self.course.id).delete()
|
|
mode = CourseMode.NO_ID_PROFESSIONAL_MODE
|
|
CourseModeFactory.create(course_id=self.course.id, mode_slug=mode, mode_display_name=mode,
|
|
sku=uuid4().hex.decode('ascii'))
|
|
|
|
with self.mock_create_order() as api_mock:
|
|
response = self._post_to_view()
|
|
|
|
# The view should return an error status code
|
|
self.assertEqual(response.status_code, 406)
|
|
msg = Messages.NO_HONOR_MODE.format(course_id=self.course.id)
|
|
self.assertResponseMessage(response, msg)
|
|
|
|
# No calls should be made to the E-Commerce API.
|
|
self.assertFalse(api_mock.called)
|
|
|
|
def test_course_with_professional_mode_only(self):
|
|
""" Verifies that the view behaves appropriately when the course only has a professional mode. """
|
|
self.assertProfessionalModeBypassed()
|
|
|
|
@override_settings(ECOMMERCE_API_URL=None, ECOMMERCE_API_SIGNING_KEY=None)
|
|
def test_professional_mode_only_and_ecommerce_service_not_configured(self):
|
|
"""
|
|
Verifies that the view behaves appropriately when the course only has a professional mode and
|
|
the E-Commerce Service is not configured.
|
|
"""
|
|
self.assertProfessionalModeBypassed()
|
|
|
|
def test_empty_sku(self):
|
|
""" If the CourseMode has an empty string for a SKU, the API should not be used. """
|
|
# Set SKU to empty string for all modes.
|
|
for course_mode in CourseMode.objects.filter(course_id=self.course.id):
|
|
course_mode.sku = ''
|
|
course_mode.save()
|
|
|
|
self._test_course_without_sku()
|
|
|
|
def test_existing_active_enrollment(self):
|
|
""" The view should respond with HTTP 409 if the user has an existing active enrollment for the course. """
|
|
|
|
# Enroll user in the course
|
|
CourseEnrollment.enroll(self.user, self.course.id)
|
|
self.assertTrue(CourseEnrollment.is_enrolled(self.user, self.course.id))
|
|
|
|
response = self._post_to_view()
|
|
self.assertEqual(response.status_code, 409)
|
|
msg = Messages.ENROLLMENT_EXISTS.format(username=self.user.username, course_id=self.course.id)
|
|
self.assertResponseMessage(response, msg)
|
|
|
|
def test_existing_inactive_enrollment(self):
|
|
"""
|
|
If the user has an inactive enrollment for the course, the view should behave as if the
|
|
user has no enrollment.
|
|
"""
|
|
# Create an inactive enrollment
|
|
CourseEnrollment.enroll(self.user, self.course.id)
|
|
CourseEnrollment.unenroll(self.user, self.course.id, True)
|
|
self.assertFalse(CourseEnrollment.is_enrolled(self.user, self.course.id))
|
|
self.assertIsNotNone(get_enrollment(self.user.username, unicode(self.course.id)))
|
|
|
|
self._test_successful_ecommerce_api_call()
|