Skip to content

Commit

Permalink
fix: Check preferred_course_run_key for normalized_metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
@brobro10000
brobro10000 committed Nov 7, 2024
1 parent 2ee4466 commit 3e7bfb0
Show file tree
Hide file tree
Showing 3 changed files with 113 additions and 31 deletions.
1 change: 0 additions & 1 deletion enterprise_access/apps/api_client/tests/test_constants.py
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
Constants for api client tests
"""

DATE_FORMAT_ISO_8601 = "%Y-%m-%dT%H:%M:%SZ"
DATE_FORMAT_ISO_8601_MS = '%Y-%m-%dT%H:%M:%S.%fZ'
129 changes: 105 additions & 24 deletions enterprise_access/apps/content_assignments/tests/test_utils.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,50 +5,93 @@
import ddt
from django.test import TestCase

from enterprise_access.apps.api_client.tests.test_constants import DATE_FORMAT_ISO_8601
from enterprise_access.apps.content_assignments.constants import BRAZE_ACTION_REQUIRED_BY_TIMESTAMP_FORMAT
from enterprise_access.apps.content_assignments.tests.factories import LearnerContentAssignmentFactory
from enterprise_access.apps.content_assignments.utils import (
get_self_paced_normalized_start_date,
has_time_to_complete,
is_within_minimum_start_date_threshold
)
from enterprise_access.utils import _curr_date, _days_from_now
from enterprise_access.utils import _curr_date, _days_from_now, get_normalized_metadata_for_assignment

mock_course_run_1 = {
'start_date': _days_from_now(-370, DATE_FORMAT_ISO_8601),
'end_date': _days_from_now(350, DATE_FORMAT_ISO_8601),
'enroll_by_date': _days_from_now(-363, DATE_FORMAT_ISO_8601),
'enroll_start_date': _days_from_now(-380, DATE_FORMAT_ISO_8601),
'content_price': 100,
}

mock_course_run_2 = {
'start_date': _days_from_now(-70, DATE_FORMAT_ISO_8601),
'end_date': _days_from_now(50, DATE_FORMAT_ISO_8601),
'enroll_by_date': _days_from_now(-63, DATE_FORMAT_ISO_8601),
'enroll_start_date': _days_from_now(-80, DATE_FORMAT_ISO_8601),
'content_price': 100,
}

mock_advertised_course_run = {
'start_date': _days_from_now(-10, DATE_FORMAT_ISO_8601),
'end_date': _days_from_now(10, DATE_FORMAT_ISO_8601),
'enroll_by_date': _days_from_now(-3, DATE_FORMAT_ISO_8601),
'enroll_start_date': _days_from_now(-20, DATE_FORMAT_ISO_8601),
'content_price': 100,
}


@ddt.ddt
class UtilsTests(TestCase):
"""
Tests related to utility functions for content assignments
"""
def setUp(self):
super().setUp()
self.mock_course_key = "edX+DemoX"
self.mock_course_run_key_1 = "course-v1:edX+DemoX+1T360"
self.mock_course_run_key_2 = "course-v1:edX+DemoX+1T60"
self.mock_advertised_course_run_key = 'course-v1:edX+DemoX+1T0'
self.mock_course_run_1 = mock_course_run_1
self.mock_course_run_2 = mock_course_run_2
self.mock_advertised_course_run = mock_advertised_course_run
self.mock_content_metadata = {
'normalized_metadata': self.mock_advertised_course_run,
'normalized_metadata_by_run': {
"course-v1:edX+DemoX+1T360": self.mock_course_run_1,
"course-v1:edX+DemoX+1T60": self.mock_course_run_2,
'course-v1:edX+DemoX+1T0': self.mock_advertised_course_run
}
}

@ddt.data(
# Start after is before the curr_date - START_DATE_DEFAULT_TO_TODAY_THRESHOLD_DAYS
{
"start_date": _days_from_now(5, '%Y-%m-%dT%H:%M:%SZ'),
"start_date": _days_from_now(5, DATE_FORMAT_ISO_8601),
"curr_date": _curr_date(),
"expected_output": False
},
# Start after is before the curr_date - START_DATE_DEFAULT_TO_TODAY_THRESHOLD_DAYS
{
"start_date": _days_from_now(-5, '%Y-%m-%dT%H:%M:%SZ'),
"start_date": _days_from_now(-5, DATE_FORMAT_ISO_8601),
"curr_date": _curr_date(),
"expected_output": False
},
# Start after is before the curr_date - START_DATE_DEFAULT_TO_TODAY_THRESHOLD_DAYS
{
"start_date": _days_from_now(15, '%Y-%m-%dT%H:%M:%SZ'),
"start_date": _days_from_now(15, DATE_FORMAT_ISO_8601),
"curr_date": _curr_date(),
"expected_output": False
},
# Start date is before the curr_date - START_DATE_DEFAULT_TO_TODAY_THRESHOLD_DAYS
{
"start_date": _days_from_now(-15, '%Y-%m-%dT%H:%M:%SZ'),
"start_date": _days_from_now(-15, DATE_FORMAT_ISO_8601),
"curr_date": _curr_date(),
"expected_output": True
},
# Start after is before the curr_date - START_DATE_DEFAULT_TO_TODAY_THRESHOLD_DAYS
{
"start_date": _curr_date('%Y-%m-%dT%H:%M:%SZ'),
"start_date": _curr_date(DATE_FORMAT_ISO_8601),
"curr_date": _curr_date(),
"expected_output": False
}
Expand All @@ -60,28 +103,28 @@ def test_is_within_minimum_start_date_threshold(self, start_date, curr_date, exp
@ddt.data(
# endDate is the exact day as weeks to complete offset
{
"end_date": _days_from_now(49, '%Y-%m-%dT%H:%M:%SZ'),
"end_date": _days_from_now(49, DATE_FORMAT_ISO_8601),
"curr_date": _curr_date(),
"weeks_to_complete": 7,
"expected_output": True
},
# weeks to complete is within endDate
{
"end_date": _days_from_now(49, '%Y-%m-%dT%H:%M:%SZ'),
"end_date": _days_from_now(49, DATE_FORMAT_ISO_8601),
"curr_date": _curr_date(),
"weeks_to_complete": 4,
"expected_output": True
},
# weeks to complete is beyond end date
{
"end_date": _days_from_now(49, '%Y-%m-%dT%H:%M:%SZ'),
"end_date": _days_from_now(49, DATE_FORMAT_ISO_8601),
"curr_date": _curr_date(),
"weeks_to_complete": 8,
"expected_output": False
},
# end date is current date
{
"end_date": _curr_date('%Y-%m-%dT%H:%M:%SZ'),
"end_date": _curr_date(DATE_FORMAT_ISO_8601),
"curr_date": _curr_date(),
"weeks_to_complete": 1,
"expected_output": False
Expand All @@ -94,31 +137,31 @@ def test_has_time_to_complete(self, end_date, curr_date, weeks_to_complete, expe
@ddt.data(
{
"start_date": None,
"end_date": _days_from_now(10, '%Y-%m-%dT%H:%M:%SZ'),
"end_date": _days_from_now(10, DATE_FORMAT_ISO_8601),
"course_metadata": {
"pacing_type": "self_paced",
"weeks_to_complete": 8,
},
},
{
"start_date": _days_from_now(5, '%Y-%m-%dT%H:%M:%SZ'),
"start_date": _days_from_now(5, DATE_FORMAT_ISO_8601),
"end_date": None,
"course_metadata": {
"pacing_type": "self_paced",
"weeks_to_complete": 8,
},
},
{
"start_date": _days_from_now(5, '%Y-%m-%dT%H:%M:%SZ'),
"end_date": _days_from_now(10, '%Y-%m-%dT%H:%M:%SZ'),
"start_date": _days_from_now(5, DATE_FORMAT_ISO_8601),
"end_date": _days_from_now(10, DATE_FORMAT_ISO_8601),
"course_metadata": {
"pacing_type": None,
"weeks_to_complete": 8,
},
},
{
"start_date": _days_from_now(5, '%Y-%m-%dT%H:%M:%SZ'),
"end_date": _days_from_now(10, '%Y-%m-%dT%H:%M:%SZ'),
"start_date": _days_from_now(5, DATE_FORMAT_ISO_8601),
"end_date": _days_from_now(10, DATE_FORMAT_ISO_8601),
"course_metadata": {
"pacing_type": "self_paced",
"weeks_to_complete": None,
Expand All @@ -141,8 +184,8 @@ def test_get_self_paced_normalized_start_date_empty_data(self, start_date, end_d
@ddt.data(
# self-paced, has time to complete
{
"start_date": _days_from_now(5, '%Y-%m-%dT%H:%M:%SZ'),
"end_date": _days_from_now(28, '%Y-%m-%dT%H:%M:%SZ'),
"start_date": _days_from_now(5, DATE_FORMAT_ISO_8601),
"end_date": _days_from_now(28, DATE_FORMAT_ISO_8601),
"course_metadata": {
"pacing_type": "self_paced",
"weeks_to_complete": 3,
Expand All @@ -151,8 +194,8 @@ def test_get_self_paced_normalized_start_date_empty_data(self, start_date, end_d
# self-paced, does not have time to complete, but start date older than
# START_DATE_DEFAULT_TO_TODAY_THRESHOLD_DAYS
{
"start_date": _days_from_now(-15, '%Y-%m-%dT%H:%M:%SZ'),
"end_date": _days_from_now(10, '%Y-%m-%dT%H:%M:%SZ'),
"start_date": _days_from_now(-15, DATE_FORMAT_ISO_8601),
"end_date": _days_from_now(10, DATE_FORMAT_ISO_8601),
"course_metadata": {
"pacing_type": "self_paced",
"weeks_to_complete": 300,
Expand All @@ -161,17 +204,17 @@ def test_get_self_paced_normalized_start_date_empty_data(self, start_date, end_d
# self-paced, does not have time to complete, start date within
# START_DATE_DEFAULT_TO_TODAY_THRESHOLD_DAYS
{
"start_date": _days_from_now(-5, '%Y-%m-%dT%H:%M:%SZ'),
"end_date": _days_from_now(10, '%Y-%m-%dT%H:%M:%SZ'),
"start_date": _days_from_now(-5, DATE_FORMAT_ISO_8601),
"end_date": _days_from_now(10, DATE_FORMAT_ISO_8601),
"course_metadata": {
"pacing_type": "self_paced",
"weeks_to_complete": 300,
},
},
# instructor paced
{
"start_date": _days_from_now(5, '%Y-%m-%dT%H:%M:%SZ'),
"end_date": _days_from_now(10, '%Y-%m-%dT%H:%M:%SZ'),
"start_date": _days_from_now(5, DATE_FORMAT_ISO_8601),
"end_date": _days_from_now(10, DATE_FORMAT_ISO_8601),
"course_metadata": {
"pacing_type": "instructor_paced",
"weeks_to_complete": 8,
Expand All @@ -192,3 +235,41 @@ def test_get_self_paced_normalized_start_date_self_paced(self, start_date, end_d
else:
assert get_self_paced_normalized_start_date(start_date, end_date, course_metadata) == \
start_date

@ddt.data(
# Expects course run associated with configured content_key for run-based assignment
{
'assignment': {
'is_assigned_course_run': True,
'preferred_course_run_key': 'course-v1:edX+DemoX+1T60',
'content_key': 'course-v1:edX+DemoX+1T60',
},
'expected_output': mock_course_run_2,
},
# Expects the preferred content_key
{
'assignment': {
'is_assigned_course_run': False,
'preferred_course_run_key': 'course-v1:edX+DemoX+1T360',
'content_key': 'edX+DemoX',
},
'expected_output': mock_course_run_1,
},
# Expects the top level course key
{
'assignment': {
'is_assigned_course_run': False,
'preferred_course_run_key': None,
'content_key': 'edX+DemoX',
},
'expected_output': mock_advertised_course_run,
},
)
@ddt.unpack
def test_get_normalized_metadata_for_assignment(self, assignment, expected_output):
assignment_obj = LearnerContentAssignmentFactory(**assignment)
normalized_metadata = get_normalized_metadata_for_assignment(
assignment=assignment_obj,
content_metadata=self.mock_content_metadata
)
self.assertEqual(normalized_metadata, expected_output)
14 changes: 8 additions & 6 deletions enterprise_access/utils.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -214,8 +214,8 @@ def should_send_email_to_pecu(recent_action):
def get_normalized_metadata_for_assignment(assignment, content_metadata):
"""
Retrieve normalized metadata for a given object. If the object is associated
with a specific course run, return the metadata for that run. If metadata
for the run is missing, log a warning and return an empty dictionary.
with a specific course run or a preferred course run key, return the metadata for that run.
If metadata for the run is missing, return the normalized metadata for the advertised run.
Args:
assignment (dict): The assignment object.
Expand All @@ -224,11 +224,13 @@ def get_normalized_metadata_for_assignment(assignment, content_metadata):
Returns:
dict: Normalized metadata, either for a specific course run or the advertised course run, if any.
"""
if not assignment.is_assigned_course_run:
return content_metadata.get('normalized_metadata', {})

normalized_metadata_by_run = content_metadata.get('normalized_metadata_by_run', {})
return normalized_metadata_by_run.get(assignment.content_key, {})
# Return the content metadata for a specific course run based on the preferred_course_run_key
if preferred_course_run_key := assignment.preferred_course_run_key:
return normalized_metadata_by_run.get(preferred_course_run_key, {})
# Return current advertised course run metadata if preferred_course_run_key is NULL (i.e.,
# impacting legacy course-based assignments created pre-May 2024).
return content_metadata.get('normalized_metadata', {})


def _curr_date(date_format=None):
Expand Down

0 comments on commit 3e7bfb0

Please sign in to comment.