18d5abb2f6
First PR to replace pytz with zoneinfo for UTC handling across codebase. This PR migrates all UTC timezone handling from pytz to Python’s standard library zoneinfo. The pytz library is now deprecated, and its documentation recommends using zoneinfo for all new code. This update modernizes our codebase, removes legacy pytz usage, and ensures compatibility with current best practices for timezone management in Python 3.9+. No functional changes to timezone logic - just a direct replacement for UTC handling. https://github.com/openedx/edx-platform/issues/33980
124 lines
4.5 KiB
Python
124 lines
4.5 KiB
Python
""" Tests for the Calendar Sync .ics methods """
|
|
|
|
from datetime import datetime, timedelta
|
|
from unittest.mock import patch
|
|
|
|
from zoneinfo import ZoneInfo
|
|
from django.test import RequestFactory, TestCase
|
|
from freezegun import freeze_time
|
|
|
|
from common.djangoapps.student.tests.factories import UserFactory
|
|
from lms.djangoapps.courseware.courses import _Assignment
|
|
from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory
|
|
from openedx.core.djangoapps.site_configuration.tests.factories import SiteConfigurationFactory, SiteFactory
|
|
from openedx.features.calendar_sync import get_calendar_event_id
|
|
from openedx.features.calendar_sync.ics import generate_ics_files_for_user_course
|
|
from openedx.features.calendar_sync.tests.factories import UserCalendarSyncConfigFactory
|
|
|
|
|
|
class TestIcsGeneration(TestCase):
|
|
""" Test icalendar file generator """
|
|
def setUp(self):
|
|
super().setUp()
|
|
|
|
freezer = freeze_time(datetime(2013, 10, 3, 8, 24, 55, tzinfo=ZoneInfo("UTC")))
|
|
self.addCleanup(freezer.stop)
|
|
freezer.start()
|
|
|
|
self.course = CourseOverviewFactory()
|
|
|
|
self.user = UserFactory()
|
|
self.request = RequestFactory().request()
|
|
self.request.site = SiteFactory()
|
|
self.request.user = self.user
|
|
self.site_config = SiteConfigurationFactory.create(
|
|
site_values={'course_org_filter': self.course.org}
|
|
)
|
|
self.user_calendar_sync_config = UserCalendarSyncConfigFactory.create(
|
|
user=self.user,
|
|
course_key=self.course.id,
|
|
)
|
|
|
|
def make_assigment(
|
|
self, block_key=None, title=None, url=None, date=None, contains_gated_content=False, complete=False,
|
|
past_due=False, assignment_type=None, extra_info=None, first_component_block_id=None
|
|
):
|
|
""" Bundles given info into a namedtupled like get_course_assignments returns """
|
|
return _Assignment(
|
|
block_key,
|
|
title,
|
|
url,
|
|
date,
|
|
contains_gated_content,
|
|
complete,
|
|
past_due,
|
|
assignment_type,
|
|
extra_info,
|
|
first_component_block_id
|
|
)
|
|
|
|
def expected_ics(self, *assignments):
|
|
""" Returns hardcoded expected ics strings for given assignments """
|
|
template = '''BEGIN:VCALENDAR
|
|
VERSION:2.0
|
|
PRODID:-//Open edX//calendar_sync//EN
|
|
METHOD:REQUEST
|
|
BEGIN:VEVENT
|
|
SUMMARY:{summary}
|
|
DTSTART:{timedue}
|
|
DURATION:P0D
|
|
DTSTAMP:20131003T082455Z
|
|
UID:{uid}
|
|
SEQUENCE:{sequence}
|
|
DESCRIPTION:{summary} is due for {course}.
|
|
ORGANIZER;CN=édX:mailto:registration@example.com
|
|
TRANSP:TRANSPARENT
|
|
END:VEVENT
|
|
END:VCALENDAR
|
|
'''
|
|
return (
|
|
template.format(
|
|
summary=assignment.title,
|
|
course=self.course.display_name_with_default,
|
|
timedue=assignment.date.strftime('%Y%m%dT%H%M%SZ'),
|
|
uid=get_calendar_event_id(self.user, str(assignment.block_key), 'due', self.site_config.site.domain),
|
|
sequence=self.user_calendar_sync_config.ics_sequence
|
|
)
|
|
for assignment in assignments
|
|
)
|
|
|
|
def generate_ics(self, *assignments):
|
|
""" Uses generate_ics_for_user_course to create ics files for the given assignments """
|
|
with patch('openedx.features.calendar_sync.ics.get_course_assignments') as mock_get_assignments:
|
|
mock_get_assignments.return_value = assignments
|
|
return generate_ics_files_for_user_course(self.course, self.user, self.user_calendar_sync_config)
|
|
|
|
def assert_ics(self, *assignments):
|
|
""" Asserts that the generated and expected ics for the given assignments are equal """
|
|
generated = [
|
|
file.decode('utf8').replace('\r\n', '\n') for file in sorted(self.generate_ics(*assignments).values())
|
|
]
|
|
assert len(generated) == len(assignments)
|
|
self.assertListEqual(generated, list(self.expected_ics(*assignments)))
|
|
|
|
def test_generate_ics_for_user_course(self):
|
|
""" Tests that a simple sample set of course assignments is generated correctly """
|
|
now = datetime.now(ZoneInfo("UTC"))
|
|
day1 = now + timedelta(1)
|
|
day2 = now + timedelta(1)
|
|
|
|
self.assert_ics(
|
|
self.make_assigment(
|
|
block_key='block1',
|
|
title='Block1',
|
|
url='https://example.com/block1',
|
|
date=day1,
|
|
),
|
|
self.make_assigment(
|
|
block_key='block2',
|
|
title='Block2',
|
|
url='https://example.com/block2',
|
|
date=day2,
|
|
),
|
|
)
|