The V2 libraries project had a few past iterations which were never launched. This commit cleans up pieces from those which we don't need for the real Libraries Relaunch MVP in Sumac: * Remove ENABLE_LIBRARY_AUTHORING_MICROFRONTEND, LIBRARY_AUTHORING_FRONTEND_URL, and REDIRECT_TO_LIBRARY_AUTHORING_MICROFRONTEND, all of which are obsolete now that library authoring has been merged into https://github.com/openedx/frontend-app-authoring. More details on the new Content Libraries configuration settings are here: https://github.com/openedx/frontend-app-authoring/issues/1334 * Remove dangling support for syncing V2 (learning core-backed) library content using the LibraryContentBlock. This code was all based on an older understanding of V2 Content Libraries, where the libraries were smaller and versioned as a whole rather then versioned by-item. Reference to V2 libraries will be done on a per-block basis using the upstream/downstream system, described here: https://github.com/openedx/edx-platform/blob/master/docs/decisions/0020-upstream-downstream.rst It's important that we remove this support now so that OLX course authors don't stuble upon it and use it, which would be buggy and complicate future migrations. * Remove the "mode" parameter from LibraryContentBlock. The only supported mode was and is "random". We will not be adding any further modes. Going forward for V2, we will have an ItemBank block for randomizing items (regardless of source), which can be synthesized with upstream referenced as described above. Existing LibraryContentBlocks will be migrated. * Finally, some renamings: * LibraryContentBlock -> LegacyLibraryContentBlock * LibraryToolsService -> LegacyLibraryToolsService * LibrarySummary -> LegacyLibrarySummary Module names and the old OLX tag (library_content) are unchanged. Closes: https://github.com/openedx/frontend-app-authoring/issues/1115
102 lines
4.0 KiB
Python
102 lines
4.0 KiB
Python
"""
|
|
Tests for legacy library tools service (only used by CMS)
|
|
|
|
The only known user of the LegacyLibraryToolsService is the
|
|
LegacyLibraryContentBlock, so these tests are all written with only that
|
|
block type in mind.
|
|
"""
|
|
|
|
from unittest import mock
|
|
|
|
import ddt
|
|
from opaque_keys.edx.locator import LibraryLocator
|
|
|
|
from common.djangoapps.student.tests.factories import UserFactory
|
|
from openedx.core.djangolib.testing.utils import skip_unless_cms
|
|
from openedx.core.djangoapps.content_libraries.tests.base import ContentLibrariesRestApiTest
|
|
from xmodule.library_tools import LegacyLibraryToolsService
|
|
from xmodule.modulestore.tests.factories import CourseFactory, LibraryFactory
|
|
from xmodule.modulestore.tests.utils import MixedSplitTestCase
|
|
|
|
|
|
@skip_unless_cms
|
|
@ddt.ddt
|
|
class ContentLibraryToolsTest(MixedSplitTestCase, ContentLibrariesRestApiTest):
|
|
"""
|
|
Tests for LegacyLibraryToolsService.
|
|
"""
|
|
def setUp(self):
|
|
super().setUp()
|
|
UserFactory(is_staff=True, id=self.user_id)
|
|
self.tools = LegacyLibraryToolsService(self.store, self.user_id)
|
|
|
|
def test_list_available_libraries(self):
|
|
"""
|
|
Test listing of v1 libraries.
|
|
"""
|
|
# create V1 library
|
|
_ = LibraryFactory.create(modulestore=self.store)
|
|
# create V2 library (should not be included in this list)
|
|
self._create_library(slug="testlib1_preview", title="Test Library 1", description="Testing XBlocks")
|
|
all_libraries = self.tools.list_available_libraries()
|
|
assert len(all_libraries) == 1
|
|
|
|
@mock.patch('xmodule.modulestore.split_mongo.split.SplitMongoModuleStore.get_library_summaries')
|
|
def test_list_available_libraries_fetch(self, mock_get_library_summaries):
|
|
"""
|
|
Test that library list is compiled using light weight library summary objects.
|
|
"""
|
|
_ = self.tools.list_available_libraries()
|
|
assert mock_get_library_summaries.called
|
|
|
|
def test_get_latest_library_version(self):
|
|
"""
|
|
Test get_v1_library_version for V1 libraries.
|
|
|
|
Covers getting results for either string library key or LibraryLocator.
|
|
"""
|
|
lib_key = LibraryFactory.create(modulestore=self.store).location.library_key
|
|
# Re-load the library from the modulestore, explicitly including version information:
|
|
lib = self.store.get_library(lib_key, remove_version=False, remove_branch=False)
|
|
# check the result using the LibraryLocator
|
|
assert isinstance(lib_key, LibraryLocator)
|
|
result = self.tools.get_latest_library_version(lib_key)
|
|
assert result
|
|
assert result == str(lib.location.library_key.version_guid)
|
|
# the same check for string representation of the LibraryLocator
|
|
str_key = str(lib_key)
|
|
result = self.tools.get_latest_library_version(str_key)
|
|
assert result
|
|
assert result == str(lib.location.library_key.version_guid)
|
|
|
|
@ddt.data(
|
|
'library-v1:Fake+Key',
|
|
LibraryLocator.from_string('library-v1:Fake+Key'),
|
|
)
|
|
def test_get_latest_library_version_no_library(self, lib_key):
|
|
"""
|
|
Test get_latest_library_version result when the library does not exist.
|
|
"""
|
|
assert self.tools.get_latest_library_version(lib_key) is None
|
|
|
|
def test_update_children(self):
|
|
"""
|
|
Test update_children with V1 library as a source.
|
|
|
|
As for now, covers usage of update_children for the library content module only.
|
|
"""
|
|
library = LibraryFactory.create(modulestore=self.store)
|
|
self.make_block("html", library, data="Hello world from the block")
|
|
course = CourseFactory.create(modulestore=self.store)
|
|
content_block = self.make_block(
|
|
"library_content",
|
|
course,
|
|
max_count=1,
|
|
source_library_id=str(library.location.library_key)
|
|
)
|
|
|
|
assert len(content_block.children) == 0
|
|
self.tools.trigger_library_sync(content_block, library_version=None)
|
|
content_block = self.store.get_item(content_block.location)
|
|
assert len(content_block.children) == 1
|