feat: added integration tests in CI workflow

.github/workflows/ci.yml

@@ -26,8 +26,8 @@ jobs:
       - name: Python setup
         uses: actions/setup-python@v4
         with:
-          python-version: ${{ matrix.python-version }}
-
+          python-version: ${{ matrix.python-version }}  
+      
       - name: tox install
         run: pip install tox
 
@@ -36,6 +36,15 @@ jobs:
           TOXENV: ${{ matrix.toxenv }}
         run: tox
 
+      - name: Run Integration Tests 
+        run: |
+            cd ..
+            git clone https://github.com/edx/devstack.git
+            cd devstack
+            sed -i 's/:cached//g' ./docker-compose-host.yml
+            make dev.clone.https
+            DEVSTACK_WORKSPACE=$PWD/.. docker-compose -f docker-compose.yml -f docker-compose-host.yml run -v $PWD/../edx-sga:/edx-sga lms /edx-sga/run_devstack_integration_tests.sh
+
       - name: Upload coverage to CodeCov
         if: matrix.python-version == '3.8' && matrix.toxenv == 'py38-django32'
         uses: codecov/codecov-action@v3

edx_sga/sga.py

@@ -656,7 +656,7 @@ def get_student_item_dict(self, student_id=None):
         """
         if student_id is None and (user_service := self.runtime.service(self, 'user')):
             student_id = user_service.get_current_user().opt_attrs.get(ATTR_KEY_ANONYMOUS_USER_ID)
-            
+
             assert student_id != ("MOCK", "Forgot to call 'personalize' in test.")
         return {
             "student_id": student_id,
@@ -762,7 +762,7 @@ def student_state(self):
             if score:
                 score = score.get("points_earned")
                 graded = {"score": score, "comment": force_str(self.comment)}
-                
+
         else:
             uploaded = None
 

edx_sga/tests/integration_tests.py

@@ -7,7 +7,6 @@
 import json
 import os
 import shutil
-import functools
 import tempfile
 from unittest import mock
 
@@ -32,16 +31,13 @@
 from submissions.models import StudentItem
 from xblock.field_data import DictFieldData
 from xblock.fields import ScopeIds
-from xblock.runtime import DictKeyValueStore, KvsFieldData
+from xblock.runtime import DictKeyValueStore, KvsFieldData, Mixologist
 from xblock.test.tools import TestRuntime
 from xmodule.modulestore.django import modulestore
-from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase, mixed_store_config, StoreConstructors
+from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
 from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory
 from xmodule.modulestore.xml_exporter import export_course_to_xml
 from xmodule.modulestore.xml_importer import import_course_from_xml
-from xmodule.modulestore.inheritance import InheritanceMixin
-from openedx.core.lib import tempdir
-from xblock.runtime import Mixologist
 
 from edx_sga.constants import ShowAnswer
 from edx_sga.sga import StaffGradedAssignmentXBlock
@@ -166,7 +162,7 @@ def make_student(self, block, name, make_state=True, **state):
                 module.save()
 
             anonymous_id = anonymous_id_for_user(user, self.course_id)
-            
+
             item = StudentItem(
                 student_id=anonymous_id,
                 course_id=self.course_id,
@@ -175,14 +171,14 @@ def make_student(self, block, name, make_state=True, **state):
             )
             item.save()
 
-            if answer:              
+            if answer:
                 student_id = block.get_student_item_dict(anonymous_id)
                 submission = submissions_api.create_submission(student_id, answer)
                 if score is not None:
                     submissions_api.set_score(
                         submission["uuid"], score, block.max_score()
                     )
-                    pass
+
             else:
                 submission = None
 
@@ -204,7 +200,7 @@ def personalize(self, block, module, item, submission):
         state = json.loads(student_module.state)
         for key, value in state.items():
             setattr(block, key, value)
-        
+
         self.runtime.deprecated_anonymous_student_id = item.student_id
 
     def test_ctor(self):
@@ -245,16 +241,15 @@ def test_student_view(self, fragment, render_template):
         self.assertEqual(template_arg, "templates/staff_graded_assignment/show.html")
         context = render_template.call_args[0][1]
         self.assertEqual(context["is_course_staff"], True)
-        # self.assertEqual(context["id"], "name")
+        self.assertEqual(context["id"], "d_0")
         self.assertEqual(context["support_email"], "[email protected]")
         student_state = json.loads(context["student_state"])
-        # self.assertEqual(student_state["display_name"], "Custom name")
+        self.assertEqual(student_state["display_name"], "Custom name")
         self.assertEqual(student_state["uploaded"], None)
         self.assertEqual(student_state["annotated"], None)
         self.assertEqual(student_state["upload_allowed"], True)
         self.assertEqual(student_state["max_score"], 100)
         self.assertEqual(student_state["graded"], None)
-        # pylint: disable=no-member
         fragment.add_css.assert_called_once_with(
             DummyResource("static/css/edx_sga.css")
         )
@@ -327,7 +322,6 @@ def test_student_view_with_score(self, fragment, render_template):
             self.assertEqual(student_state["upload_allowed"], False)
             self.assertEqual(student_state["max_score"], 100)
             self.assertEqual(student_state["graded"], {"comment": "", "score": 10})
-            # pylint: disable=no-member
             fragment.add_css.assert_called_once_with(
                 DummyResource("static/css/edx_sga.css")
             )
@@ -566,7 +560,8 @@ def test_staff_download(self):
             user = student["module"].student
             student_id = anonymous_id_for_user(user,self.course_id)
 
-            with mock.patch.object(StaffGradedAssignmentXBlock.get_student_item_dict,"__defaults__",(student_id,)), self.dummy_upload(filename, text) as (upload, __):
+            with mock.patch.object(StaffGradedAssignmentXBlock.get_student_item_dict,"__defaults__",(student_id,)),\
+                  self.dummy_upload(filename, text) as (upload, __):
                 block.upload_assignment(mock.Mock(params={"assignment": upload}))
             students.append(
                 (
@@ -627,8 +622,9 @@ def test_staff_download_unicode_filename(self):
         self.personalize(block, **student)
         user = student["module"].student
         student_id = anonymous_id_for_user(user,self.course_id)
-
-        with mock.patch.object(StaffGradedAssignmentXBlock.get_student_item_dict,"__defaults__",(student_id,)), self.dummy_upload("файл.txt") as (upload, expected):
+
+        with mock.patch.object(StaffGradedAssignmentXBlock.get_student_item_dict,"__defaults__",(student_id,)),\
+              self.dummy_upload("файл.txt") as (upload, expected):
             block.upload_assignment(mock.Mock(params={"assignment": upload}))
         response = block.staff_download(
             mock.Mock(params={"student_id": student["item"].student_id})
@@ -656,8 +652,9 @@ def test_staff_download_filename_with_spaces(self):
         self.personalize(block, **student)
         user = student["module"].student
         student_id = anonymous_id_for_user(user,self.course_id)
-
-        with mock.patch.object(StaffGradedAssignmentXBlock.get_student_item_dict,"__defaults__",(student_id,)), self.dummy_upload(file_name) as (upload, expected):
+
+        with mock.patch.object(StaffGradedAssignmentXBlock.get_student_item_dict,"__defaults__",(student_id,)),\
+              self.dummy_upload(file_name) as (upload, expected):
             block.upload_assignment(mock.Mock(params={"assignment": upload}))
         response = block.staff_download(
             mock.Mock(params={"student_id": student["item"].student_id})
@@ -678,8 +675,9 @@ def test_file_download_comma_in_name(self, file_name):
         self.personalize(block, **student)
         user = student["module"].student
         student_id = anonymous_id_for_user(user,self.course_id)
-
-        with mock.patch.object(StaffGradedAssignmentXBlock.get_student_item_dict,"__defaults__",(student_id,)), self.dummy_upload(file_name) as (upload, expected):
+
+        with mock.patch.object(StaffGradedAssignmentXBlock.get_student_item_dict,"__defaults__",(student_id,)),\
+              self.dummy_upload(file_name) as (upload, expected):
             block.upload_assignment(mock.Mock(params={"assignment": upload}))
         response = block.staff_download(
             mock.Mock(params={"student_id": student["item"].student_id})
@@ -695,7 +693,8 @@ def test_get_staff_grading_data_not_staff(self):
         test staff grading data for non staff members.
         """
         block = self.make_one()
-        with mock.patch("edx_sga.sga.StaffGradedAssignmentXBlock.is_course_staff", return_value=False), self.assertRaises(PermissionDenied):
+        with mock.patch("edx_sga.sga.StaffGradedAssignmentXBlock.is_course_staff", return_value=False),\
+              self.assertRaises(PermissionDenied):
             block.get_staff_grading_data(None)
 
     def test_get_staff_grading_data(self):
@@ -934,7 +933,7 @@ def test_has_attempted(self):
 
     @data(True, False)
     def test_runtime_user_is_staff(self, is_staff):
-        
+
         staff = StaffFactory.create(course_key=self.course.id)
 
         render.prepare_runtime_for_user(

pytest.ini

@@ -0,0 +1,4 @@
+[pytest]
+DJANGO_SETTINGS_MODULE = edx_sga.test_settings
+addopts = --cov . --ds=edx_sga.test_settings
+norecursedirs = .git .tox edx_sga.static edx_sga.locale edx_sga.templates {arch} *.egg

run_devstack_integration_tests.sh

@@ -8,6 +8,8 @@ mkdir -p reports
 
 pip install -r requirements/edx/testing.txt
 
+pip install -e .
+
 cd /edx-sga
 pip uninstall edx-sga -y
 pip install -e .