test: content library export tests added

Author: marslanabdulrauf

cms/djangoapps/contentstore/git_export_utils.py

@@ -15,7 +15,7 @@
 from django.utils.translation import gettext_lazy as _
 from opaque_keys.edx.locator import LibraryLocator, LibraryLocatorV2
 
-from openedx.core.djangoapps.content_libraries.api import export_library_v2_to_dir
+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
@@ -88,7 +88,7 @@ def export_to_git(content_key, repo, user='', rdir=None):
     is_library_v2 = isinstance(content_key, LibraryLocatorV2)
     if is_library_v2:
         # V2 libraries use backup API with zip extraction
-        content_export_func = export_library_v2_to_dir
+        content_export_func = extract_library_v2_zip_to_dir
     elif isinstance(content_key, LibraryLocator):
         content_export_func = export_library_to_xml
     else:

cms/djangoapps/contentstore/management/commands/tests/test_git_export.py

@@ -9,13 +9,14 @@
 import subprocess
 import unittest
 from io import StringIO
+from unittest.mock import patch
 from uuid import uuid4
 
 from django.conf import settings
 from django.core.management import call_command
 from django.core.management.base import CommandError
 from django.test.utils import override_settings
-from opaque_keys.edx.locator import CourseLocator
+from opaque_keys.edx.locator import CourseLocator, LibraryLocator, LibraryLocatorV2
 
 import cms.djangoapps.contentstore.git_export_utils as git_export_utils
 from cms.djangoapps.contentstore.git_export_utils import GitExportError
@@ -34,6 +35,9 @@ class TestGitExport(CourseTestCase):
     Excercise the git_export django management command with various inputs.
     """
 
+    LIBRARY_V2_KEY = LibraryLocatorV2(org='TestOrg', slug='test-lib')
+    LIBRARY_V1_KEY = LibraryLocator(org='TestOrg', library='test-lib')
+
     def setUp(self):
         """
         Create/reinitialize bare repo and folders needed
@@ -182,3 +186,52 @@ def test_no_change(self):
         with self.assertRaisesRegex(GitExportError, str(GitExportError.CANNOT_COMMIT)):
             git_export_utils.export_to_git(
                 self.course.id, f'file://{self.bare_repo_dir}')
+
+    @patch('cms.djangoapps.contentstore.git_export_utils.cmd_log', return_value=b'main')
+    @patch('cms.djangoapps.contentstore.git_export_utils.extract_library_v2_zip_to_dir')
+    def test_library_v2_export_selects_correct_function(self, mock_extract, mock_cmd_log):
+        """
+        When ``export_to_git`` is given a LibraryLocatorV2 key it must call
+        ``extract_library_v2_zip_to_dir`` and must not call the v1 XML export
+        functions (``export_library_to_xml`` or ``export_course_to_xml``).
+        cmd_log is mocked so no real git subprocess or repo state is needed.
+        """
+        mock_extract.return_value = None
+        repo_url = f'file://{self.bare_repo_dir}'
+
+        with patch('cms.djangoapps.contentstore.git_export_utils.export_course_to_xml') as mock_course_xml, \
+             patch('cms.djangoapps.contentstore.git_export_utils.export_library_to_xml') as mock_lib_xml:
+            git_export_utils.export_to_git(self.LIBRARY_V2_KEY, repo_url, self.user.username)
+
+        assert mock_extract.call_args[0][0] == self.LIBRARY_V2_KEY
+        mock_course_xml.assert_not_called()
+        mock_lib_xml.assert_not_called()
+
+    @patch('cms.djangoapps.contentstore.git_export_utils.cmd_log', return_value=b'main')
+    @patch('cms.djangoapps.contentstore.git_export_utils.export_library_to_xml')
+    def test_library_v1_export_selects_correct_function(self, mock_lib_xml, mock_cmd_log):
+        """
+        When ``export_to_git`` is given a LibraryLocator (v1) key it must call
+        ``export_library_to_xml`` and must not call ``extract_library_v2_zip_to_dir``.
+        cmd_log is mocked so no real git subprocess or repo state is needed.
+        """
+        mock_lib_xml.return_value = None
+        repo_url = f'file://{self.bare_repo_dir}'
+
+        with patch('cms.djangoapps.contentstore.git_export_utils.extract_library_v2_zip_to_dir') as mock_v2, \
+             patch('cms.djangoapps.contentstore.git_export_utils.export_course_to_xml') as mock_course_xml:
+            git_export_utils.export_to_git(self.LIBRARY_V1_KEY, repo_url, self.user.username)
+
+        assert mock_lib_xml.called
+        mock_v2.assert_not_called()
+        mock_course_xml.assert_not_called()
+
+    @patch('cms.djangoapps.contentstore.git_export_utils.extract_library_v2_zip_to_dir',
+           side_effect=OSError('disk full'))
+    def test_library_v2_export_failure_raises_xml_export_fail(self, mock_extract):
+        """
+        If ``extract_library_v2_zip_to_dir`` raises, ``export_to_git`` should
+        wrap it in ``GitExportError.XML_EXPORT_FAIL``.
+        """
+        with self.assertRaisesRegex(GitExportError, str(GitExportError.XML_EXPORT_FAIL)):
+            git_export_utils.export_to_git(self.LIBRARY_V2_KEY, f'file://{self.bare_repo_dir}')

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

@@ -4,20 +4,19 @@
 from __future__ import annotations
 
 import os
-from datetime import datetime
 import shutil
-from tempfile import mkdtemp
 import zipfile
+from datetime import datetime
+from tempfile import mkdtemp
 
 from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.utils.text import slugify
 from opaque_keys.edx.locator import LibraryLocatorV2, log
-from path import Path
-
 from openedx_content.api import create_zip_file as create_lib_zip_file
+from path import Path
 
-__all__ = ["create_library_v2_zip", "export_library_v2_to_dir"]
+__all__ = ["create_library_v2_zip", "extract_library_v2_zip_to_dir"]
 
 
 def create_library_v2_zip(library_key: LibraryLocatorV2, user) -> tuple:
@@ -44,7 +43,7 @@ def create_library_v2_zip(library_key: LibraryLocatorV2, user) -> tuple:
     return root_dir, file_path
 
 
-def export_library_v2_to_dir(library_key, root_dir, library_dir, user=None):
+def extract_library_v2_zip_to_dir(library_key, root_dir, library_dir, user=None):
     """
     Export a v2 library to a directory by creating a zip backup and extracting it.
 

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

@@ -0,0 +1,88 @@
+"""
+Tests for content library backup (zip export) utilities.
+"""
+from __future__ import annotations
+
+import shutil
+import tempfile
+import zipfile
+from unittest.mock import MagicMock, patch
+
+import pytest
+from django.test import TestCase
+from opaque_keys.edx.locator import LibraryLocatorV2
+from path import Path
+
+from openedx.core.djangoapps.content_libraries.api.backup import extract_library_v2_zip_to_dir
+
+LIBRARY_KEY = LibraryLocatorV2(org='TestOrg', slug='test-lib')
+
+
+class TestExtractLibraryV2ZipToDir(TestCase):
+    """
+    Tests for ``extract_library_v2_zip_to_dir``.
+    """
+
+    def _make_zip_in_temp_dir(self, contents=None):
+        """
+        Helper: create a real temp dir + zip file and return (temp_dir_path, zip_path).
+        ``contents`` is a dict of {filename: bytes} to write into the zip.
+        """
+        temp_dir = Path(tempfile.mkdtemp())
+        zip_path = str(temp_dir / 'library.zip')
+        with zipfile.ZipFile(zip_path, 'w') as zf:
+            for name, data in (contents or {'data.xml': b'<library/>'}).items():
+                zf.writestr(name, data)
+        return temp_dir, zip_path
+
+    @patch('openedx.core.djangoapps.content_libraries.api.backup.get_user_model')
+    @patch('openedx.core.djangoapps.content_libraries.api.backup.create_library_v2_zip')
+    def test_successful_extraction(self, mock_create_zip, mock_get_user_model):
+        """
+        On a successful call the function should:
+        - resolve the username to a user object via the user model,
+        - pass that user object to ``create_library_v2_zip``,
+        - create the target directory if it does not already exist,
+        - extract the zip contents into <root_dir>/<library_dir>,
+        - clean up the temporary zip directory.
+        """
+        root_dir = Path(tempfile.mkdtemp())
+        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
+
+        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')
+
+            mock_get_user_model.return_value.objects.filter.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"
+            assert not temp_zip_dir.exists(), "Temp zip dir should have been removed"
+        finally:
+            shutil.rmtree(root_dir, ignore_errors=True)
+            shutil.rmtree(temp_zip_dir, ignore_errors=True)
+
+    @patch('openedx.core.djangoapps.content_libraries.api.backup.get_user_model')
+    @patch('openedx.core.djangoapps.content_libraries.api.backup.create_library_v2_zip')
+    def test_temp_dir_cleaned_up_even_on_extraction_error(self, mock_create_zip, mock_get_user_model):
+        """
+        The temporary directory must be cleaned up even when extraction raises.
+        """
+        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
+
+        try:
+            with patch('zipfile.ZipFile.extractall', side_effect=OSError('disk full')):
+                with pytest.raises(OSError):
+                    extract_library_v2_zip_to_dir(LIBRARY_KEY, str(root_dir), 'my-library', user=None)
+            assert not temp_zip_dir.exists(), "Temp dir should be cleaned up on error"
+        finally:
+            shutil.rmtree(root_dir, ignore_errors=True)
+            shutil.rmtree(temp_zip_dir, ignore_errors=True)