Mjevtic/sol 536 implement experiment aware content search

.gitignore

@@ -74,10 +74,12 @@ bin/
 lms/static/css/
 lms/static/sass/*.css
 lms/static/sass/*.css.map
-lms/static/sass/application.scss
-lms/static/sass/application-rtl.scss
-lms/static/sass/course.scss
-lms/static/sass/course-rtl.scss
+lms/static/sass/lms-main.scss
+lms/static/sass/lms-main-rtl.scss
+lms/static/sass/lms-course.scss
+lms/static/sass/lms-course-rtl.scss
+lms/static/sass/lms-footer-edx.scss
+lms/static/sass/lms-footer-edx-rtl.scss
 cms/static/css/
 cms/static/sass/*.css
 cms/static/sass/*.css.map

AUTHORS

@@ -211,3 +211,4 @@ Amir Qayyum Khan <amir.qayyum@arbisoft.com>
 Jolyon Bloomfield <jolyon@mit.edu>
 Kyle McCormick <kylemccor@gmail.com>
 Jim Cai <jimcai@stanford.edu>
+Richard Moch <richard.moch@gmail.com>

cms/djangoapps/contentstore/__init__.py

@@ -1,2 +0,0 @@
-""" module init will register signal handlers """
-import contentstore.signals

cms/djangoapps/contentstore/course_info_model.py

@@ -22,7 +22,7 @@
 from xmodule.modulestore.django import modulestore
 from xmodule.html_module import CourseInfoModule
 
-from xmodule_modifiers import get_course_update_items
+from openedx.core.lib.xblock_utils import get_course_update_items
 from cms.djangoapps.contentstore.push_notification import enqueue_push_course_update
 
 # # This should be in a class which inherits from XmlDescriptor

cms/djangoapps/contentstore/courseware_index.py

@@ -12,6 +12,7 @@
 
 from contentstore.utils import course_image_url
 from contentstore.course_group_config import GroupConfiguration
+from contentstore.views.component import SPLIT_TEST_COMPONENT_TYPE
 from course_modes.models import CourseMode
 from eventtracking import tracker
 from search.search_engine_base import SearchEngine
@@ -153,6 +154,12 @@ def index(cls, modulestore, structure_key, triggered_at=None, reindex_age=REINDE
         # list - those are ready to be destroyed
         indexed_items = set()
 
+        def get_item_location(item):
+            """
+            Gets the version agnostic item location
+            """
+            return item.location.version_agnostic().replace(branch=None)
+
         def index_item(item, skip_index=False, groups_usage_info=None):
             """
             Add this item to the search index and indexed_items list
@@ -175,9 +182,22 @@ def index_item(item, skip_index=False, groups_usage_info=None):
                 return
 
             item_content_groups = None
+
+            if item.category == SPLIT_TEST_COMPONENT_TYPE:
+                if groups_usage_info is None and item.has_children:
+                    groups_usage_info = {}
+                for vertical in item.get_children():
+                    group_id = int(vertical.display_name.split(" ")[2])
+                    groups_usage_info.update({
+                        unicode(get_item_location(vertical)): [group_id],
+                    })
+                    for component in vertical.get_children():
+                        groups_usage_info.update({
+                            unicode(get_item_location(component)): [group_id]
+                        })
+
             if groups_usage_info:
-                item_location = item.location.version_agnostic().replace(branch=None)
-                item_content_groups = groups_usage_info.get(unicode(item_location), None)
+                item_content_groups = groups_usage_info.get(unicode(get_item_location(item)), None)
 
             item_id = unicode(cls._id_modifier(item.scope_ids.usage_id))
             indexed_items.add(item_id)

cms/djangoapps/contentstore/tests/test_contentstore.py

@@ -5,6 +5,7 @@
 from mock import patch
 import shutil
 import lxml.html
+from lxml import etree
 import ddt
 
 from datetime import timedelta
@@ -1836,6 +1837,44 @@ def test_rerun_error_trunc_message(self):
             self.assertEqual(len(rerun_state.message), CourseRerunState.MAX_MESSAGE_LENGTH)
 
 
+class ContentLicenseTest(ContentStoreTestCase):
+    """
+    Tests around content licenses
+    """
+    def test_course_license_export(self):
+        content_store = contentstore()
+        root_dir = path(mkdtemp_clean())
+        self.course.license = "creative-commons: BY SA"
+        self.store.update_item(self.course, None)
+        export_course_to_xml(self.store, content_store, self.course.id, root_dir, 'test_license')
+        fname = "{block}.xml".format(block=self.course.scope_ids.usage_id.block_id)
+        run_file_path = root_dir / "test_license" / "course" / fname
+        run_xml = etree.parse(run_file_path.open())
+        self.assertEqual(run_xml.getroot().get("license"), "creative-commons: BY SA")
+
+    def test_video_license_export(self):
+        content_store = contentstore()
+        root_dir = path(mkdtemp_clean())
+        video_descriptor = ItemFactory.create(
+            parent_location=self.course.location, category='video',
+            license="all-rights-reserved"
+        )
+        export_course_to_xml(self.store, content_store, self.course.id, root_dir, 'test_license')
+        fname = "{block}.xml".format(block=video_descriptor.scope_ids.usage_id.block_id)
+        video_file_path = root_dir / "test_license" / "video" / fname
+        video_xml = etree.parse(video_file_path.open())
+        self.assertEqual(video_xml.getroot().get("license"), "all-rights-reserved")
+
+    def test_license_import(self):
+        course_items = import_course_from_xml(
+            self.store, self.user.id, TEST_DATA_DIR, ['toy'], create_if_not_present=True
+        )
+        course = course_items[0]
+        self.assertEqual(course.license, "creative-commons: BY")
+        videos = self.store.get_items(course.id, qualifiers={'category': 'video'})
+        self.assertEqual(videos[0].license, "all-rights-reserved")
+
+
 class EntryPageTestCase(TestCase):
     """
     Tests entry pages that aren't specific to a course.

cms/djangoapps/contentstore/tests/test_courseware_index.py

@@ -964,6 +964,7 @@ def setUp(self):
             publish_item=True,
             start=datetime(2015, 3, 1, tzinfo=UTC),
         )
+
         self.sequential = ItemFactory.create(
             parent_location=self.chapter.location,
             category='sequential',
@@ -972,6 +973,16 @@ def setUp(self):
             publish_item=True,
             start=datetime(2015, 3, 1, tzinfo=UTC),
         )
+
+        self.sequential2 = ItemFactory.create(
+            parent_location=self.chapter.location,
+            category='sequential',
+            display_name="Lesson 2",
+            modulestore=self.store,
+            publish_item=True,
+            start=datetime(2015, 3, 1, tzinfo=UTC),
+        )
+
         self.vertical = ItemFactory.create(
             parent_location=self.sequential.location,
             category='vertical',
@@ -990,6 +1001,15 @@ def setUp(self):
             start=datetime(2015, 4, 1, tzinfo=UTC),
         )
 
+        self.vertical3 = ItemFactory.create(
+            parent_location=self.sequential2.location,
+            category='vertical',
+            display_name='Subsection 3',
+            modulestore=self.store,
+            publish_item=True,
+            start=datetime(2015, 4, 1, tzinfo=UTC),
+        )
+
         # unspecified start - should inherit from container
         self.html_unit1 = ItemFactory.create(
             parent_location=self.vertical.location,
@@ -1018,6 +1038,66 @@ def setUp(self):
         )
         self.html_unit3.parent = self.vertical2
 
+        c0_url = self.course.id.make_usage_key("vertical", "condition_0_vertical")
+        c1_url = self.course.id.make_usage_key("vertical", "condition_1_vertical")
+        c2_url = self.course.id.make_usage_key("vertical", "condition_2_vertical")
+
+        self.split_test_unit = ItemFactory.create(
+            parent_location=self.vertical3.location,
+            category='split_test',
+            user_partition_id=0,
+            display_name="Test Content Experiment 1",
+            group_id_to_child={"0": c0_url, "1": c1_url, "2": c2_url}
+        )
+
+        self.condition_0_vertical = ItemFactory.create(
+            parent_location=self.split_test_unit.location,
+            category="vertical",
+            display_name="Group ID 0",
+            location=c0_url,
+        )
+        self.condition_0_vertical.parent = self.vertical3
+
+        self.condition_1_vertical = ItemFactory.create(
+            parent_location=self.split_test_unit.location,
+            category="vertical",
+            display_name="Group ID 1",
+            location=c1_url,
+        )
+        self.condition_1_vertical.parent = self.vertical3
+
+        self.condition_2_vertical = ItemFactory.create(
+            parent_location=self.split_test_unit.location,
+            category="vertical",
+            display_name="Group ID 2",
+            location=c2_url,
+        )
+        self.condition_2_vertical.parent = self.vertical3
+
+        self.html_unit4 = ItemFactory.create(
+            parent_location=self.condition_0_vertical.location,
+            category="html",
+            display_name="Split A",
+            publish_item=True,
+        )
+        self.html_unit4.parent = self.condition_0_vertical
+
+        self.html_unit5 = ItemFactory.create(
+            parent_location=self.condition_1_vertical.location,
+            category="html",
+            display_name="Split B",
+            publish_item=True,
+        )
+        self.html_unit5.parent = self.condition_1_vertical
+
+        self.html_unit6 = ItemFactory.create(
+            parent_location=self.condition_2_vertical.location,
+            category="html",
+            display_name="Split C",
+            publish_item=True,
+        )
+        self.html_unit6.parent = self.condition_2_vertical
+
         groups_list = {
             u'id': 666,
             u'name': u'Test name',
@@ -1075,6 +1155,52 @@ def _html_group_result(self, html_unit, content_groups):
             }
         )
 
+    def _html_experiment_group_result(self, html_unit, content_groups):
+        """
+        Return call object with arguments and content group for html_unit.
+        """
+        return call(
+            'courseware_content',
+            {
+                'course_name': unicode(self.course.display_name),
+                'id': unicode(html_unit.location),
+                'content': {'html_content': '', 'display_name': unicode(html_unit.display_name)},
+                'course': unicode(self.course.id),
+                'location': [
+                    unicode(self.chapter.display_name),
+                    unicode(self.sequential2.display_name),
+                    unicode(self.vertical3.display_name)
+                ],
+                'content_type': 'Text',
+                'org': self.course.org,
+                'content_groups': content_groups,
+                'start_date': datetime(2015, 4, 1, 0, 0, tzinfo=tzutc())
+            }
+        )
+
+    def _vertical_experiment_group_result(self, vertical, content_groups):
+        """
+        Return call object with arguments and content group for split_test vertical.
+        """
+        return call(
+            'courseware_content',
+            {
+                'start_date': datetime(2015, 4, 1, 0, 0, tzinfo=tzutc()),
+                'content': {'display_name': unicode(vertical.display_name)},
+                'course': unicode(self.course.id),
+                'location': [
+                    unicode(self.chapter.display_name),
+                    unicode(self.sequential2.display_name),
+                    unicode(vertical.parent.display_name)
+                ],
+                'content_type': 'Sequence',
+                'content_groups': content_groups,
+                'id': unicode(vertical.location),
+                'course_name': unicode(self.course.display_name),
+                'org': self.course.org
+            }
+        )
+
     def _html_nogroup_result(self, html_unit):
         """
         Return call object with arguments and content group set to empty array for html_unit.
@@ -1107,9 +1233,9 @@ def test_content_group_gets_indexed(self):
 
         # Only published modules should be in the index
         added_to_index = self.reindex_course(self.store)
-        self.assertEqual(added_to_index, 7)
+        self.assertEqual(added_to_index, 16)
         response = self.searcher.search(field_dictionary={"course": unicode(self.course.id)})
-        self.assertEqual(response["total"], 8)
+        self.assertEqual(response["total"], 17)
 
         group_access_content = {'group_access': {666: [1]}}
 
@@ -1119,11 +1245,18 @@ def test_content_group_gets_indexed(self):
         )
 
         self.publish_item(self.store, self.html_unit1.location)
+        self.publish_item(self.store, self.split_test_unit.location)
 
         with patch(settings.SEARCH_ENGINE + '.index') as mock_index:
             self.reindex_course(self.store)
             self.assertTrue(mock_index.called)
             self.assertIn(self._html_group_result(self.html_unit1, [1]), mock_index.mock_calls)
+            self.assertIn(self._html_experiment_group_result(self.html_unit4, [0]), mock_index.mock_calls)
+            self.assertIn(self._html_experiment_group_result(self.html_unit5, [1]), mock_index.mock_calls)
+            self.assertIn(self._html_experiment_group_result(self.html_unit6, [2]), mock_index.mock_calls)
+            self.assertIn(self._vertical_experiment_group_result(self.condition_0_vertical, [0]), mock_index.mock_calls)
+            self.assertIn(self._vertical_experiment_group_result(self.condition_1_vertical, [1]), mock_index.mock_calls)
+            self.assertIn(self._vertical_experiment_group_result(self.condition_2_vertical, [2]), mock_index.mock_calls)
             mock_index.reset_mock()
 
     def test_content_group_not_assigned(self):

cms/djangoapps/contentstore/views/component.py

@@ -63,7 +63,7 @@
     "editor-mode-button", "upload-dialog", "image-modal",
     "add-xblock-component", "add-xblock-component-button", "add-xblock-component-menu",
     "add-xblock-component-menu-problem", "xblock-string-field-editor", "publish-xblock", "publish-history",
-    "unit-outline", "container-message"
+    "unit-outline", "container-message", "license-selector",
 ]
 
 

cms/djangoapps/contentstore/views/item.py

@@ -11,7 +11,7 @@
 from collections import OrderedDict
 from functools import partial
 from static_replace import replace_static_urls
-from xmodule_modifiers import wrap_xblock, request_token
+from openedx.core.lib.xblock_utils import wrap_xblock, request_token
 
 import dogstats_wrapper as dog_stats_api
 from django.conf import settings

cms/djangoapps/contentstore/views/preview.py

@@ -9,14 +9,15 @@
 from django.contrib.auth.decorators import login_required
 from edxmako.shortcuts import render_to_string
 
-from xmodule_modifiers import replace_static_urls, wrap_xblock, wrap_fragment, request_token
+from openedx.core.lib.xblock_utils import replace_static_urls, wrap_xblock, wrap_fragment, request_token
 from xmodule.x_module import PREVIEW_VIEWS, STUDENT_VIEW, AUTHOR_VIEW
 from xmodule.contentstore.django import contentstore
 from xmodule.error_module import ErrorDescriptor
 from xmodule.exceptions import NotFoundError, ProcessingError
 from xmodule.library_tools import LibraryToolsService
 from xmodule.services import SettingsService
 from xmodule.modulestore.django import modulestore, ModuleI18nService
+from xmodule.mixin import wrap_with_license
 from opaque_keys.edx.keys import UsageKey
 from opaque_keys.edx.locator import LibraryUsageLocator
 from xmodule.x_module import ModuleSystem
@@ -170,6 +171,10 @@ def _preview_module_system(request, descriptor, field_data):
         _studio_wrap_xblock,
     ]
 
+    if settings.FEATURES.get("LICENSING", False):
+        # stick the license wrapper in front
+        wrappers.insert(0, wrap_with_license)
+
     descriptor.runtime._services['studio_user_permissions'] = StudioPermissionsService(request)  # pylint: disable=protected-access
 
     return PreviewModuleSystem(

cms/djangoapps/course_creators/tests/test_admin.py

@@ -27,6 +27,7 @@ class CourseCreatorAdminTest(TestCase):
 
     def setUp(self):
         """ Test case setup """
+        super(CourseCreatorAdminTest, self).setUp()
         self.user = User.objects.create_user('test_user', 'test_user+courses@edx.org', 'foo')
         self.table_entry = CourseCreator(user=self.user)
         self.table_entry.save()

cms/djangoapps/course_creators/tests/test_views.py

@@ -21,6 +21,7 @@ class CourseCreatorView(TestCase):
 
     def setUp(self):
         """ Test case setup """
+        super(CourseCreatorView, self).setUp()
         self.user = User.objects.create_user('test_user', 'test_user+courses@edx.org', 'foo')
         self.admin = User.objects.create_user('Mark', 'admin+courses@edx.org', 'foo')
         self.admin.is_staff = True