chore: AA-1058: Update edx-when version

.github/pull_request_template.md

@@ -1,6 +1,10 @@
 <!--
 
-Happy Autumn!
+🍁🍁
+🍁🍁🍁🍁         🍁 Note: the Maple master branch has been created.  Please consider whether your change
+    🍁🍁🍁🍁     should also be applied to Maple. If so, make another pull request against the
+🍁🍁🍁🍁         open-release/maple.master branch, or ping @nedbat for help or questions.
+🍁🍁
 
 Please give your pull request a short but descriptive title.
 Use conventional commits to separate and summarize commits logically:

.github/workflows/quality-checks.yml

@@ -23,8 +23,8 @@ jobs:
       with:
         fetch-depth: 2
 
-    - name: Fetch master for comparison
-      run: git fetch --depth=1 origin master
+    - name: Fetch base branch for comparison
+      run: git fetch --depth=1 origin ${{ github.base_ref }}
 
     - name: Install Required System Packages
       run: sudo apt-get update && sudo apt-get install libxmlsec1-dev
@@ -65,6 +65,7 @@ jobs:
         SCRIPT_TO_RUN: ./scripts/generic-ci-tests.sh
         SHARD: 4
         PIP_SRC_DIR: ${{ runner.temp }}
+        TARGET_BRANCH: ${{ github.base_ref }}
       run: |
         ./scripts/all-tests.sh
 

.github/workflows/verify-dunder-init.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+
+  verify_dunder_init:
+
+    name: Verify __init__.py Files
+    runs-on: ubuntu-20.04
+
+    steps:
+
+    - name: Check out branch
+      uses: actions/checkout@v2
+
+    - name: Ensure git is installed
+      run: |
+        sudo apt-get update && sudo apt-get install git
+
+    - name: Verify __init__.py files exist
+      run: |
+        scripts/verify-dunder-init.sh

.tx/config

@@ -66,3 +66,16 @@ file_filter = conf/locale/<lang>/LC_MESSAGES/edx_proctoring_proctortrack.po
 source_file = conf/locale/en/LC_MESSAGES/edx_proctoring_proctortrack.po
 source_lang = en
 type = PO
+
+[open-edx-releases.release-maple]
+file_filter = conf/locale/<lang>/LC_MESSAGES/django.po
+source_file = conf/locale/en/LC_MESSAGES/django.po
+source_lang = en
+type = PO
+
+[open-edx-releases.release-maple-js]
+file_filter = conf/locale/<lang>/LC_MESSAGES/djangojs.po
+source_file = conf/locale/en/LC_MESSAGES/djangojs.po
+source_lang = en
+type = PO
+

Makefile

@@ -84,7 +84,6 @@ REQ_FILES = \
 	requirements/edx/coverage \
 	requirements/edx/doc \
 	requirements/edx/paver \
-	requirements/edx-sandbox/py35 \
 	requirements/edx-sandbox/py38 \
 	requirements/edx/base \
 	requirements/edx/testing \

cms/djangoapps/contentstore/rest_api/v0/tests/test_tabs.py

@@ -42,11 +42,15 @@ def setUp(self):
         )
 
         # add a static tab to the course, for code coverage
-        self.test_tab = ItemFactory.create(
-            parent_location=self.course.location,
-            category="static_tab",
-            display_name="Static_1",
-        )
+        # add 4 static tabs to the course, for code coverage
+        self.test_tabs = []
+        for i in range(1, 5):
+            tab = ItemFactory.create(
+                parent_location=self.course.location,
+                category="static_tab",
+                display_name=f"Static_{i}"
+            )
+        self.test_tabs.append(tab)
         self.reload_course()
 
     def check_invalid_response(self, resp):
@@ -107,13 +111,13 @@ def test_reorder_tabs(self):
         # reorder the last two tabs
         tab_ids[num_orig_tabs - 1], tab_ids[num_orig_tabs - 2] = tab_ids[num_orig_tabs - 2], tab_ids[num_orig_tabs - 1]
 
-        # remove the middle tab
+        # remove the third to the last tab, the removed tab has to be a static tab
         # (the code needs to handle the case where tabs requested for re-ordering is a subset of the tabs in the course)
-        removed_tab = tab_ids.pop(num_orig_tabs // 2)
-        assert len(tab_ids) == num_orig_tabs - 1
+        removed_tab = tab_ids.pop(num_orig_tabs - 3)
+        self.assertEqual(len(tab_ids), num_orig_tabs - 1)
 
         # post the request
-        resp = self.make_reorder_tabs_request([{"tab_id": tab_id} for tab_id in tab_ids])
+        resp = self.make_reorder_tabs_request([{"tab_id": tab_id} for tab_id in tab_ids if 'static' in tab_id])
         assert resp.status_code == 204
 
         # reload the course and verify the new tab order

cms/djangoapps/contentstore/rest_api/v0/views/tabs.py

@@ -13,7 +13,7 @@
 from common.djangoapps.student.auth import has_studio_read_access, has_studio_write_access
 from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes
 from ..serializers import CourseTabSerializer, CourseTabUpdateSerializer, TabIDLocatorSerializer
-from ....views.tabs import edit_tab_handler, get_course_tabs, reorder_tabs_handler
+from ....views.tabs import edit_tab_handler, get_course_static_tabs, reorder_tabs_handler
 
 
 @view_auth_classes(is_authenticated=True)
@@ -34,7 +34,7 @@ class CourseTabListView(DeveloperErrorViewMixin, APIView):
     @verify_course_exists()
     def get(self, request: Request, course_id: str) -> Response:
         """
-        Get a list of all the tabs in a course including hidden tabs.
+        Get a list of all the static tabs in a course including hidden tabs.
 
         **Example Request**
 
@@ -82,7 +82,7 @@ def get(self, request: Request, course_id: str) -> Response:
             self.permission_denied(request)
 
         course_module = modulestore().get_course(course_key)
-        tabs_to_render = get_course_tabs(course_module, request.user)
+        tabs_to_render = get_course_static_tabs(course_module, request.user)
         return Response(CourseTabSerializer(tabs_to_render, many=True).data)
 
 

cms/djangoapps/contentstore/rest_api/v1/tests/test_views.py

@@ -87,7 +87,7 @@ def test_404_no_course_module(self):
 class ProctoringExamSettingsGetTests(ProctoringExamSettingsTestMixin, ModuleStoreTestCase, APITestCase):
     """ Tests for proctored exam settings GETs """
     @classmethod
-    def get_expected_response_data(cls, course, user):
+    def get_expected_response_data(cls, course, user):  # pylint: disable=unused-argument
         return {
             'proctored_exam_settings': {
                 'enable_proctored_exams': course.enable_proctored_exams,

cms/djangoapps/contentstore/rest_api/v1/views.py

@@ -107,10 +107,13 @@ def get(self, request, course_id):
 
     def post(self, request, course_id):
         """ POST handler """
-        serializer = ProctoredExamSettingsSerializer if request.user.is_staff else LimitedProctoredExamSettingsSerializer
+        serializer = ProctoredExamSettingsSerializer if request.user.is_staff \
+            else LimitedProctoredExamSettingsSerializer
         exam_config = serializer(data=request.data.get('proctored_exam_settings', {}))
         valid_request = exam_config.is_valid()
-        if not request.user.is_staff and valid_request and ProctoredExamSettingsSerializer(data=request.data.get('proctored_exam_settings', {})).is_valid():
+        if not request.user.is_staff and valid_request and ProctoredExamSettingsSerializer(
+            data=request.data.get('proctored_exam_settings', {})
+        ).is_valid():
             return Response(status=status.HTTP_403_FORBIDDEN)
 
         with modulestore().bulk_operations(CourseKey.from_string(course_id)):

cms/djangoapps/contentstore/views/component.py

@@ -405,7 +405,7 @@ def create_support_legend_dict():
     # Set component types according to course policy file
     if isinstance(course_advanced_keys, list):
         for category in course_advanced_keys:
-            if category in advanced_component_types.keys() and category not in categories:
+            if category in advanced_component_types.keys() and category not in categories:  # pylint: disable=consider-iterating-dictionary
                 # boilerplates not supported for advanced components
                 try:
                     component_display_name = xblock_type_display_name(category, default_display_name=category)

cms/djangoapps/contentstore/views/course.py

@@ -1,7 +1,6 @@
 """
 Views related to operations on course objects
 """
-# pylint: disable=filter-builtin-not-iterating
 
 
 import copy
@@ -916,7 +915,7 @@ def _create_or_rerun_course(request):
         return JsonResponse({
             "ErrMsg": _("Unable to create course '{name}'.\n\n{err}").format(name=display_name, err=str(error))}
         )
-    except PermissionDenied as error:
+    except PermissionDenied as error:  # pylint: disable=unused-variable
         log.info(
             "User does not have the permission to create course in this organization"
             "or course creation is disabled."

cms/djangoapps/contentstore/views/library.py

@@ -208,7 +208,7 @@ def _create_library(request):
             )
         # Give the user admin ("Instructor") role for this library:
         add_instructor(new_lib.location.library_key, request.user, request.user)
-    except PermissionDenied as error:
+    except PermissionDenied as error:  # pylint: disable=unused-variable
         log.info(
             "User does not have the permission to create LIBRARY in this organization."
             "User: '%s' Org: '%s' LIBRARY #: '%s'.",

cms/djangoapps/contentstore/views/tabs.py

@@ -61,10 +61,10 @@ def tabs_handler(request, course_key_string):
             return JsonResponse()
 
     elif request.method == "GET":  # assume html
-        # get all tabs from the tabs list: static tabs (a.k.a. user-created tabs) and built-in tabs
+        # get all tabs from the tabs list and select only static tabs (a.k.a. user-created tabs)
         # present in the same order they are displayed in LMS
 
-        tabs_to_render = list(get_course_tabs(course_item, request.user))
+        tabs_to_render = list(get_course_static_tabs(course_item, request.user))
 
         return render_to_response(
             "edit-tabs.html",
@@ -78,9 +78,9 @@ def tabs_handler(request, course_key_string):
         return HttpResponseNotFound()
 
 
-def get_course_tabs(course_item: CourseBlock, user: User) -> Iterable[CourseTab]:
+def get_course_static_tabs(course_item: CourseBlock, user: User) -> Iterable[CourseTab]:
     """
-    Yields all the course tabs in a course including hidden tabs.
+    Yields all the static tabs in a course including hidden tabs.
 
     Args:
         course_item (CourseBlock): The course object from which to get the tabs
@@ -96,7 +96,7 @@ def get_course_tabs(course_item: CourseBlock, user: User) -> Iterable[CourseTab]
             # static tab needs its locator information to render itself as an xmodule
             static_tab_loc = course_item.id.make_usage_key("static_tab", tab.url_slug)
             tab.locator = static_tab_loc
-        yield tab
+            yield tab
 
 
 def update_tabs_handler(course_item: CourseBlock, tabs_data: Dict, user: User) -> None:
@@ -119,7 +119,7 @@ def update_tabs_handler(course_item: CourseBlock, tabs_data: Dict, user: User) -
 
 def reorder_tabs_handler(course_item, tabs_data, user):
     """
-    Helper function for handling reorder of tabs request
+    Helper function for handling reorder of static tabs request
     """
 
     # Tabs are identified by tab_id or locators.
@@ -128,10 +128,40 @@ def reorder_tabs_handler(course_item, tabs_data, user):
     # their tab_ids since the xmodule editor uses only locators to identify new objects.
     requested_tab_id_locators = tabs_data["tabs"]
 
-    # original tab list in original order
-    old_tab_list = course_item.tabs
+    #get original tab list of only static tabs with their original index(position) in the full course tabs list
+    old_tab_dict = {}
+    for idx, tab in enumerate(course_item.tabs):
+        if isinstance(tab, StaticTab):
+            old_tab_dict[tab] = idx
+    old_tab_list = list(old_tab_dict.keys())
+
+    new_tab_list = create_new_list(requested_tab_id_locators, old_tab_list)
+
+    # Creates a full new course tab list of both default and static course tabs
+    # by looping through the new tab list of static only tabs and
+    # putting them in their new position in the list of course item tabs
+    # original_idx gives the list of positions of all static tabs in course tabs originally
+    full_new_tab_list = course_item.tabs
+    original_idx = list(old_tab_dict.values())
+    for i in range(len(new_tab_list)):
+        full_new_tab_list[original_idx[i]] = new_tab_list[i]
+
+    # validate the tabs to make sure everything is Ok (e.g., did the client try to reorder unmovable tabs?)
+    try:
+        CourseTabList.validate_tabs(full_new_tab_list)
+    except InvalidTabsException as exception:
+        raise ValidationError({"error": f"New list of tabs is not valid: {str(exception)}."}) from exception
+
+    # persist the new order of the tabs
+    course_item.tabs = full_new_tab_list
+    modulestore().update_item(course_item, user.id)
 
-    # create a new list in the new order
+
+def create_new_list(requested_tab_id_locators, old_tab_list):
+    """
+    Helper function for creating a new course tab list in the new order
+    of reordered tabs
+    """
     new_tab_list = []
     for tab_id_locator in requested_tab_id_locators:
         tab = get_tab_by_tab_id_locator(old_tab_list, tab_id_locator)
@@ -143,16 +173,7 @@ def reorder_tabs_handler(course_item, tabs_data, user):
     # global or course settings.  so add those to the end of the list.
     non_displayed_tabs = set(old_tab_list) - set(new_tab_list)
     new_tab_list.extend(non_displayed_tabs)
-
-    # validate the tabs to make sure everything is Ok (e.g., did the client try to reorder unmovable tabs?)
-    try:
-        CourseTabList.validate_tabs(new_tab_list)
-    except InvalidTabsException as exception:
-        raise ValidationError({"error": f"New list of tabs is not valid: {str(exception)}."}) from exception
-
-    # persist the new order of the tabs
-    course_item.tabs = new_tab_list
-    modulestore().update_item(course_item, user.id)
+    return new_tab_list
 
 
 def edit_tab_handler(course_item: CourseBlock, tabs_data: Dict, user: User):

cms/djangoapps/contentstore/views/tests/test_tabs.py

@@ -1,6 +1,5 @@
 """ Tests for tab functions (just primitive). """
 
-
 import json
 
 from cms.djangoapps.contentstore.tests.utils import CourseTestCase
@@ -25,12 +24,15 @@ def setUp(self):
         # Set the URL for tests
         self.url = reverse_course_url('tabs_handler', self.course.id)
 
-        # add a static tab to the course, for code coverage
-        self.test_tab = ItemFactory.create(
-            parent_location=self.course.location,
-            category="static_tab",
-            display_name="Static_1"
-        )
+        # add 4 static tabs to the course, for code coverage
+        self.test_tabs = []
+        for i in range(1, 5):
+            tab = ItemFactory.create(
+                parent_location=self.course.location,
+                category="static_tab",
+                display_name=f"Static_{i}"
+            )
+        self.test_tabs.append(tab)
         self.reload_course()
 
     def check_invalid_tab_id_response(self, resp):
@@ -39,7 +41,6 @@ def check_invalid_tab_id_response(self, resp):
         self.assertEqual(resp.status_code, 400)
         resp_content = json.loads(resp.content.decode('utf-8'))
         self.assertIn("error", resp_content)
-        self.assertIn("invalid_tab_id", resp_content['error'])
 
     def test_not_implemented(self):
         """Verify not implemented errors"""
@@ -85,15 +86,15 @@ def test_reorder_tabs(self):
         # reorder the last two tabs
         tab_ids[num_orig_tabs - 1], tab_ids[num_orig_tabs - 2] = tab_ids[num_orig_tabs - 2], tab_ids[num_orig_tabs - 1]
 
-        # remove the middle tab
+        # remove the third to the last tab, the removed tab has to be a static tab
         # (the code needs to handle the case where tabs requested for re-ordering is a subset of the tabs in the course)
-        removed_tab = tab_ids.pop(num_orig_tabs // 2)
+        removed_tab = tab_ids.pop(num_orig_tabs - 3)
         self.assertEqual(len(tab_ids), num_orig_tabs - 1)
 
-        # post the request
+        # post the request with the reordered static tabs only
         resp = self.client.ajax_post(
             self.url,
-            data={'tabs': [{'tab_id': tab_id} for tab_id in tab_ids]},
+            data={'tabs': [{'tab_id': tab_id} for tab_id in tab_ids if 'static' in tab_id]},
         )
         self.assertEqual(resp.status_code, 204)
 
@@ -178,7 +179,7 @@ def test_tab_preview_html(self):
         """
         Verify that the static tab renders itself with the correct HTML
         """
-        preview_url = f'/xblock/{self.test_tab.location}/{STUDENT_VIEW}'
+        preview_url = f'/xblock/{self.test_tabs[0].location}/{STUDENT_VIEW}'
 
         resp = self.client.get(preview_url, HTTP_ACCEPT='application/json')
         self.assertEqual(resp.status_code, 200)

cms/djangoapps/course_creators/models.py

@@ -79,7 +79,7 @@ def post_save_callback(sender, **kwargs):
     # We need to keep track of all_organization switch. If this switch is changed we are going to remove the
     # Course Creator group.
     if instance.state != instance.orig_state or instance.all_organizations != instance.orig_all_organizations:
-        granted_state_change = instance.state == CourseCreator.GRANTED or instance.orig_state == CourseCreator.GRANTED
+        granted_state_change = instance.state == CourseCreator.GRANTED or instance.orig_state == CourseCreator.GRANTED  # pylint: disable=consider-using-in
         # If either old or new state is 'granted', we must manipulate the course creator
         # group maintained by authz. That requires staff permissions (stored admin).
         if granted_state_change: