Merge pull request #733 from edx/andya/fix-ora-dev-environment

Make improvements to ORA's development environment

Makefile

@@ -48,3 +48,6 @@ install: install-wheels install-python install-js install-nltk-data install-test
 
 test:
 	./scripts/test.sh
+
+test-js:
+	./scripts/test-js.sh

karma.conf.js

@@ -11,7 +11,7 @@ module.exports = function(config) {
       'karma-coverage',
       'karma-jasmine',
       'karma-chrome-launcher',
-      'karma-phantomjs-launcher',
+      'karma-phantomjs-launcher'
     ],
 
     // frameworks to use
@@ -36,7 +36,7 @@ module.exports = function(config) {
       {
         pattern: 'fixtures/*.html',
         served: true, included: false
-      },
+      }
     ],
 
 

openassessment/xblock/openassessmentblock.py

@@ -4,10 +4,12 @@ import copy
 import datetime as dt
 import json
 import logging
+import os
 import pkg_resources
 
 import pytz
 
+from django.conf import settings
 from django.template.context import Context
 from django.template.loader import get_template
 from webob import Response
@@ -16,6 +18,7 @@ from lazy import lazy
 from xblock.core import XBlock
 from xblock.fields import List, Scope, String, Boolean, Integer
 from xblock.fragment import Fragment
+
 from openassessment.xblock.grade_mixin import GradeMixin
 from openassessment.xblock.leaderboard_mixin import LeaderboardMixin
 from openassessment.xblock.defaults import * # pylint: disable=wildcard-import, unused-wildcard-import
@@ -256,6 +259,18 @@ class OpenAssessmentBlock(
         )
         return student_item_dict
 
+    def add_javascript_files(self, fragment, item):
+        """
+        Add all the JavaScript files from a directory to the specified fragment
+        """
+        if pkg_resources.resource_isdir(__name__, item):
+            for child_item in pkg_resources.resource_listdir(__name__, item):
+                path = os.path.join(item, child_item)
+                if not pkg_resources.resource_isdir(__name__, path):
+                    fragment.add_javascript_url(self.runtime.local_resource_url(self, path))
+        else:
+            fragment.add_javascript_url(self.runtime.local_resource_url(self, item))
+
     def student_view(self, context=None):
         """The main view of OpenAssessmentBlock, displayed when viewing courses.
 
@@ -290,17 +305,25 @@ class OpenAssessmentBlock(
         }
         template = get_template("openassessmentblock/oa_base.html")
         context = Context(context_dict)
-        frag = Fragment(template.render(context))
+        fragment = Fragment(template.render(context))
 
         i18n_service = self.runtime.service(self, 'i18n')
         if hasattr(i18n_service, 'get_language_bidi') and i18n_service.get_language_bidi():
-            frag.add_css(load("static/css/openassessment-rtl.css"))
+            css_url = "static/css/openassessment-rtl.css"
         else:
-            frag.add_css(load("static/css/openassessment-ltr.css"))
+            css_url = "static/css/openassessment-ltr.css"
 
-        frag.add_javascript(load("static/js/openassessment-lms.min.js"))
-        frag.initialize_js('OpenAssessmentBlock')
-        return frag
+        if settings.DEBUG:
+            fragment.add_css_url(self.runtime.local_resource_url(self, css_url))
+            self.add_javascript_files(fragment, "static/js/src/oa_shared.js")
+            self.add_javascript_files(fragment, "static/js/src/oa_server.js")
+            self.add_javascript_files(fragment, "static/js/src/lms")
+        else:
+            # TODO: load CSS and JavaScript as URLs once they can be served by the CDN
+            fragment.add_css(load(css_url))
+            fragment.add_javascript(load("static/js/openassessment-lms.min.js"))
+        fragment.initialize_js('OpenAssessmentBlock')
+        return fragment
 
 
     @property

openassessment/xblock/studio_mixin.py

@@ -5,20 +5,22 @@ import copy
 import logging
 import pkg_resources
 from uuid import uuid4
+from xml import UpdateFromXmlError
 
+from django.conf import settings
 from django.template import Context
 from django.template.loader import get_template
 from voluptuous import MultipleInvalid
 from xblock.core import XBlock
 from xblock.fields import List, Scope
 from xblock.fragment import Fragment
+
 from openassessment.xblock.defaults import DEFAULT_EDITOR_ASSESSMENTS_ORDER, DEFAULT_RUBRIC_FEEDBACK_TEXT
 from openassessment.xblock.validation import validator
 from openassessment.xblock.data_conversion import create_rubric_dict, make_django_template_key, update_assessments_format
 from openassessment.xblock.schema import EDITOR_UPDATE_SCHEMA
 from openassessment.xblock.resolve_dates import resolve_dates
 from openassessment.xblock.xml import serialize_examples_to_xml_str, parse_examples_from_xml_str
-from xml import UpdateFromXmlError
 
 logger = logging.getLogger(__name__)
 
@@ -63,10 +65,16 @@ class StudioMixin(object):
         rendered_template = get_template(
             'openassessmentblock/edit/oa_edit.html'
         ).render(Context(self.editor_context()))
-        frag = Fragment(rendered_template)
-        frag.add_javascript(pkg_resources.resource_string(__name__, "static/js/openassessment-studio.min.js"))
-        frag.initialize_js('OpenAssessmentEditor')
-        return frag
+        fragment = Fragment(rendered_template)
+        if settings.DEBUG:
+            self.add_javascript_files(fragment, "static/js/src/oa_shared.js")
+            self.add_javascript_files(fragment, "static/js/src/oa_server.js")
+            self.add_javascript_files(fragment, "static/js/src/studio")
+        else:
+            # TODO: switch to add_javascript_url once XBlock resources are loaded from the CDN
+            fragment.add_javascript(pkg_resources.resource_string(__name__, "static/js/openassessment-studio.min.js"))
+        fragment.initialize_js('OpenAssessmentEditor')
+        return fragment
 
     def editor_context(self):
         """

scripts/test-js.sh

@@ -3,7 +3,7 @@
 cd `dirname $BASH_SOURCE` && cd ..
 
 echo "Generating HTML fixtures for JavaScript tests..."
-export DJANGO_SETTINGS_MODULE="settings.test"
+export DJANGO_SETTINGS_MODULE=${DJANGO_SETTINGS_MODULE:-"settings.test"}
 ./scripts/render_templates.py openassessment/xblock/static/js/fixtures/templates.json
 
 echo "Running JavaScript tests..."

scripts/test-python.sh

@@ -6,5 +6,5 @@ cd `dirname $BASH_SOURCE` && cd ..
 git clean -xfd "./storage/test/"
 
 echo "Running Python tests..."
-export DJANGO_SETTINGS_MODULE="settings.test"
+export DJANGO_SETTINGS_MODULE=${DJANGO_SETTINGS_MODULE:-"settings.test"}
 python manage.py test $1

scripts/test.sh

@@ -4,6 +4,7 @@
 set -e
 
 cd `dirname $BASH_SOURCE` && cd ..
+export DJANGO_SETTINGS_MODULE=${DJANGO_SETTINGS_MODULE:-"settings.test_with_coverage"}
 ./scripts/test-python.sh $1
 ./scripts/test-js.sh
 ./scripts/build-docs.sh

scripts/workbench.sh

@@ -9,7 +9,7 @@ make install-js
 make javascript
 
 # Configure Django settings
-export DJANGO_SETTINGS_MODULE="settings.dev"
+export DJANGO_SETTINGS_MODULE=${DJANGO_SETTINGS_MODULE:-"settings.dev"}
 
 # Create the database
 echo "Updating the database..."

settings/test.py

@@ -15,10 +15,6 @@ TEST_APPS = (
 # Configure nose
 NOSE_ARGS = [
     "-a !acceptance",
-    '--with-coverage',
-    '--cover-package=' + ",".join(TEST_APPS),
-    '--cover-branches',
-    '--cover-erase',
     ]
 
 DATABASES = {

settings/test_with_coverage.py

+"""
+Django settings for running tests with coverage.
+"""
+
+# Inherit from the test settings
+from .test import *     # pylint:disable=W0614,W0401
+
+# Configure nose so that tests are run with coverage
+NOSE_ARGS = [
+    "-a !acceptance",
+    '--with-coverage',
+    '--cover-package=' + ",".join(TEST_APPS),
+    '--cover-branches',
+    '--cover-erase',
+    ]