fix: replace content_key with context_key

Author: marslanabdulrauf

cms/djangoapps/contentstore/git_export_utils.py

@@ -18,7 +18,7 @@
 from openedx.core.djangoapps.content_libraries.api import extract_library_v2_zip_to_dir
 from xmodule.contentstore.django import contentstore
 from xmodule.modulestore.django import modulestore
-from xmodule.modulestore.xml_exporter import export_course_to_xml, export_library_to_xml
+from xmodule.modulestore.xml_exporter import CourseLocator, export_course_to_xml, export_library_to_xml
 
 log = logging.getLogger(__name__)
 
@@ -68,12 +68,12 @@ def cmd_log(cmd, cwd):
     return output
 
 
-def export_to_git(content_key, repo, user='', rdir=None):
+def export_to_git(context_key, repo, user='', rdir=None):
     """
     Export a course or library to git.
 
     Args:
-        content_key: CourseKey or LibraryLocator for the content to export
+        context_key: LearningContextKey for the content to export
         repo (str): Git repository URL
         user (str): Optional username for git commit identity
         rdir (str): Optional custom directory name for the repository
@@ -83,17 +83,12 @@ def export_to_git(content_key, repo, user='', rdir=None):
     """
     # pylint: disable=too-many-statements
 
-    # Detect content type and select appropriate export function
-    content_type_label = "library"
-    is_library_v2 = isinstance(content_key, LibraryLocatorV2)
-    if is_library_v2:
-        # V2 libraries use backup API with zip extraction
-        content_export_func = extract_library_v2_zip_to_dir
-    elif isinstance(content_key, LibraryLocator):
-        content_export_func = export_library_to_xml
-    else:
-        content_export_func = export_course_to_xml
-        content_type_label = "course"
+    # Validate context_key type and determine export function and content type label
+    if not isinstance(context_key, (LibraryLocatorV2, LibraryLocator, CourseLocator)):
+        raise TypeError(
+            f"{context_key!r} for git export must be LibraryLocatorV2, LibraryLocator, "
+            f"or CourseLocator, not {type(context_key)}"
+        )
 
     if not GIT_REPO_EXPORT_DIR:
         raise GitExportError(GitExportError.NO_EXPORT_DIR)
@@ -157,12 +152,23 @@ def export_to_git(content_key, repo, user='', rdir=None):
     root_dir = os.path.dirname(rdirp)
     content_dir = os.path.basename(rdirp).rsplit('.git', 1)[0]
 
+    content_type_label = "course" if context_key.is_course else "library"
+
+    is_library_v2 = isinstance(context_key, LibraryLocatorV2)
+    if is_library_v2:
+        # V2 libraries use backup API with zip extraction
+        content_export_func = extract_library_v2_zip_to_dir
+    elif isinstance(context_key, LibraryLocator):
+        content_export_func = export_library_to_xml
+    else:
+        content_export_func = export_course_to_xml
+
     try:
         if is_library_v2:
-            content_export_func(content_key, root_dir, content_dir, user)
+            content_export_func(context_key, root_dir, content_dir, user)
         else:
             # V1 libraries and courses: use XML export (no user parameter)
-            content_export_func(modulestore(), contentstore(), content_key,
+            content_export_func(modulestore(), contentstore(), context_key,
                             root_dir, content_dir)
     except (OSError, AttributeError):
         log.exception('Failed to export %s', content_type_label)
@@ -212,6 +218,6 @@ def export_to_git(content_key, repo, user='', rdir=None):
     log.info(
         '%s %s exported to git repository %s successfully',
         content_type_label.capitalize(),
-        content_key,
+        context_key,
         repo,
     )

openedx/core/djangoapps/content_libraries/api/backup.py

@@ -7,9 +7,7 @@
 import shutil
 import zipfile
 from datetime import datetime
-import shutil
 from tempfile import mkdtemp
-import zipfile
 
 from django.conf import settings
 from django.contrib.auth import get_user_model
@@ -41,11 +39,11 @@ def create_library_v2_zip(library_key: LibraryLocatorV2, user) -> tuple:
     filename = f'{sanitized_lib_key}-{timestamp}.zip'
     file_path = os.path.join(root_dir, filename)
     origin_server = getattr(settings, 'CMS_BASE', None)
-    create_lib_zip_file(lp_key=str(library_key), path=file_path, user=user, origin_server=origin_server)
+    create_lib_zip_file(package_ref=str(library_key), path=file_path, user=user, origin_server=origin_server)
     return root_dir, file_path
 
 
-def extract_library_v2_zip_to_dir(library_key, root_dir, library_dir, user=None):
+def extract_library_v2_zip_to_dir(library_key, root_dir, library_dir, username=None):
     """
     Export a v2 library to a directory by creating a zip backup and extracting it.
 
@@ -57,13 +55,18 @@ def extract_library_v2_zip_to_dir(library_key, root_dir, library_dir, user=None)
         library_key: LibraryLocatorV2 for the library to export
         root_dir: Root directory where library_dir will be created
         library_dir: Directory name under root_dir to extract the library into
-        user: Username string for the backup API (optional)
+        username: Username string for the backup API (optional)
 
     Raises:
         Exception: If backup creation or extraction fails
+        DoesNotExist: If the specified user does not exist
     """
-    # Get user object for backup API
-    user_obj = get_user_model().objects.filter(username=user).first()
+    # Get user object for backup API (if username provided)
+    user_obj = None
+    if username:
+        # Let it raise if given user doesn't exist
+        user_obj = get_user_model().objects.get(username=username)
+
     temp_dir, zip_path = create_library_v2_zip(library_key, user_obj)
 
     try:

openedx/core/djangoapps/content_libraries/api/tests/test_backup.py

@@ -50,15 +50,15 @@ def test_successful_extraction(self, mock_create_zip, mock_get_user_model):
         temp_zip_dir, zip_path = self._make_zip_in_temp_dir({'content.xml': b'<lib/>'})
         mock_create_zip.return_value = (temp_zip_dir, zip_path)
         mock_user = MagicMock()
-        mock_get_user_model.return_value.objects.filter.return_value.first.return_value = mock_user
+        mock_get_user_model.return_value.objects.get.return_value = mock_user
 
         try:
             target = root_dir / 'my-library'
             assert not target.exists(), "Target dir should not exist before the call"
 
-            extract_library_v2_zip_to_dir(LIBRARY_KEY, str(root_dir), 'my-library', user='testuser')
+            extract_library_v2_zip_to_dir(LIBRARY_KEY, str(root_dir), 'my-library', username='testuser')
 
-            mock_get_user_model.return_value.objects.filter.assert_called_once_with(username='testuser')
+            mock_get_user_model.return_value.objects.get.assert_called_once_with(username='testuser')
             mock_create_zip.assert_called_once_with(LIBRARY_KEY, mock_user)
             assert target.isdir(), "Target dir should have been created"
             assert (target / 'content.xml').exists(), "Zip content should be extracted"
@@ -76,12 +76,12 @@ def test_temp_dir_cleaned_up_even_on_extraction_error(self, mock_create_zip, moc
         root_dir = Path(tempfile.mkdtemp())
         temp_zip_dir, zip_path = self._make_zip_in_temp_dir()
         mock_create_zip.return_value = (temp_zip_dir, zip_path)
-        mock_get_user_model.return_value.objects.filter.return_value.first.return_value = None
+        mock_get_user_model.return_value.objects.get.return_value = None
 
         try:
             with patch('zipfile.ZipFile.extractall', side_effect=OSError('disk full')):
                 with pytest.raises(OSError, match='disk full'):
-                    extract_library_v2_zip_to_dir(LIBRARY_KEY, str(root_dir), 'my-library', user=None)
+                    extract_library_v2_zip_to_dir(LIBRARY_KEY, str(root_dir), 'my-library', username=None)
             assert not temp_zip_dir.exists(), "Temp dir should be cleaned up on error"
         finally:
             shutil.rmtree(root_dir, ignore_errors=True)