Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MIT CCX: Respond to PR feedback

Browse Source 
Use the lazy module to create cached attributes

Ensure tests for localized date formatting are insulated from changes in default formatting

Other minor fixes
This commit is contained in:
cewing
2015-04-23 15:51:50 -07:00
parent 9250577f1f
commit 870c30fde5
2 changed files with 40 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
lms/djangoapps/ccx/models.py
View File

@@ -8,6 +8,7 @@ from django.contrib.auth.models import User
from django.db import models
from django.utils.timezone import UTC
from lazy import lazy
from student.models import CourseEnrollment, AlreadyEnrolledError # pylint: disable=import-error
from xmodule_django.models import CourseKeyField, LocationKeyField # pylint: disable=import-error
from xmodule.error_module import ErrorDescriptor
@@ -15,7 +16,6 @@ from xmodule.modulestore.django import modulestore
log = logging.getLogger("edx.ccx")
_MARKER = object()
class CustomCourseForEdX(models.Model):
@@ -26,47 +26,33 @@ class CustomCourseForEdX(models.Model):
display_name = models.CharField(max_length=255)
coach = models.ForeignKey(User, db_index=True)
_course = None
_start = None
_due = _MARKER
@property
@lazy
def course(self):
"""Return the CourseDescriptor of the course related to this CCX"""
if self._course is None:
store = modulestore()
with store.bulk_operations(self.course_id):
course = store.get_course(self.course_id)
if course and not isinstance(course, ErrorDescriptor):
self._course = course
else:
log.error("CCX {0} from {2} course {1}".format( # pylint: disable=logging-format-interpolation
self.display_name, self.course_id, "broken" if course else "non-existent"
))
store = modulestore()
with store.bulk_operations(self.course_id):
course = store.get_course(self.course_id)
if not course or isinstance(course, ErrorDescriptor):
log.error("CCX {0} from {2} course {1}".format( # pylint: disable=logging-format-interpolation
self.display_name, self.course_id, "broken" if course else "non-existent"
))
return course
return self._course
@property
@lazy
def start(self):
"""Get the value of the override of the 'start' datetime for this CCX
"""
if self._start is None:
# avoid circular import problems
from .overrides import get_override_for_ccx
start = get_override_for_ccx(self, self.course, 'start')
self._start = start
return self._start
# avoid circular import problems
from .overrides import get_override_for_ccx
return get_override_for_ccx(self, self.course, 'start')
@property
@lazy
def due(self):
"""Get the value of the override of the 'due' datetime for this CCX
"""
if self._due is _MARKER:
# avoid circular import problems
from .overrides import get_override_for_ccx
due = get_override_for_ccx(self, self.course, 'due')
self._due = due
return self._due
# avoid circular import problems
from .overrides import get_override_for_ccx
return get_override_for_ccx(self, self.course, 'due')
def has_started(self):
"""Return True if the CCX start date is in the past"""

30
lms/djangoapps/ccx/tests/test_models.py
View File

@@ -3,6 +3,7 @@ tests for the models
"""
from datetime import datetime, timedelta
from django.utils.timezone import UTC
from mock import patch
from student.models import CourseEnrollment # pylint: disable=import-error
from student.roles import CourseCcxCoachRole # pylint: disable=import-error
from student.tests.factories import ( # pylint: disable=import-error
@@ -10,6 +11,7 @@ from student.tests.factories import ( # pylint: disable=import-error
CourseEnrollmentFactory,
UserFactory,
)
from util.tests.test_date_utils import fake_ugettext
from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
from xmodule.modulestore.tests.factories import (
CourseFactory,
@@ -178,7 +180,7 @@ class TestCCX(ModuleStoreTestCase):
self.set_ccx_override('start', expected)
actual = self.ccx.start # pylint: disable=no-member
diff = expected - actual
self.assertEqual(diff.seconds, 0)
self.assertTrue(abs(diff.total_seconds()) < 1)
def test_ccx_start_caching(self):
"""verify that caching the start property works to limit queries"""
@@ -194,9 +196,8 @@ class TestCCX(ModuleStoreTestCase):
def test_ccx_due_without_override(self):
"""verify that due returns None when the field has not been set"""
expected = None
actual = self.ccx.due # pylint: disable=no-member
self.assertTrue(expected is actual)
self.assertIsNone(actual)
def test_ccx_due_is_correct(self):
"""verify that the due datetime for a ccx is correctly retrieved"""
@@ -204,7 +205,7 @@ class TestCCX(ModuleStoreTestCase):
self.set_ccx_override('due', expected)
actual = self.ccx.due # pylint: disable=no-member
diff = expected - actual
self.assertEqual(diff.seconds, 0)
self.assertTrue(abs(diff.total_seconds()) < 1)
def test_ccx_due_caching(self):
"""verify that caching the due property works to limit queries"""
@@ -255,42 +256,55 @@ class TestCCX(ModuleStoreTestCase):
"""verify that a ccx without a due date has not ended"""
self.assertFalse(self.ccx.has_ended()) # pylint: disable=no-member
# ensure that the expected localized format will be found by the i18n
# service
@patch('util.date_utils.ugettext', fake_ugettext(translations={
"SHORT_DATE_FORMAT": "%b %d, %Y",
}))
def test_start_datetime_short_date(self):
"""verify that the start date for a ccx formats properly by default"""
start = datetime(2015, 1, 1, 12, 0, 0, tzinfo=UTC())
# This relies on SHORT_DATE remaining the same, is there a better way?
expected = "Jan 01, 2015"
self.set_ccx_override('start', start)
actual = self.ccx.start_datetime_text() # pylint: disable=no-member
self.assertEqual(expected, actual)
@patch('util.date_utils.ugettext', fake_ugettext(translations={
"DATE_TIME_FORMAT": "%b %d, %Y at %H:%M",
}))
def test_start_datetime_date_time_format(self):
"""verify that the DATE_TIME format also works as expected"""
start = datetime(2015, 1, 1, 12, 0, 0, tzinfo=UTC())
# This relies on SHORT_DATE remaining the same, is there a better way?
expected = "Jan 01, 2015 at 12:00 UTC"
self.set_ccx_override('start', start)
actual = self.ccx.start_datetime_text('DATE_TIME') # pylint: disable=no-member
self.assertEqual(expected, actual)
@patch('util.date_utils.ugettext', fake_ugettext(translations={
"SHORT_DATE_FORMAT": "%b %d, %Y",
}))
def test_end_datetime_short_date(self):
"""verify that the end date for a ccx formats properly by default"""
end = datetime(2015, 1, 1, 12, 0, 0, tzinfo=UTC())
# This relies on SHORT_DATE remaining the same, is there a better way?
expected = "Jan 01, 2015"
self.set_ccx_override('due', end)
actual = self.ccx.end_datetime_text() # pylint: disable=no-member
self.assertEqual(expected, actual)
@patch('util.date_utils.ugettext', fake_ugettext(translations={
"DATE_TIME_FORMAT": "%b %d, %Y at %H:%M",
}))
def test_end_datetime_date_time_format(self):
"""verify that the DATE_TIME format also works as expected"""
end = datetime(2015, 1, 1, 12, 0, 0, tzinfo=UTC())
# This relies on SHORT_DATE remaining the same, is there a better way?
expected = "Jan 01, 2015 at 12:00 UTC"
self.set_ccx_override('due', end)
actual = self.ccx.end_datetime_text('DATE_TIME') # pylint: disable=no-member
self.assertEqual(expected, actual)
@patch('util.date_utils.ugettext', fake_ugettext(translations={
"DATE_TIME_FORMAT": "%b %d, %Y at %H:%M",
}))
def test_end_datetime_no_due_date(self):
"""verify that without a due date, the end date is an empty string"""
expected = ''