Merge pull request #336 from CodeWithEmad/fix/warning

fix: warning message on migrate

README.rst

@@ -100,7 +100,7 @@ or::
 
     $ docker-compose down
 
-will shut down the container and delete non-persistant data.
+will shut down the container and delete non-persistent data.
 
 On the first startup run the following command to create the SQLite database.
 (Otherwise you will get an error no such table: workbench_xblockstate.)

bin/workbench-make-xblock

@@ -6,7 +6,6 @@ from __future__ import print_function
 
 import os
 import re
-import textwrap
 from builtins import input
 
 from cookiecutter.main import cookiecutter
@@ -54,7 +53,7 @@ def main():
 
     # Find the prototype.
     proto_dir = os.path.abspath(os.path.join(__file__, "../../prototype"))
-    
+
     cookiecutter(
         proto_dir,
         no_input=True,

sample_xblocks/basic/test/test_view_counter.py

@@ -3,6 +3,7 @@
 
 
 from unittest.mock import Mock
+
 from xblock.runtime import DictKeyValueStore, KvsFieldData
 from xblock.test.tools import TestRuntime as Runtime  # Workaround for pytest trying to collect "TestRuntime" as a test
 

setup.py

@@ -6,6 +6,7 @@
 
 from setuptools import setup
 
+
 def find_package_data(pkg, data_paths):
     """Generic function to find package_data for `pkg` under `root`."""
     data = []

workbench/runtime.py

@@ -10,8 +10,8 @@
 import logging
 from collections import defaultdict
 from datetime import datetime, timedelta
-
 from unittest.mock import Mock
+
 from web_fragments.fragment import Fragment
 from xblock.core import XBlockAside
 from xblock.exceptions import NoSuchDefinition, NoSuchUsage

workbench/settings.py

@@ -43,6 +43,7 @@
                 'django.template.context_processors.debug',
                 'django.template.context_processors.i18n',
                 'django.template.context_processors.media',
+                'django.template.context_processors.request',
                 'django.template.context_processors.static',
                 'django.template.context_processors.tz',
                 'django.contrib.messages.context_processors.messages',

workbench/test/test_runtime.py

@@ -1,10 +1,8 @@
 """Test Workbench Runtime"""
 
 
+from unittest import TestCase, mock
 
-from unittest import TestCase
-
-from unittest import mock
 import pytest
 from xblock.fields import Scope
 from xblock.reference.user_service import UserService
@@ -34,47 +32,59 @@ def test_should_increment(self):
 
     def test_slug_support(self):
         self.assertEqual(
-            self.id_mgr.create_definition("my_block", "my_slug"),
-            ".my_block.my_slug.d0"
+            self.id_mgr.create_definition("my_block", "my_slug"), ".my_block.my_slug.d0"
         )
         self.assertEqual(
-            self.id_mgr.create_definition("my_block", "my_slug"),
-            ".my_block.my_slug.d1"
+            self.id_mgr.create_definition("my_block", "my_slug"), ".my_block.my_slug.d1"
         )
 
     def test_scenario_support(self):
         self.test_should_increment()
 
         # Now that we have a scenario, our definition numbering starts over again.
         self.id_mgr.set_scenario("my_scenario")
-        self.assertEqual(self.id_mgr.create_definition("my_block"), "my_scenario.my_block.d0")
-        self.assertEqual(self.id_mgr.create_definition("my_block"), "my_scenario.my_block.d1")
+        self.assertEqual(
+            self.id_mgr.create_definition("my_block"), "my_scenario.my_block.d0"
+        )
+        self.assertEqual(
+            self.id_mgr.create_definition("my_block"), "my_scenario.my_block.d1"
+        )
 
         self.id_mgr.set_scenario("another_scenario")
-        self.assertEqual(self.id_mgr.create_definition("my_block"), "another_scenario.my_block.d0")
+        self.assertEqual(
+            self.id_mgr.create_definition("my_block"), "another_scenario.my_block.d0"
+        )
 
     def test_usages(self):
         # Now make sure our usages are attached to definitions
         self.assertIsNone(self.id_mgr.last_created_usage_id())
         self.assertEqual(
             self.id_mgr.create_usage("my_scenario.my_block.d0"),
-            "my_scenario.my_block.d0.u0"
+            "my_scenario.my_block.d0.u0",
         )
         self.assertEqual(
             self.id_mgr.create_usage("my_scenario.my_block.d0"),
-            "my_scenario.my_block.d0.u1"
+            "my_scenario.my_block.d0.u1",
+        )
+        self.assertEqual(
+            self.id_mgr.last_created_usage_id(), "my_scenario.my_block.d0.u1"
         )
-        self.assertEqual(self.id_mgr.last_created_usage_id(), "my_scenario.my_block.d0.u1")
 
     def test_asides(self):
-        definition_id = self.id_mgr.create_definition('my_block')
+        definition_id = self.id_mgr.create_definition("my_block")
         usage_id = self.id_mgr.create_usage(definition_id)
 
-        aside_definition, aside_usage = self.id_mgr.create_aside(definition_id, usage_id, 'my_aside')
+        aside_definition, aside_usage = self.id_mgr.create_aside(
+            definition_id, usage_id, "my_aside"
+        )
 
-        self.assertEqual(self.id_mgr.get_aside_type_from_definition(aside_definition), 'my_aside')
-        self.assertEqual(self.id_mgr.get_definition_id_from_aside(aside_definition), definition_id)
-        self.assertEqual(self.id_mgr.get_aside_type_from_usage(aside_usage), 'my_aside')
+        self.assertEqual(
+            self.id_mgr.get_aside_type_from_definition(aside_definition), "my_aside"
+        )
+        self.assertEqual(
+            self.id_mgr.get_definition_id_from_aside(aside_definition), definition_id
+        )
+        self.assertEqual(self.id_mgr.get_aside_type_from_usage(aside_usage), "my_aside")
         self.assertEqual(self.id_mgr.get_usage_id_from_aside(aside_usage), usage_id)
 
 
@@ -88,24 +98,29 @@ def test_lti_consumer_xblock_requirements(self):
         The LTI Consumer XBlock expects a lot of values from the LMS Runtime,
         this test ensures that those requirements fulfilled.
         """
-        runtime = WorkbenchRuntime('test_user')
-        assert runtime.get_real_user(object()), 'The LTI Consumer XBlock needs this method.'
-        assert runtime.hostname, 'The LTI Consumer XBlock needs this property.'
-        assert runtime.anonymous_student_id, 'The LTI Consumer XBlock needs this property.'
+        runtime = WorkbenchRuntime("test_user")
+        assert runtime.get_real_user(
+            object()
+        ), "The LTI Consumer XBlock needs this method."
+        assert runtime.hostname, "The LTI Consumer XBlock needs this property."
+        assert (
+            runtime.anonymous_student_id
+        ), "The LTI Consumer XBlock needs this property."
 
 
 class TestKVStore(TestCase):
     """
     Test the Workbench KVP Store
     """
+
     def setUp(self):
         super().setUp()
         self.kvs = WorkbenchDjangoKeyValueStore()
         self.key = KeyValueStore.Key(
             scope=Scope.content,
             user_id="rusty",
             block_scope_id="my_scenario.my_block.d0",
-            field_name="age"
+            field_name="age",
         )
 
     @pytest.mark.django_db
@@ -119,11 +134,12 @@ def test_storage(self):
 
 
 class StubService:
-    """Empty service to test loading additional services. """
+    """Empty service to test loading additional services."""
 
 
 class ExceptionService:
-    """Stub service that raises an exception on init. """
+    """Stub service that raises an exception on init."""
+
     def __init__(self):
         raise Exception("Kaboom!")
 
@@ -138,55 +154,58 @@ def setUp(self):
         self.xblock = mock.Mock()
 
     def test_default_services(self):
-        runtime = WorkbenchRuntime('test_user')
+        runtime = WorkbenchRuntime("test_user")
         self._assert_default_services(runtime)
 
-    @mock.patch.dict(settings.WORKBENCH['services'], {
-        'stub': 'workbench.test.test_runtime.StubService'
-    })
+    @mock.patch.dict(
+        settings.WORKBENCH["services"],
+        {"stub": "workbench.test.test_runtime.StubService"},
+    )
     def test_settings_adds_services(self):
-        runtime = WorkbenchRuntime('test_user')
+        runtime = WorkbenchRuntime("test_user")
 
         # Default services should still be available
         self._assert_default_services(runtime)
 
         # An additional service should be provided
-        self._assert_service(runtime, 'stub', StubService)
+        self._assert_service(runtime, "stub", StubService)
 
         # Check that the service has the runtime attribute set
-        service = runtime.service(self.xblock, 'stub')
+        service = runtime.service(self.xblock, "stub")
         self.assertIs(service.runtime, runtime)
 
-    @mock.patch.dict(settings.WORKBENCH['services'], {
-        'not_found': 'workbench.test.test_runtime.NotFoundService'
-    })
+    @mock.patch.dict(
+        settings.WORKBENCH["services"],
+        {"not_found": "workbench.test.test_runtime.NotFoundService"},
+    )
     def test_could_not_find_service(self):
-        runtime = WorkbenchRuntime('test_user')
+        runtime = WorkbenchRuntime("test_user")
 
         # Default services should still be available
         self._assert_default_services(runtime)
 
         # The additional service should NOT be available
-        self.assertIs(runtime.service(self.xblock, 'not_found'), None)
+        self.assertIs(runtime.service(self.xblock, "not_found"), None)
 
-    @mock.patch.dict(settings.WORKBENCH['services'], {
-        'exception': 'workbench.test.test_runtime.ExceptionService'
-    })
+    @mock.patch.dict(
+        settings.WORKBENCH["services"],
+        {"exception": "workbench.test.test_runtime.ExceptionService"},
+    )
     def test_runtime_service_initialization_failed(self):
-        runtime = WorkbenchRuntime('test_user')
+        runtime = WorkbenchRuntime("test_user")
 
         # Default services should still be available
         self._assert_default_services(runtime)
 
         # The additional service should NOT be available
-        self.assertIs(runtime.service(self.xblock, 'exception'), None)
+        self.assertIs(runtime.service(self.xblock, "exception"), None)
 
     def _assert_default_services(self, runtime):
-        """Check that the default services are available. """
-        self._assert_service(runtime, 'field-data', KvsFieldData)
-        self._assert_service(runtime, 'user', UserService)
+        """Check that the default services are available."""
+        self._assert_service(runtime, "field-data", KvsFieldData)
+        self._assert_service(runtime, "user", UserService)
 
     def _assert_service(self, runtime, service_name, service_class):
-        """Check that a service is loaded. """
+        """Check that a service is loaded."""
         service_instance = runtime.service(self.xblock, service_name)
         self.assertIsInstance(service_instance, service_class)