diff --git a/.gitignore b/.gitignore index f1784a48f3..05e76c4caa 100644 --- a/.gitignore +++ b/.gitignore @@ -9,7 +9,7 @@ :2e# .AppleDouble database.sqlite -private-requirements.txt +requirements/private.txt courseware/static/js/mathjax/* flushdb.sh build @@ -26,6 +26,7 @@ Gemfile.lock conf/locale/en/LC_MESSAGES/*.po !messages.po lms/static/sass/*.css +lms/static/sass/application.scss cms/static/sass/*.css lms/lib/comment_client/python nosetests.xml @@ -36,3 +37,7 @@ chromedriver.log /nbproject ghostdriver.log node_modules +.pip_download_cache/ +.prereqs_cache +autodeploy.properties +.ws_migrations_complete diff --git a/.reviewboardrc b/.reviewboardrc new file mode 100644 index 0000000000..b79235a4a4 --- /dev/null +++ b/.reviewboardrc @@ -0,0 +1,2 @@ +REVIEWBOARD_URL = "https://rbcommons.com/s/edx/" +GUESS_FIELDS = True diff --git a/.ruby-gemset b/.ruby-gemset index 93a8706d3e..77266c35f0 100644 --- a/.ruby-gemset +++ b/.ruby-gemset @@ -1 +1 @@ -mitx +edx-platform diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000000..091e054a45 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,76 @@ +Piotr Mitros +Kyle Fiedler +Ernie Park +Bridger Maxwell +Lyla Fischer +David Ormsbee +Chris Terman +Reda Lemeden +Anant Agarwal +Jean-Michel Claus +Calen Pennington +JM Van Thong +Prem Sichanugrist +Isaac Chuang +Galen Frechette +Edward Loveall +Matt Jankowski +John Jarvis +Victor Shnayder +Matthew Mongeau +Tony Kim +Arjun Singh +John Hess +Carlos Andrés Rocha +Mike Chen +Rocky Duan +Sidhanth Rao +Brittany Cheng +Dhaval Adjodah +Tom Giannattasio +Ibrahim Awwal +Sarina Canelake +Mark L. Chang +Dean Dieker +Tommy MacWilliam +Nate Hardison +Chris Dodge +Kevin Chugh +Ned Batchelder +Alexander Kryklia +Vik Paruchuri +Louis Sobel +Brian Wilson +Ashley Penney +Don Mitchell +Aaron Culich +Brian Talbot +Jay Zoldak +Valera Rozuvan +Diana Huang +Marco Morales +Christina Roberts +Robert Chirwa +Ed Zarecor +Deena Wang +Jean Manuel-Nater +Emily Zhang <1800.ehz.hang@gmail.com> +Jennifer Akana +Peter Baratta +Julian Arni +Arthur Barrett +Vasyl Nakvasiuk +Will Daly +James Tauber +Greg Price +Joe Blaylock +Sef Kloninger +Anto Stupak +David Adams +Steve Strassmann +Giulio Gratta +David Baumgold +Jason Bau +Frances Botsford +Jonah Stanley +Slater Victoroff diff --git a/LICENSE.TXT b/LICENSE similarity index 100% rename from LICENSE.TXT rename to LICENSE diff --git a/README.md b/README.md index ec17d7c9a4..3a6236ea70 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,18 @@ -This is edX, a platform for online course delivery. The project is primarily -written in [Python](http://python.org/), using the -[Django](https://www.djangoproject.com/) framework. We also use some -[Ruby](http://www.ruby-lang.org/) and some [NodeJS](http://nodejs.org/). +This is the main edX platform which consists of LMS and Studio. + +See [code.edx.org](http://code.edx.org/) for other parts of the edX code base. Installation ============ -The installation process is a bit messy at the moment. Here's a high-level -overview of what you should do to get started. -**TLDR:** There is a `create-dev-env.sh` script that will attempt to set all -of this up for you. If you're in a hurry, run that script. Otherwise, I suggest -that you understand what the script is doing, and why, by reading this document. +There is a `scripts/create-dev-env.sh` that will attempt to set up a development +environment. + +If you want to better understand what the script is doing, keep reading. Directory Hierarchy ------------------- + This code assumes that it is checked out in a directory that has three sibling directories: `data` (used for XML course data), `db` (used to hold a [sqlite](https://sqlite.org/) database), and `log` (used to hold logs). If you @@ -77,11 +76,17 @@ environment), and Node has a library installer called Once you've got your languages and virtual environments set up, install the libraries like so: - $ pip install -r pre-requirements.txt - $ pip install -r requirements.txt + $ pip install -r requirements/edx/pre.txt + $ pip install -r requirements/edx/base.txt + $ pip install -r requirements/edx/post.txt $ bundle install $ npm install +You can also use [`rake`](http://rake.rubyforge.org/) to get all of the prerequisites (or to update) +them if they've changed + + $ rake install_prereqs + Other Dependencies ------------------ You'll also need to install [MongoDB](http://www.mongodb.org/), since our @@ -106,7 +111,7 @@ CMS templates. Fortunately, `rake` will do all of this for you! Just run: $ rake django-admin[syncdb] $ rake django-admin[migrate] - $ rake django-admin[update_templates] + $ rake cms:update_templates If you are running these commands using the [`zsh`](http://www.zsh.org/) shell, zsh will assume that you are doing @@ -137,12 +142,30 @@ Studio, visit `127.0.0.1:8001` in your web browser; to view the LMS, visit There's also an older version of the LMS that saves its information in XML files in the `data` directory, instead of in Mongo. To run this older version, run: -$ rake lms + $ rake lms -Further Documentation -===================== -Once you've got your project up and running, you can check out the `docs` -directory to see more documentation about how edX is structured. +License +------- +The code in this repository is licensed under version 3 of the AGPL unless +otherwise noted. +Please see ``LICENSE.txt`` for details. +How to Contribute +----------------- + +Contributions are very welcome. The easiest way is to fork this repo, and then +make a pull request from your fork. The first time you make a pull request, you +may be asked to sign a Contributor Agreement. + +Reporting Security Issues +------------------------- + +Please do not report security issues in public. Please email security@edx.org + +Mailing List and IRC Channel +---------------------------- + +You can discuss this code on the [edx-code Google Group](https://groups.google.com/forum/#!forum/edx-code) or in the +`edx-code` IRC channel on Freenode. diff --git a/cms/djangoapps/contentstore/features/advanced-settings.feature b/cms/djangoapps/contentstore/features/advanced-settings.feature index ca5b62e596..6f6cc50702 100644 --- a/cms/djangoapps/contentstore/features/advanced-settings.feature +++ b/cms/djangoapps/contentstore/features/advanced-settings.feature @@ -11,7 +11,8 @@ Feature: Advanced (manual) course policy Given I am on the Advanced Course Settings page in Studio Then the settings are alphabetized - @skip-phantom + # Skipped because Ubuntu ChromeDriver cannot click notification "Cancel" + @skip Scenario: Test cancel editing key value Given I am on the Advanced Course Settings page in Studio When I edit the value of a policy key @@ -20,7 +21,8 @@ Feature: Advanced (manual) course policy And I reload the page Then the policy key value is unchanged - @skip-phantom + # Skipped because Ubuntu ChromeDriver cannot click notification "Save" + @skip Scenario: Test editing key value Given I am on the Advanced Course Settings page in Studio When I edit the value of a policy key and save @@ -28,7 +30,8 @@ Feature: Advanced (manual) course policy And I reload the page Then the policy key value is changed - @skip-phantom + # Skipped because Ubuntu ChromeDriver cannot edit CodeMirror input + @skip Scenario: Test how multi-line input appears Given I am on the Advanced Course Settings page in Studio When I create a JSON object as a value @@ -36,7 +39,8 @@ Feature: Advanced (manual) course policy And I reload the page Then it is displayed as formatted - @skip-phantom + # Skipped because Ubuntu ChromeDriver cannot edit CodeMirror input + @skip Scenario: Test automatic quoting of non-JSON values Given I am on the Advanced Course Settings page in Studio When I create a non-JSON value not in quotes diff --git a/cms/djangoapps/contentstore/features/advanced-settings.py b/cms/djangoapps/contentstore/features/advanced-settings.py index ea5b24b21f..3acebecac8 100644 --- a/cms/djangoapps/contentstore/features/advanced-settings.py +++ b/cms/djangoapps/contentstore/features/advanced-settings.py @@ -19,9 +19,7 @@ DISPLAY_NAME_VALUE = '"Robot Super Course"' ############### ACTIONS #################### @step('I select the Advanced Settings$') def i_select_advanced_settings(step): - expand_icon_css = 'li.nav-course-settings i.icon-expand' - if world.browser.is_element_present_by_css(expand_icon_css): - world.css_click(expand_icon_css) + world.click_course_settings() link_css = 'li.nav-course-settings-advanced a' world.css_click(link_css) diff --git a/cms/djangoapps/contentstore/features/checklists.feature b/cms/djangoapps/contentstore/features/checklists.feature index ddf1adf263..3767144c99 100644 --- a/cms/djangoapps/contentstore/features/checklists.feature +++ b/cms/djangoapps/contentstore/features/checklists.feature @@ -10,8 +10,6 @@ Feature: Course checklists Then I can check and uncheck tasks in a checklist And They are correctly selected after I reload the page - @skip-phantom - @skip-firefox Scenario: A task can link to a location within Studio Given I have opened Checklists When I select a link to the course outline @@ -19,8 +17,6 @@ Feature: Course checklists And I press the browser back button Then I am brought back to the course outline in the correct state - @skip-phantom - @skip-firefox Scenario: A task can link to a location outside Studio Given I have opened Checklists When I select a link to help page diff --git a/cms/djangoapps/contentstore/features/checklists.py b/cms/djangoapps/contentstore/features/checklists.py index 1c9fbf0994..9552d35036 100644 --- a/cms/djangoapps/contentstore/features/checklists.py +++ b/cms/djangoapps/contentstore/features/checklists.py @@ -10,9 +10,7 @@ from selenium.common.exceptions import StaleElementReferenceException ############### ACTIONS #################### @step('I select Checklists from the Tools menu$') def i_select_checklists(step): - expand_icon_css = 'li.nav-course-tools i.icon-expand' - if world.browser.is_element_present_by_css(expand_icon_css): - world.css_click(expand_icon_css) + world.click_tools() link_css = 'li.nav-course-tools-checklists a' world.css_click(link_css) diff --git a/cms/djangoapps/contentstore/features/common.py b/cms/djangoapps/contentstore/features/common.py index afb38c3f9e..96b840ae96 100644 --- a/cms/djangoapps/contentstore/features/common.py +++ b/cms/djangoapps/contentstore/features/common.py @@ -5,8 +5,6 @@ from lettuce import world, step from nose.tools import assert_true from nose.tools import assert_equal -from xmodule.modulestore.django import _MODULESTORES, modulestore -from xmodule.templates import update_templates from auth.authz import get_user_by_email from selenium.webdriver.common.keys import Keys @@ -50,31 +48,31 @@ def i_press_the_category_delete_icon(step, category): @step('I have opened a new course in Studio$') def i_have_opened_a_new_course(step): + open_new_course() + + +####### HELPER FUNCTIONS ############## +def open_new_course(): world.clear_courses() log_into_studio() create_a_course() -####### HELPER FUNCTIONS ############## def create_studio_user( uname='robot', email='robot+studio@edx.org', password='test', is_staff=False): - studio_user = world.UserFactory.build( + studio_user = world.UserFactory( username=uname, email=email, password=password, is_staff=is_staff) - studio_user.set_password(password) - studio_user.save() registration = world.RegistrationFactory(user=studio_user) registration.register(studio_user) registration.activate() - user_profile = world.UserProfileFactory(user=studio_user) - def fill_in_course_info( name='Robot Super Course', @@ -153,4 +151,13 @@ def set_date_and_time(date_css, desired_date, time_css, desired_time): world.css_fill(time_css, desired_time) e = world.css_find(time_css).first e._element.send_keys(Keys.TAB) - time.sleep(float(1)) + time.sleep(float(1)) + + +@step('I have created a Video component$') +def i_created_a_video_component(step): + world.create_component_instance( + step, '.large-video-icon', + 'i4x://edx/templates/video/default', + '.xmodule_VideoModule' + ) diff --git a/cms/djangoapps/contentstore/features/component_settings_editor_helpers.py b/cms/djangoapps/contentstore/features/component_settings_editor_helpers.py new file mode 100644 index 0000000000..4c674dc34c --- /dev/null +++ b/cms/djangoapps/contentstore/features/component_settings_editor_helpers.py @@ -0,0 +1,85 @@ +# disable missing docstring +#pylint: disable=C0111 + +from lettuce import world +from nose.tools import assert_equal +from terrain.steps import reload_the_page + + +@world.absorb +def create_component_instance(step, component_button_css, instance_id, expected_css): + click_new_component_button(step, component_button_css) + click_component_from_menu(instance_id, expected_css) + + +@world.absorb +def click_new_component_button(step, component_button_css): + step.given('I have opened a new course section in Studio') + step.given('I have added a new subsection') + step.given('I expand the first section') + world.css_click('a.new-unit-item') + world.css_click(component_button_css) + + +@world.absorb +def click_component_from_menu(instance_id, expected_css): + elem_css = "a[data-location='%s']" % instance_id + assert_equal(1, len(world.css_find(elem_css))) + world.css_click(elem_css) + assert_equal(1, len(world.css_find(expected_css))) + +@world.absorb +def edit_component_and_select_settings(): + world.css_click('a.edit-button') + world.css_click('#settings-mode') + + +@world.absorb +def verify_setting_entry(setting, display_name, value, explicitly_set): + assert_equal(display_name, setting.find_by_css('.setting-label')[0].value) + assert_equal(value, setting.find_by_css('.setting-input')[0].value) + settingClearButton = setting.find_by_css('.setting-clear')[0] + assert_equal(explicitly_set, settingClearButton.has_class('active')) + assert_equal(not explicitly_set, settingClearButton.has_class('inactive')) + + +@world.absorb +def verify_all_setting_entries(expected_entries): + settings = world.browser.find_by_css('.wrapper-comp-setting') + assert_equal(len(expected_entries), len(settings)) + for (counter, setting) in enumerate(settings): + world.verify_setting_entry( + setting, expected_entries[counter][0], + expected_entries[counter][1], expected_entries[counter][2] + ) + + +@world.absorb +def save_component_and_reopen(step): + world.css_click("a.save-button") + # We have a known issue that modifications are still shown within the edit window after cancel (though) + # they are not persisted. Refresh the browser to make sure the changes WERE persisted after Save. + reload_the_page(step) + edit_component_and_select_settings() + + +@world.absorb +def cancel_component(step): + world.css_click("a.cancel-button") + # We have a known issue that modifications are still shown within the edit window after cancel (though) + # they are not persisted. Refresh the browser to make sure the changes were not persisted. + reload_the_page(step) + + +@world.absorb +def revert_setting_entry(label): + get_setting_entry(label).find_by_css('.setting-clear')[0].click() + + +@world.absorb +def get_setting_entry(label): + settings = world.browser.find_by_css('.wrapper-comp-setting') + for setting in settings: + if setting.find_by_css('.setting-label')[0].value == label: + return setting + return None diff --git a/cms/djangoapps/contentstore/features/course-settings.feature b/cms/djangoapps/contentstore/features/course-settings.feature index fc9641cb46..e869bfe47a 100644 --- a/cms/djangoapps/contentstore/features/course-settings.feature +++ b/cms/djangoapps/contentstore/features/course-settings.feature @@ -1,20 +1,17 @@ Feature: Course Settings As a course author, I want to be able to configure my course settings. - @skip-phantom Scenario: User can set course dates Given I have opened a new course in Studio When I select Schedule and Details And I set course dates Then I see the set dates on refresh - @skip-phantom Scenario: User can clear previously set course dates (except start date) Given I have set course dates And I clear all the dates except start Then I see cleared dates on refresh - @skip-phantom Scenario: User cannot clear the course start date Given I have set course dates And I clear the course start date diff --git a/cms/djangoapps/contentstore/features/course-settings.py b/cms/djangoapps/contentstore/features/course-settings.py index d69266b7de..bd86fff9b7 100644 --- a/cms/djangoapps/contentstore/features/course-settings.py +++ b/cms/djangoapps/contentstore/features/course-settings.py @@ -25,9 +25,7 @@ DEFAULT_TIME = "00:00" ############### ACTIONS #################### @step('I select Schedule and Details$') def test_i_select_schedule_and_details(step): - expand_icon_css = 'li.nav-course-settings i.icon-expand' - if world.browser.is_element_present_by_css(expand_icon_css): - world.css_click(expand_icon_css) + world.click_course_settings() link_css = 'li.nav-course-settings-schedule a' world.css_click(link_css) diff --git a/cms/djangoapps/contentstore/features/courses.py b/cms/djangoapps/contentstore/features/courses.py index 5da7720945..a3e838a9d1 100644 --- a/cms/djangoapps/contentstore/features/courses.py +++ b/cms/djangoapps/contentstore/features/courses.py @@ -47,12 +47,6 @@ def i_see_the_course_in_my_courses(step): assert world.css_has_text(course_css, 'Robot Super Course') -@step('the course is loaded$') -def course_is_loaded(step): - class_css = 'a.class-name' - assert world.css_has_text(course_css, 'Robot Super Cousre') - - @step('I am on the "([^"]*)" tab$') def i_am_on_tab(step, tab_name): header_css = 'div.inner-wrapper h1' @@ -62,4 +56,4 @@ def i_am_on_tab(step, tab_name): @step('I see a link for adding a new section$') def i_see_new_section_link(step): link_css = 'a.new-courseware-section-button' - assert world.css_has_text(link_css, '+ New Section') + assert world.css_has_text(link_css, 'New Section') diff --git a/cms/djangoapps/contentstore/features/discussion-editor.feature b/cms/djangoapps/contentstore/features/discussion-editor.feature new file mode 100644 index 0000000000..24683c3297 --- /dev/null +++ b/cms/djangoapps/contentstore/features/discussion-editor.feature @@ -0,0 +1,13 @@ +Feature: Discussion Component Editor + As a course author, I want to be able to create discussion components. + + Scenario: User can view metadata + Given I have created a Discussion Tag + And I edit and select Settings + Then I see three alphabetized settings and their expected values + + Scenario: User can modify display name + Given I have created a Discussion Tag + And I edit and select Settings + Then I can modify the display name + And my display name change is persisted on save diff --git a/cms/djangoapps/contentstore/features/discussion-editor.py b/cms/djangoapps/contentstore/features/discussion-editor.py new file mode 100644 index 0000000000..aced4c2c88 --- /dev/null +++ b/cms/djangoapps/contentstore/features/discussion-editor.py @@ -0,0 +1,23 @@ +# disable missing docstring +#pylint: disable=C0111 + +from lettuce import world, step + + +@step('I have created a Discussion Tag$') +def i_created_discussion_tag(step): + world.create_component_instance( + step, '.large-discussion-icon', + 'i4x://edx/templates/discussion/Discussion_Tag', + '.xmodule_DiscussionModule' + ) + + +@step('I see three alphabetized settings and their expected values$') +def i_see_only_the_settings_and_values(step): + world.verify_all_setting_entries( + [ + ['Category', "Week 1", True], + ['Display Name', "Discussion Tag", True], + ['Subcategory', "Topic-Level Student-Visible Label", True] + ]) diff --git a/cms/djangoapps/contentstore/features/html-editor.feature b/cms/djangoapps/contentstore/features/html-editor.feature new file mode 100644 index 0000000000..6cd455d681 --- /dev/null +++ b/cms/djangoapps/contentstore/features/html-editor.feature @@ -0,0 +1,13 @@ +Feature: HTML Editor + As a course author, I want to be able to create HTML blocks. + + Scenario: User can view metadata + Given I have created a Blank HTML Page + And I edit and select Settings + Then I see only the HTML display name setting + + Scenario: User can modify display name + Given I have created a Blank HTML Page + And I edit and select Settings + Then I can modify the display name + And my display name change is persisted on save diff --git a/cms/djangoapps/contentstore/features/html-editor.py b/cms/djangoapps/contentstore/features/html-editor.py new file mode 100644 index 0000000000..054c0ea642 --- /dev/null +++ b/cms/djangoapps/contentstore/features/html-editor.py @@ -0,0 +1,17 @@ +# disable missing docstring +#pylint: disable=C0111 + +from lettuce import world, step + + +@step('I have created a Blank HTML Page$') +def i_created_blank_html_page(step): + world.create_component_instance( + step, '.large-html-icon', 'i4x://edx/templates/html/Blank_HTML_Page', + '.xmodule_HtmlModule' + ) + + +@step('I see only the HTML display name setting$') +def i_see_only_the_html_display_name(step): + world.verify_all_setting_entries([['Display Name', "Blank HTML Page", True]]) diff --git a/cms/djangoapps/contentstore/features/problem-editor.feature b/cms/djangoapps/contentstore/features/problem-editor.feature new file mode 100644 index 0000000000..6ed8c1619b --- /dev/null +++ b/cms/djangoapps/contentstore/features/problem-editor.feature @@ -0,0 +1,67 @@ +Feature: Problem Editor + As a course author, I want to be able to create problems and edit their settings. + + Scenario: User can view metadata + Given I have created a Blank Common Problem + And I edit and select Settings + Then I see five alphabetized settings and their expected values + And Edit High Level Source is not visible + + Scenario: User can modify String values + Given I have created a Blank Common Problem + And I edit and select Settings + Then I can modify the display name + And my display name change is persisted on save + + Scenario: User can specify special characters in String values + Given I have created a Blank Common Problem + And I edit and select Settings + Then I can specify special characters in the display name + And my special characters and persisted on save + + Scenario: User can revert display name to unset + Given I have created a Blank Common Problem + And I edit and select Settings + Then I can revert the display name to unset + And my display name is unset on save + + Scenario: User can select values in a Select + Given I have created a Blank Common Problem + And I edit and select Settings + Then I can select Per Student for Randomization + And my change to randomization is persisted + And I can revert to the default value for randomization + + Scenario: User can modify float input values + Given I have created a Blank Common Problem + And I edit and select Settings + Then I can set the weight to "3.5" + And my change to weight is persisted + And I can revert to the default value of unset for weight + + Scenario: User cannot type letters in float number field + Given I have created a Blank Common Problem + And I edit and select Settings + Then if I set the weight to "abc", it remains unset + + Scenario: User cannot type decimal values integer number field + Given I have created a Blank Common Problem + And I edit and select Settings + Then if I set the max attempts to "2.34", it displays initially as "234", and is persisted as "234" + + Scenario: User cannot type out of range values in an integer number field + Given I have created a Blank Common Problem + And I edit and select Settings + Then if I set the max attempts to "-3", it displays initially as "-3", and is persisted as "1" + + Scenario: Settings changes are not saved on Cancel + Given I have created a Blank Common Problem + And I edit and select Settings + Then I can set the weight to "3.5" + And I can modify the display name + Then If I press Cancel my changes are not persisted + + Scenario: Edit High Level source is available for LaTeX problem + Given I have created a LaTeX Problem + And I edit and select Settings + Then Edit High Level Source is visible diff --git a/cms/djangoapps/contentstore/features/problem-editor.py b/cms/djangoapps/contentstore/features/problem-editor.py new file mode 100644 index 0000000000..5dfcf55046 --- /dev/null +++ b/cms/djangoapps/contentstore/features/problem-editor.py @@ -0,0 +1,187 @@ +# disable missing docstring +#pylint: disable=C0111 + +from lettuce import world, step +from nose.tools import assert_equal + +DISPLAY_NAME = "Display Name" +MAXIMUM_ATTEMPTS = "Maximum Attempts" +PROBLEM_WEIGHT = "Problem Weight" +RANDOMIZATION = 'Randomization' +SHOW_ANSWER = "Show Answer" + + +############### ACTIONS #################### +@step('I have created a Blank Common Problem$') +def i_created_blank_common_problem(step): + world.create_component_instance( + step, + '.large-problem-icon', + 'i4x://edx/templates/problem/Blank_Common_Problem', + '.xmodule_CapaModule' + ) + + +@step('I edit and select Settings$') +def i_edit_and_select_settings(step): + world.edit_component_and_select_settings() + + +@step('I see five alphabetized settings and their expected values$') +def i_see_five_settings_with_values(step): + world.verify_all_setting_entries( + [ + [DISPLAY_NAME, "Blank Common Problem", True], + [MAXIMUM_ATTEMPTS, "", False], + [PROBLEM_WEIGHT, "", False], + [RANDOMIZATION, "Never", True], + [SHOW_ANSWER, "Finished", True] + ]) + + +@step('I can modify the display name') +def i_can_modify_the_display_name(step): + world.get_setting_entry(DISPLAY_NAME).find_by_css('.setting-input')[0].fill('modified') + verify_modified_display_name() + + +@step('my display name change is persisted on save') +def my_display_name_change_is_persisted_on_save(step): + world.save_component_and_reopen(step) + verify_modified_display_name() + + +@step('I can specify special characters in the display name') +def i_can_modify_the_display_name_with_special_chars(step): + world.get_setting_entry(DISPLAY_NAME).find_by_css('.setting-input')[0].fill("updated ' \" &") + verify_modified_display_name_with_special_chars() + + +@step('my special characters and persisted on save') +def special_chars_persisted_on_save(step): + world.save_component_and_reopen(step) + verify_modified_display_name_with_special_chars() + + +@step('I can revert the display name to unset') +def can_revert_display_name_to_unset(step): + world.revert_setting_entry(DISPLAY_NAME) + verify_unset_display_name() + + +@step('my display name is unset on save') +def my_display_name_is_persisted_on_save(step): + world.save_component_and_reopen(step) + verify_unset_display_name() + + +@step('I can select Per Student for Randomization') +def i_can_select_per_student_for_randomization(step): + world.browser.select(RANDOMIZATION, "Per Student") + verify_modified_randomization() + + +@step('my change to randomization is persisted') +def my_change_to_randomization_is_persisted(step): + world.save_component_and_reopen(step) + verify_modified_randomization() + + +@step('I can revert to the default value for randomization') +def i_can_revert_to_default_for_randomization(step): + world.revert_setting_entry(RANDOMIZATION) + world.save_component_and_reopen(step) + world.verify_setting_entry(world.get_setting_entry(RANDOMIZATION), RANDOMIZATION, "Always", False) + + +@step('I can set the weight to "(.*)"?') +def i_can_set_weight(step, weight): + set_weight(weight) + verify_modified_weight() + + +@step('my change to weight is persisted') +def my_change_to_weight_is_persisted(step): + world.save_component_and_reopen(step) + verify_modified_weight() + + +@step('I can revert to the default value of unset for weight') +def i_can_revert_to_default_for_unset_weight(step): + world.revert_setting_entry(PROBLEM_WEIGHT) + world.save_component_and_reopen(step) + world.verify_setting_entry(world.get_setting_entry(PROBLEM_WEIGHT), PROBLEM_WEIGHT, "", False) + + +@step('if I set the weight to "(.*)", it remains unset') +def set_the_weight_to_abc(step, bad_weight): + set_weight(bad_weight) + # We show the clear button immediately on type, hence the "True" here. + world.verify_setting_entry(world.get_setting_entry(PROBLEM_WEIGHT), PROBLEM_WEIGHT, "", True) + world.save_component_and_reopen(step) + # But no change was actually ever sent to the model, so on reopen, explicitly_set is False + world.verify_setting_entry(world.get_setting_entry(PROBLEM_WEIGHT), PROBLEM_WEIGHT, "", False) + + +@step('if I set the max attempts to "(.*)", it displays initially as "(.*)", and is persisted as "(.*)"') +def set_the_max_attempts(step, max_attempts_set, max_attempts_displayed, max_attempts_persisted): + world.get_setting_entry(MAXIMUM_ATTEMPTS).find_by_css('.setting-input')[0].fill(max_attempts_set) + world.verify_setting_entry(world.get_setting_entry(MAXIMUM_ATTEMPTS), MAXIMUM_ATTEMPTS, max_attempts_displayed, True) + world.save_component_and_reopen(step) + world.verify_setting_entry(world.get_setting_entry(MAXIMUM_ATTEMPTS), MAXIMUM_ATTEMPTS, max_attempts_persisted, True) + + +@step('Edit High Level Source is not visible') +def edit_high_level_source_not_visible(step): + verify_high_level_source(step, False) + + +@step('Edit High Level Source is visible') +def edit_high_level_source_visible(step): + verify_high_level_source(step, True) + + +@step('If I press Cancel my changes are not persisted') +def cancel_does_not_save_changes(step): + world.cancel_component(step) + step.given("I edit and select Settings") + step.given("I see five alphabetized settings and their expected values") + + +@step('I have created a LaTeX Problem') +def create_latex_problem(step): + world.click_new_component_button(step, '.large-problem-icon') + # Go to advanced tab (waiting for the tab to be visible) + world.css_find('#ui-id-2') + world.css_click('#ui-id-2') + world.click_component_from_menu("i4x://edx/templates/problem/Problem_Written_in_LaTeX", '.xmodule_CapaModule') + + +def verify_high_level_source(step, visible): + assert_equal(visible, world.is_css_present('.launch-latex-compiler')) + world.cancel_component(step) + assert_equal(visible, world.is_css_present('.upload-button')) + + +def verify_modified_weight(): + world.verify_setting_entry(world.get_setting_entry(PROBLEM_WEIGHT), PROBLEM_WEIGHT, "3.5", True) + + +def verify_modified_randomization(): + world.verify_setting_entry(world.get_setting_entry(RANDOMIZATION), RANDOMIZATION, "Per Student", True) + + +def verify_modified_display_name(): + world.verify_setting_entry(world.get_setting_entry(DISPLAY_NAME), DISPLAY_NAME, 'modified', True) + + +def verify_modified_display_name_with_special_chars(): + world.verify_setting_entry(world.get_setting_entry(DISPLAY_NAME), DISPLAY_NAME, "updated ' \" &", True) + + +def verify_unset_display_name(): + world.verify_setting_entry(world.get_setting_entry(DISPLAY_NAME), DISPLAY_NAME, '', False) + + +def set_weight(weight): + world.get_setting_entry(PROBLEM_WEIGHT).find_by_css('.setting-input')[0].fill(weight) diff --git a/cms/djangoapps/contentstore/features/section.feature b/cms/djangoapps/contentstore/features/section.feature index 24cbeb3db9..236cf501fc 100644 --- a/cms/djangoapps/contentstore/features/section.feature +++ b/cms/djangoapps/contentstore/features/section.feature @@ -3,7 +3,6 @@ Feature: Create Section As a course author I want to create and edit sections - @skip-phantom Scenario: Add a new section to a course Given I have opened a new course in Studio When I click the New Section link @@ -27,7 +26,8 @@ Feature: Create Section And I save a new section release date Then the section release date is updated - @skip-phantom + # Skipped because Ubuntu ChromeDriver hangs on alert + @skip Scenario: Delete section Given I have opened a new course in Studio And I have added a new section diff --git a/cms/djangoapps/contentstore/features/section.py b/cms/djangoapps/contentstore/features/section.py index 59c5a37b33..9a896d8ebe 100644 --- a/cms/djangoapps/contentstore/features/section.py +++ b/cms/djangoapps/contentstore/features/section.py @@ -62,7 +62,7 @@ def i_click_to_edit_section_name(step): @step('I see the complete section name with a quote in the editor$') def i_see_complete_section_name_with_quote_in_editor(step): - css = '.edit-section-name' + css = '.section-name-edit input[type=text]' assert world.is_css_present(css) assert_equal(world.browser.find_by_css(css).value, 'Section with "Quote"') diff --git a/cms/djangoapps/contentstore/features/signup.py b/cms/djangoapps/contentstore/features/signup.py index 6ca358183b..398f8d074d 100644 --- a/cms/djangoapps/contentstore/features/signup.py +++ b/cms/djangoapps/contentstore/features/signup.py @@ -18,10 +18,7 @@ def i_fill_in_the_registration_form(step): @step('I press the Create My Account button on the registration form$') def i_press_the_button_on_the_registration_form(step): submit_css = 'form#register_form button#submit' - # Workaround for click not working on ubuntu - # for some unknown reason. - e = world.css_find(submit_css) - e.type(' ') + world.css_click(submit_css) @step('I should see be on the studio home page$') diff --git a/cms/djangoapps/contentstore/features/studio-overview-togglesection.feature b/cms/djangoapps/contentstore/features/studio-overview-togglesection.feature index a0e0a48f9e..c9f5b43dfb 100644 --- a/cms/djangoapps/contentstore/features/studio-overview-togglesection.feature +++ b/cms/djangoapps/contentstore/features/studio-overview-togglesection.feature @@ -14,7 +14,6 @@ Feature: Overview Toggle Section When I navigate to the course overview page Then I do not see the "Collapse All Sections" link - @skip-phantom Scenario: Collapse link appears after creating first section of a course Given I have a course with no sections When I navigate to the course overview page @@ -22,7 +21,8 @@ Feature: Overview Toggle Section Then I see the "Collapse All Sections" link And all sections are expanded - @skip-phantom + # Skipped because Ubuntu ChromeDriver hangs on alert + @skip Scenario: Collapse link is not removed after last section of a course is deleted Given I have a course with 1 section And I navigate to the course overview page diff --git a/cms/djangoapps/contentstore/features/studio-overview-togglesection.py b/cms/djangoapps/contentstore/features/studio-overview-togglesection.py index 7f717b731c..3a39f3cc15 100644 --- a/cms/djangoapps/contentstore/features/studio-overview-togglesection.py +++ b/cms/djangoapps/contentstore/features/studio-overview-togglesection.py @@ -112,7 +112,7 @@ def all_sections_are_expanded(step): @step(u'all sections are collapsed$') -def all_sections_are_expanded(step): +def all_sections_are_collapsed(step): subsection_locator = 'div.subsection-list' subsections = world.css_find(subsection_locator) for s in subsections: diff --git a/cms/djangoapps/contentstore/features/subsection.feature b/cms/djangoapps/contentstore/features/subsection.feature index 28285bf8a1..8bb12467ff 100644 --- a/cms/djangoapps/contentstore/features/subsection.feature +++ b/cms/djangoapps/contentstore/features/subsection.feature @@ -3,14 +3,12 @@ Feature: Create Subsection As a course author I want to create and edit subsections - @skip-phantom Scenario: Add a new subsection to a section Given I have opened a new course section in Studio When I click the New Subsection link And I enter the subsection name and click save Then I see my subsection on the Courseware page - @skip-phantom Scenario: Add a new subsection (with a name containing a quote) to a section (bug #216) Given I have opened a new course section in Studio When I click the New Subsection link @@ -27,7 +25,6 @@ Feature: Create Subsection And I reload the page Then I see it marked as Homework - @skip-phantom Scenario: Set a due date in a different year (bug #256) Given I have opened a new subsection in Studio And I have set a release date and due date in different years @@ -35,7 +32,8 @@ Feature: Create Subsection And I reload the page Then I see the correct dates - @skip-phantom + # Skipped because Ubuntu ChromeDriver hangs on alert + @skip Scenario: Delete a subsection Given I have opened a new course section in Studio And I have added a new subsection diff --git a/cms/djangoapps/contentstore/features/subsection.py b/cms/djangoapps/contentstore/features/subsection.py index f9e5b52bb2..1134e53280 100644 --- a/cms/djangoapps/contentstore/features/subsection.py +++ b/cms/djangoapps/contentstore/features/subsection.py @@ -10,9 +10,7 @@ from nose.tools import assert_equal @step('I have opened a new course section in Studio$') def i_have_opened_a_new_course_section(step): - world.clear_courses() - log_into_studio() - create_a_course() + open_new_course() add_section() @@ -63,14 +61,6 @@ def test_have_set_dates_in_different_years(step): set_date_and_time('input#due_date', '01/02/2012', 'input#due_time', '04:00') -@step('I see the correct dates$') -def i_see_the_correct_dates(step): - assert_equal('12/25/2011', world.css_find('input#start_date').first.value) - assert_equal('03:00', world.css_find('input#start_time').first.value) - assert_equal('01/02/2012', world.css_find('input#due_date').first.value) - assert_equal('04:00', world.css_find('input#due_time').first.value) - - @step('I mark it as Homework$') def i_mark_it_as_homework(step): world.css_click('a.menu-toggle') @@ -101,8 +91,20 @@ def the_subsection_does_not_exist(step): assert world.browser.is_element_not_present_by_css(css) +@step('I see the correct dates$') +def i_see_the_correct_dates(step): + assert_equal('12/25/2011', get_date('input#start_date')) + assert_equal('03:00', get_date('input#start_time')) + assert_equal('01/02/2012', get_date('input#due_date')) + assert_equal('04:00', get_date('input#due_time')) + + ############ HELPER METHODS ################### +def get_date(css): + return world.css_find(css).first.value.strip() + + def save_subsection_name(name): name_css = 'input.new-subsection-name-input' save_css = 'input.new-subsection-name-save' diff --git a/cms/djangoapps/contentstore/features/video-editor.feature b/cms/djangoapps/contentstore/features/video-editor.feature new file mode 100644 index 0000000000..4c2a460042 --- /dev/null +++ b/cms/djangoapps/contentstore/features/video-editor.feature @@ -0,0 +1,13 @@ +Feature: Video Component Editor + As a course author, I want to be able to create video components. + + Scenario: User can view metadata + Given I have created a Video component + And I edit and select Settings + Then I see only the Video display name setting + + Scenario: User can modify display name + Given I have created a Video component + And I edit and select Settings + Then I can modify the display name + And my display name change is persisted on save diff --git a/cms/djangoapps/contentstore/features/video-editor.py b/cms/djangoapps/contentstore/features/video-editor.py new file mode 100644 index 0000000000..27423575c3 --- /dev/null +++ b/cms/djangoapps/contentstore/features/video-editor.py @@ -0,0 +1,9 @@ +# disable missing docstring +#pylint: disable=C0111 + +from lettuce import world, step + + +@step('I see only the video display name setting$') +def i_see_only_the_video_display_name(step): + world.verify_all_setting_entries([['Display Name', "default", True]]) diff --git a/cms/djangoapps/contentstore/features/video.feature b/cms/djangoapps/contentstore/features/video.feature new file mode 100644 index 0000000000..a4cf84d978 --- /dev/null +++ b/cms/djangoapps/contentstore/features/video.feature @@ -0,0 +1,6 @@ +Feature: Video Component + As a course author, I want to be able to view my created videos in Studio. + + Scenario: Autoplay is disabled in Studio + Given I have created a Video component + Then when I view the video it does not have autoplay enabled diff --git a/cms/djangoapps/contentstore/features/video.py b/cms/djangoapps/contentstore/features/video.py new file mode 100644 index 0000000000..f25b8d6d7e --- /dev/null +++ b/cms/djangoapps/contentstore/features/video.py @@ -0,0 +1,11 @@ +#pylint: disable=C0111 + +from lettuce import world, step + +############### ACTIONS #################### + + +@step('when I view the video it does not have autoplay enabled') +def does_not_autoplay(step): + assert world.css_find('.video')[0]['data-autoplay'] == 'False' + assert world.css_find('.video_control')[0].has_class('play') diff --git a/cms/djangoapps/contentstore/tests/test_contentstore.py b/cms/djangoapps/contentstore/tests/test_contentstore.py index 0aec61729c..0b4535bb70 100644 --- a/cms/djangoapps/contentstore/tests/test_contentstore.py +++ b/cms/djangoapps/contentstore/tests/test_contentstore.py @@ -34,6 +34,10 @@ from xmodule.course_module import CourseDescriptor from xmodule.seq_module import SequenceDescriptor from xmodule.modulestore.exceptions import ItemNotFoundError +from contentstore.views.component import ADVANCED_COMPONENT_TYPES + +from django_comment_common.utils import are_permissions_roles_seeded + TEST_DATA_MODULESTORE = copy.deepcopy(settings.MODULESTORE) TEST_DATA_MODULESTORE['default']['OPTIONS']['fs_root'] = path('common/test/data') TEST_DATA_MODULESTORE['direct']['OPTIONS']['fs_root'] = path('common/test/data') @@ -45,7 +49,7 @@ class MongoCollectionFindWrapper(object): self.counter = 0 def find(self, query, *args, **kwargs): - self.counter = self.counter+1 + self.counter = self.counter + 1 return self.original(query, *args, **kwargs) @@ -73,8 +77,33 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): self.client = Client() self.client.login(username=uname, password=password) + def test_advanced_components_in_edit_unit(self): + store = modulestore('direct') + import_from_xml(store, 'common/test/data/', ['simple']) + + course = store.get_item(Location(['i4x', 'edX', 'simple', + 'course', '2012_Fall', None]), depth=None) + + course.advanced_modules = ADVANCED_COMPONENT_TYPES + + store.update_metadata(course.location, own_metadata(course)) + + # just pick one vertical + descriptor = store.get_items(Location('i4x', 'edX', 'simple', 'vertical', None, None))[0] + + resp = self.client.get(reverse('edit_unit', kwargs={'location': descriptor.location.url()})) + self.assertEqual(resp.status_code, 200) + + # This could be made better, but for now let's just assert that we see the advanced modules mentioned in the page + # response HTML + self.assertIn('Video Alpha', resp.content) + self.assertIn('Word cloud', resp.content) + self.assertIn('Annotation', resp.content) + self.assertIn('Open Ended Response', resp.content) + self.assertIn('Peer Grading Interface', resp.content) + def check_edit_unit(self, test_course_name): - import_from_xml(modulestore(), 'common/test/data/', [test_course_name]) + import_from_xml(modulestore('direct'), 'common/test/data/', [test_course_name]) for descriptor in modulestore().get_items(Location(None, None, 'vertical', None, None)): print "Checking ", descriptor.location.url() @@ -101,7 +130,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): Unfortunately, None = published for the revision field, so get_items() would return both draft and non-draft copies. ''' - store = modulestore() + store = modulestore('direct') draft_store = modulestore('draft') import_from_xml(store, 'common/test/data/', ['simple']) @@ -128,7 +157,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): module as 'own-metadata' when publishing. Also verifies the metadata inheritance is properly computed ''' - store = modulestore() + store = modulestore('direct') draft_store = modulestore('draft') import_from_xml(store, 'common/test/data/', ['simple']) @@ -186,7 +215,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): self.assertEqual(html_module.lms.graceperiod, new_graceperiod) def test_get_depth_with_drafts(self): - import_from_xml(modulestore(), 'common/test/data/', ['simple']) + import_from_xml(modulestore('direct'), 'common/test/data/', ['simple']) course = modulestore('draft').get_item( Location(['i4x', 'edX', 'simple', 'course', '2012_Fall', None]), @@ -221,17 +250,17 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): self.assertEqual(num_drafts, 1) def test_import_textbook_as_content_element(self): - import_from_xml(modulestore(), 'common/test/data/', ['full']) - module_store = modulestore('direct') + import_from_xml(module_store, 'common/test/data/', ['full']) + course = module_store.get_item(Location(['i4x', 'edX', 'full', 'course', '6.002_Spring_2012', None])) self.assertGreater(len(course.textbooks), 0) def test_static_tab_reordering(self): - import_from_xml(modulestore(), 'common/test/data/', ['full']) - module_store = modulestore('direct') + import_from_xml(module_store, 'common/test/data/', ['full']) + course = module_store.get_item(Location(['i4x', 'edX', 'full', 'course', '6.002_Spring_2012', None])) # reverse the ordering @@ -253,10 +282,8 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): self.assertEqual(reverse_tabs, course_tabs) def test_import_polls(self): - import_from_xml(modulestore(), 'common/test/data/', ['full']) - module_store = modulestore('direct') - found = False + import_from_xml(module_store, 'common/test/data/', ['full']) items = module_store.get_items(['i4x', 'edX', 'full', 'poll_question', None, None]) found = len(items) > 0 @@ -270,9 +297,8 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): self.assertGreater(err_cnt, 0) def test_delete(self): - import_from_xml(modulestore(), 'common/test/data/', ['full']) - direct_store = modulestore('direct') + import_from_xml(direct_store, 'common/test/data/', ['full']) sequential = direct_store.get_item(Location(['i4x', 'edX', 'full', 'sequential', 'Administrivia_and_Circuit_Elements', None])) @@ -306,8 +332,9 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): This test case verifies that a course can use specialized override for about data, e.g. /about/Fall_2012/effort.html while there is a base definition in /about/effort.html ''' - import_from_xml(modulestore(), 'common/test/data/', ['full']) module_store = modulestore('direct') + import_from_xml(module_store, 'common/test/data/', ['full']) + effort = module_store.get_item(Location(['i4x', 'edX', 'full', 'about', 'effort', None])) self.assertEqual(effort.data, '6 hours') @@ -316,9 +343,8 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): self.assertEqual(effort.data, 'TBD') def test_remove_hide_progress_tab(self): - import_from_xml(modulestore(), 'common/test/data/', ['full']) - module_store = modulestore('direct') + import_from_xml(module_store, 'common/test/data/', ['full']) source_location = CourseDescriptor.id_to_location('edX/full/6.002_Spring_2012') course = module_store.get_item(source_location) @@ -333,14 +359,14 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): 'display_name': 'Robot Super Course', } - import_from_xml(modulestore(), 'common/test/data/', ['full']) + module_store = modulestore('direct') + import_from_xml(module_store, 'common/test/data/', ['full']) resp = self.client.post(reverse('create_new_course'), course_data) self.assertEqual(resp.status_code, 200) data = parse_json(resp) self.assertEqual(data['id'], 'i4x://MITx/999/course/Robot_Super_Course') - module_store = modulestore('direct') content_store = contentstore() source_location = CourseDescriptor.id_to_location('edX/full/6.002_Spring_2012') @@ -355,7 +381,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): clone_items = module_store.get_items(Location(['i4x', 'MITx', '999', 'vertical', None])) self.assertGreater(len(clone_items), 0) for descriptor in items: - new_loc = descriptor.location._replace(org='MITx', course='999') + new_loc = descriptor.location.replace(org='MITx', course='999') print "Checking {0} should now also be at {1}".format(descriptor.location.url(), new_loc.url()) resp = self.client.get(reverse('edit_unit', kwargs={'location': new_loc.url()})) self.assertEqual(resp.status_code, 200) @@ -365,9 +391,9 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): self.assertEqual(resp.status_code, 400) def test_delete_course(self): - import_from_xml(modulestore(), 'common/test/data/', ['full']) - module_store = modulestore('direct') + import_from_xml(module_store, 'common/test/data/', ['full']) + content_store = contentstore() location = CourseDescriptor.id_to_location('edX/full/6.002_Spring_2012') @@ -378,15 +404,15 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): self.assertEqual(len(items), 0) def verify_content_existence(self, modulestore, root_dir, location, dirname, category_name, filename_suffix=''): - fs = OSFS(root_dir / 'test_export') - self.assertTrue(fs.exists(dirname)) + filesystem = OSFS(root_dir / 'test_export') + self.assertTrue(filesystem.exists(dirname)) query_loc = Location('i4x', location.org, location.course, category_name, None) items = modulestore.get_items(query_loc) for item in items: - fs = OSFS(root_dir / ('test_export/' + dirname)) - self.assertTrue(fs.exists(item.location.name + filename_suffix)) + filesystem = OSFS(root_dir / ('test_export/' + dirname)) + self.assertTrue(filesystem.exists(item.location.name + filename_suffix)) def test_export_course(self): module_store = modulestore('direct') @@ -418,7 +444,7 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): # add private to list of children sequential = module_store.get_item(Location(['i4x', 'edX', 'full', 'sequential', 'Administrivia_and_Circuit_Elements', None])) - private_location_no_draft = private_vertical.location._replace(revision=None) + private_location_no_draft = private_vertical.location.replace(revision=None) module_store.update_children(sequential.location, sequential.children + [private_location_no_draft.url()]) @@ -443,20 +469,20 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): self.verify_content_existence(module_store, root_dir, location, 'custom_tags', 'custom_tag_template') # check for graiding_policy.json - fs = OSFS(root_dir / 'test_export/policies/6.002_Spring_2012') - self.assertTrue(fs.exists('grading_policy.json')) + filesystem = OSFS(root_dir / 'test_export/policies/6.002_Spring_2012') + self.assertTrue(filesystem.exists('grading_policy.json')) course = module_store.get_item(location) # compare what's on disk compared to what we have in our course - with fs.open('grading_policy.json', 'r') as grading_policy: + with filesystem.open('grading_policy.json', 'r') as grading_policy: on_disk = loads(grading_policy.read()) self.assertEqual(on_disk, course.grading_policy) #check for policy.json - self.assertTrue(fs.exists('policy.json')) + self.assertTrue(filesystem.exists('policy.json')) # compare what's on disk to what we have in the course module - with fs.open('policy.json', 'r') as course_policy: + with filesystem.open('policy.json', 'r') as course_policy: on_disk = loads(course_policy.read()) self.assertIn('course/6.002_Spring_2012', on_disk) self.assertEqual(on_disk['course/6.002_Spring_2012'], own_metadata(course)) @@ -523,8 +549,9 @@ class ContentStoreToyCourseTest(ModuleStoreTestCase): self.assertContains(resp, '/c4x/edX/full/asset/handouts_schematic_tutorial.pdf') def test_prefetch_children(self): - import_from_xml(modulestore(), 'common/test/data/', ['full']) module_store = modulestore('direct') + import_from_xml(module_store, 'common/test/data/', ['full']) + location = CourseDescriptor.id_to_location('edX/full/6.002_Spring_2012') wrapper = MongoCollectionFindWrapper(module_store.collection.find) @@ -610,6 +637,14 @@ class ContentStoreTest(ModuleStoreTestCase): data = parse_json(resp) self.assertEqual(data['id'], 'i4x://MITx/999/course/Robot_Super_Course') + def test_create_course_check_forum_seeding(self): + """Test new course creation and verify forum seeding """ + resp = self.client.post(reverse('create_new_course'), self.course_data) + self.assertEqual(resp.status_code, 200) + data = parse_json(resp) + self.assertEqual(data['id'], 'i4x://MITx/999/course/Robot_Super_Course') + self.assertTrue(are_permissions_roles_seeded('MITx/999/Robot_Super_Course')) + def test_create_course_duplicate_course(self): """Test new course creation - error path""" resp = self.client.post(reverse('create_new_course'), self.course_data) @@ -736,7 +771,7 @@ class ContentStoreTest(ModuleStoreTestCase): Import and walk through some common URL endpoints. This just verifies non-500 and no other correct behavior, so it is not a deep test """ - import_from_xml(modulestore(), 'common/test/data/', ['simple']) + import_from_xml(modulestore('direct'), 'common/test/data/', ['simple']) loc = Location(['i4x', 'edX', 'simple', 'course', '2012_Fall', None]) resp = self.client.get(reverse('course_index', kwargs={'org': loc.org, @@ -803,44 +838,46 @@ class ContentStoreTest(ModuleStoreTestCase): self.assertEqual(200, resp.status_code) # go look at a subsection page - subsection_location = loc._replace(category='sequential', name='test_sequence') + subsection_location = loc.replace(category='sequential', name='test_sequence') resp = self.client.get(reverse('edit_subsection', kwargs={'location': subsection_location.url()})) self.assertEqual(200, resp.status_code) # go look at the Edit page - unit_location = loc._replace(category='vertical', name='test_vertical') + unit_location = loc.replace(category='vertical', name='test_vertical') resp = self.client.get(reverse('edit_unit', kwargs={'location': unit_location.url()})) self.assertEqual(200, resp.status_code) # delete a component - del_loc = loc._replace(category='html', name='test_html') + del_loc = loc.replace(category='html', name='test_html') resp = self.client.post(reverse('delete_item'), json.dumps({'id': del_loc.url()}), "application/json") self.assertEqual(200, resp.status_code) # delete a unit - del_loc = loc._replace(category='vertical', name='test_vertical') + del_loc = loc.replace(category='vertical', name='test_vertical') resp = self.client.post(reverse('delete_item'), json.dumps({'id': del_loc.url()}), "application/json") self.assertEqual(200, resp.status_code) # delete a unit - del_loc = loc._replace(category='sequential', name='test_sequence') + del_loc = loc.replace(category='sequential', name='test_sequence') resp = self.client.post(reverse('delete_item'), json.dumps({'id': del_loc.url()}), "application/json") self.assertEqual(200, resp.status_code) # delete a chapter - del_loc = loc._replace(category='chapter', name='chapter_2') + del_loc = loc.replace(category='chapter', name='chapter_2') resp = self.client.post(reverse('delete_item'), json.dumps({'id': del_loc.url()}), "application/json") self.assertEqual(200, resp.status_code) + def test_import_metadata_with_attempts_empty_string(self): - import_from_xml(modulestore(), 'common/test/data/', ['simple']) module_store = modulestore('direct') + import_from_xml(module_store, 'common/test/data/', ['simple']) + did_load_item = False try: module_store.get_item(Location(['i4x', 'edX', 'simple', 'problem', 'ps01-simple', None])) @@ -852,8 +889,9 @@ class ContentStoreTest(ModuleStoreTestCase): self.assertTrue(did_load_item) def test_forum_id_generation(self): - import_from_xml(modulestore(), 'common/test/data/', ['full']) module_store = modulestore('direct') + import_from_xml(module_store, 'common/test/data/', ['full']) + new_component_location = Location('i4x', 'edX', 'full', 'discussion', 'new_component') source_template_location = Location('i4x', 'edx', 'templates', 'discussion', 'Discussion_Tag') @@ -865,9 +903,8 @@ class ContentStoreTest(ModuleStoreTestCase): self.assertNotEquals(new_discussion_item.discussion_id, '$$GUID$$') def test_update_modulestore_signal_did_fire(self): - - import_from_xml(modulestore(), 'common/test/data/', ['full']) module_store = modulestore('direct') + import_from_xml(module_store, 'common/test/data/', ['full']) try: module_store.modulestore_update_signal = Signal(providing_args=['modulestore', 'course_id', 'location']) @@ -891,9 +928,9 @@ class ContentStoreTest(ModuleStoreTestCase): self.assertTrue(self.got_signal) def test_metadata_inheritance(self): - import_from_xml(modulestore(), 'common/test/data/', ['full']) - module_store = modulestore('direct') + import_from_xml(module_store, 'common/test/data/', ['full']) + course = module_store.get_item(Location(['i4x', 'edX', 'full', 'course', '6.002_Spring_2012', None])) verticals = module_store.get_items(['i4x', 'edX', 'full', 'vertical', None, None]) diff --git a/cms/djangoapps/contentstore/tests/test_course_settings.py b/cms/djangoapps/contentstore/tests/test_course_settings.py index c9f6b2053e..2a4ff46038 100644 --- a/cms/djangoapps/contentstore/tests/test_course_settings.py +++ b/cms/djangoapps/contentstore/tests/test_course_settings.py @@ -17,7 +17,6 @@ from xmodule.modulestore.tests.factories import CourseFactory from models.settings.course_metadata import CourseMetadata from xmodule.modulestore.xml_importer import import_from_xml -from xmodule.modulestore.django import modulestore from xmodule.fields import Date @@ -256,7 +255,7 @@ class CourseMetadataEditingTest(CourseTestCase): def setUp(self): CourseTestCase.setUp(self) # add in the full class too - import_from_xml(modulestore(), 'common/test/data/', ['full']) + import_from_xml(get_modulestore(self.course_location), 'common/test/data/', ['full']) self.fullcourse_location = Location(['i4x', 'edX', 'full', 'course', '6.002_Spring_2012', None]) def test_fetch_initial_fields(self): diff --git a/cms/djangoapps/contentstore/tests/test_item.py b/cms/djangoapps/contentstore/tests/test_item.py new file mode 100644 index 0000000000..07264cdc30 --- /dev/null +++ b/cms/djangoapps/contentstore/tests/test_item.py @@ -0,0 +1,29 @@ +from contentstore.utils import get_modulestore, get_url_reverse +from contentstore.tests.test_course_settings import CourseTestCase +from xmodule.modulestore.tests.factories import CourseFactory +from django.core.urlresolvers import reverse + + +class DeleteItem(CourseTestCase): + def setUp(self): + """ Creates the test course with a static page in it. """ + super(DeleteItem, self).setUp() + self.course = CourseFactory.create(org='mitX', number='333', display_name='Dummy Course') + + def testDeleteStaticPage(self): + # Add static tab + data = { + 'parent_location': 'i4x://mitX/333/course/Dummy_Course', + 'template': 'i4x://edx/templates/static_tab/Empty' + } + + resp = self.client.post(reverse('clone_item'), data) + self.assertEqual(resp.status_code, 200) + + # Now delete it. There was a bug that the delete was failing (static tabs do not exist in draft modulestore). + resp = self.client.post(reverse('delete_item'), resp.content, "application/json") + self.assertEqual(resp.status_code, 200) + + + + diff --git a/cms/djangoapps/contentstore/tests/test_utils.py b/cms/djangoapps/contentstore/tests/test_utils.py index eb7bfb6db9..c4b0f4bb51 100644 --- a/cms/djangoapps/contentstore/tests/test_utils.py +++ b/cms/djangoapps/contentstore/tests/test_utils.py @@ -1,7 +1,10 @@ """ Tests for utils. """ from contentstore import utils import mock +import collections +import copy from django.test import TestCase +from django.test.utils import override_settings from xmodule.modulestore.tests.factories import CourseFactory from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase @@ -9,11 +12,28 @@ from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase class LMSLinksTestCase(TestCase): """ Tests for LMS links. """ def about_page_test(self): - """ Get URL for about page. """ + """ Get URL for about page, no marketing site """ + # default for ENABLE_MKTG_SITE is False. + self.assertEquals(self.get_about_page_link(), "//localhost:8000/courses/mitX/101/test/about") + + @override_settings(MKTG_URLS={'ROOT': 'dummy-root'}) + def about_page_marketing_site_test(self): + """ Get URL for about page, marketing root present. """ + with mock.patch.dict('django.conf.settings.MITX_FEATURES', {'ENABLE_MKTG_SITE': True}): + self.assertEquals(self.get_about_page_link(), "//dummy-root/courses/mitX/101/test/about") + with mock.patch.dict('django.conf.settings.MITX_FEATURES', {'ENABLE_MKTG_SITE': False}): + self.assertEquals(self.get_about_page_link(), "//localhost:8000/courses/mitX/101/test/about") + + @override_settings(LMS_BASE=None) + def about_page_no_lms_base_test(self): + """ No LMS_BASE, nor is ENABLE_MKTG_SITE True """ + self.assertEquals(self.get_about_page_link(), None) + + def get_about_page_link(self): + """ create mock course and return the about page link """ location = 'i4x', 'mitX', '101', 'course', 'test' utils.get_course_id = mock.Mock(return_value="mitX/101/test") - link = utils.get_lms_link_for_about_page(location) - self.assertEquals(link, "//localhost:8000/courses/mitX/101/test/about") + return utils.get_lms_link_for_about_page(location) def lms_link_test(self): """ Tests get_lms_link_for_item. """ @@ -24,7 +44,7 @@ class LMSLinksTestCase(TestCase): link = utils.get_lms_link_for_item(location, True) self.assertEquals( link, - "//preview.localhost:8000/courses/mitX/101/test/jump_to/i4x://mitX/101/vertical/contacting_us" + "//preview/courses/mitX/101/test/jump_to/i4x://mitX/101/vertical/contacting_us" ) @@ -70,3 +90,79 @@ class UrlReverseTestCase(ModuleStoreTestCase): 'https://edge.edx.org/courses/edX/edX101/How_to_Create_an_edX_Course/about', utils.get_url_reverse('https://edge.edx.org/courses/edX/edX101/How_to_Create_an_edX_Course/about', course) ) + + +class ExtraPanelTabTestCase(TestCase): + """ Tests adding and removing extra course tabs. """ + + def get_tab_type_dicts(self, tab_types): + """ Returns an array of tab dictionaries. """ + if tab_types: + return [{'tab_type': tab_type} for tab_type in tab_types.split(',')] + else: + return [] + + def get_course_with_tabs(self, tabs=[]): + """ Returns a mock course object with a tabs attribute. """ + course = collections.namedtuple('MockCourse', ['tabs']) + if isinstance(tabs, basestring): + course.tabs = self.get_tab_type_dicts(tabs) + else: + course.tabs = tabs + return course + + def test_add_extra_panel_tab(self): + """ Tests if a tab can be added to a course tab list. """ + for tab_type in utils.EXTRA_TAB_PANELS.keys(): + tab = utils.EXTRA_TAB_PANELS.get(tab_type) + + # test adding with changed = True + for tab_setup in ['', 'x', 'x,y,z']: + course = self.get_course_with_tabs(tab_setup) + expected_tabs = copy.copy(course.tabs) + expected_tabs.append(tab) + changed, actual_tabs = utils.add_extra_panel_tab(tab_type, course) + self.assertTrue(changed) + self.assertEqual(actual_tabs, expected_tabs) + + # test adding with changed = False + tab_test_setup = [ + [tab], + [tab, self.get_tab_type_dicts('x,y,z')], + [self.get_tab_type_dicts('x,y'), tab, self.get_tab_type_dicts('z')], + [self.get_tab_type_dicts('x,y,z'), tab]] + + for tab_setup in tab_test_setup: + course = self.get_course_with_tabs(tab_setup) + expected_tabs = copy.copy(course.tabs) + changed, actual_tabs = utils.add_extra_panel_tab(tab_type, course) + self.assertFalse(changed) + self.assertEqual(actual_tabs, expected_tabs) + + def test_remove_extra_panel_tab(self): + """ Tests if a tab can be removed from a course tab list. """ + for tab_type in utils.EXTRA_TAB_PANELS.keys(): + tab = utils.EXTRA_TAB_PANELS.get(tab_type) + + # test removing with changed = True + tab_test_setup = [ + [tab], + [tab, self.get_tab_type_dicts('x,y,z')], + [self.get_tab_type_dicts('x,y'), tab, self.get_tab_type_dicts('z')], + [self.get_tab_type_dicts('x,y,z'), tab]] + + for tab_setup in tab_test_setup: + course = self.get_course_with_tabs(tab_setup) + expected_tabs = [t for t in course.tabs if t != utils.EXTRA_TAB_PANELS.get(tab_type)] + changed, actual_tabs = utils.remove_extra_panel_tab(tab_type, course) + self.assertTrue(changed) + self.assertEqual(actual_tabs, expected_tabs) + + # test removing with changed = False + for tab_setup in ['', 'x', 'x,y,z']: + course = self.get_course_with_tabs(tab_setup) + expected_tabs = copy.copy(course.tabs) + changed, actual_tabs = utils.remove_extra_panel_tab(tab_type, course) + self.assertFalse(changed) + self.assertEqual(actual_tabs, expected_tabs) + diff --git a/cms/djangoapps/contentstore/tests/tests.py b/cms/djangoapps/contentstore/tests/tests.py index 34e5da4b4d..f769652493 100644 --- a/cms/djangoapps/contentstore/tests/tests.py +++ b/cms/djangoapps/contentstore/tests/tests.py @@ -111,6 +111,18 @@ class AuthTestCase(ContentStoreTestCase): # Now login should work self.login(self.email, self.pw) + def test_login_link_on_activation_age(self): + self.create_account(self.username, self.email, self.pw) + # we want to test the rendering of the activation page when the user isn't logged in + self.client.logout() + resp = self._activate_user(self.email) + self.assertEqual(resp.status_code, 200) + + # check the the HTML has links to the right login page. Note that this is merely a content + # check and thus could be fragile should the wording change on this page + expected = 'You can now login.' + self.assertIn(expected, resp.content) + def test_private_pages_auth(self): """Make sure pages that do require login work.""" auth_pages = ( diff --git a/cms/djangoapps/contentstore/utils.py b/cms/djangoapps/contentstore/utils.py index a5a3b47bce..703e9a266a 100644 --- a/cms/djangoapps/contentstore/utils.py +++ b/cms/djangoapps/contentstore/utils.py @@ -9,6 +9,8 @@ DIRECT_ONLY_CATEGORIES = ['course', 'chapter', 'sequential', 'about', 'static_ta #In order to instantiate an open ended tab automatically, need to have this data OPEN_ENDED_PANEL = {"name": "Open Ended Panel", "type": "open_ended"} +NOTES_PANEL = {"name": "My Notes", "type": "notes"} +EXTRA_TAB_PANELS = dict([(p['type'], p) for p in [OPEN_ENDED_PANEL, NOTES_PANEL]]) def get_modulestore(location): @@ -86,7 +88,7 @@ def get_lms_link_for_item(location, preview=False, course_id=None): if settings.LMS_BASE is not None: if preview: - lms_base = settings.MITX_FEATURES.get('PREVIEW_LMS_BASE', 'preview.' + settings.LMS_BASE) + lms_base = settings.MITX_FEATURES.get('PREVIEW_LMS_BASE') else: lms_base = settings.LMS_BASE @@ -105,9 +107,18 @@ def get_lms_link_for_about_page(location): """ Returns the url to the course about page from the location tuple. """ - if settings.LMS_BASE is not None: - lms_link = "//{lms_base}/courses/{course_id}/about".format( - lms_base=settings.LMS_BASE, + if settings.MITX_FEATURES.get('ENABLE_MKTG_SITE', False): + # Root will be "www.edx.org". The complete URL will still not be exactly correct, + # but redirects exist from www.edx.org to get to the drupal course about page URL. + about_base = settings.MKTG_URLS.get('ROOT') + elif settings.LMS_BASE is not None: + about_base = settings.LMS_BASE + else: + about_base = None + + if about_base is not None: + lms_link = "//{about_base_url}/courses/{course_id}/about".format( + about_base_url=about_base, course_id=get_course_id(location) ) else: @@ -192,9 +203,10 @@ class CoursePageNames: Checklists = "checklists" -def add_open_ended_panel_tab(course): +def add_extra_panel_tab(tab_type, course): """ - Used to add the open ended panel tab to a course if it does not exist. + Used to add the panel tab to a course if it does not exist. + @param tab_type: A string representing the tab type. @param course: A course object from the modulestore. @return: Boolean indicating whether or not a tab was added and a list of tabs for the course. """ @@ -202,16 +214,19 @@ def add_open_ended_panel_tab(course): course_tabs = copy.copy(course.tabs) changed = False #Check to see if open ended panel is defined in the course - if OPEN_ENDED_PANEL not in course_tabs: + + tab_panel = EXTRA_TAB_PANELS.get(tab_type) + if tab_panel not in course_tabs: #Add panel to the tabs if it is not defined - course_tabs.append(OPEN_ENDED_PANEL) + course_tabs.append(tab_panel) changed = True return changed, course_tabs -def remove_open_ended_panel_tab(course): +def remove_extra_panel_tab(tab_type, course): """ - Used to remove the open ended panel tab from a course if it exists. + Used to remove the panel tab from a course if it exists. + @param tab_type: A string representing the tab type. @param course: A course object from the modulestore. @return: Boolean indicating whether or not a tab was added and a list of tabs for the course. """ @@ -219,8 +234,10 @@ def remove_open_ended_panel_tab(course): course_tabs = copy.copy(course.tabs) changed = False #Check to see if open ended panel is defined in the course - if OPEN_ENDED_PANEL in course_tabs: + + tab_panel = EXTRA_TAB_PANELS.get(tab_type) + if tab_panel in course_tabs: #Add panel to the tabs if it is not defined - course_tabs = [ct for ct in course_tabs if ct != OPEN_ENDED_PANEL] + course_tabs = [ct for ct in course_tabs if ct != tab_panel] changed = True return changed, course_tabs diff --git a/cms/djangoapps/contentstore/views/component.py b/cms/djangoapps/contentstore/views/component.py index 5127effae6..8120e08107 100644 --- a/cms/djangoapps/contentstore/views/component.py +++ b/cms/djangoapps/contentstore/views/component.py @@ -41,7 +41,8 @@ log = logging.getLogger(__name__) COMPONENT_TYPES = ['customtag', 'discussion', 'html', 'problem', 'video'] OPEN_ENDED_COMPONENT_TYPES = ["combinedopenended", "peergrading"] -ADVANCED_COMPONENT_TYPES = ['annotatable', 'word_cloud'] + OPEN_ENDED_COMPONENT_TYPES +NOTE_COMPONENT_TYPES = ['notes'] +ADVANCED_COMPONENT_TYPES = ['annotatable', 'word_cloud', 'videoalpha'] + OPEN_ENDED_COMPONENT_TYPES + NOTE_COMPONENT_TYPES ADVANCED_COMPONENT_CATEGORY = 'advanced' ADVANCED_COMPONENT_POLICY_KEY = 'advanced_modules' @@ -148,8 +149,7 @@ def edit_unit(request, location): component_templates[category].append(( template.display_name_with_default, template.location.url(), - hasattr(template, 'markdown') and template.markdown is not None, - template.cms.empty, + hasattr(template, 'markdown') and template.markdown is not None )) components = [ @@ -178,8 +178,7 @@ def edit_unit(request, location): break index = index + 1 - preview_lms_base = settings.MITX_FEATURES.get('PREVIEW_LMS_BASE', - 'preview.' + settings.LMS_BASE) + preview_lms_base = settings.MITX_FEATURES.get('PREVIEW_LMS_BASE') preview_lms_link = '//{preview_lms_base}/courses/{org}/{course}/{course_name}/courseware/{section}/{subsection}/{index}'.format( preview_lms_base=preview_lms_base, diff --git a/cms/djangoapps/contentstore/views/course.py b/cms/djangoapps/contentstore/views/course.py index c6fa340f67..07f6b9669c 100644 --- a/cms/djangoapps/contentstore/views/course.py +++ b/cms/djangoapps/contentstore/views/course.py @@ -13,17 +13,13 @@ from django.core.urlresolvers import reverse from mitxmako.shortcuts import render_to_response from xmodule.modulestore.django import modulestore -from xmodule.modulestore.exceptions \ - import ItemNotFoundError, InvalidLocationError + +from xmodule.modulestore.exceptions import ItemNotFoundError, InvalidLocationError from xmodule.modulestore import Location -from contentstore.course_info_model \ - import get_course_updates, update_course_updates, delete_course_update -from contentstore.utils \ - import get_lms_link_for_item, add_open_ended_panel_tab, \ - remove_open_ended_panel_tab -from models.settings.course_details \ - import CourseDetails, CourseSettingsEncoder +from contentstore.course_info_model import get_course_updates, update_course_updates, delete_course_update +from contentstore.utils import get_lms_link_for_item, add_extra_panel_tab, remove_extra_panel_tab +from models.settings.course_details import CourseDetails, CourseSettingsEncoder from models.settings.course_grading import CourseGradingModel from models.settings.course_metadata import CourseMetadata from auth.authz import create_all_course_groups @@ -32,7 +28,12 @@ from util.json_request import expect_json from .access import has_access, get_location_and_verify_access from .requests import get_request_method from .tabs import initialize_course_tabs -from .component import OPEN_ENDED_COMPONENT_TYPES, ADVANCED_COMPONENT_POLICY_KEY +from .component import OPEN_ENDED_COMPONENT_TYPES, \ + NOTE_COMPONENT_TYPES, ADVANCED_COMPONENT_POLICY_KEY + +from django_comment_common.utils import seed_permissions_roles + +# TODO: should explicitly enumerate exports with __all__ __all__ = ['course_index', 'create_new_course', 'course_info', 'course_info_updates', 'get_course_settings', @@ -135,6 +136,9 @@ def create_new_course(request): create_all_course_groups(request.user, new_course.location) + # seed the forums + seed_permissions_roles(new_course.location.course_id) + return HttpResponse(json.dumps({'id': new_course.location.url()})) @@ -352,38 +356,52 @@ def course_advanced_updates(request, org, course, name): request_body = json.loads(request.body) # Whether or not to filter the tabs key out of the settings metadata filter_tabs = True - # Check to see if the user instantiated any advanced components. - # This is a hack to add the open ended panel tab - # to a course automatically if the user has indicated that they want - # to edit the combinedopenended or peergrading - # module, and to remove it if they have removed the open ended elements. + + #Check to see if the user instantiated any advanced components. This is a hack + #that does the following : + # 1) adds/removes the open ended panel tab to a course automatically if the user + # has indicated that they want to edit the combinedopendended or peergrading module + # 2) adds/removes the notes panel tab to a course automatically if the user has + # indicated that they want the notes module enabled in their course + # TODO refactor the above into distinct advanced policy settings if ADVANCED_COMPONENT_POLICY_KEY in request_body: - # Check to see if the user instantiated any open ended components - found_oe_type = False - # Get the course so that we can scrape current tabs + #Get the course so that we can scrape current tabs course_module = modulestore().get_item(location) - for oe_type in OPEN_ENDED_COMPONENT_TYPES: - if oe_type in request_body[ADVANCED_COMPONENT_POLICY_KEY]: - # Add an open ended tab to the course if needed - changed, new_tabs = add_open_ended_panel_tab(course_module) - # If a tab has been added to the course, then send the - # metadata along to CourseMetadata.update_from_json + + #Maps tab types to components + tab_component_map = { + 'open_ended': OPEN_ENDED_COMPONENT_TYPES, + 'notes': NOTE_COMPONENT_TYPES, + } + + #Check to see if the user instantiated any notes or open ended components + for tab_type in tab_component_map.keys(): + component_types = tab_component_map.get(tab_type) + found_ac_type = False + for ac_type in component_types: + if ac_type in request_body[ADVANCED_COMPONENT_POLICY_KEY]: + #Add tab to the course if needed + changed, new_tabs = add_extra_panel_tab(tab_type, course_module) + #If a tab has been added to the course, then send the metadata along to CourseMetadata.update_from_json + if changed: + course_module.tabs = new_tabs + request_body.update({'tabs': new_tabs}) + #Indicate that tabs should not be filtered out of the metadata + filter_tabs = False + #Set this flag to avoid the tab removal code below. + found_ac_type = True + break + #If we did not find a module type in the advanced settings, + # we may need to remove the tab from the course. + if not found_ac_type: + #Remove tab from the course if needed + changed, new_tabs = remove_extra_panel_tab(tab_type, course_module) if changed: + course_module.tabs = new_tabs request_body.update({'tabs': new_tabs}) - # Indicate that tabs should not be filtered out of the metadata + #Indicate that tabs should *not* be filtered out of the metadata filter_tabs = False - # Set this flag to avoid the open ended tab removal code below. - found_oe_type = True - break - # If we did not find an open ended module type in the advanced settings, - # we may need to remove the open ended tab from the course. - if not found_oe_type: - # Remove open ended tab to the course if needed - changed, new_tabs = remove_open_ended_panel_tab(course_module) - if changed: - request_body.update({'tabs': new_tabs}) - # Indicate that tabs should not be filtered out of the metadata - filter_tabs = False + response_json = json.dumps(CourseMetadata.update_from_json(location, request_body, filter_tabs=filter_tabs)) diff --git a/cms/djangoapps/contentstore/views/item.py b/cms/djangoapps/contentstore/views/item.py index 67a4ad4e0c..25094ddcfe 100644 --- a/cms/djangoapps/contentstore/views/item.py +++ b/cms/djangoapps/contentstore/views/item.py @@ -113,7 +113,7 @@ def delete_item(request): delete_children = request.POST.get('delete_children', False) delete_all_versions = request.POST.get('delete_all_versions', False) - store = modulestore() + store = get_modulestore(item_location) item = store.get_item(item_location) diff --git a/cms/djangoapps/contentstore/views/public.py b/cms/djangoapps/contentstore/views/public.py index 0433aa9e9d..0ee228b996 100644 --- a/cms/djangoapps/contentstore/views/public.py +++ b/cms/djangoapps/contentstore/views/public.py @@ -8,7 +8,7 @@ from mitxmako.shortcuts import render_to_response from external_auth.views import ssl_login_shortcut from .user import index -__all__ = ['signup', 'old_login_redirect', 'login_page', 'howitworks', 'ux_alerts'] +__all__ = ['signup', 'old_login_redirect', 'login_page', 'howitworks'] """ Public views @@ -49,10 +49,3 @@ def howitworks(request): return index(request) else: return render_to_response('howitworks.html', {}) - - -def ux_alerts(request): - """ - static/proof-of-concept views - """ - return render_to_response('ux-alerts.html', {}) diff --git a/cms/djangoapps/contentstore/views/requests.py b/cms/djangoapps/contentstore/views/requests.py index b02a13fe3f..c493441c77 100644 --- a/cms/djangoapps/contentstore/views/requests.py +++ b/cms/djangoapps/contentstore/views/requests.py @@ -21,7 +21,7 @@ def event(request): A noop to swallow the analytics call so that cms methods don't spook and poor developers looking at console logs don't get distracted :-) ''' - return HttpResponse(True) + return HttpResponse(status=204) def get_request_method(request): diff --git a/cms/envs/acceptance.py b/cms/envs/acceptance.py index 1e7a32dc68..36616ab257 100644 --- a/cms/envs/acceptance.py +++ b/cms/envs/acceptance.py @@ -2,33 +2,52 @@ This config file extends the test environment configuration so that we can run the lettuce acceptance tests. """ + +# We intentionally define lots of variables that aren't used, and +# want to import all variables from base settings files +# pylint: disable=W0401, W0614 + from .test import * # You need to start the server in debug mode, # otherwise the browser will not render the pages correctly DEBUG = True -# Show the courses that are in the data directory -COURSES_ROOT = ENV_ROOT / "data" -DATA_DIR = COURSES_ROOT -# MODULESTORE = { -# 'default': { -# 'ENGINE': 'xmodule.modulestore.xml.XMLModuleStore', -# 'OPTIONS': { -# 'data_dir': DATA_DIR, -# 'default_class': 'xmodule.hidden_module.HiddenDescriptor', -# } -# } -# } +# Disable warnings for acceptance tests, to make the logs readable +import logging +logging.disable(logging.ERROR) +MODULESTORE_OPTIONS = { + 'default_class': 'xmodule.raw_module.RawDescriptor', + 'host': 'localhost', + 'db': 'test_xmodule', + 'collection': 'acceptance_modulestore', + 'fs_root': TEST_ROOT / "data", + 'render_template': 'mitxmako.shortcuts.render_to_string', +} + +MODULESTORE = { + 'default': { + 'ENGINE': 'xmodule.modulestore.mongo.DraftMongoModuleStore', + 'OPTIONS': MODULESTORE_OPTIONS + }, + 'direct': { + 'ENGINE': 'xmodule.modulestore.mongo.MongoModuleStore', + 'OPTIONS': MODULESTORE_OPTIONS + }, + 'draft': { + 'ENGINE': 'xmodule.modulestore.mongo.DraftMongoModuleStore', + 'OPTIONS': MODULESTORE_OPTIONS + } +} # Set this up so that rake lms[acceptance] and running the # harvest command both use the same (test) database # which they can flush without messing up your dev db DATABASES = { 'default': { 'ENGINE': 'django.db.backends.sqlite3', - 'NAME': ENV_ROOT / "db" / "test_mitx.db", - 'TEST_NAME': ENV_ROOT / "db" / "test_mitx.db", + 'NAME': TEST_ROOT / "db" / "test_mitx.db", + 'TEST_NAME': TEST_ROOT / "db" / "test_mitx.db", } } diff --git a/cms/envs/aws.py b/cms/envs/aws.py index 05c57d8263..f6064229e6 100644 --- a/cms/envs/aws.py +++ b/cms/envs/aws.py @@ -1,6 +1,11 @@ """ This is the default template for our main set of AWS servers. """ + +# We intentionally define lots of variables that aren't used, and +# want to import all variables from base settings files +# pylint: disable=W0401, W0614 + import json from .common import * @@ -28,12 +33,55 @@ EMAIL_BACKEND = 'django_ses.SESBackend' SESSION_ENGINE = 'django.contrib.sessions.backends.cache' DEFAULT_FILE_STORAGE = 'storages.backends.s3boto.S3BotoStorage' +###################################### CELERY ################################ + +# Don't use a connection pool, since connections are dropped by ELB. +BROKER_POOL_LIMIT = 0 +BROKER_CONNECTION_TIMEOUT = 1 + +# For the Result Store, use the django cache named 'celery' +CELERY_RESULT_BACKEND = 'cache' +CELERY_CACHE_BACKEND = 'celery' + +# When the broker is behind an ELB, use a heartbeat to refresh the +# connection and to detect if it has been dropped. +BROKER_HEARTBEAT = 10.0 +BROKER_HEARTBEAT_CHECKRATE = 2 + +# Each worker should only fetch one message at a time +CELERYD_PREFETCH_MULTIPLIER = 1 + +# Skip djcelery migrations, since we don't use the database as the broker +SOUTH_MIGRATION_MODULES = { + 'djcelery': 'ignore', +} + +# Rename the exchange and queues for each variant + +QUEUE_VARIANT = CONFIG_PREFIX.lower() + +CELERY_DEFAULT_EXCHANGE = 'edx.{0}core'.format(QUEUE_VARIANT) + +HIGH_PRIORITY_QUEUE = 'edx.{0}core.high'.format(QUEUE_VARIANT) +DEFAULT_PRIORITY_QUEUE = 'edx.{0}core.default'.format(QUEUE_VARIANT) +LOW_PRIORITY_QUEUE = 'edx.{0}core.low'.format(QUEUE_VARIANT) + +CELERY_DEFAULT_QUEUE = DEFAULT_PRIORITY_QUEUE +CELERY_DEFAULT_ROUTING_KEY = DEFAULT_PRIORITY_QUEUE + +CELERY_QUEUES = { + HIGH_PRIORITY_QUEUE: {}, + LOW_PRIORITY_QUEUE: {}, + DEFAULT_PRIORITY_QUEUE: {} +} + ############# NON-SECURE ENV CONFIG ############################## # Things like server locations, ports, etc. with open(ENV_ROOT / CONFIG_PREFIX + "env.json") as env_file: ENV_TOKENS = json.load(env_file) LMS_BASE = ENV_TOKENS.get('LMS_BASE') +# Note that MITX_FEATURES['PREVIEW_LMS_BASE'] gets read in from the environment file. SITE_NAME = ENV_TOKENS['SITE_NAME'] @@ -78,3 +126,14 @@ CONTENTSTORE = AUTH_TOKENS['CONTENTSTORE'] # Datadog for events! DATADOG_API = AUTH_TOKENS.get("DATADOG_API") + +# Celery Broker +CELERY_BROKER_TRANSPORT = ENV_TOKENS.get("CELERY_BROKER_TRANSPORT", "") +CELERY_BROKER_HOSTNAME = ENV_TOKENS.get("CELERY_BROKER_HOSTNAME", "") +CELERY_BROKER_USER = AUTH_TOKENS.get("CELERY_BROKER_USER", "") +CELERY_BROKER_PASSWORD = AUTH_TOKENS.get("CELERY_BROKER_PASSWORD", "") + +BROKER_URL = "{0}://{1}:{2}@{3}".format(CELERY_BROKER_TRANSPORT, + CELERY_BROKER_USER, + CELERY_BROKER_PASSWORD, + CELERY_BROKER_HOSTNAME) diff --git a/cms/envs/common.py b/cms/envs/common.py index a53830082b..04d5888750 100644 --- a/cms/envs/common.py +++ b/cms/envs/common.py @@ -19,6 +19,10 @@ Longer TODO: multiple sites, but we do need a way to map their data assets. """ +# We intentionally define lots of variables that aren't used, and +# want to import all variables from base settings files +# pylint: disable=W0401, W0614 + import sys import lms.envs.common from path import path @@ -34,6 +38,12 @@ MITX_FEATURES = { 'STAFF_EMAIL': '', # email address for staff (eg to request course creation) 'STUDIO_NPS_SURVEY': True, 'SEGMENT_IO': True, + + # Enable URL that shows information about the status of various services + 'ENABLE_SERVICE_STATUS': False, + + # Don't autoplay videos for course authors + 'AUTOPLAY_VIDEOS': False } ENABLE_JASMINE = False @@ -214,7 +224,10 @@ PIPELINE_JS = { 'source_filenames': sorted( rooted_glob(COMMON_ROOT / 'static/', 'coffee/src/**/*.js') + rooted_glob(PROJECT_ROOT / 'static/', 'coffee/src/**/*.js') - ) + ['js/hesitate.js', 'js/base.js'], + ) + ['js/hesitate.js', 'js/base.js', + 'js/models/feedback.js', 'js/views/feedback.js', + 'js/models/section.js', 'js/views/section.js', + 'js/models/metadata_model.js', 'js/views/metadata_editor_view.js'], 'output_filename': 'js/cms-application.js', 'test_order': 0 }, @@ -240,6 +253,51 @@ STATICFILES_IGNORE_PATTERNS = ( PIPELINE_YUI_BINARY = 'yui-compressor' +################################# CELERY ###################################### + +# Message configuration + +CELERY_TASK_SERIALIZER = 'json' +CELERY_RESULT_SERIALIZER = 'json' + +CELERY_MESSAGE_COMPRESSION = 'gzip' + +# Results configuration + +CELERY_IGNORE_RESULT = False +CELERY_STORE_ERRORS_EVEN_IF_IGNORED = True + +# Events configuration + +CELERY_TRACK_STARTED = True + +CELERY_SEND_EVENTS = True +CELERY_SEND_TASK_SENT_EVENT = True + +# Exchange configuration + +CELERY_DEFAULT_EXCHANGE = 'edx.core' +CELERY_DEFAULT_EXCHANGE_TYPE = 'direct' + +# Queues configuration + +HIGH_PRIORITY_QUEUE = 'edx.core.high' +DEFAULT_PRIORITY_QUEUE = 'edx.core.default' +LOW_PRIORITY_QUEUE = 'edx.core.low' + +CELERY_QUEUE_HA_POLICY = 'all' + +CELERY_CREATE_MISSING_QUEUES = True + +CELERY_DEFAULT_QUEUE = DEFAULT_PRIORITY_QUEUE +CELERY_DEFAULT_ROUTING_KEY = DEFAULT_PRIORITY_QUEUE + +CELERY_QUEUES = { + HIGH_PRIORITY_QUEUE: {}, + LOW_PRIORITY_QUEUE: {}, + DEFAULT_PRIORITY_QUEUE: {} +} + ############################ APPS ##################################### INSTALLED_APPS = ( @@ -249,8 +307,12 @@ INSTALLED_APPS = ( 'django.contrib.sessions', 'django.contrib.sites', 'django.contrib.messages', + 'djcelery', 'south', + # Monitor the status of services + 'service_status', + # For CMS 'contentstore', 'auth', @@ -261,7 +323,15 @@ INSTALLED_APPS = ( 'track', # For asset pipelining + 'mitxmako', 'pipeline', 'staticfiles', 'static_replace', + + # comment common + 'django_comment_common', ) + +################# EDX MARKETING SITE ################################## + +EDXMKTG_COOKIE_NAME = 'edxloggedin' diff --git a/cms/envs/dev.py b/cms/envs/dev.py index dbf9c5574c..e63968d338 100644 --- a/cms/envs/dev.py +++ b/cms/envs/dev.py @@ -1,6 +1,10 @@ """ This config file runs the simplest dev environment""" +# We intentionally define lots of variables that aren't used, and +# want to import all variables from base settings files +# pylint: disable=W0401, W0614 + from .common import * from logsettings import get_logger_config @@ -51,6 +55,7 @@ DATABASES = { } LMS_BASE = "localhost:8000" +MITX_FEATURES['PREVIEW_LMS_BASE'] = "localhost:8000" REPOS = { 'edx4edx': { @@ -116,10 +121,14 @@ SECRET_KEY = '85920908f28904ed733fe576320db18cabd7b6cd' PIPELINE_SASS_ARGUMENTS = '--debug-info --require {proj_dir}/static/sass/bourbon/lib/bourbon.rb'.format(proj_dir=PROJECT_ROOT) +################################# CELERY ###################################### + +# By default don't use a worker, execute tasks as if they were local functions +CELERY_ALWAYS_EAGER = True + ################################ DEBUG TOOLBAR ################################# INSTALLED_APPS += ('debug_toolbar', 'debug_toolbar_mongo') -MIDDLEWARE_CLASSES += ('django_comment_client.utils.QueryCountDebugMiddleware', - 'debug_toolbar.middleware.DebugToolbarMiddleware',) +MIDDLEWARE_CLASSES += ('debug_toolbar.middleware.DebugToolbarMiddleware',) INTERNAL_IPS = ('127.0.0.1',) DEBUG_TOOLBAR_PANELS = ( @@ -151,5 +160,8 @@ DEBUG_TOOLBAR_MONGO_STACKTRACES = True # disable NPS survey in dev mode MITX_FEATURES['STUDIO_NPS_SURVEY'] = False +# Enable URL that shows information about the status of variuous services +MITX_FEATURES['ENABLE_SERVICE_STATUS'] = True + # segment-io key for dev SEGMENT_IO_KEY = 'mty8edrrsg' diff --git a/cms/envs/dev_ike.py b/cms/envs/dev_ike.py index 1ebf219d44..0c798b68aa 100644 --- a/cms/envs/dev_ike.py +++ b/cms/envs/dev_ike.py @@ -1,3 +1,7 @@ +# We intentionally define lots of variables that aren't used, and +# want to import all variables from base settings files +# pylint: disable=W0401, W0614 + # dev environment for ichuang/mit # FORCE_SCRIPT_NAME = '/cms' diff --git a/cms/envs/dev_with_worker.py b/cms/envs/dev_with_worker.py new file mode 100644 index 0000000000..078567c493 --- /dev/null +++ b/cms/envs/dev_with_worker.py @@ -0,0 +1,39 @@ +""" +This config file follows the dev enviroment, but adds the +requirement of a celery worker running in the background to process +celery tasks. + +The worker can be executed using: + +django_admin.py celery worker +""" + +# We intentionally define lots of variables that aren't used, and +# want to import all variables from base settings files +# pylint: disable=W0401, W0614 + +from dev import * + +################################# CELERY ###################################### + +# Requires a separate celery worker + +CELERY_ALWAYS_EAGER = False + +# Use django db as the broker and result store + +BROKER_URL = 'django://' +INSTALLED_APPS += ('djcelery.transport', ) +CELERY_RESULT_BACKEND = 'database' +DJKOMBU_POLLING_INTERVAL = 1.0 + +# Disable transaction management because we are using a worker. Views +# that request a task and wait for the result will deadlock otherwise. + +MIDDLEWARE_CLASSES = tuple( + c for c in MIDDLEWARE_CLASSES + if c != 'django.middleware.transaction.TransactionMiddleware') + +# Note: other alternatives for disabling transactions don't work in 1.4 +# https://code.djangoproject.com/ticket/2304 +# https://code.djangoproject.com/ticket/16039 diff --git a/cms/envs/jasmine.py b/cms/envs/jasmine.py index 6c7cbcdcb0..a4b8292d71 100644 --- a/cms/envs/jasmine.py +++ b/cms/envs/jasmine.py @@ -2,6 +2,10 @@ This configuration is used for running jasmine tests """ +# We intentionally define lots of variables that aren't used, and +# want to import all variables from base settings files +# pylint: disable=W0401, W0614 + from .test import * from logsettings import get_logger_config @@ -32,8 +36,13 @@ PIPELINE_JS['spec'] = { } JASMINE_TEST_DIRECTORY = PROJECT_ROOT + '/static/coffee' +JASMINE_REPORT_DIR = os.environ.get('JASMINE_REPORT_DIR', 'reports/cms/jasmine') + +TEMPLATE_CONTEXT_PROCESSORS += ('settings_context_processor.context_processors.settings',) +TEMPLATE_VISIBLE_SETTINGS = ('JASMINE_REPORT_DIR', ) STATICFILES_DIRS.append(REPO_ROOT/'node_modules/phantom-jasmine/lib') +STATICFILES_DIRS.append(REPO_ROOT/'node_modules/jasmine-reporters/src') # Remove the localization middleware class because it requires the test database # to be sync'd and migrated in order to run the jasmine tests interactively @@ -41,4 +50,4 @@ STATICFILES_DIRS.append(REPO_ROOT/'node_modules/phantom-jasmine/lib') MIDDLEWARE_CLASSES = tuple(e for e in MIDDLEWARE_CLASSES \ if e != 'django.middleware.locale.LocaleMiddleware') -INSTALLED_APPS += ('django_jasmine', ) +INSTALLED_APPS += ('django_jasmine', 'settings_context_processor') diff --git a/cms/envs/test.py b/cms/envs/test.py index 63b5efc645..8a3f9ba158 100644 --- a/cms/envs/test.py +++ b/cms/envs/test.py @@ -7,6 +7,11 @@ sessions. Assumes structure: /mitx # The location of this repo /log # Where we're going to write log files """ + +# We intentionally define lots of variables that aren't used, and +# want to import all variables from base settings files +# pylint: disable=W0401, W0614 + from .common import * import os from path import path @@ -41,14 +46,14 @@ MODULESTORE_OPTIONS = { 'default_class': 'xmodule.raw_module.RawDescriptor', 'host': 'localhost', 'db': 'test_xmodule', - 'collection': 'modulestore', - 'fs_root': GITHUB_REPO_ROOT, + 'collection': 'test_modulestore', + 'fs_root': TEST_ROOT / "data", 'render_template': 'mitxmako.shortcuts.render_to_string', } MODULESTORE = { 'default': { - 'ENGINE': 'xmodule.modulestore.mongo.MongoModuleStore', + 'ENGINE': 'xmodule.modulestore.mongo.DraftMongoModuleStore', 'OPTIONS': MODULESTORE_OPTIONS }, 'direct': { @@ -77,6 +82,7 @@ DATABASES = { } LMS_BASE = "localhost:8000" +MITX_FEATURES['PREVIEW_LMS_BASE'] = "preview" CACHES = { # This is the cache used for most things. Askbot will not work without a @@ -108,6 +114,12 @@ CACHES = { } } +################################# CELERY ###################################### + +CELERY_ALWAYS_EAGER = True +CELERY_RESULT_BACKEND = 'cache' +BROKER_TRANSPORT = 'memory' + ################### Make tests faster #http://slacy.com/blog/2012/04/make-your-tests-faster-in-django-1-4/ PASSWORD_HASHERS = ( @@ -121,3 +133,4 @@ SEGMENT_IO_KEY = '***REMOVED***' # disable NPS survey in test mode MITX_FEATURES['STUDIO_NPS_SURVEY'] = False +MITX_FEATURES['ENABLE_SERVICE_STATUS'] = True diff --git a/cms/static/client_templates/checklist.html b/cms/static/client_templates/checklist.html index 6884b0e9c9..e985ab9509 100644 --- a/cms/static/client_templates/checklist.html +++ b/cms/static/client_templates/checklist.html @@ -11,11 +11,11 @@ <%= percentChecked %>% of checklist completed

- ▾ + <%= checklistShortDescription %>

Tasks Completed: <%= itemsChecked %>/<%= items.length %> - ✓ +
@@ -58,4 +58,4 @@ <% taskIndex+=1; }) %> - \ No newline at end of file + diff --git a/cms/static/coffee/files.json b/cms/static/coffee/files.json index c2e1a8acf6..73dfc565a2 100644 --- a/cms/static/coffee/files.json +++ b/cms/static/coffee/files.json @@ -8,6 +8,8 @@ "js/vendor/json2.js", "js/vendor/underscore-min.js", "js/vendor/backbone-min.js", - "js/vendor/jquery.leanModal.min.js" + "js/vendor/jquery.leanModal.min.js", + "js/vendor/sinon-1.7.1.js", + "js/test/i18n.js" ] } diff --git a/cms/static/coffee/fixtures/metadata-editor.underscore b/cms/static/coffee/fixtures/metadata-editor.underscore new file mode 120000 index 0000000000..9696774d0a --- /dev/null +++ b/cms/static/coffee/fixtures/metadata-editor.underscore @@ -0,0 +1 @@ +../../../templates/js/metadata-editor.underscore \ No newline at end of file diff --git a/cms/static/coffee/fixtures/metadata-number-entry.underscore b/cms/static/coffee/fixtures/metadata-number-entry.underscore new file mode 120000 index 0000000000..99138aa9c1 --- /dev/null +++ b/cms/static/coffee/fixtures/metadata-number-entry.underscore @@ -0,0 +1 @@ +../../../templates/js/metadata-number-entry.underscore \ No newline at end of file diff --git a/cms/static/coffee/fixtures/metadata-option-entry.underscore b/cms/static/coffee/fixtures/metadata-option-entry.underscore new file mode 120000 index 0000000000..c6cd499801 --- /dev/null +++ b/cms/static/coffee/fixtures/metadata-option-entry.underscore @@ -0,0 +1 @@ +../../../templates/js/metadata-option-entry.underscore \ No newline at end of file diff --git a/cms/static/coffee/fixtures/metadata-string-entry.underscore b/cms/static/coffee/fixtures/metadata-string-entry.underscore new file mode 120000 index 0000000000..f713ab5387 --- /dev/null +++ b/cms/static/coffee/fixtures/metadata-string-entry.underscore @@ -0,0 +1 @@ +../../../templates/js/metadata-string-entry.underscore \ No newline at end of file diff --git a/cms/static/coffee/fixtures/section-name-edit.underscore b/cms/static/coffee/fixtures/section-name-edit.underscore new file mode 120000 index 0000000000..89284ccf90 --- /dev/null +++ b/cms/static/coffee/fixtures/section-name-edit.underscore @@ -0,0 +1 @@ +../../../templates/js/section-name-edit.underscore \ No newline at end of file diff --git a/cms/static/coffee/fixtures/system-feedback.underscore b/cms/static/coffee/fixtures/system-feedback.underscore new file mode 120000 index 0000000000..10893f87c4 --- /dev/null +++ b/cms/static/coffee/fixtures/system-feedback.underscore @@ -0,0 +1 @@ +../../../templates/js/system-feedback.underscore \ No newline at end of file diff --git a/cms/static/coffee/spec/helpers.coffee b/cms/static/coffee/spec/helpers.coffee index 91a411a8fc..116983edf5 100644 --- a/cms/static/coffee/spec/helpers.coffee +++ b/cms/static/coffee/spec/helpers.coffee @@ -1,3 +1,5 @@ +jasmine.getFixtures().fixturesPath = 'fixtures' + # Stub jQuery.cookie @stubCookies = csrftoken: "stubCSRFToken" diff --git a/cms/static/coffee/spec/main_spec.coffee b/cms/static/coffee/spec/main_spec.coffee index 8b2fa52866..9383f2547e 100644 --- a/cms/static/coffee/spec/main_spec.coffee +++ b/cms/static/coffee/spec/main_spec.coffee @@ -22,3 +22,37 @@ describe "main helper", -> it "setup AJAX CSRF token", -> expect($.ajaxSettings.headers["X-CSRFToken"]).toEqual("stubCSRFToken") + +describe "AJAX Errors", -> + tpl = readFixtures('system-feedback.underscore') + + beforeEach -> + setFixtures($(" + + ## javascript - - <%static:js group='main'/> <%static:js group='module-js'/> @@ -49,17 +52,18 @@ - + + + +
<%include file="widgets/header.html" /> + ## remove this block after advanced settings notification is rewritten <%block name="view_alerts"> - <%block name="view_banners"> +
<%block name="content"> @@ -70,10 +74,14 @@ <%include file="widgets/footer.html" /> <%include file="widgets/tender.html" /> + ## remove this block after advanced settings notification is rewritten <%block name="view_notifications"> +
+ ## remove this block after advanced settings notification is rewritten <%block name="view_prompts"> +
<%block name="jsextra"> diff --git a/cms/templates/checklists.html b/cms/templates/checklists.html index e5227c71fd..6f78e952c0 100644 --- a/cms/templates/checklists.html +++ b/cms/templates/checklists.html @@ -9,7 +9,6 @@ - + + + +
-
- ${editor} -
-
- Save - Cancel -
-
+
+ + +
+ +
+
+ ${editor} +
+
+
+ ${_("Save")} + ${_("Cancel")} +
+
- Edit - Delete + ${_("Edit")} + ${_("Delete")}
- + ${preview} diff --git a/cms/templates/course_info.html b/cms/templates/course_info.html index fc7b883c88..b13a024fde 100644 --- a/cms/templates/course_info.html +++ b/cms/templates/course_info.html @@ -11,7 +11,6 @@ - @@ -53,7 +52,7 @@

Page Actions

diff --git a/cms/templates/edit-tabs.html b/cms/templates/edit-tabs.html index 161c938020..77eb1cb9b8 100644 --- a/cms/templates/edit-tabs.html +++ b/cms/templates/edit-tabs.html @@ -27,7 +27,7 @@

Page Actions

@@ -41,7 +41,7 @@ @@ -76,7 +76,7 @@ - ␡ + close modal diff --git a/cms/templates/howitworks.html b/cms/templates/howitworks.html index 6c0029c425..b5acc66339 100644 --- a/cms/templates/howitworks.html +++ b/cms/templates/howitworks.html @@ -28,7 +28,7 @@ Studio Helps You Keep Your Courses Organized
Studio Helps You Keep Your Courses Organized
- + @@ -62,7 +62,7 @@ Learning is More than Just Lectures
Learning is More than Just Lectures
- + @@ -96,7 +96,7 @@ Studio Gives You Simple, Fast, and Incremental Publishing. With Friends.
Studio Gives You Simple, Fast, and Incremental Publishing. With Friends.
- + @@ -132,7 +132,7 @@

Sign Up for Studio Today!

- +
  • Sign Up & Start Making an edX Course @@ -152,7 +152,7 @@ - ␡ + close modal @@ -165,7 +165,7 @@ - ␡ + close modal @@ -178,8 +178,8 @@ - ␡ + close modal - \ No newline at end of file + diff --git a/cms/templates/index.html b/cms/templates/index.html index 007033623d..e7205c9430 100644 --- a/cms/templates/index.html +++ b/cms/templates/index.html @@ -45,7 +45,7 @@ diff --git a/cms/templates/js/metadata-editor.underscore b/cms/templates/js/metadata-editor.underscore new file mode 100644 index 0000000000..03fdd28996 --- /dev/null +++ b/cms/templates/js/metadata-editor.underscore @@ -0,0 +1,6 @@ +
      + <% _.each(_.range(numEntries), function() { %> +
    • +
      • + <% }) %> +
    diff --git a/cms/templates/js/metadata-number-entry.underscore b/cms/templates/js/metadata-number-entry.underscore new file mode 100644 index 0000000000..333233ef4e --- /dev/null +++ b/cms/templates/js/metadata-number-entry.underscore @@ -0,0 +1,8 @@ +
    + + + +
    +<%= model.get('help') %> diff --git a/cms/templates/js/metadata-option-entry.underscore b/cms/templates/js/metadata-option-entry.underscore new file mode 100644 index 0000000000..4cb107e882 --- /dev/null +++ b/cms/templates/js/metadata-option-entry.underscore @@ -0,0 +1,16 @@ +
    + + + +
    +<%= model.get('help') %> diff --git a/cms/templates/js/metadata-string-entry.underscore b/cms/templates/js/metadata-string-entry.underscore new file mode 100644 index 0000000000..759e3ad826 --- /dev/null +++ b/cms/templates/js/metadata-string-entry.underscore @@ -0,0 +1,8 @@ +
    + + + +
    +<%= model.get('help') %> diff --git a/cms/templates/js/section-name-edit.underscore b/cms/templates/js/section-name-edit.underscore new file mode 100644 index 0000000000..cfbd64fffe --- /dev/null +++ b/cms/templates/js/section-name-edit.underscore @@ -0,0 +1,5 @@ +
    + + " /> + " /> +
    diff --git a/cms/templates/js/system-feedback.underscore b/cms/templates/js/system-feedback.underscore new file mode 100644 index 0000000000..b8ef1b8dc8 --- /dev/null +++ b/cms/templates/js/system-feedback.underscore @@ -0,0 +1,48 @@ +
    aria-describedby="<%= type %>-<%= intent %>-description" <% } %> + <% if (obj.actions) { %>role="dialog"<% } %> + > +
    + <% if(obj.icon) { %> + <% var iconClass = {"warning": "warning-sign", "confirmation": "ok", "error": "warning-sign", "announcement": "bullhorn", "step-required": "exclamation-sign", "help": "question-sign", "saving": "cog"} %> + + <% } %> + +
    +

    <%= title %>

    + <% if(obj.message) { %>

    <%= message %>

    <% } %> +
    + + <% if(obj.actions) { %> + + <% } %> + + <% if(obj.closeIcon) { %> + + + close <%= type %> + + <% } %> +
    +
    diff --git a/cms/templates/manage_users.html b/cms/templates/manage_users.html index 0edf88510c..462dd32c81 100644 --- a/cms/templates/manage_users.html +++ b/cms/templates/manage_users.html @@ -16,7 +16,7 @@ diff --git a/cms/templates/overview.html b/cms/templates/overview.html index fe2636a346..d327c8b324 100644 --- a/cms/templates/overview.html +++ b/cms/templates/overview.html @@ -20,6 +20,12 @@ + + + + @@ -115,13 +129,13 @@

    Page Actions

    @@ -137,14 +151,7 @@
    -

    - ${section.display_name_with_default} - -

    +

    <% start_date_str = get_time_struct_display(section.lms.start, '%m/%d/%Y') diff --git a/cms/templates/registration/activation_complete.html b/cms/templates/registration/activation_complete.html index 8cc3dc8c56..a4d028ef5b 100644 --- a/cms/templates/registration/activation_complete.html +++ b/cms/templates/registration/activation_complete.html @@ -3,6 +3,12 @@ <%namespace name='static' file='../static_content.html'/> +%if not user_logged_in: +<%block name="bodyclass"> + not-signedin + +%endif + <%block name="content">
    @@ -18,7 +24,7 @@ %if user_logged_in: Visit your dashboard to see your courses. %else: - You can now login. + You can now login. %endif

    diff --git a/cms/templates/settings.html b/cms/templates/settings.html index f6633c8d65..2adc0cd980 100644 --- a/cms/templates/settings.html +++ b/cms/templates/settings.html @@ -15,7 +15,6 @@ from contentstore import utils - @@ -92,7 +91,7 @@ from contentstore import utils
    diff --git a/cms/templates/settings_advanced.html b/cms/templates/settings_advanced.html index 858dc9cbf0..242148418e 100644 --- a/cms/templates/settings_advanced.html +++ b/cms/templates/settings_advanced.html @@ -11,7 +11,6 @@ from contentstore import utils <%block name="jsextra"> - @@ -110,7 +109,7 @@ editor.render();
@@ -143,7 +142,7 @@ from contentstore import utils
- +
randomize all problems @@ -217,7 +216,7 @@ from contentstore import utils
- +
randomize all problems @@ -283,7 +282,7 @@ from contentstore import utils

Discussions

- +

General Settings

@@ -296,7 +295,7 @@ from contentstore import utils
- +
Students and faculty will be able to post anonymously @@ -320,7 +319,7 @@ from contentstore import utils
- +
Students and faculty will be able to post anonymously @@ -329,7 +328,7 @@ from contentstore import utils
- +
This option is disabled since there are previous discussions that are anonymous. @@ -351,7 +350,7 @@ from contentstore import utils - +
  • diff --git a/cms/templates/settings_graders.html b/cms/templates/settings_graders.html index 321be55985..2c6846bece 100644 --- a/cms/templates/settings_graders.html +++ b/cms/templates/settings_graders.html @@ -12,7 +12,6 @@ from contentstore import utils - @@ -117,7 +116,7 @@ from contentstore import utils
    - New Assignment Type + New Assignment Type
    • diff --git a/cms/templates/unit.html b/cms/templates/unit.html index cb34f42a09..851e3da260 100644 --- a/cms/templates/unit.html +++ b/cms/templates/unit.html @@ -78,22 +78,13 @@ % endif
      - % for name, location, has_markdown, is_empty in templates: + % for name, location, has_markdown in templates: % if has_markdown or type != "problem": - % if is_empty: -
    • - - ${name} - -
      • - - % else: -
    • - - ${name} - -
      • - % endif +
    • + + ${name} + +
      • % endif %endfor @@ -102,23 +93,13 @@ % if type == "problem":
        - % for name, location, has_markdown, is_empty in templates: + % for name, location, has_markdown in templates: % if not has_markdown: - % if is_empty: -
      • - - ${name} - -
        • - - % else: -
      • - - ${name} - - -
        • - % endif +
      • + + ${name} + +
        • % endif % endfor
      diff --git a/cms/templates/ux-alerts.html b/cms/templates/ux-alerts.html deleted file mode 100644 index b7e91acae8..0000000000 --- a/cms/templates/ux-alerts.html +++ /dev/null @@ -1,572 +0,0 @@ -<%inherit file="base.html" /> -<%block name="title">Studio Alerts -<%block name="bodyclass">is-signedin course uxdesign alerts - -<%block name="jsextra"> - - - -<%block name="content"> -
      -
      -

      - UX Design - > System Notifications -

      -
      -
      - -
      -
      -
      -
      -
      -

      Alerts

      - persistant, static messages to the user -
      - -

      In Studio, alerts are 1) general warnings/notes (e.g. drafts, published content, next steps) about the current view a user is interacting with or 2) notes about the status (e.g. saved confirmations, errors, next system steps) of any previous state that need to communicated to the user when arriving at the current view.

      - -

      Different Static Examples of Alerts

      -

      Note: alerts will probably never been shown based on click or page action and will primarily be loaded along with a pageload and initial display

      - - -
      - -
      -
      -

      Notifications

      - contextual, feedback-based, and temporal messages to the user -
      - -

      In Studio, notifications are meant to inform the user of 1) any system status (e.g. saving, processing/validating) occurring based on any action they have taken or 2) any decisions (e.g. saving/discarding) a user must make to confirm.

      - -

      Different Static Examples of Notifications

      - - -
      - -
      -
      -

      Prompts

      - presents a user with a choice, based on their previous interaction, that must be decided before they can proceed -
      - -

      In Studio, prompts are dialogs that are presented above all other page components and present a user with a choice, based on their previous interaction, that must be decided before they can proceed (or return to the previous interaction step).

      - -

      Different Static Examples of Prompts

      - - -
      -
      -
      -
      - - -<%block name="view_alerts"> - -
      -
      - ⚠ - -
      -

      You are editing a draft

      -

      Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.

      -
      - - -
      -
      - - -
      -
      - ⚠ - -
      -

      You are editing a draft

      -

      Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.

      -
      - - -
      -
      - - -
      -
      - ⚠ - -
      -

      A Newer Version of This Exists

      -

      Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.

      -
      - - -
      -
      - - -
      -
      - ✓ - -
      -

      Your changes have been saved

      -

      Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Please see below

      -
      -
      -
      - - -
      -
      - ✓ - -
      -

      Your changes have been saved

      -

      Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Please see below

      -
      - - - ␡ - close alert - -
      -
      - - -
      -
      - ✓ - -
      -

      X Has been removed

      -

      Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.

      -
      -
      -
      - - -
      -
      - ⚠ - -
      -

      We're sorry, there was a error with Studio

      -

      Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.

      -
      -
      -
      - - -
      -
      - ⚠ - -
      -

      There was an error in your submission

      -

      Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Please see below

      -
      - - -
      -
      - - -
      -
      - 📢 - -
      -

      Studio will be unavailable this weekend

      -

      Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.

      -
      - - -
      -
      - - -
      -
      - 📢 - -
      -

      Studio will be unavailable this weekend

      -

      Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.

      -
      -
      -
      - - -
      -
      - - -
      -

      Your Studio account has been created, but needs to be activated

      -

      Donec sed odio dui. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Etiam porta sem malesuada magna mollis euismod. Cras mattis consectetur purus sit amet fermentum. Curabitur blandit tempus porttitor.

      -
      - - -
      -
      - - -<%block name="view_notifications"> - - - - - - - - - - -
      -
      - ⚙ - -
      -

      Saving …

      -
      -
      -
      - - -
      -
      - ✓ - -
      -

      Your Section Has Been Created

      -
      -
      -
      - - -
      -
      - ❓ - -
      -

      Fun Fact:

      -

      Using the checkmark will allow you make a subsection gradable as an assignment, which counts towards a student's total grade

      -
      - - - ␡ - close notification - -
      -
      - - -<%block name="view_prompts"> - - - - - - - - - diff --git a/cms/templates/widgets/header.html b/cms/templates/widgets/header.html index 167d5417d7..3c8a598b5e 100644 --- a/cms/templates/widgets/header.html +++ b/cms/templates/widgets/header.html @@ -21,7 +21,7 @@
      1. -

        Course Content ▾

        +

        Course Content

        @@ -36,7 +36,7 @@
      2. -

        Course Settings ▾

        +

        Course Settings

        @@ -51,7 +51,7 @@
      3. -

        Tools ▾

        +

        Tools

        @@ -76,10 +76,10 @@
      -
      Explanation
      +
      ${_("Explanation")}
      @@ -105,3 +107,5 @@
      +
    +<%include file="metadata-edit.html" /> diff --git a/cms/templates/widgets/raw-edit.html b/cms/templates/widgets/raw-edit.html index 9488552be5..2b1b0f9ef3 100644 --- a/cms/templates/widgets/raw-edit.html +++ b/cms/templates/widgets/raw-edit.html @@ -1,4 +1,6 @@ +
    +
    + +
    +
    <%include file="metadata-edit.html" /> -
    - -
    diff --git a/cms/templates/widgets/sequence-edit.html b/cms/templates/widgets/sequence-edit.html index c70f2568fa..7956fbfbaf 100644 --- a/cms/templates/widgets/sequence-edit.html +++ b/cms/templates/widgets/sequence-edit.html @@ -29,7 +29,6 @@
    - <%include file="metadata-edit.html" />
      @@ -50,5 +49,6 @@
    + <%include file="metadata-edit.html" /> diff --git a/cms/templates/widgets/sock.html b/cms/templates/widgets/sock.html index 823624c531..c62ffa1433 100644 --- a/cms/templates/widgets/sock.html +++ b/cms/templates/widgets/sock.html @@ -2,14 +2,14 @@
    -

    ❓ edX Studio Help

    +

    edX Studio Help

    @@ -21,15 +21,15 @@ @@ -45,7 +45,7 @@
    diff --git a/cms/urls.py b/cms/urls.py index 3b91eceb44..e7444de4e9 100644 --- a/cms/urls.py +++ b/cms/urls.py @@ -115,9 +115,6 @@ urlpatterns += ( url(r'^login_post$', 'student.views.login_user', name='login_post'), url(r'^logout$', 'student.views.logout_user', name='logout'), - - # static/proof-of-concept views - url(r'^ux-alerts$', 'contentstore.views.ux_alerts', name='ux-alerts') ) js_info_dict = { @@ -135,6 +132,12 @@ if settings.ENABLE_JASMINE: # # Jasmine urlpatterns = urlpatterns + (url(r'^_jasmine/', include('django_jasmine.urls')),) + +if settings.MITX_FEATURES.get('ENABLE_SERVICE_STATUS'): + urlpatterns += ( + url(r'^status/', include('service_status.urls')), + ) + urlpatterns = patterns(*urlpatterns) # Custom error pages diff --git a/cms/xmodule_namespace.py b/cms/xmodule_namespace.py index 1b509a14f4..4857fe68ca 100644 --- a/cms/xmodule_namespace.py +++ b/cms/xmodule_namespace.py @@ -28,4 +28,4 @@ class CmsNamespace(Namespace): """ published_date = DateTuple(help="Date when the module was published", scope=Scope.settings) published_by = String(help="Id of the user who published this module", scope=Scope.settings) - empty = StringyBoolean(help="Whether this is an empty template", scope=Scope.settings, default=False) + diff --git a/common/.gitignore b/common/.gitignore new file mode 100644 index 0000000000..d8d38be945 --- /dev/null +++ b/common/.gitignore @@ -0,0 +1 @@ +jasmine_test_runner.html diff --git a/__init__.py b/common/djangoapps/django_comment_common/__init__.py similarity index 100% rename from __init__.py rename to common/djangoapps/django_comment_common/__init__.py diff --git a/common/djangoapps/django_comment_common/migrations/0001_initial.py b/common/djangoapps/django_comment_common/migrations/0001_initial.py new file mode 100644 index 0000000000..f2c3ca3aee --- /dev/null +++ b/common/djangoapps/django_comment_common/migrations/0001_initial.py @@ -0,0 +1,92 @@ +# -*- coding: utf-8 -*- +from south.v2 import SchemaMigration + + +class Migration(SchemaMigration): +# +# cdodge: This is basically an empty migration since everything has - up to now - managed in the django_comment_client app +# But going forward we should be using this migration +# + def forwards(self, orm): + pass + + def backwards(self, orm): + pass + + models = { + 'auth.group': { + 'Meta': {'object_name': 'Group'}, + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}), + 'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}) + }, + 'auth.permission': { + 'Meta': {'ordering': "('content_type__app_label', 'content_type__model', 'codename')", 'unique_together': "(('content_type', 'codename'),)", 'object_name': 'Permission'}, + 'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}), + 'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['contenttypes.ContentType']"}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'max_length': '50'}) + }, + 'auth.user': { + 'Meta': {'object_name': 'User'}, + 'about': ('django.db.models.fields.TextField', [], {'blank': 'True'}), + 'avatar_type': ('django.db.models.fields.CharField', [], {'default': "'n'", 'max_length': '1'}), + 'bronze': ('django.db.models.fields.SmallIntegerField', [], {'default': '0'}), + 'consecutive_days_visit_count': ('django.db.models.fields.IntegerField', [], {'default': '0'}), + 'country': ('django_countries.fields.CountryField', [], {'max_length': '2', 'blank': 'True'}), + 'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}), + 'date_of_birth': ('django.db.models.fields.DateField', [], {'null': 'True', 'blank': 'True'}), + 'display_tag_filter_strategy': ('django.db.models.fields.SmallIntegerField', [], {'default': '0'}), + 'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'blank': 'True'}), + 'email_isvalid': ('django.db.models.fields.BooleanField', [], {'default': 'False'}), + 'email_key': ('django.db.models.fields.CharField', [], {'max_length': '32', 'null': 'True'}), + 'email_tag_filter_strategy': ('django.db.models.fields.SmallIntegerField', [], {'default': '1'}), + 'first_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}), + 'gold': ('django.db.models.fields.SmallIntegerField', [], {'default': '0'}), + 'gravatar': ('django.db.models.fields.CharField', [], {'max_length': '32'}), + 'groups': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Group']", 'symmetrical': 'False', 'blank': 'True'}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'ignored_tags': ('django.db.models.fields.TextField', [], {'blank': 'True'}), + 'interesting_tags': ('django.db.models.fields.TextField', [], {'blank': 'True'}), + 'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False'}), + 'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False'}), + 'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}), + 'last_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}), + 'last_seen': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}), + 'location': ('django.db.models.fields.CharField', [], {'max_length': '100', 'blank': 'True'}), + 'new_response_count': ('django.db.models.fields.IntegerField', [], {'default': '0'}), + 'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}), + 'questions_per_page': ('django.db.models.fields.SmallIntegerField', [], {'default': '10'}), + 'real_name': ('django.db.models.fields.CharField', [], {'max_length': '100', 'blank': 'True'}), + 'reputation': ('django.db.models.fields.PositiveIntegerField', [], {'default': '1'}), + 'seen_response_count': ('django.db.models.fields.IntegerField', [], {'default': '0'}), + 'show_country': ('django.db.models.fields.BooleanField', [], {'default': 'False'}), + 'silver': ('django.db.models.fields.SmallIntegerField', [], {'default': '0'}), + 'status': ('django.db.models.fields.CharField', [], {'default': "'w'", 'max_length': '2'}), + 'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}), + 'username': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30'}), + 'website': ('django.db.models.fields.URLField', [], {'max_length': '200', 'blank': 'True'}) + }, + 'contenttypes.contenttype': { + 'Meta': {'ordering': "('name',)", 'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"}, + 'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}), + 'name': ('django.db.models.fields.CharField', [], {'max_length': '100'}) + }, + 'django_comment_common.permission': { + 'Meta': {'object_name': 'Permission'}, + 'name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'primary_key': 'True'}), + 'roles': ('django.db.models.fields.related.ManyToManyField', [], {'related_name': "'permissions'", 'symmetrical': 'False', 'to': "orm['django_comment_common.Role']"}) + }, + 'django_comment_common.role': { + 'Meta': {'object_name': 'Role'}, + 'course_id': ('django.db.models.fields.CharField', [], {'db_index': 'True', 'max_length': '255', 'blank': 'True'}), + 'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'max_length': '30'}), + 'users': ('django.db.models.fields.related.ManyToManyField', [], {'related_name': "'roles'", 'symmetrical': 'False', 'to': "orm['auth.User']"}) + } + } + + complete_apps = ['django_comment_common'] diff --git a/common/lib/capa/capa/chem/__init__.py b/common/djangoapps/django_comment_common/migrations/__init__.py similarity index 100% rename from common/lib/capa/capa/chem/__init__.py rename to common/djangoapps/django_comment_common/migrations/__init__.py diff --git a/common/djangoapps/django_comment_common/models.py b/common/djangoapps/django_comment_common/models.py new file mode 100644 index 0000000000..ec722b718a --- /dev/null +++ b/common/djangoapps/django_comment_common/models.py @@ -0,0 +1,74 @@ +import logging + +from django.db import models +from django.contrib.auth.models import User + +from django.dispatch import receiver +from django.db.models.signals import post_save + +from student.models import CourseEnrollment + +from xmodule.modulestore.django import modulestore +from xmodule.course_module import CourseDescriptor + +FORUM_ROLE_ADMINISTRATOR = 'Administrator' +FORUM_ROLE_MODERATOR = 'Moderator' +FORUM_ROLE_COMMUNITY_TA = 'Community TA' +FORUM_ROLE_STUDENT = 'Student' + + +@receiver(post_save, sender=CourseEnrollment) +def assign_default_role(sender, instance, **kwargs): + if instance.user.is_staff: + role = Role.objects.get_or_create(course_id=instance.course_id, name="Moderator")[0] + else: + role = Role.objects.get_or_create(course_id=instance.course_id, name="Student")[0] + + logging.info("assign_default_role: adding %s as %s" % (instance.user, role)) + instance.user.roles.add(role) + + +class Role(models.Model): + name = models.CharField(max_length=30, null=False, blank=False) + users = models.ManyToManyField(User, related_name="roles") + course_id = models.CharField(max_length=255, blank=True, db_index=True) + + class Meta: + # use existing table that was originally created from django_comment_client app + db_table = 'django_comment_client_role' + + def __unicode__(self): + return self.name + " for " + (self.course_id if self.course_id else "all courses") + + def inherit_permissions(self, role): # TODO the name of this method is a little bit confusing, + # since it's one-off and doesn't handle inheritance later + if role.course_id and role.course_id != self.course_id: + logging.warning("%s cannot inherit permissions from %s due to course_id inconsistency", \ + self, role) + for per in role.permissions.all(): + self.add_permission(per) + + def add_permission(self, permission): + self.permissions.add(Permission.objects.get_or_create(name=permission)[0]) + + def has_permission(self, permission): + course_loc = CourseDescriptor.id_to_location(self.course_id) + course = modulestore().get_instance(self.course_id, course_loc) + if self.name == FORUM_ROLE_STUDENT and \ + (permission.startswith('edit') or permission.startswith('update') or permission.startswith('create')) and \ + (not course.forum_posts_allowed): + return False + + return self.permissions.filter(name=permission).exists() + + +class Permission(models.Model): + name = models.CharField(max_length=30, null=False, blank=False, primary_key=True) + roles = models.ManyToManyField(Role, related_name="permissions") + + class Meta: + # use existing table that was originally created from django_comment_client app + db_table = 'django_comment_client_permission' + + def __unicode__(self): + return self.name diff --git a/common/djangoapps/django_comment_common/utils.py b/common/djangoapps/django_comment_common/utils.py new file mode 100644 index 0000000000..f74116d59f --- /dev/null +++ b/common/djangoapps/django_comment_common/utils.py @@ -0,0 +1,56 @@ +from django_comment_common.models import Role + +_STUDENT_ROLE_PERMISSIONS = ["vote", "update_thread", "follow_thread", "unfollow_thread", + "update_comment", "create_sub_comment", "unvote", "create_thread", + "follow_commentable", "unfollow_commentable", "create_comment", ] + +_MODERATOR_ROLE_PERMISSIONS = ["edit_content", "delete_thread", "openclose_thread", + "endorse_comment", "delete_comment", "see_all_cohorts"] + +_ADMINISTRATOR_ROLE_PERMISSIONS = ["manage_moderator"] + +def seed_permissions_roles(course_id): + administrator_role = Role.objects.get_or_create(name="Administrator", course_id=course_id)[0] + moderator_role = Role.objects.get_or_create(name="Moderator", course_id=course_id)[0] + community_ta_role = Role.objects.get_or_create(name="Community TA", course_id=course_id)[0] + student_role = Role.objects.get_or_create(name="Student", course_id=course_id)[0] + + for per in _STUDENT_ROLE_PERMISSIONS: + student_role.add_permission(per) + + for per in _MODERATOR_ROLE_PERMISSIONS: + moderator_role.add_permission(per) + + for per in _ADMINISTRATOR_ROLE_PERMISSIONS: + administrator_role.add_permission(per) + + moderator_role.inherit_permissions(student_role) + + # For now, Community TA == Moderator, except for the styling. + community_ta_role.inherit_permissions(moderator_role) + + administrator_role.inherit_permissions(moderator_role) + + +def are_permissions_roles_seeded(course_id): + + try: + administrator_role = Role.objects.get(name="Administrator", course_id=course_id) + moderator_role = Role.objects.get(name="Moderator", course_id=course_id) + student_role = Role.objects.get(name="Student", course_id=course_id) + except: + return False + + for per in _STUDENT_ROLE_PERMISSIONS: + if not student_role.has_permission(per): + return False + + for per in _MODERATOR_ROLE_PERMISSIONS + _STUDENT_ROLE_PERMISSIONS: + if not moderator_role.has_permission(per): + return False + + for per in _ADMINISTRATOR_ROLE_PERMISSIONS + _MODERATOR_ROLE_PERMISSIONS + _STUDENT_ROLE_PERMISSIONS: + if not administrator_role.has_permission(per): + return False + + return True diff --git a/common/djangoapps/mitxmako/README b/common/djangoapps/mitxmako/README index ab04df2cf7..9896d78747 100644 --- a/common/djangoapps/mitxmako/README +++ b/common/djangoapps/mitxmako/README @@ -1,3 +1,11 @@ +The code in this directory is based on: + + django-mako Copyright (c) 2008 Mikeal Rogers + +and is redistributed here with modifications under the same Apache 2.0 license +as the orginal. + + ================================================================================ django-mako ================================================================================ diff --git a/common/lib/capa/capa/verifiers/__init__.py b/common/djangoapps/mitxmako/management/__init__.py similarity index 100% rename from common/lib/capa/capa/verifiers/__init__.py rename to common/djangoapps/mitxmako/management/__init__.py diff --git a/common/djangoapps/mitxmako/management/commands/__init__.py b/common/djangoapps/mitxmako/management/commands/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/common/djangoapps/mitxmako/management/commands/preprocess_assets.py b/common/djangoapps/mitxmako/management/commands/preprocess_assets.py new file mode 100644 index 0000000000..36a2da9ad3 --- /dev/null +++ b/common/djangoapps/mitxmako/management/commands/preprocess_assets.py @@ -0,0 +1,65 @@ +""" +Preprocess templatized asset files, enabling asset authors to use +Python/Django inside of Sass and CoffeeScript. This preprocessing +will happen before the invocation of the asset compiler (currently +handled by the asset Rakefile). + +For this to work, assets need to be named with the appropriate +template extension (e.g., .mako for Mako templates). Currently Mako +is the only template engine supported. +""" +import os + +from django.core.management.base import NoArgsCommand +from django.conf import settings + +from mako.template import Template + +class Command(NoArgsCommand): + """ + Basic management command to preprocess asset template files. + """ + + help = "Preprocess asset template files to ready them for compilation." + + def handle_noargs(self, **options): + """ + Walk over all of the static files directories specified in the + settings file, looking for asset template files (indicated by + a file extension like .mako). + """ + for staticfiles_dir in getattr(settings, "STATICFILES_DIRS", []): + # Cribbed from the django-staticfiles app at: + # https://github.com/jezdez/django-staticfiles/blob/develop/staticfiles/finders.py#L52 + if isinstance(staticfiles_dir, (list, tuple)): + prefix, staticfiles_dir = staticfiles_dir + + # Walk over the current static files directory tree, + # preprocessing files that have a template extension. + for root, dirs, files in os.walk(staticfiles_dir): + for filename in files: + outfile, extension = os.path.splitext(filename) + # We currently only handle Mako templates + if extension == ".mako": + self.__preprocess(os.path.join(root, filename), + os.path.join(root, outfile)) + + + def __context(self): + """ + Return a dict that contains all of the available context + variables to the asset template. + """ + # TODO: do we need to include anything else? + # TODO: do this with the django-settings-context-processor + return { "THEME_NAME" : getattr(settings, "THEME_NAME", None) } + + + def __preprocess(self, infile, outfile): + """ + Run `infile` through the Mako template engine, storing the + result in `outfile`. + """ + with open(outfile, "w") as _outfile: + _outfile.write(Template(filename=str(infile)).render(env=self.__context())) + diff --git a/common/djangoapps/mitxmako/shortcuts.py b/common/djangoapps/mitxmako/shortcuts.py index ebeb0fc180..0766564027 100644 --- a/common/djangoapps/mitxmako/shortcuts.py +++ b/common/djangoapps/mitxmako/shortcuts.py @@ -14,9 +14,57 @@ from django.template import Context from django.http import HttpResponse +import logging from . import middleware from django.conf import settings +from django.core.urlresolvers import reverse +log = logging.getLogger(__name__) + + +def marketing_link(name): + """Returns the correct URL for a link to the marketing site + depending on if the marketing site is enabled + + Since the marketing site is enabled by a setting, we have two + possible URLs for certain links. This function is to decides + which URL should be provided. + """ + + # link_map maps URLs from the marketing site to the old equivalent on + # the Django site + link_map = settings.MKTG_URL_LINK_MAP + if settings.MITX_FEATURES.get('ENABLE_MKTG_SITE') and name in settings.MKTG_URLS: + # special case for when we only want the root marketing URL + if name == 'ROOT': + return settings.MKTG_URLS.get('ROOT') + return settings.MKTG_URLS.get('ROOT') + settings.MKTG_URLS.get(name) + # only link to the old pages when the marketing site isn't on + elif not settings.MITX_FEATURES.get('ENABLE_MKTG_SITE') and name in link_map: + return reverse(link_map[name]) + else: + log.warning("Cannot find corresponding link for name: {name}".format(name=name)) + return '#' + + +def marketing_link_context_processor(request): + """ + A django context processor to give templates access to marketing URLs + + Returns a dict whose keys are the marketing link names usable with the + marketing_link method (e.g. 'ROOT', 'CONTACT', etc.) prefixed with + 'MKTG_URL_' and whose values are the corresponding URLs as computed by the + marketing_link method. + """ + return dict( + [ + ("MKTG_URL_" + k, marketing_link(k)) + for k in ( + settings.MKTG_URL_LINK_MAP.viewkeys() | + settings.MKTG_URLS.viewkeys() + ) + ] + ) def render_to_string(template_name, dictionary, context=None, namespace='main'): @@ -27,6 +75,7 @@ def render_to_string(template_name, dictionary, context=None, namespace='main'): context_dictionary = {} context_instance['settings'] = settings context_instance['MITX_ROOT_URL'] = settings.MITX_ROOT_URL + context_instance['marketing_link'] = marketing_link # In various testing contexts, there might not be a current request context. if middleware.requestcontext is not None: diff --git a/common/djangoapps/mitxmako/template.py b/common/djangoapps/mitxmako/template.py index 6ef8058c7c..5becfbf1df 100644 --- a/common/djangoapps/mitxmako/template.py +++ b/common/djangoapps/mitxmako/template.py @@ -14,6 +14,7 @@ from django.conf import settings from mako.template import Template as MakoTemplate +from mitxmako.shortcuts import marketing_link from mitxmako import middleware @@ -37,7 +38,6 @@ class Template(MakoTemplate): kwargs.update(overrides) super(Template, self).__init__(*args, **kwargs) - def render(self, context_instance): """ This takes a render call with a context (from Django) and translates @@ -55,5 +55,6 @@ class Template(MakoTemplate): context_dictionary['settings'] = settings context_dictionary['MITX_ROOT_URL'] = settings.MITX_ROOT_URL context_dictionary['django_context'] = context_instance + context_dictionary['marketing_link'] = marketing_link return super(Template, self).render_unicode(**context_dictionary) diff --git a/common/djangoapps/mitxmako/tests.py b/common/djangoapps/mitxmako/tests.py new file mode 100644 index 0000000000..21866eb9b5 --- /dev/null +++ b/common/djangoapps/mitxmako/tests.py @@ -0,0 +1,27 @@ +from django.test import TestCase +from django.test.utils import override_settings +from django.core.urlresolvers import reverse +from django.conf import settings +from mitxmako.shortcuts import marketing_link +from mock import patch + + +class ShortcutsTests(TestCase): + """ + Test the mitxmako shortcuts file + """ + + @override_settings(MKTG_URLS={'ROOT': 'dummy-root', 'ABOUT': '/about-us'}) + @override_settings(MKTG_URL_LINK_MAP={'ABOUT': 'login'}) + def test_marketing_link(self): + # test marketing site on + with patch.dict('django.conf.settings.MITX_FEATURES', {'ENABLE_MKTG_SITE': True}): + expected_link = 'dummy-root/about-us' + link = marketing_link('ABOUT') + self.assertEquals(link, expected_link) + # test marketing site off + with patch.dict('django.conf.settings.MITX_FEATURES', {'ENABLE_MKTG_SITE': False}): + # we are using login because it is common across both cms and lms + expected_link = reverse('login') + link = marketing_link('ABOUT') + self.assertEquals(link, expected_link) diff --git a/common/djangoapps/pipeline_mako/templates/static_content.html b/common/djangoapps/pipeline_mako/templates/static_content.html index 302d4d7aa5..2a1308923a 100644 --- a/common/djangoapps/pipeline_mako/templates/static_content.html +++ b/common/djangoapps/pipeline_mako/templates/static_content.html @@ -28,3 +28,8 @@ except: % endfor %endif + +<%def name="include(path)"><% +from django.template.loaders.filesystem import _loader +source, template_path = _loader.load_template_source(path) +%>${source} diff --git a/common/djangoapps/service_status/__init__.py b/common/djangoapps/service_status/__init__.py new file mode 100644 index 0000000000..e90be0088e --- /dev/null +++ b/common/djangoapps/service_status/__init__.py @@ -0,0 +1,3 @@ +""" +Stub for a Django app to report the status of various services +""" diff --git a/common/djangoapps/service_status/tasks.py b/common/djangoapps/service_status/tasks.py new file mode 100644 index 0000000000..40367120b2 --- /dev/null +++ b/common/djangoapps/service_status/tasks.py @@ -0,0 +1,25 @@ +""" +Django Celery tasks for service status app +""" + +import time + +from dogapi import dog_stats_api + +from djcelery import celery + + +@celery.task +@dog_stats_api.timed('status.service.celery.pong') +def delayed_ping(value, delay): + """A simple tasks that replies to a message after a especified amount + of seconds. + """ + if value == 'ping': + result = 'pong' + else: + result = 'got: {0}'.format(value) + + time.sleep(delay) + + return result diff --git a/common/djangoapps/service_status/test.py b/common/djangoapps/service_status/test.py new file mode 100644 index 0000000000..1c4f10497e --- /dev/null +++ b/common/djangoapps/service_status/test.py @@ -0,0 +1,47 @@ +"""Test for async task service status""" + +from django.utils import unittest +from django.test.client import Client +from django.core.urlresolvers import reverse +import json + + +class CeleryConfigTest(unittest.TestCase): + """ + Test that we can get a response from Celery + """ + + def setUp(self): + """ + Create a django test client + """ + self.client = Client() + self.ping_url = reverse('status.service.celery.ping') + + def test_ping(self): + """ + Try to ping celery. + """ + + # Access the service status page, which starts a delayed + # asynchronous task + response = self.client.get(self.ping_url) + + # HTTP response should be successful + self.assertEqual(response.status_code, 200) + + # Expect to get a JSON-serialized dict with + # task and time information + result_dict = json.loads(response.content) + + # Was it successful? + self.assertTrue(result_dict['success']) + + # We should get a "pong" message back + self.assertEqual(result_dict['value'], "pong") + + # We don't know the other dict values exactly, + # but we can assert that they take the right form + self.assertTrue(isinstance(result_dict['task_id'], unicode)) + self.assertTrue(isinstance(result_dict['time'], float)) + self.assertTrue(result_dict['time'] > 0.0) diff --git a/common/djangoapps/service_status/urls.py b/common/djangoapps/service_status/urls.py new file mode 100644 index 0000000000..c5ee44b8b6 --- /dev/null +++ b/common/djangoapps/service_status/urls.py @@ -0,0 +1,15 @@ +""" +Django URLs for service status app +""" + +from django.conf.urls import patterns, url + + +urlpatterns = patterns( + '', + url(r'^$', 'service_status.views.index', name='status.service.index'), + url(r'^celery/$', 'service_status.views.celery_status', + name='status.service.celery.status'), + url(r'^celery/ping/$', 'service_status.views.celery_ping', + name='status.service.celery.ping'), +) diff --git a/common/djangoapps/service_status/views.py b/common/djangoapps/service_status/views.py new file mode 100644 index 0000000000..7233cbdbda --- /dev/null +++ b/common/djangoapps/service_status/views.py @@ -0,0 +1,59 @@ +""" +Django Views for service status app +""" + +import json +import time + +from django.http import HttpResponse + +from dogapi import dog_stats_api + +from service_status import tasks +from djcelery import celery +from celery.exceptions import TimeoutError + + +def index(_): + """ + An empty view + """ + return HttpResponse() + + +@dog_stats_api.timed('status.service.celery.status') +def celery_status(_): + """ + A view that returns Celery stats + """ + stats = celery.control.inspect().stats() or {} + return HttpResponse(json.dumps(stats, indent=4), + mimetype="application/json") + + +@dog_stats_api.timed('status.service.celery.ping') +def celery_ping(_): + """ + A Simple view that checks if Celery can process a simple task + """ + start = time.time() + result = tasks.delayed_ping.apply_async(('ping', 0.1)) + task_id = result.id + + # Wait until we get the result + try: + value = result.get(timeout=4.0) + success = True + except TimeoutError: + value = None + success = False + + output = { + 'success': success, + 'task_id': task_id, + 'value': value, + 'time': time.time() - start, + } + + return HttpResponse(json.dumps(output, indent=4), + mimetype="application/json") diff --git a/common/djangoapps/student/tests/factories.py b/common/djangoapps/student/tests/factories.py index 9560025441..d73bb6f01d 100644 --- a/common/djangoapps/student/tests/factories.py +++ b/common/djangoapps/student/tests/factories.py @@ -1,43 +1,47 @@ from student.models import (User, UserProfile, Registration, - CourseEnrollmentAllowed, CourseEnrollment) + CourseEnrollmentAllowed, CourseEnrollment, + PendingEmailChange) from django.contrib.auth.models import Group from datetime import datetime -from factory import DjangoModelFactory, Factory, SubFactory, PostGenerationMethodCall, post_generation +from factory import DjangoModelFactory, SubFactory, PostGenerationMethodCall, post_generation, Sequence from uuid import uuid4 +# Factories don't have __init__ methods, and are self documenting +# pylint: disable=W0232 + class GroupFactory(DjangoModelFactory): FACTORY_FOR = Group - name = 'staff_MITx/999/Robot_Super_Course' + name = u'staff_MITx/999/Robot_Super_Course' class UserProfileFactory(DjangoModelFactory): FACTORY_FOR = UserProfile user = None - name = 'Robot Test' + name = u'Robot Test' level_of_education = None - gender = 'm' + gender = u'm' mailing_address = None - goals = 'World domination' + goals = u'World domination' class RegistrationFactory(DjangoModelFactory): FACTORY_FOR = Registration user = None - activation_key = uuid4().hex + activation_key = uuid4().hex.decode('ascii') class UserFactory(DjangoModelFactory): FACTORY_FOR = User - username = 'robot' - email = 'robot+test@edx.org' + username = Sequence(u'robot{0}'.format) + email = Sequence(u'robot+test+{0}@edx.org'.format) password = PostGenerationMethodCall('set_password', 'test') - first_name = 'Robot' + first_name = Sequence(u'Robot{0}'.format) last_name = 'Test' is_staff = False is_active = True @@ -64,7 +68,7 @@ class CourseEnrollmentFactory(DjangoModelFactory): FACTORY_FOR = CourseEnrollment user = SubFactory(UserFactory) - course_id = 'edX/toy/2012_Fall' + course_id = u'edX/toy/2012_Fall' class CourseEnrollmentAllowedFactory(DjangoModelFactory): @@ -72,3 +76,17 @@ class CourseEnrollmentAllowedFactory(DjangoModelFactory): email = 'test@edx.org' course_id = 'edX/test/2012_Fall' + + +class PendingEmailChangeFactory(DjangoModelFactory): + """Factory for PendingEmailChange objects + + user: generated by UserFactory + new_email: sequence of new+email+{}@edx.org + activation_key: sequence of integers, padded to 30 characters + """ + FACTORY_FOR = PendingEmailChange + + user = SubFactory(UserFactory) + new_email = Sequence(u'new+email+{0}@edx.org'.format) + activation_key = Sequence(u'{:0<30d}'.format) diff --git a/common/djangoapps/student/tests/test_email.py b/common/djangoapps/student/tests/test_email.py new file mode 100644 index 0000000000..3b31bb5c28 --- /dev/null +++ b/common/djangoapps/student/tests/test_email.py @@ -0,0 +1,261 @@ +import json +import django.db + +from student.tests.factories import UserFactory, RegistrationFactory, PendingEmailChangeFactory +from student.views import reactivation_email_for_user, change_email_request, confirm_email_change +from student.models import UserProfile, PendingEmailChange +from django.contrib.auth.models import User +from django.test import TestCase, TransactionTestCase +from django.test.client import RequestFactory +from mock import Mock, patch +from django.http import Http404, HttpResponse +from django.conf import settings +from nose.plugins.skip import SkipTest + + +class TestException(Exception): + """Exception used for testing that nothing will catch explicitly""" + pass + + +def mock_render_to_string(template_name, context): + """Return a string that encodes template_name and context""" + return str((template_name, sorted(context.iteritems()))) + + +def mock_render_to_response(template_name, context): + """Return an HttpResponse with content that encodes template_name and context""" + return HttpResponse(mock_render_to_string(template_name, context)) + + +class EmailTestMixin(object): + """Adds useful assertions for testing `email_user`""" + + def assertEmailUser(self, email_user, subject_template, subject_context, body_template, body_context): + """Assert that `email_user` was used to send and email with the supplied subject and body + + `email_user`: The mock `django.contrib.auth.models.User.email_user` function + to verify + `subject_template`: The template to have been used for the subject + `subject_context`: The context to have been used for the subject + `body_template`: The template to have been used for the body + `body_context`: The context to have been used for the body + """ + email_user.assert_called_with( + mock_render_to_string(subject_template, subject_context), + mock_render_to_string(body_template, body_context), + settings.DEFAULT_FROM_EMAIL + ) + + +@patch('student.views.render_to_string', Mock(side_effect=mock_render_to_string, autospec=True)) +@patch('django.contrib.auth.models.User.email_user') +class ReactivationEmailTests(EmailTestMixin, TestCase): + """Test sending a reactivation email to a user""" + + def setUp(self): + self.user = UserFactory.create() + self.registration = RegistrationFactory.create(user=self.user) + + def reactivation_email(self): + """Send the reactivation email, and return the response as json data""" + return json.loads(reactivation_email_for_user(self.user).content) + + def assertReactivateEmailSent(self, email_user): + """Assert that the correct reactivation email has been sent""" + context = { + 'name': self.user.profile.name, + 'key': self.registration.activation_key + } + + self.assertEmailUser( + email_user, + 'emails/activation_email_subject.txt', + context, + 'emails/activation_email.txt', + context + ) + + def test_reactivation_email_failure(self, email_user): + self.user.email_user.side_effect = Exception + response_data = self.reactivation_email() + + self.assertReactivateEmailSent(email_user) + self.assertFalse(response_data['success']) + + def test_reactivation_email_success(self, email_user): + response_data = self.reactivation_email() + + self.assertReactivateEmailSent(email_user) + self.assertTrue(response_data['success']) + + +class EmailChangeRequestTests(TestCase): + """Test changing a user's email address""" + + def setUp(self): + self.user = UserFactory.create() + self.new_email = 'new.email@edx.org' + self.req_factory = RequestFactory() + self.request = self.req_factory.post('unused_url', data={ + 'password': 'test', + 'new_email': self.new_email + }) + self.request.user = self.user + self.user.email_user = Mock() + + def run_request(self, request=None): + """Execute request and return result parsed as json + + If request isn't passed in, use self.request instead + """ + if request is None: + request = self.request + + response = change_email_request(self.request) + return json.loads(response.content) + + def assertFailedRequest(self, response_data, expected_error): + """Assert that `response_data` indicates a failed request that returns `expected_error`""" + self.assertFalse(response_data['success']) + self.assertEquals(expected_error, response_data['error']) + self.assertFalse(self.user.email_user.called) + + def test_unauthenticated(self): + self.user.is_authenticated = False + with self.assertRaises(Http404): + change_email_request(self.request) + self.assertFalse(self.user.email_user.called) + + def test_invalid_password(self): + self.request.POST['password'] = 'wrong' + self.assertFailedRequest(self.run_request(), 'Invalid password') + + def test_invalid_emails(self): + for email in ('bad_email', 'bad_email@', '@bad_email'): + self.request.POST['new_email'] = email + self.assertFailedRequest(self.run_request(), 'Valid e-mail address required.') + + def check_duplicate_email(self, email): + """Test that a request to change a users email to `email` fails""" + request = self.req_factory.post('unused_url', data={ + 'new_email': email, + 'password': 'test', + }) + request.user = self.user + self.assertFailedRequest(self.run_request(request), 'An account with this e-mail already exists.') + + def test_duplicate_email(self): + UserFactory.create(email=self.new_email) + self.check_duplicate_email(self.new_email) + + def test_capitalized_duplicate_email(self): + raise SkipTest("We currently don't check for emails in a case insensitive way, but we should") + UserFactory.create(email=self.new_email) + self.check_duplicate_email(self.new_email.capitalize()) + + # TODO: Finish testing the rest of change_email_request + + +@patch('django.contrib.auth.models.User.email_user') +@patch('student.views.render_to_response', Mock(side_effect=mock_render_to_response, autospec=True)) +@patch('student.views.render_to_string', Mock(side_effect=mock_render_to_string, autospec=True)) +class EmailChangeConfirmationTests(EmailTestMixin, TransactionTestCase): + """Test that confirmation of email change requests function even in the face of exceptions thrown while sending email""" + def setUp(self): + self.user = UserFactory.create() + self.profile = UserProfile.objects.get(user=self.user) + self.req_factory = RequestFactory() + self.request = self.req_factory.get('unused_url') + self.request.user = self.user + self.user.email_user = Mock() + self.pending_change_request = PendingEmailChangeFactory.create(user=self.user) + self.key = self.pending_change_request.activation_key + + def assertRolledBack(self): + """Assert that no changes to user, profile, or pending email have been made to the db""" + self.assertEquals(self.user.email, User.objects.get(username=self.user.username).email) + self.assertEquals(self.profile.meta, UserProfile.objects.get(user=self.user).meta) + self.assertEquals(1, PendingEmailChange.objects.count()) + + def assertFailedBeforeEmailing(self, email_user): + """Assert that the function failed before emailing a user""" + self.assertRolledBack() + self.assertFalse(email_user.called) + + def check_confirm_email_change(self, expected_template, expected_context): + """Call `confirm_email_change` and assert that the content was generated as expected + + `expected_template`: The name of the template that should have been used + to generate the content + `expected_context`: The context dictionary that should have been used to + generate the content + """ + response = confirm_email_change(self.request, self.key) + self.assertEquals( + mock_render_to_response(expected_template, expected_context).content, + response.content + ) + + def assertChangeEmailSent(self, email_user): + """Assert that the correct email was sent to confirm an email change""" + context = { + 'old_email': self.user.email, + 'new_email': self.pending_change_request.new_email, + } + self.assertEmailUser( + email_user, + 'emails/email_change_subject.txt', + context, + 'emails/confirm_email_change.txt', + context + ) + + def test_not_pending(self, email_user): + self.key = 'not_a_key' + self.check_confirm_email_change('invalid_email_key.html', {}) + self.assertFailedBeforeEmailing(email_user) + + def test_duplicate_email(self, email_user): + UserFactory.create(email=self.pending_change_request.new_email) + self.check_confirm_email_change('email_exists.html', {}) + self.assertFailedBeforeEmailing(email_user) + + def test_old_email_fails(self, email_user): + email_user.side_effect = [Exception, None] + self.check_confirm_email_change('email_change_failed.html', { + 'email': self.user.email, + }) + self.assertRolledBack() + self.assertChangeEmailSent(email_user) + + def test_new_email_fails(self, email_user): + email_user.side_effect = [None, Exception] + self.check_confirm_email_change('email_change_failed.html', { + 'email': self.pending_change_request.new_email + }) + self.assertRolledBack() + self.assertChangeEmailSent(email_user) + + def test_successful_email_change(self, email_user): + self.check_confirm_email_change('email_change_successful.html', { + 'old_email': self.user.email, + 'new_email': self.pending_change_request.new_email + }) + self.assertChangeEmailSent(email_user) + meta = json.loads(UserProfile.objects.get(user=self.user).meta) + self.assertIn('old_emails', meta) + self.assertEquals(self.user.email, meta['old_emails'][0][0]) + self.assertEquals( + self.pending_change_request.new_email, + User.objects.get(username=self.user.username).email + ) + self.assertEquals(0, PendingEmailChange.objects.count()) + + @patch('student.views.PendingEmailChange.objects.get', Mock(side_effect=TestException)) + @patch('student.views.transaction.rollback', wraps=django.db.transaction.rollback) + def test_always_rollback(self, rollback, _email_user): + with self.assertRaises(TestException): + confirm_email_change(self.request, self.key) + + rollback.assert_called_with() diff --git a/common/djangoapps/student/views.py b/common/djangoapps/student/views.py index d204ef7b6e..c74650b7f4 100644 --- a/common/djangoapps/student/views.py +++ b/common/djangoapps/student/views.py @@ -7,7 +7,7 @@ import string import sys import urllib import uuid - +import time from django.conf import settings from django.contrib.auth import logout, authenticate, login @@ -19,10 +19,11 @@ from django.core.context_processors import csrf from django.core.mail import send_mail from django.core.urlresolvers import reverse from django.core.validators import validate_email, validate_slug, ValidationError -from django.db import IntegrityError -from django.http import HttpResponse, HttpResponseRedirect, Http404 +from django.db import IntegrityError, transaction +from django.http import HttpResponse, HttpResponseBadRequest, HttpResponseForbidden, HttpResponseNotAllowed, HttpResponseRedirect, Http404 from django.shortcuts import redirect from django_future.csrf import ensure_csrf_cookie, csrf_exempt +from django.utils.http import cookie_date from mitxmako.shortcuts import render_to_response, render_to_string from bs4 import BeautifulSoup @@ -212,6 +213,36 @@ def _cert_info(user, course, cert_status): return d +@ensure_csrf_cookie +def signin_user(request): + """ + This view will display the non-modal login form + """ + if request.user.is_authenticated(): + return redirect(reverse('dashboard')) + + context = { + 'course_id': request.GET.get('course_id'), + 'enrollment_action': request.GET.get('enrollment_action') + } + return render_to_response('login.html', context) + + +@ensure_csrf_cookie +def register_user(request): + """ + This view will display the non-modal registration form + """ + if request.user.is_authenticated(): + return redirect(reverse('dashboard')) + + context = { + 'course_id': request.GET.get('course_id'), + 'enrollment_action': request.GET.get('enrollment_action') + } + return render_to_response('register.html', context) + + @login_required @ensure_csrf_cookie def dashboard(request): @@ -250,7 +281,7 @@ def dashboard(request): exam_registrations = {course.id: exam_registration_info(request.user, course) for course in courses} # Get the 3 most recent news - top_news = _get_news(top=3) + top_news = _get_news(top=3) if not settings.MITX_FEATURES.get('ENABLE_MKTG_SITE', False) else None context = {'courses': courses, 'message': message, @@ -275,35 +306,47 @@ def try_change_enrollment(request): """ if 'enrollment_action' in request.POST: try: - enrollment_output = change_enrollment(request) + enrollment_response = change_enrollment(request) # There isn't really a way to display the results to the user, so we just log it # We expect the enrollment to be a success, and will show up on the dashboard anyway - log.info("Attempted to automatically enroll after login. Results: {0}".format(enrollment_output)) + log.info( + "Attempted to automatically enroll after login. Response code: {0}; response body: {1}".format( + enrollment_response.status_code, + enrollment_response.content + ) + ) except Exception, e: log.exception("Exception automatically enrolling after login: {0}".format(str(e))) -@login_required -def change_enrollment_view(request): - """Delegate to change_enrollment to actually do the work.""" - return HttpResponse(json.dumps(change_enrollment(request))) - - - def change_enrollment(request): + """ + Modify the enrollment status for the logged-in user. + + The request parameter must be a POST request (other methods return 405) + that specifies course_id and enrollment_action parameters. If course_id or + enrollment_action is not specified, if course_id is not valid, if + enrollment_action is something other than "enroll" or "unenroll", if + enrollment_action is "enroll" and enrollment is closed for the course, or + if enrollment_action is "unenroll" and the user is not enrolled in the + course, a 400 error will be returned. If the user is not logged in, 403 + will be returned; it is important that only this case return 403 so the + front end can redirect the user to a registration or login page when this + happens. This function should only be called from an AJAX request or + as a post-login/registration helper, so the error messages in the responses + should never actually be user-visible. + """ if request.method != "POST": - raise Http404 + return HttpResponseNotAllowed(["POST"]) user = request.user if not user.is_authenticated(): - raise Http404 + return HttpResponseForbidden() - action = request.POST.get("enrollment_action", "") - - course_id = request.POST.get("course_id", None) + action = request.POST.get("enrollment_action") + course_id = request.POST.get("course_id") if course_id is None: - return HttpResponse(json.dumps({'success': False, - 'error': 'There was an error receiving the course id.'})) + return HttpResponseBadRequest("Course id not specified") if action == "enroll": # Make sure the course exists @@ -313,12 +356,10 @@ def change_enrollment(request): except ItemNotFoundError: log.warning("User {0} tried to enroll in non-existent course {1}" .format(user.username, course_id)) - return {'success': False, 'error': 'The course requested does not exist.'} + return HttpResponseBadRequest("Course id is invalid") if not has_access(user, course, 'enroll'): - return {'success': False, - 'error': 'enrollment in {} not allowed at this time' - .format(course.display_name_with_default)} + return HttpResponseBadRequest("Enrollment is closed") org, course_num, run = course_id.split("/") statsd.increment("common.student.enrollment", @@ -332,7 +373,7 @@ def change_enrollment(request): # If we've already created this enrollment in a separate transaction, # then just continue pass - return {'success': True} + return HttpResponse() elif action == "unenroll": try: @@ -345,21 +386,17 @@ def change_enrollment(request): "course:{0}".format(course_num), "run:{0}".format(run)]) - return {'success': True} + return HttpResponse() except CourseEnrollment.DoesNotExist: - return {'success': False, 'error': 'You are not enrolled for this course.'} + return HttpResponseBadRequest("You are not enrolled in this course") else: - return {'success': False, 'error': 'Invalid enrollment_action.'} - - return {'success': False, 'error': 'We weren\'t able to unenroll you. Please try again.'} + return HttpResponseBadRequest("Enrollment action is invalid") @ensure_csrf_cookie def accounts_login(request, error=""): - - return render_to_response('accounts_login.html', {'error': error}) - + return render_to_response('login.html', {'error': error}) # Need different levels of logging @@ -403,8 +440,29 @@ def login_user(request, error=""): try_change_enrollment(request) statsd.increment("common.student.successful_login") + response = HttpResponse(json.dumps({'success': True})) - return HttpResponse(json.dumps({'success': True})) + # set the login cookie for the edx marketing site + # we want this cookie to be accessed via javascript + # so httponly is set to None + + if request.session.get_expire_at_browser_close(): + max_age = None + expires = None + else: + max_age = request.session.get_expiry_age() + expires_time = time.time() + max_age + expires = cookie_date(expires_time) + + + response.set_cookie(settings.EDXMKTG_COOKIE_NAME, + 'true', max_age=max_age, + expires=expires, domain=settings.SESSION_COOKIE_DOMAIN, + path='/', + secure=None, + httponly=None) + + return response log.warning(u"Login failed - Account not active for user {0}, resending activation".format(username)) @@ -418,9 +476,18 @@ def login_user(request, error=""): @ensure_csrf_cookie def logout_user(request): - ''' HTTP request to log out the user. Redirects to marketing page''' + ''' + HTTP request to log out the user. Redirects to marketing page. + Deletes both the CSRF and sessionid cookies so the marketing + site can determine the logged in state of the user + ''' + logout(request) - return redirect('/') + response = redirect('/') + response.delete_cookie(settings.EDXMKTG_COOKIE_NAME, + path='/', + domain=settings.SESSION_COOKIE_DOMAIN) + return response @login_required @@ -460,12 +527,12 @@ def _do_create_account(post_vars): js = {'success': False} # Figure out the cause of the integrity error if len(User.objects.filter(username=post_vars['username'])) > 0: - js['value'] = "An account with this username already exists." + js['value'] = "An account with the Public Username '" + post_vars['username'] + "' already exists." js['field'] = 'username' return HttpResponse(json.dumps(js)) if len(User.objects.filter(email=post_vars['email'])) > 0: - js['value'] = "An account with this e-mail already exists." + js['value'] = "An account with the Email '" + post_vars['email'] + "' already exists." js['field'] = 'email' return HttpResponse(json.dumps(js)) @@ -588,7 +655,7 @@ def create_account(request, post_override=None): elif not settings.GENERATE_RANDOM_USER_CREDENTIALS: res = user.email_user(subject, message, settings.DEFAULT_FROM_EMAIL) except: - log.exception(sys.exc_info()) + log.warning('Unable to send activation email to user', exc_info=True) js['value'] = 'Could not send activation e-mail.' return HttpResponse(json.dumps(js)) @@ -615,7 +682,31 @@ def create_account(request, post_override=None): statsd.increment("common.student.account_created") js = {'success': True} - return HttpResponse(json.dumps(js), mimetype="application/json") + HttpResponse(json.dumps(js), mimetype="application/json") + + response = HttpResponse(json.dumps({'success': True})) + + # set the login cookie for the edx marketing site + # we want this cookie to be accessed via javascript + # so httponly is set to None + + if request.session.get_expire_at_browser_close(): + max_age = None + expires = None + else: + max_age = request.session.get_expiry_age() + expires_time = time.time() + max_age + expires = cookie_date(expires_time) + + + response.set_cookie(settings.EDXMKTG_COOKIE_NAME, + 'true', max_age=max_age, + expires=expires, domain=settings.SESSION_COOKIE_DOMAIN, + path='/', + secure=None, + httponly=None) + return response + def exam_registration_info(user, course): @@ -701,7 +792,6 @@ def create_exam_registration(request, post_override=None): for fieldname in TestCenterUser.user_provided_fields(): if fieldname in post_vars: demographic_data[fieldname] = (post_vars[fieldname]).strip() - try: testcenter_user = TestCenterUser.objects.get(user=user) needs_updating = testcenter_user.needs_update(demographic_data) @@ -894,7 +984,11 @@ def reactivation_email_for_user(user): subject = ''.join(subject.splitlines()) message = render_to_string('emails/activation_email.txt', d) - res = user.email_user(subject, message, settings.DEFAULT_FROM_EMAIL) + try: + res = user.email_user(subject, message, settings.DEFAULT_FROM_EMAIL) + except: + log.warning('Unable to send reactivation email', exc_info=True) + return HttpResponse(json.dumps({'success': False, 'error': 'Unable to send reactivation email'})) return HttpResponse(json.dumps({'success': True})) @@ -920,7 +1014,7 @@ def change_email_request(request): return HttpResponse(json.dumps({'success': False, 'error': 'Valid e-mail address required.'})) - if len(User.objects.filter(email=new_email)) != 0: + if User.objects.filter(email=new_email).count() != 0: ## CRITICAL TODO: Handle case sensitivity for e-mails return HttpResponse(json.dumps({'success': False, 'error': 'An account with this e-mail already exists.'})) @@ -955,41 +1049,63 @@ def change_email_request(request): @ensure_csrf_cookie +@transaction.commit_manually def confirm_email_change(request, key): ''' User requested a new e-mail. This is called when the activation link is clicked. We confirm with the old e-mail, and update ''' try: - pec = PendingEmailChange.objects.get(activation_key=key) - except PendingEmailChange.DoesNotExist: - return render_to_response("invalid_email_key.html", {}) + try: + pec = PendingEmailChange.objects.get(activation_key=key) + except PendingEmailChange.DoesNotExist: + transaction.rollback() + return render_to_response("invalid_email_key.html", {}) - user = pec.user - d = {'old_email': user.email, - 'new_email': pec.new_email} + user = pec.user + address_context = { + 'old_email': user.email, + 'new_email': pec.new_email + } - if len(User.objects.filter(email=pec.new_email)) != 0: - return render_to_response("email_exists.html", d) + if len(User.objects.filter(email=pec.new_email)) != 0: + transaction.rollback() + return render_to_response("email_exists.html", {}) - subject = render_to_string('emails/email_change_subject.txt', d) - subject = ''.join(subject.splitlines()) - message = render_to_string('emails/confirm_email_change.txt', d) - up = UserProfile.objects.get(user=user) - meta = up.get_meta() - if 'old_emails' not in meta: - meta['old_emails'] = [] - meta['old_emails'].append([user.email, datetime.datetime.now().isoformat()]) - up.set_meta(meta) - up.save() - # Send it to the old email... - user.email_user(subject, message, settings.DEFAULT_FROM_EMAIL) - user.email = pec.new_email - user.save() - pec.delete() - # And send it to the new email... - user.email_user(subject, message, settings.DEFAULT_FROM_EMAIL) + subject = render_to_string('emails/email_change_subject.txt', address_context) + subject = ''.join(subject.splitlines()) + message = render_to_string('emails/confirm_email_change.txt', address_context) + up = UserProfile.objects.get(user=user) + meta = up.get_meta() + if 'old_emails' not in meta: + meta['old_emails'] = [] + meta['old_emails'].append([user.email, datetime.datetime.now().isoformat()]) + up.set_meta(meta) + up.save() + # Send it to the old email... + try: + user.email_user(subject, message, settings.DEFAULT_FROM_EMAIL) + except Exception: + transaction.rollback() + log.warning('Unable to send confirmation email to old address', exc_info=True) + return render_to_response("email_change_failed.html", {'email': user.email}) - return render_to_response("email_change_successful.html", d) + user.email = pec.new_email + user.save() + pec.delete() + # And send it to the new email... + try: + user.email_user(subject, message, settings.DEFAULT_FROM_EMAIL) + except Exception: + transaction.rollback() + log.warning('Unable to send confirmation email to new address', exc_info=True) + return render_to_response("email_change_failed.html", {'email': pec.new_email}) + + transaction.commit() + return render_to_response("email_change_successful.html", address_context) + except Exception: + # If we get an unexpected exception, be sure to rollback the transaction + transaction.rollback() + raise @ensure_csrf_cookie diff --git a/common/djangoapps/terrain/browser.py b/common/djangoapps/terrain/browser.py index 1d371a3242..a932863322 100644 --- a/common/djangoapps/terrain/browser.py +++ b/common/djangoapps/terrain/browser.py @@ -1,50 +1,105 @@ +""" +Browser set up for acceptance tests. +""" + +#pylint: disable=E1101 +#pylint: disable=W0613 +#pylint: disable=W0611 + from lettuce import before, after, world from splinter.browser import Browser from logging import getLogger from django.core.management import call_command from django.conf import settings +from selenium.common.exceptions import WebDriverException # Let the LMS and CMS do their one-time setup # For example, setting up mongo caches from lms import one_time_startup from cms import one_time_startup -logger = getLogger(__name__) -logger.info("Loading the lettuce acceptance testing terrain file...") +# There is an import issue when using django-staticfiles with lettuce +# Lettuce assumes that we are using django.contrib.staticfiles, +# but the rest of the app assumes we are using django-staticfiles +# (in particular, django-pipeline and our mako implementation) +# To resolve this, we check whether staticfiles is installed, +# then redirect imports for django.contrib.staticfiles +# to use staticfiles. +try: + import staticfiles +except ImportError: + pass +else: + import sys + sys.modules['django.contrib.staticfiles'] = staticfiles + +LOGGER = getLogger(__name__) +LOGGER.info("Loading the lettuce acceptance testing terrain file...") + +MAX_VALID_BROWSER_ATTEMPTS = 20 @before.harvest def initial_setup(server): - ''' - Launch the browser once before executing the tests - ''' + """ + Launch the browser once before executing the tests. + """ browser_driver = getattr(settings, 'LETTUCE_BROWSER', 'chrome') - world.browser = Browser(browser_driver) + + # There is an issue with ChromeDriver2 r195627 on Ubuntu + # in which we sometimes get an invalid browser session. + # This is a work-around to ensure that we get a valid session. + success = False + num_attempts = 0 + while (not success) and num_attempts < MAX_VALID_BROWSER_ATTEMPTS: + + # Get a browser session + world.browser = Browser(browser_driver) + + # Try to visit the main page + # If the browser session is invalid, this will + # raise a WebDriverException + try: + world.visit('/') + + except WebDriverException: + world.browser.quit() + num_attempts += 1 + + else: + success = True + + # If we were unable to get a valid session within the limit of attempts, + # then we cannot run the tests. + if not success: + raise IOError("Could not acquire valid ChromeDriver browser session.") + + # Set the browser size to 1280x1024 + world.browser.driver.set_window_size(1280, 1024) @before.each_scenario def reset_data(scenario): - ''' + """ Clean out the django test database defined in the envs/acceptance.py file: mitx_all/db/test_mitx.db - ''' - logger.debug("Flushing the test database...") + """ + LOGGER.debug("Flushing the test database...") call_command('flush', interactive=False) @after.each_scenario def screenshot_on_error(scenario): - ''' - Save a screenshot to help with debugging - ''' + """ + Save a screenshot to help with debugging. + """ if scenario.failed: world.browser.driver.save_screenshot('/tmp/last_failed_scenario.png') @after.all def teardown_browser(total): - ''' - Quit the browser after executing the tests - ''' + """ + Quit the browser after executing the tests. + """ world.browser.quit() - pass diff --git a/common/djangoapps/terrain/course_helpers.py b/common/djangoapps/terrain/course_helpers.py index 9d6837ae86..cc1f770217 100644 --- a/common/djangoapps/terrain/course_helpers.py +++ b/common/djangoapps/terrain/course_helpers.py @@ -38,9 +38,11 @@ def create_user(uname): @world.absorb def log_in(username, password): - ''' - Log the user in programatically - ''' + """ + Log the user in programatically. + This will delete any existing cookies to ensure that the user + logs in to the correct session. + """ # Authenticate the user user = authenticate(username=username, password=password) @@ -60,15 +62,8 @@ def log_in(username, password): # Retrieve the sessionid and add it to the browser's cookies cookie_dict = {settings.SESSION_COOKIE_NAME: request.session.session_key} - try: - world.browser.cookies.add(cookie_dict) - - # WebDriver has an issue where we cannot set cookies - # before we make a GET request, so if we get an error, - # we load the '/' page and try again - except: - world.browser.visit(django_url('/')) - world.browser.cookies.add(cookie_dict) + world.browser.cookies.delete() + world.browser.cookies.add(cookie_dict) @world.absorb diff --git a/common/djangoapps/terrain/factories.py b/common/djangoapps/terrain/factories.py index 768c51b25e..decce42368 100644 --- a/common/djangoapps/terrain/factories.py +++ b/common/djangoapps/terrain/factories.py @@ -13,6 +13,7 @@ class UserFactory(sf.UserFactory): """ User account for lms / cms """ + FACTORY_DJANGO_GET_OR_CREATE = ('username',) pass @@ -21,6 +22,7 @@ class UserProfileFactory(sf.UserProfileFactory): """ Demographics etc for the User """ + FACTORY_DJANGO_GET_OR_CREATE = ('user',) pass @@ -29,6 +31,7 @@ class RegistrationFactory(sf.RegistrationFactory): """ Activation key for registering the user account """ + FACTORY_DJANGO_GET_OR_CREATE = ('user',) pass diff --git a/common/djangoapps/terrain/steps.py b/common/djangoapps/terrain/steps.py index fdab514177..1d9e59cd72 100644 --- a/common/djangoapps/terrain/steps.py +++ b/common/djangoapps/terrain/steps.py @@ -122,9 +122,19 @@ def should_see_a_link_called(step, text): assert len(world.browser.find_link_by_text(text)) > 0 -@step(r'should see "(.*)" (?:somewhere|anywhere) in (?:the|this) page') -def should_see_in_the_page(step, text): - assert_in(text, world.css_text('body')) +@step(r'should see (?:the|a) link with the id "([^"]*)" called "([^"]*)"$') +def should_have_link_with_id_and_text(step, link_id, text): + link = world.browser.find_by_id(link_id) + assert len(link) > 0 + assert_equals(link.text, text) + + +@step(r'should( not)? see "(.*)" (?:somewhere|anywhere) (?:in|on) (?:the|this) page') +def should_see_in_the_page(step, doesnt_appear, text): + if doesnt_appear: + assert world.browser.is_text_not_present(text, wait_time=5) + else: + assert world.browser.is_text_present(text, wait_time=5) @step('I am logged in$') @@ -144,3 +154,8 @@ def i_am_an_edx_user(step): @step(u'User "([^"]*)" is an edX user$') def registered_edx_user(step, uname): world.create_user(uname) + + +@step(u'All dialogs should be closed$') +def dialogs_are_closed(step): + assert world.dialogs_closed() diff --git a/common/djangoapps/terrain/ui_helpers.py b/common/djangoapps/terrain/ui_helpers.py index d4d99e17b5..ecd43eb719 100644 --- a/common/djangoapps/terrain/ui_helpers.py +++ b/common/djangoapps/terrain/ui_helpers.py @@ -1,10 +1,10 @@ #pylint: disable=C0111 #pylint: disable=W0621 -from lettuce import world, step +from lettuce import world import time from urllib import quote_plus -from selenium.common.exceptions import WebDriverException +from selenium.common.exceptions import WebDriverException, StaleElementReferenceException from selenium.webdriver.support import expected_conditions as EC from selenium.webdriver.common.by import By from selenium.webdriver.support.ui import WebDriverWait @@ -32,8 +32,13 @@ def url_equals(url): @world.absorb -def is_css_present(css_selector): - return world.browser.is_element_present_by_css(css_selector, wait_time=4) +def is_css_present(css_selector, wait_time=5): + return world.browser.is_element_present_by_css(css_selector, wait_time=wait_time) + + +@world.absorb +def is_css_not_present(css_selector, wait_time=5): + return world.browser.is_element_not_present_by_css(css_selector, wait_time=wait_time) @world.absorb @@ -42,23 +47,21 @@ def css_has_text(css_selector, text): @world.absorb -def css_find(css): +def css_find(css, wait_time=5): def is_visible(driver): return EC.visibility_of_element_located((By.CSS_SELECTOR, css,)) - world.browser.is_element_present_by_css(css, 5) + world.browser.is_element_present_by_css(css, wait_time=wait_time) wait_for(is_visible) return world.browser.find_by_css(css) @world.absorb def css_click(css_selector): - ''' - First try to use the regular click method, - but if clicking in the middle of an element - doesn't work it might be that it thinks some other - element is on top of it there so click in the upper left - ''' + """ + Perform a click on a CSS selector, retrying if it initially fails + """ + assert is_css_present(css_selector) try: world.browser.find_by_css(css_selector).click() @@ -66,7 +69,7 @@ def css_click(css_selector): # Occassionally, MathJax or other JavaScript can cover up # an element temporarily. # If this happens, wait a second, then try again - time.sleep(1) + world.wait(1) world.browser.find_by_css(css_selector).click() @@ -82,8 +85,17 @@ def css_click_at(css, x=10, y=10): e.action_chains.perform() +@world.absorb +def id_click(elem_id): + """ + Perform a click on an element as specified by its id + """ + world.css_click('#%s' % elem_id) + + @world.absorb def css_fill(css_selector, text): + assert is_css_present(css_selector) world.browser.find_by_css(css_selector).first.fill(text) @@ -97,16 +109,33 @@ def css_text(css_selector): # Wait for the css selector to appear if world.is_css_present(css_selector): - return world.browser.find_by_css(css_selector).first.text + try: + return world.browser.find_by_css(css_selector).first.text + except StaleElementReferenceException: + # The DOM was still redrawing. Wait a second and try again. + world.wait(1) + return world.browser.find_by_css(css_selector).first.text else: return "" @world.absorb def css_visible(css_selector): + assert is_css_present(css_selector) return world.browser.find_by_css(css_selector).visible +@world.absorb +def dialogs_closed(): + def are_dialogs_closed(driver): + ''' + Return True when no modal dialogs are visible + ''' + return not css_visible('.modal') + wait_for(are_dialogs_closed) + return not css_visible('.modal') + + @world.absorb def save_the_html(path='/tmp'): u = world.browser.url @@ -114,4 +143,18 @@ def save_the_html(path='/tmp'): filename = '%s.html' % quote_plus(u) f = open('%s/%s' % (path, filename), 'w') f.write(html) - f.close + f.close() + + +@world.absorb +def click_course_settings(): + course_settings_css = 'li.nav-course-settings' + if world.browser.is_element_present_by_css(course_settings_css): + world.css_click(course_settings_css) + + +@world.absorb +def click_tools(): + tools_css = 'li.nav-course-tools' + if world.browser.is_element_present_by_css(tools_css): + world.css_click(tools_css) diff --git a/common/djangoapps/util/views.py b/common/djangoapps/util/views.py index 4eae1d66e5..d0aa0dc680 100644 --- a/common/djangoapps/util/views.py +++ b/common/djangoapps/util/views.py @@ -16,7 +16,7 @@ from mitxmako.shortcuts import render_to_response, render_to_string from urllib import urlencode import zendesk -import capa.calc +import calc import track.views @@ -27,7 +27,7 @@ def calculate(request): ''' Calculator in footer of every page. ''' equation = request.GET['equation'] try: - result = capa.calc.evaluator({}, {}, equation) + result = calc.evaluator({}, {}, equation) except: event = {'error': map(str, sys.exc_info()), 'equation': equation} @@ -209,30 +209,3 @@ def accepts(request, media_type): accept = parse_accept_header(request.META.get("HTTP_ACCEPT", "")) return media_type in [t for (t, p, q) in accept] - -def debug_request(request): - """Return a pretty printed version of the request""" - - return HttpResponse(""" -

    request:

    -
    {0}
    - -

    request.GET

    : - -
    {1}
    - -

    request.POST

    : -
    {2}
    - -

    request.REQUEST

    : -
    {3}
    - - - - -""".format( - pprint.pformat(request), - pprint.pformat(dict(request.GET)), - pprint.pformat(dict(request.POST)), - pprint.pformat(dict(request.REQUEST)), - )) diff --git a/common/lib/.gitignore b/common/lib/.gitignore deleted file mode 100644 index bf6b783416..0000000000 --- a/common/lib/.gitignore +++ /dev/null @@ -1 +0,0 @@ -*/jasmine_test_runner.html diff --git a/common/lib/calc/.coveragerc b/common/lib/calc/.coveragerc new file mode 100644 index 0000000000..352ddf399e --- /dev/null +++ b/common/lib/calc/.coveragerc @@ -0,0 +1,15 @@ +# .coveragerc for common/lib/calc +[run] +data_file = reports/common/lib/calc/.coverage +source = common/lib/calc +branch = true + +[report] +ignore_errors = True + +[html] +title = Calc Python Test Coverage Report +directory = reports/common/lib/calc/cover + +[xml] +output = reports/common/lib/calc/coverage.xml diff --git a/common/lib/capa/capa/calc.py b/common/lib/calc/calc.py similarity index 88% rename from common/lib/capa/capa/calc.py rename to common/lib/calc/calc.py index bb1fb97153..2ee82e2fb4 100644 --- a/common/lib/capa/capa/calc.py +++ b/common/lib/calc/calc.py @@ -144,6 +144,8 @@ def evaluator(variables, functions, string, cs=False): return x def parallel(x): # Parallel resistors [ 1 2 ] => 2/3 + # convert from pyparsing.ParseResults, which doesn't support '0 in x' + x = list(x) if len(x) == 1: return x[0] if 0 in x: @@ -180,8 +182,8 @@ def evaluator(variables, functions, string, cs=False): number_part = Word(nums) - # 0.33 or 7 or .34 - inner_number = (number_part + Optional("." + number_part)) | ("." + number_part) + # 0.33 or 7 or .34 or 16. + inner_number = (number_part + Optional("." + Optional(number_part))) | ("." + number_part) # 0.33k or -17 number = (Optional(minus | plus) + inner_number @@ -230,27 +232,3 @@ def evaluator(variables, functions, string, cs=False): expr << Optional((plus | minus)) + term + ZeroOrMore((plus | minus) + term) # -5 + 4 - 3 expr = expr.setParseAction(sum_parse_action) return (expr + stringEnd).parseString(string)[0] - -if __name__ == '__main__': - variables = {'R1': 2.0, 'R3': 4.0} - functions = {'sin': numpy.sin, 'cos': numpy.cos} - print "X", evaluator(variables, functions, "10000||sin(7+5)-6k") - print "X", evaluator(variables, functions, "13") - print evaluator({'R1': 2.0, 'R3': 4.0}, {}, "13") - - print evaluator({'e1': 1, 'e2': 1.0, 'R3': 7, 'V0': 5, 'R5': 15, 'I1': 1, 'R4': 6}, {}, "e2") - - print evaluator({'a': 2.2997471478310274, 'k': 9, 'm': 8, 'x': 0.66009498411213041}, {}, "5") - print evaluator({}, {}, "-1") - print evaluator({}, {}, "-(7+5)") - print evaluator({}, {}, "-0.33") - print evaluator({}, {}, "-.33") - print evaluator({}, {}, "5+1*j") - print evaluator({}, {}, "j||1") - print evaluator({}, {}, "e^(j*pi)") - print evaluator({}, {}, "fact(5)") - print evaluator({}, {}, "factorial(5)") - try: - print evaluator({}, {}, "5+7 QWSEKO") - except UndefinedVariable: - print "Successfully caught undefined variable" diff --git a/common/lib/calc/setup.py b/common/lib/calc/setup.py new file mode 100644 index 0000000000..cb638914f9 --- /dev/null +++ b/common/lib/calc/setup.py @@ -0,0 +1,12 @@ +from setuptools import setup + +setup( + name="calc", + version="0.1.1", + py_modules=["calc"], + install_requires=[ + "pyparsing==1.5.6", + "numpy", + "scipy" + ], +) diff --git a/common/lib/calc/tests/test_calc.py b/common/lib/calc/tests/test_calc.py new file mode 100644 index 0000000000..cfa1b7525d --- /dev/null +++ b/common/lib/calc/tests/test_calc.py @@ -0,0 +1,377 @@ +""" +Unit tests for calc.py +""" + +import unittest +import numpy +import calc +from pyparsing import ParseException + + +class EvaluatorTest(unittest.TestCase): + """ + Run tests for calc.evaluator + Go through all functionalities as specifically as possible-- + work from number input to functions and complex expressions + Also test custom variable substitutions (i.e. + `evaluator({'x':3.0},{}, '3*x')` + gives 9.0) and more. + """ + + def test_number_input(self): + """ + Test different kinds of float inputs + + See also + test_trailing_period (slightly different) + test_exponential_answer + test_si_suffix + """ + easy_eval = lambda x: calc.evaluator({}, {}, x) + + self.assertEqual(easy_eval("13"), 13) + self.assertEqual(easy_eval("3.14"), 3.14) + self.assertEqual(easy_eval(".618033989"), 0.618033989) + + self.assertEqual(easy_eval("-13"), -13) + self.assertEqual(easy_eval("-3.14"), -3.14) + self.assertEqual(easy_eval("-.618033989"), -0.618033989) + + def test_period(self): + """ + The string '.' should not evaluate to anything. + """ + self.assertRaises(ParseException, calc.evaluator, {}, {}, '.') + self.assertRaises(ParseException, calc.evaluator, {}, {}, '1+.') + + def test_trailing_period(self): + """ + Test that things like '4.' will be 4 and not throw an error + """ + try: + self.assertEqual(4.0, calc.evaluator({}, {}, '4.')) + except ParseException: + self.fail("'4.' is a valid input, but threw an exception") + + def test_exponential_answer(self): + """ + Test for correct interpretation of scientific notation + """ + answer = 50 + correct_responses = ["50", "50.0", "5e1", "5e+1", + "50e0", "50.0e0", "500e-1"] + incorrect_responses = ["", "3.9", "4.1", "0", "5.01e1"] + + for input_str in correct_responses: + result = calc.evaluator({}, {}, input_str) + fail_msg = "Expected '{0}' to equal {1}".format( + input_str, answer) + self.assertEqual(answer, result, msg=fail_msg) + + for input_str in incorrect_responses: + result = calc.evaluator({}, {}, input_str) + fail_msg = "Expected '{0}' to not equal {1}".format( + input_str, answer) + self.assertNotEqual(answer, result, msg=fail_msg) + + def test_si_suffix(self): + """ + Test calc.py's unique functionality of interpreting si 'suffixes'. + + For instance 'k' stand for 'kilo-' so '1k' should be 1,000 + """ + test_mapping = [('4.2%', 0.042), ('2.25k', 2250), ('8.3M', 8300000), + ('9.9G', 9.9e9), ('1.2T', 1.2e12), ('7.4c', 0.074), + ('5.4m', 0.0054), ('8.7u', 0.0000087), + ('5.6n', 5.6e-9), ('4.2p', 4.2e-12)] + + for (expr, answer) in test_mapping: + tolerance = answer * 1e-6 # Make rel. tolerance, because of floats + fail_msg = "Failure in testing suffix '{0}': '{1}' was not {2}" + fail_msg = fail_msg.format(expr[-1], expr, answer) + self.assertAlmostEqual(calc.evaluator({}, {}, expr), answer, + delta=tolerance, msg=fail_msg) + + def test_operator_sanity(self): + """ + Test for simple things like '5+2' and '5/2' + """ + var1 = 5.0 + var2 = 2.0 + operators = [('+', 7), ('-', 3), ('*', 10), ('/', 2.5), ('^', 25)] + + for (operator, answer) in operators: + input_str = "{0} {1} {2}".format(var1, operator, var2) + result = calc.evaluator({}, {}, input_str) + fail_msg = "Failed on operator '{0}': '{1}' was not {2}".format( + operator, input_str, answer) + self.assertEqual(answer, result, msg=fail_msg) + + def test_raises_zero_division_err(self): + """ + Ensure division by zero gives an error + """ + self.assertRaises(ZeroDivisionError, calc.evaluator, + {}, {}, '1/0') + self.assertRaises(ZeroDivisionError, calc.evaluator, + {}, {}, '1/0.0') + self.assertRaises(ZeroDivisionError, calc.evaluator, + {'x': 0.0}, {}, '1/x') + + def test_parallel_resistors(self): + """ + Test the parallel resistor operator || + + The formula is given by + a || b || c ... + = 1 / (1/a + 1/b + 1/c + ...) + It is the resistance of a parallel circuit of resistors with resistance + a, b, c, etc&. See if this evaulates correctly. + """ + self.assertEqual(calc.evaluator({}, {}, '1||1'), 0.5) + self.assertEqual(calc.evaluator({}, {}, '1||1||2'), 0.4) + self.assertEqual(calc.evaluator({}, {}, "j||1"), 0.5 + 0.5j) + + def test_parallel_resistors_with_zero(self): + """ + Check the behavior of the || operator with 0 + """ + self.assertTrue(numpy.isnan(calc.evaluator({}, {}, '0||1'))) + self.assertTrue(numpy.isnan(calc.evaluator({}, {}, '0.0||1'))) + self.assertTrue(numpy.isnan(calc.evaluator({'x': 0.0}, {}, 'x||1'))) + + def assert_function_values(self, fname, ins, outs, tolerance=1e-3): + """ + Helper function to test many values at once + + Test the accuracy of evaluator's use of the function given by fname + Specifically, the equality of `fname(ins[i])` against outs[i]. + This is used later to test a whole bunch of f(x) = y at a time + """ + + for (arg, val) in zip(ins, outs): + input_str = "{0}({1})".format(fname, arg) + result = calc.evaluator({}, {}, input_str) + fail_msg = "Failed on function {0}: '{1}' was not {2}".format( + fname, input_str, val) + self.assertAlmostEqual(val, result, delta=tolerance, msg=fail_msg) + + def test_trig_functions(self): + """ + Test the trig functions provided in calc.py + + which are: sin, cos, tan, arccos, arcsin, arctan + """ + + angles = ['-pi/4', '0', 'pi/6', 'pi/5', '5*pi/4', '9*pi/4', '1 + j'] + sin_values = [-0.707, 0, 0.5, 0.588, -0.707, 0.707, 1.298 + 0.635j] + cos_values = [0.707, 1, 0.866, 0.809, -0.707, 0.707, 0.834 - 0.989j] + tan_values = [-1, 0, 0.577, 0.727, 1, 1, 0.272 + 1.084j] + # Cannot test tan(pi/2) b/c pi/2 is a float and not precise... + + self.assert_function_values('sin', angles, sin_values) + self.assert_function_values('cos', angles, cos_values) + self.assert_function_values('tan', angles, tan_values) + + # Include those where the real part is between -pi/2 and pi/2 + arcsin_inputs = ['-0.707', '0', '0.5', '0.588', '1.298 + 0.635*j'] + arcsin_angles = [-0.785, 0, 0.524, 0.629, 1 + 1j] + self.assert_function_values('arcsin', arcsin_inputs, arcsin_angles) + # Rather than throwing an exception, numpy.arcsin gives nan + # self.assertTrue(numpy.isnan(calc.evaluator({}, {}, 'arcsin(-1.1)'))) + # self.assertTrue(numpy.isnan(calc.evaluator({}, {}, 'arcsin(1.1)'))) + # Disabled for now because they are giving a runtime warning... :-/ + + # Include those where the real part is between 0 and pi + arccos_inputs = ['1', '0.866', '0.809', '0.834-0.989*j'] + arccos_angles = [0, 0.524, 0.628, 1 + 1j] + self.assert_function_values('arccos', arccos_inputs, arccos_angles) + # self.assertTrue(numpy.isnan(calc.evaluator({}, {}, 'arccos(-1.1)'))) + # self.assertTrue(numpy.isnan(calc.evaluator({}, {}, 'arccos(1.1)'))) + + # Has the same range as arcsin + arctan_inputs = ['-1', '0', '0.577', '0.727', '0.272 + 1.084*j'] + arctan_angles = arcsin_angles + self.assert_function_values('arctan', arctan_inputs, arctan_angles) + + def test_other_functions(self): + """ + Test the non-trig functions provided in calc.py + + Specifically: + sqrt, log10, log2, ln, abs, + fact, factorial + """ + + # Test sqrt + self.assert_function_values('sqrt', + [0, 1, 2, 1024], # -1 + [0, 1, 1.414, 32]) # 1j + # sqrt(-1) is NAN not j (!!). + + # Test logs + self.assert_function_values('log10', + [0.1, 1, 3.162, 1000000, '1+j'], + [-1, 0, 0.5, 6, 0.151 + 0.341j]) + self.assert_function_values('log2', + [0.5, 1, 1.414, 1024, '1+j'], + [-1, 0, 0.5, 10, 0.5 + 1.133j]) + self.assert_function_values('ln', + [0.368, 1, 1.649, 2.718, 42, '1+j'], + [-1, 0, 0.5, 1, 3.738, 0.347 + 0.785j]) + + # Test abs + self.assert_function_values('abs', [-1, 0, 1, 'j'], [1, 0, 1, 1]) + + # Test factorial + fact_inputs = [0, 1, 3, 7] + fact_values = [1, 1, 6, 5040] + self.assert_function_values('fact', fact_inputs, fact_values) + self.assert_function_values('factorial', fact_inputs, fact_values) + + self.assertRaises(ValueError, calc.evaluator, {}, {}, "fact(-1)") + self.assertRaises(ValueError, calc.evaluator, {}, {}, "fact(0.5)") + self.assertRaises(ValueError, calc.evaluator, {}, {}, "factorial(-1)") + self.assertRaises(ValueError, calc.evaluator, {}, {}, "factorial(0.5)") + + def test_constants(self): + """ + Test the default constants provided in calc.py + + which are: j (complex number), e, pi, k, c, T, q + """ + + # Of the form ('expr', python value, tolerance (or None for exact)) + default_variables = [('j', 1j, None), + ('e', 2.7183, 1e-3), + ('pi', 3.1416, 1e-3), + # c = speed of light + ('c', 2.998e8, 1e5), + # 0 deg C = T Kelvin + ('T', 298.15, 0.01), + # Note k = scipy.constants.k = 1.3806488e-23 + ('k', 1.3806488e-23, 1e-26), + # Note q = scipy.constants.e = 1.602176565e-19 + ('q', 1.602176565e-19, 1e-22)] + for (variable, value, tolerance) in default_variables: + fail_msg = "Failed on constant '{0}', not within bounds".format( + variable) + result = calc.evaluator({}, {}, variable) + if tolerance is None: + self.assertEqual(value, result, msg=fail_msg) + else: + self.assertAlmostEqual(value, result, + delta=tolerance, msg=fail_msg) + + def test_complex_expression(self): + """ + Calculate combinations of operators and default functions + """ + + self.assertAlmostEqual( + calc.evaluator({}, {}, "(2^2+1.0)/sqrt(5e0)*5-1"), + 10.180, + delta=1e-3) + + self.assertAlmostEqual( + calc.evaluator({}, {}, "1+1/(1+1/(1+1/(1+1)))"), + 1.6, + delta=1e-3) + self.assertAlmostEqual( + calc.evaluator({}, {}, "10||sin(7+5)"), + -0.567, delta=0.01) + self.assertAlmostEqual(calc.evaluator({}, {}, "sin(e)"), + 0.41, delta=0.01) + self.assertAlmostEqual(calc.evaluator({}, {}, "k*T/q"), + 0.025, delta=1e-3) + self.assertAlmostEqual(calc.evaluator({}, {}, "e^(j*pi)"), + -1, delta=1e-5) + + def test_simple_vars(self): + """ + Substitution of variables into simple equations + """ + variables = {'x': 9.72, 'y': 7.91, 'loooooong': 6.4} + + # Should not change value of constant + # even with different numbers of variables... + self.assertEqual(calc.evaluator({'x': 9.72}, {}, '13'), 13) + self.assertEqual(calc.evaluator({'x': 9.72, 'y': 7.91}, {}, '13'), 13) + self.assertEqual(calc.evaluator(variables, {}, '13'), 13) + + # Easy evaluation + self.assertEqual(calc.evaluator(variables, {}, 'x'), 9.72) + self.assertEqual(calc.evaluator(variables, {}, 'y'), 7.91) + self.assertEqual(calc.evaluator(variables, {}, 'loooooong'), 6.4) + + # Test a simple equation + self.assertAlmostEqual(calc.evaluator(variables, {}, '3*x-y'), + 21.25, delta=0.01) # = 3 * 9.72 - 7.91 + self.assertAlmostEqual(calc.evaluator(variables, {}, 'x*y'), + 76.89, delta=0.01) + + self.assertEqual(calc.evaluator({'x': 9.72, 'y': 7.91}, {}, "13"), 13) + self.assertEqual(calc.evaluator(variables, {}, "13"), 13) + self.assertEqual( + calc.evaluator({ + 'a': 2.2997471478310274, 'k': 9, 'm': 8, + 'x': 0.66009498411213041}, + {}, "5"), + 5) + + def test_variable_case_sensitivity(self): + """ + Test the case sensitivity flag and corresponding behavior + """ + self.assertEqual( + calc.evaluator({'R1': 2.0, 'R3': 4.0}, {}, "r1*r3"), + 8.0) + + variables = {'t': 1.0} + self.assertEqual(calc.evaluator(variables, {}, "t"), 1.0) + self.assertEqual(calc.evaluator(variables, {}, "T"), 1.0) + self.assertEqual(calc.evaluator(variables, {}, "t", cs=True), 1.0) + # Recall 'T' is a default constant, with value 298.15 + self.assertAlmostEqual(calc.evaluator(variables, {}, "T", cs=True), + 298, delta=0.2) + + def test_simple_funcs(self): + """ + Subsitution of custom functions + """ + variables = {'x': 4.712} + functions = {'id': lambda x: x} + self.assertEqual(calc.evaluator({}, functions, 'id(2.81)'), 2.81) + self.assertEqual(calc.evaluator({}, functions, 'id(2.81)'), 2.81) + self.assertEqual(calc.evaluator(variables, functions, 'id(x)'), 4.712) + + functions.update({'f': numpy.sin}) + self.assertAlmostEqual(calc.evaluator(variables, functions, 'f(x)'), + -1, delta=1e-3) + + def test_function_case_sensitivity(self): + """ + Test the case sensitivity of functions + """ + functions = {'f': lambda x: x, + 'F': lambda x: x + 1} + # Test case insensitive evaluation + # Both evaulations should call the same function + self.assertEqual(calc.evaluator({}, functions, 'f(6)'), + calc.evaluator({}, functions, 'F(6)')) + # Test case sensitive evaluation + self.assertNotEqual(calc.evaluator({}, functions, 'f(6)', cs=True), + calc.evaluator({}, functions, 'F(6)', cs=True)) + + def test_undefined_vars(self): + """ + Check to see if the evaluator catches undefined variables + """ + variables = {'R1': 2.0, 'R3': 4.0} + + self.assertRaises(calc.UndefinedVariable, calc.evaluator, + {}, {}, "5+7 QWSEKO") + self.assertRaises(calc.UndefinedVariable, calc.evaluator, + {'r1': 5}, {}, "r1+r2") + self.assertRaises(calc.UndefinedVariable, calc.evaluator, + variables, {}, "r1*r3", cs=True) diff --git a/common/lib/capa/capa/capa_problem.py b/common/lib/capa/capa/capa_problem.py index 6580114bcc..150b3b3c9b 100644 --- a/common/lib/capa/capa/capa_problem.py +++ b/common/lib/capa/capa/capa_problem.py @@ -13,33 +13,19 @@ Main module which shows problems (of "capa" type). This is used by capa_module. ''' -from __future__ import division - from datetime import datetime import logging import math import numpy -import os -import random +import os.path import re -import scipy -import struct import sys from lxml import etree from xml.sax.saxutils import unescape from copy import deepcopy -import chem -import chem.miller -import chem.chemcalc -import chem.chemtools -import verifiers -import verifiers.draganddrop - -import calc from .correctmap import CorrectMap -import eia import inputtypes import customrender from .util import contextualize_text, convert_files_to_filenames @@ -47,6 +33,7 @@ import xqueue_interface # to be replaced with auto-registering import responsetypes +import safe_exec # dict of tagname, Response Class -- this should come from auto-registering response_tag_dict = dict([(x.response_tag, x) for x in responsetypes.__all__]) @@ -63,17 +50,6 @@ html_transforms = {'problem': {'tag': 'div'}, "math": {'tag': 'span'}, } -global_context = {'random': random, - 'numpy': numpy, - 'math': math, - 'scipy': scipy, - 'calc': calc, - 'eia': eia, - 'chemcalc': chem.chemcalc, - 'chemtools': chem.chemtools, - 'miller': chem.miller, - 'draganddrop': verifiers.draganddrop} - # These should be removed from HTML output, including all subelements html_problem_semantics = ["codeparam", "responseparam", "answer", "script", "hintgroup", "openendedparam", "openendedrubric"] @@ -96,7 +72,7 @@ class LoncapaProblem(object): - problem_text (string): xml defining the problem - id (string): identifier for this problem; often a filename (no spaces) - - seed (int): random number generator seed (int) + - seed (int): random number generator seed (int) - state (dict): containing the following keys: - 'seed' - (int) random number generator seed - 'student_answers' - (dict) maps input id to the stored answer for that input @@ -115,23 +91,20 @@ class LoncapaProblem(object): if self.system is None: raise Exception() - state = state if state else {} + state = state or {} # Set seed according to the following priority: # 1. Contained in problem's state # 2. Passed into capa_problem via constructor - # 3. Assign from the OS's random number generator self.seed = state.get('seed', seed) - if self.seed is None: - self.seed = struct.unpack('i', os.urandom(4))[0] + assert self.seed is not None, "Seed must be provided for LoncapaProblem." + self.student_answers = state.get('student_answers', {}) if 'correct_map' in state: self.correct_map.set_dict(state['correct_map']) self.done = state.get('done', False) self.input_state = state.get('input_state', {}) - - # Convert startouttext and endouttext to proper problem_text = re.sub("startouttext\s*/", "text", problem_text) problem_text = re.sub("endouttext\s*/", "/text", problem_text) @@ -144,7 +117,7 @@ class LoncapaProblem(object): self._process_includes() # construct script processor context (eg for customresponse problems) - self.context = self._extract_context(self.tree, seed=self.seed) + self.context = self._extract_context(self.tree) # Pre-parse the XML tree: modifies it to add ID's and perform some in-place # transformations. This also creates the dict (self.responders) of Response @@ -440,18 +413,23 @@ class LoncapaProblem(object): path = [] for dir in raw_path: - if not dir: continue # path is an absolute path or a path relative to the data dir dir = os.path.join(self.system.filestore.root_path, dir) + # Check that we are within the filestore tree. + reldir = os.path.relpath(dir, self.system.filestore.root_path) + if ".." in reldir: + log.warning("Ignoring Python directory outside of course: %r" % dir) + continue + abs_dir = os.path.normpath(dir) path.append(abs_dir) return path - def _extract_context(self, tree, seed=struct.unpack('i', os.urandom(4))[0]): # private + def _extract_context(self, tree): ''' Extract content of from the problem.xml file, and exec it in the context of this problem. Provides ability to randomize problems, and also set @@ -459,57 +437,49 @@ class LoncapaProblem(object): Problem XML goes to Python execution context. Runs everything in script tags. ''' - random.seed(self.seed) - # save global context in here also - context = {'global_context': global_context} + context = {} + context['seed'] = self.seed + all_code = '' - # initialize context to have stuff in global_context - context.update(global_context) + python_path = [] - # put globals there also - context['__builtins__'] = globals()['__builtins__'] - - # pass instance of LoncapaProblem in - context['the_lcp'] = self - context['script_code'] = '' - - self._execute_scripts(tree.findall('.//script'), context) - - return context - - def _execute_scripts(self, scripts, context): - ''' - Executes scripts in the given context. - ''' - original_path = sys.path - - for script in scripts: - sys.path = original_path + self._extract_system_path(script) + for script in tree.findall('.//script'): stype = script.get('type') - if stype: if 'javascript' in stype: continue # skip javascript if 'perl' in stype: continue # skip perl # TODO: evaluate only python - code = script.text + + for d in self._extract_system_path(script): + if d not in python_path and os.path.exists(d): + python_path.append(d) + XMLESC = {"'": "'", """: '"'} - code = unescape(code, XMLESC) - # store code source in context - context['script_code'] += code + code = unescape(script.text, XMLESC) + all_code += code + + if all_code: try: - # use "context" for global context; thus defs in code are global within code - exec code in context, context + safe_exec.safe_exec( + all_code, + context, + random_seed=self.seed, + python_path=python_path, + cache=self.system.cache, + slug=self.problem_id, + ) except Exception as err: - log.exception("Error while execing script code: " + code) + log.exception("Error while execing script code: " + all_code) msg = "Error while executing script code: %s" % str(err).replace('<', '<') raise responsetypes.LoncapaProblemError(msg) - finally: - sys.path = original_path - + # Store code source in context, along with the Python path needed to run it correctly. + context['script_code'] = all_code + context['python_path'] = python_path + return context def _extract_html(self, problemtree): # private ''' diff --git a/common/lib/capa/capa/inputtypes.py b/common/lib/capa/capa/inputtypes.py index e253b61948..65280d6d29 100644 --- a/common/lib/capa/capa/inputtypes.py +++ b/common/lib/capa/capa/inputtypes.py @@ -46,7 +46,7 @@ import sys import pyparsing from .registry import TagRegistry -from capa.chem import chemcalc +from chem import chemcalc import xqueue_interface from datetime import datetime diff --git a/common/lib/capa/capa/responsetypes.py b/common/lib/capa/capa/responsetypes.py index 9db91496be..0fa50079de 100644 --- a/common/lib/capa/capa/responsetypes.py +++ b/common/lib/capa/capa/responsetypes.py @@ -23,6 +23,7 @@ import random import re import requests import subprocess +import textwrap import traceback import xml.sax.saxutils as saxutils @@ -30,17 +31,23 @@ from collections import namedtuple from shapely.geometry import Point, MultiPoint # specific library imports -from .calc import evaluator, UndefinedVariable -from .correctmap import CorrectMap +from calc import evaluator, UndefinedVariable +from . import correctmap from datetime import datetime from .util import * from lxml import etree from lxml.html.soupparser import fromstring as fromstring_bs # uses Beautiful Soup!!! FIXME? import capa.xqueue_interface as xqueue_interface +import safe_exec + log = logging.getLogger(__name__) +CorrectMap = correctmap.CorrectMap +CORRECTMAP_PY = None + + #----------------------------------------------------------------------------- # Exceptions @@ -133,6 +140,8 @@ class LoncapaResponse(object): self.context = context self.system = system + self.id = xml.get('id') + for abox in inputfields: if abox.tag not in self.allowed_inputfields: msg = "%s: cannot have input field %s" % ( @@ -252,20 +261,41 @@ class LoncapaResponse(object): # We may extend this in the future to add another argument which provides a # callback procedure to a social hint generation system. - if not hintfn in self.context: - msg = 'missing specified hint function %s in script context' % hintfn - msg += "\nSee XML source line %s" % getattr( - self.xml, 'sourceline', '') - raise LoncapaProblemError(msg) + + global CORRECTMAP_PY + if CORRECTMAP_PY is None: + # We need the CorrectMap code for hint functions. No, this is not great. + CORRECTMAP_PY = inspect.getsource(correctmap) + + code = ( + CORRECTMAP_PY + "\n" + + self.context['script_code'] + "\n" + + textwrap.dedent(""" + new_cmap = CorrectMap() + new_cmap.set_dict(new_cmap_dict) + old_cmap = CorrectMap() + old_cmap.set_dict(old_cmap_dict) + {hintfn}(answer_ids, student_answers, new_cmap, old_cmap) + new_cmap_dict.update(new_cmap.get_dict()) + old_cmap_dict.update(old_cmap.get_dict()) + """).format(hintfn=hintfn) + ) + globals_dict = { + 'answer_ids': self.answer_ids, + 'student_answers': student_answers, + 'new_cmap_dict': new_cmap.get_dict(), + 'old_cmap_dict': old_cmap.get_dict(), + } try: - self.context[hintfn]( - self.answer_ids, student_answers, new_cmap, old_cmap) + safe_exec.safe_exec(code, globals_dict, python_path=self.context['python_path'], slug=self.id) except Exception as err: msg = 'Error %s in evaluating hint function %s' % (err, hintfn) msg += "\nSee XML source line %s" % getattr( self.xml, 'sourceline', '') raise ResponseError(msg) + + new_cmap.set_dict(globals_dict['new_cmap_dict']) return # hint specified by conditions and text dependent on conditions (a-la Loncapa design) @@ -475,6 +505,10 @@ class JavascriptResponse(LoncapaResponse): return tmp_env def call_node(self, args): + # Node.js code is un-sandboxed. If the XModuleSystem says we aren't + # allowed to run unsafe code, then stop now. + if not self.system.can_execute_unsafe_code(): + raise LoncapaProblemError("Execution of unsafe Javascript code is not allowed.") subprocess_args = ["node"] subprocess_args.extend(args) @@ -488,7 +522,7 @@ class JavascriptResponse(LoncapaResponse): output = self.call_node([generator_file, self.generator, json.dumps(self.generator_dependencies), - json.dumps(str(self.context['the_lcp'].seed)), + json.dumps(str(self.context['seed'])), json.dumps(self.params)]).strip() return json.loads(output) @@ -660,15 +694,6 @@ class ChoiceResponse(LoncapaResponse): class MultipleChoiceResponse(LoncapaResponse): # TODO: handle direction and randomize - snippets = [{'snippet': ''' - - `a+b`
     - a+b^2
     - a+b+c - a+b+d -     -     - '''}] response_tag = 'multiplechoiceresponse' max_inputfields = 1 @@ -754,14 +779,6 @@ class OptionResponse(LoncapaResponse): ''' TODO: handle direction and randomize ''' - snippets = [{'snippet': """ - - The location of the sky - - - The location of the earth - - """}] response_tag = 'optionresponse' hint_tag = 'optionhint' @@ -905,39 +922,6 @@ class CustomResponse(LoncapaResponse): Custom response. The python code to be run should be in ... or in a ''' - snippets = [{'snippet': r""" - -
    - Suppose that \(I(t)\) rises from \(0\) to \(I_S\) at a time \(t_0 \neq 0\) - In the space provided below write an algebraic expression for \(I(t)\). -
    - -     - - correct=['correct'] - try: - r = str(submission[0]) - except ValueError: - correct[0] ='incorrect' - r = '0' - if not(r=="IS*u(t-t0)"): - correct[0] ='incorrect' - -     """}, - {'snippet': """ - - - - - """}] response_tag = 'customresponse' @@ -953,7 +937,6 @@ def sympy_check2(): # if has an "expect" (or "answer") attribute then save # that self.expect = xml.get('expect') or xml.get('answer') - self.myid = xml.get('id') log.debug('answer_ids=%s' % self.answer_ids) @@ -972,19 +955,34 @@ def sympy_check2(): cfn = xml.get('cfn') if cfn: log.debug("cfn = %s" % cfn) - if cfn in self.context: - self.code = self.context[cfn] - else: - msg = "%s: can't find cfn %s in context" % ( - unicode(self), cfn) - msg += "\nSee XML source line %s" % getattr(self.xml, 'sourceline', - '') - raise LoncapaProblemError(msg) + + # This is a bit twisty. We used to grab the cfn function from + # the context, but now that we sandbox Python execution, we + # can't get functions from previous executions. So we make an + # actual function that will re-execute the original script, + # and invoke the function with the data needed. + def make_check_function(script_code, cfn): + def check_function(expect, ans, **kwargs): + extra_args = "".join(", {0}={0}".format(k) for k in kwargs) + code = ( + script_code + "\n" + + "cfn_return = %s(expect, ans%s)\n" % (cfn, extra_args) + ) + globals_dict = { + 'expect': expect, + 'ans': ans, + } + globals_dict.update(kwargs) + safe_exec.safe_exec(code, globals_dict, python_path=self.context['python_path'], slug=self.id) + return globals_dict['cfn_return'] + return check_function + + self.code = make_check_function(self.context['script_code'], cfn) if not self.code: if answer is None: log.error("[courseware.capa.responsetypes.customresponse] missing" - " code checking script! id=%s" % self.myid) + " code checking script! id=%s" % self.id) self.code = '' else: answer_src = answer.get('src') @@ -1036,11 +1034,8 @@ def sympy_check2(): # put these in the context of the check function evaluator # note that this doesn't help the "cfn" version - only the exec version self.context.update({ - # our subtree - 'xml': self.xml, - # my ID - 'response_id': self.myid, + 'response_id': self.id, # expected answer (if given as attribute) 'expect': self.expect, @@ -1075,65 +1070,63 @@ def sympy_check2(): # pass self.system.debug to cfn self.context['debug'] = self.system.DEBUG + # Run the check function + self.execute_check_function(idset, submission) + + # build map giving "correct"ness of the answer(s) + correct = self.context['correct'] + messages = self.context['messages'] + overall_message = self.clean_message_html(self.context['overall_message']) + correct_map = CorrectMap() + correct_map.set_overall_message(overall_message) + + for k in range(len(idset)): + npoints = self.maxpoints[idset[k]] if correct[k] == 'correct' else 0 + correct_map.set(idset[k], correct[k], msg=messages[k], + npoints=npoints) + return correct_map + + def execute_check_function(self, idset, submission): # exec the check function if isinstance(self.code, basestring): try: - exec self.code in self.context['global_context'], self.context - correct = self.context['correct'] - messages = self.context['messages'] - overall_message = self.context['overall_message'] - + safe_exec.safe_exec(self.code, self.context, cache=self.system.cache, slug=self.id) except Exception as err: self._handle_exec_exception(err) else: - # self.code is not a string; assume its a function + # self.code is not a string; it's a function we created earlier. # this is an interface to the Tutor2 check functions fn = self.code - ret = None + answer_given = submission[0] if (len(idset) == 1) else submission + kwnames = self.xml.get("cfn_extra_args", "").split() + kwargs = {n:self.context.get(n) for n in kwnames} log.debug(" submission = %s" % submission) try: - answer_given = submission[0] if ( - len(idset) == 1) else submission - # handle variable number of arguments in check function, for backwards compatibility - # with various Tutor2 check functions - args = [self.expect, answer_given, - student_answers, self.answer_ids[0]] - argspec = inspect.getargspec(fn) - nargs = len(argspec.args) - len(argspec.defaults or []) - kwargs = {} - for argname in argspec.args[nargs:]: - kwargs[argname] = self.context[ - argname] if argname in self.context else None - - log.debug('[customresponse] answer_given=%s' % answer_given) - log.debug('nargs=%d, args=%s, kwargs=%s' % ( - nargs, args, kwargs)) - - ret = fn(*args[:nargs], **kwargs) - + ret = fn(self.expect, answer_given, **kwargs) except Exception as err: self._handle_exec_exception(err) - - if type(ret) == dict: - + log.debug( + "[courseware.capa.responsetypes.customresponse.get_score] ret = %s", + ret + ) + if isinstance(ret, dict): # One kind of dictionary the check function can return has the # form {'ok': BOOLEAN, 'msg': STRING} # If there are multiple inputs, they all get marked # to the same correct/incorrect value if 'ok' in ret: - correct = ['correct'] * len(idset) if ret[ - 'ok'] else ['incorrect'] * len(idset) + correct = ['correct' if ret['ok'] else 'incorrect'] * len(idset) msg = ret.get('msg', None) msg = self.clean_message_html(msg) # If there is only one input, apply the message to that input # Otherwise, apply the message to the whole problem if len(idset) > 1: - overall_message = msg + self.context['overall_message'] = msg else: - messages[0] = msg + self.context['messages'][0] = msg # Another kind of dictionary the check function can return has # the form: @@ -1155,6 +1148,8 @@ def sympy_check2(): msg = (self.clean_message_html(input_dict['msg']) if 'msg' in input_dict else None) messages.append(msg) + self.context['messages'] = messages + self.context['overall_message'] = overall_message # Otherwise, we do not recognize the dictionary # Raise an exception @@ -1163,25 +1158,10 @@ def sympy_check2(): raise ResponseError( "CustomResponse: check function returned an invalid dict") - # The check function can return a boolean value, - # indicating whether all inputs should be marked - # correct or incorrect else: - n = len(idset) - correct = ['correct'] * n if ret else ['incorrect'] * n + correct = ['correct' if ret else 'incorrect'] * len(idset) - # build map giving "correct"ness of the answer(s) - correct_map = CorrectMap() - - overall_message = self.clean_message_html(overall_message) - correct_map.set_overall_message(overall_message) - - for k in range(len(idset)): - npoints = (self.maxpoints[idset[k]] - if correct[k] == 'correct' else 0) - correct_map.set(idset[k], correct[k], msg=messages[k], - npoints=npoints) - return correct_map + self.context['correct'] = correct def clean_message_html(self, msg): @@ -1253,24 +1233,38 @@ class SymbolicResponse(CustomResponse): """ Symbolic math response checking, using symmath library. """ - snippets = [{'snippet': r''' - Compute \[ \exp\left(-i \frac{\theta}{2} \left[ \begin{matrix} 0 & 1 \\ 1 & 0 \end{matrix} \right] \right) \] - and give the resulting \(2\times 2\) matrix:
    - - - -
    - Your input should be typed in as a list of lists, eg [[1,2],[3,4]]. -     -     '''}] response_tag = 'symbolicresponse' + max_inputfields = 1 def setup_response(self): + # Symbolic response always uses symmath_check() + # If the XML did not specify this, then set it now + # Otherwise, we get an error from the superclass self.xml.set('cfn', 'symmath_check') - code = "from symmath import *" - exec code in self.context, self.context - CustomResponse.setup_response(self) + + # Let CustomResponse do its setup + super(SymbolicResponse, self).setup_response() + + def execute_check_function(self, idset, submission): + from symmath import symmath_check + try: + # Since we have limited max_inputfields to 1, + # we can assume that there is only one submission + answer_given = submission[0] + + ret = symmath_check( + self.expect, answer_given, + dynamath=self.context.get('dynamath'), + options=self.context.get('options'), + debug=self.context.get('debug'), + ) + except Exception as err: + log.error("oops in symbolicresponse (cfn) error %s" % err) + log.error(traceback.format_exc()) + raise Exception("oops in symbolicresponse (cfn) error %s" % err) + self.context['messages'][0] = self.clean_message_html(ret['msg']) + self.context['correct'] = ['correct' if ret['ok'] else 'incorrect'] * len(idset) #----------------------------------------------------------------------------- @@ -1325,10 +1319,8 @@ class CodeResponse(LoncapaResponse): # Check if XML uses the ExternalResponse format or the generic # CodeResponse format codeparam = self.xml.find('codeparam') - if codeparam is None: - self._parse_externalresponse_xml() - else: - self._parse_coderesponse_xml(codeparam) + assert codeparam is not None, "Unsupported old format! without " + self._parse_coderesponse_xml(codeparam) def _parse_coderesponse_xml(self, codeparam): ''' @@ -1348,62 +1340,6 @@ class CodeResponse(LoncapaResponse): self.answer = find_with_default(codeparam, 'answer_display', 'No answer provided.') - def _parse_externalresponse_xml(self): - ''' - VS[compat]: Suppport for old ExternalResponse XML format. When successful, sets: - self.initial_display - self.answer (an answer to display to the student in the LMS) - self.payload - ''' - answer = self.xml.find('answer') - - if answer is not None: - answer_src = answer.get('src') - if answer_src is not None: - code = self.system.filesystem.open('src/' + answer_src).read() - else: - code = answer.text - else: # no stanza; get code from - - -
    - Give an equation for the relativistic energy of an object with mass m. -     - - - - - - '''}] response_tag = 'formularesponse' hint_tag = 'formulahint' @@ -1927,21 +1808,18 @@ class SchematicResponse(LoncapaResponse): self.code = answer.text def get_score(self, student_answers): - from capa_problem import global_context - submission = [json.loads(student_answers[ - k]) for k in sorted(self.answer_ids)] + #from capa_problem import global_context + submission = [ + json.loads(student_answers[k]) for k in sorted(self.answer_ids) + ] self.context.update({'submission': submission}) - try: - exec self.code in global_context, self.context - + safe_exec.safe_exec(self.code, self.context, cache=self.system.cache, slug=self.id) except Exception as err: - _, _, traceback_obj = sys.exc_info() - raise ResponseError, ResponseError(err.message), traceback_obj - + msg = 'Error %s in evaluating SchematicResponse' % err + raise ResponseError(msg) cmap = CorrectMap() - cmap.set_dict(dict(zip(sorted( - self.answer_ids), self.context['correct']))) + cmap.set_dict(dict(zip(sorted(self.answer_ids), self.context['correct']))) return cmap def get_answers(self): @@ -1977,19 +1855,6 @@ class ImageResponse(LoncapaResponse): Returns: True, if click is inside any region or rectangle. Otherwise False. """ - snippets = [{'snippet': ''' - - - - - - '''}] response_tag = 'imageresponse' allowed_inputfields = ['imageinput'] diff --git a/common/lib/capa/capa/safe_exec/README.rst b/common/lib/capa/capa/safe_exec/README.rst new file mode 100644 index 0000000000..c61100f709 --- /dev/null +++ b/common/lib/capa/capa/safe_exec/README.rst @@ -0,0 +1,51 @@ +Configuring Capa sandboxed execution +==================================== + +Capa problems can contain code authored by the course author. We need to +execute that code in a sandbox. We use CodeJail as the sandboxing facility, +but it needs to be configured specifically for Capa's use. + +As a developer, you don't have to do anything to configure sandboxing if you +don't want to, and everything will operate properly, you just won't have +protection on that code. + +If you want to configure sandboxing, you're going to use the `README from +CodeJail`__, with a few customized tweaks. + +__ https://github.com/edx/codejail/blob/master/README.rst + + +1. At the instruction to install packages into the sandboxed code, you'll + need to install both `pre-sandbox-requirements.txt` and + `sandbox-requirements.txt`:: + + $ sudo pip install -r pre-sandbox-requirements.txt + $ sudo pip install -r sandbox-requirements.txt + +2. At the instruction to create the AppArmor profile, you'll need a line in + the profile for the sandbox packages. is the full path to + your edx_platform repo:: + + /common/lib/sandbox-packages/** r, + +3. You can configure resource limits in settings.py. A CODE_JAIL setting is + available, a dictionary. The "limits" key lets you adjust the limits for + CPU time, real time, and memory use. Setting any of them to zero disables + that limit:: + + # in settings.py... + CODE_JAIL = { + # Configurable limits. + 'limits': { + # How many CPU seconds can jailed code use? + 'CPU': 1, + # How many real-time seconds will a sandbox survive? + 'REALTIME': 1, + # How much memory (in bytes) can a sandbox use? + 'VMEM': 30000000, + }, + } + + +That's it. Once you've finished the CodeJail configuration instructions, +your course-hosted Python code should be run securely. diff --git a/common/lib/capa/capa/safe_exec/__init__.py b/common/lib/capa/capa/safe_exec/__init__.py new file mode 100644 index 0000000000..ffbe8f2320 --- /dev/null +++ b/common/lib/capa/capa/safe_exec/__init__.py @@ -0,0 +1,3 @@ +"""Capa's specialized use of codejail.safe_exec.""" + +from .safe_exec import safe_exec, update_hash diff --git a/common/lib/capa/capa/safe_exec/lazymod.py b/common/lib/capa/capa/safe_exec/lazymod.py new file mode 100644 index 0000000000..cdd8410f2c --- /dev/null +++ b/common/lib/capa/capa/safe_exec/lazymod.py @@ -0,0 +1,42 @@ +"""A module proxy for delayed importing of modules. + +From http://barnesc.blogspot.com/2006/06/automatic-python-imports-with-autoimp.html, +in the public domain. + +""" + +import sys + +class LazyModule(object): + """A lazy module proxy.""" + + def __init__(self, modname): + self.__dict__['__name__'] = modname + self._set_mod(None) + + def _set_mod(self, mod): + if mod is not None: + self.__dict__ = mod.__dict__ + self.__dict__['_lazymod_mod'] = mod + + def _load_mod(self): + __import__(self.__name__) + self._set_mod(sys.modules[self.__name__]) + + def __getattr__(self, name): + if self.__dict__['_lazymod_mod'] is None: + self._load_mod() + + mod = self.__dict__['_lazymod_mod'] + + if hasattr(mod, name): + return getattr(mod, name) + else: + try: + subname = '%s.%s' % (self.__name__, name) + __import__(subname) + submod = getattr(mod, name) + except ImportError: + raise AttributeError("'module' object has no attribute %r" % name) + self.__dict__[name] = LazyModule(subname, submod) + return self.__dict__[name] diff --git a/common/lib/capa/capa/safe_exec/safe_exec.py b/common/lib/capa/capa/safe_exec/safe_exec.py new file mode 100644 index 0000000000..67e93be46f --- /dev/null +++ b/common/lib/capa/capa/safe_exec/safe_exec.py @@ -0,0 +1,133 @@ +"""Capa's specialized use of codejail.safe_exec.""" + +from codejail.safe_exec import safe_exec as codejail_safe_exec +from codejail.safe_exec import json_safe, SafeExecException +from . import lazymod +from statsd import statsd + +import hashlib + +# Establish the Python environment for Capa. +# Capa assumes float-friendly division always. +# The name "random" is a properly-seeded stand-in for the random module. +CODE_PROLOG = """\ +from __future__ import division + +import random as random_module +import sys +random = random_module.Random(%r) +random.Random = random_module.Random +del random_module +sys.modules['random'] = random +""" + +ASSUMED_IMPORTS=[ + ("numpy", "numpy"), + ("math", "math"), + ("scipy", "scipy"), + ("calc", "calc"), + ("eia", "eia"), + ("chemcalc", "chem.chemcalc"), + ("chemtools", "chem.chemtools"), + ("miller", "chem.miller"), + ("draganddrop", "verifiers.draganddrop"), +] + +# We'll need the code from lazymod.py for use in safe_exec, so read it now. +lazymod_py_file = lazymod.__file__ +if lazymod_py_file.endswith("c"): + lazymod_py_file = lazymod_py_file[:-1] + +lazymod_py = open(lazymod_py_file).read() + +LAZY_IMPORTS = [lazymod_py] +for name, modname in ASSUMED_IMPORTS: + LAZY_IMPORTS.append("{} = LazyModule('{}')\n".format(name, modname)) + +LAZY_IMPORTS = "".join(LAZY_IMPORTS) + + +def update_hash(hasher, obj): + """ + Update a `hashlib` hasher with a nested object. + + To properly cache nested structures, we need to compute a hash from the + entire structure, canonicalizing at every level. + + `hasher`'s `.update()` method is called a number of times, touching all of + `obj` in the process. Only primitive JSON-safe types are supported. + + """ + hasher.update(str(type(obj))) + if isinstance(obj, (tuple, list)): + for e in obj: + update_hash(hasher, e) + elif isinstance(obj, dict): + for k in sorted(obj): + update_hash(hasher, k) + update_hash(hasher, obj[k]) + else: + hasher.update(repr(obj)) + + +@statsd.timed('capa.safe_exec.time') +def safe_exec(code, globals_dict, random_seed=None, python_path=None, cache=None, slug=None): + """ + Execute python code safely. + + `code` is the Python code to execute. It has access to the globals in `globals_dict`, + and any changes it makes to those globals are visible in `globals_dict` when this + function returns. + + `random_seed` will be used to see the `random` module available to the code. + + `python_path` is a list of directories to add to the Python path before execution. + + `cache` is an object with .get(key) and .set(key, value) methods. It will be used + to cache the execution, taking into account the code, the values of the globals, + and the random seed. + + `slug` is an arbitrary string, a description that's meaningful to the + caller, that will be used in log messages. + + """ + # Check the cache for a previous result. + if cache: + safe_globals = json_safe(globals_dict) + md5er = hashlib.md5() + md5er.update(repr(code)) + update_hash(md5er, safe_globals) + key = "safe_exec.%r.%s" % (random_seed, md5er.hexdigest()) + cached = cache.get(key) + if cached is not None: + # We have a cached result. The result is a pair: the exception + # message, if any, else None; and the resulting globals dictionary. + emsg, cleaned_results = cached + globals_dict.update(cleaned_results) + if emsg: + raise SafeExecException(emsg) + return + + # Create the complete code we'll run. + code_prolog = CODE_PROLOG % random_seed + + # Run the code! Results are side effects in globals_dict. + try: + codejail_safe_exec( + code_prolog + LAZY_IMPORTS + code, globals_dict, + python_path=python_path, slug=slug, + ) + except SafeExecException as e: + emsg = e.message + else: + emsg = None + + # Put the result back in the cache. This is complicated by the fact that + # the globals dict might not be entirely serializable. + if cache: + cleaned_results = json_safe(globals_dict) + cache.set(key, (emsg, cleaned_results)) + + # If an exception happened, raise it now. + if emsg: + raise e diff --git a/common/lib/capa/capa/safe_exec/tests/test_files/pylib/constant.py b/common/lib/capa/capa/safe_exec/tests/test_files/pylib/constant.py new file mode 100644 index 0000000000..0769d528ba --- /dev/null +++ b/common/lib/capa/capa/safe_exec/tests/test_files/pylib/constant.py @@ -0,0 +1 @@ +THE_CONST = 23 diff --git a/common/lib/capa/capa/safe_exec/tests/test_lazymod.py b/common/lib/capa/capa/safe_exec/tests/test_lazymod.py new file mode 100644 index 0000000000..6a8ed5ff48 --- /dev/null +++ b/common/lib/capa/capa/safe_exec/tests/test_lazymod.py @@ -0,0 +1,47 @@ +"""Test lazymod.py""" + +import sys +import unittest + +from capa.safe_exec.lazymod import LazyModule + + +class ModuleIsolation(object): + """ + Manage changes to sys.modules so that we can roll back imported modules. + + Create this object, it will snapshot the currently imported modules. When + you call `clean_up()`, it will delete any module imported since its creation. + """ + def __init__(self): + # Save all the names of all the imported modules. + self.mods = set(sys.modules) + + def clean_up(self): + # Get a list of modules that didn't exist when we were created + new_mods = [m for m in sys.modules if m not in self.mods] + # and delete them all so another import will run code for real again. + for m in new_mods: + del sys.modules[m] + + +class TestLazyMod(unittest.TestCase): + + def setUp(self): + # Each test will remove modules that it imported. + self.addCleanup(ModuleIsolation().clean_up) + + def test_simple(self): + # Import some stdlib module that has not been imported before + self.assertNotIn("colorsys", sys.modules) + colorsys = LazyModule("colorsys") + hsv = colorsys.rgb_to_hsv(.3, .4, .2) + self.assertEqual(hsv[0], 0.25) + + def test_dotted(self): + # wsgiref is a module with submodules that is not already imported. + # Any similar module would do. This test demonstrates that the module + # is not already im + self.assertNotIn("wsgiref.util", sys.modules) + wsgiref_util = LazyModule("wsgiref.util") + self.assertEqual(wsgiref_util.guess_scheme({}), "http") diff --git a/common/lib/capa/capa/safe_exec/tests/test_safe_exec.py b/common/lib/capa/capa/safe_exec/tests/test_safe_exec.py new file mode 100644 index 0000000000..4592af8305 --- /dev/null +++ b/common/lib/capa/capa/safe_exec/tests/test_safe_exec.py @@ -0,0 +1,281 @@ +"""Test safe_exec.py""" + +import hashlib +import os.path +import random +import textwrap +import unittest + +from capa.safe_exec import safe_exec, update_hash +from codejail.safe_exec import SafeExecException + + +class TestSafeExec(unittest.TestCase): + def test_set_values(self): + g = {} + safe_exec("a = 17", g) + self.assertEqual(g['a'], 17) + + def test_division(self): + g = {} + # Future division: 1/2 is 0.5. + safe_exec("a = 1/2", g) + self.assertEqual(g['a'], 0.5) + + def test_assumed_imports(self): + g = {} + # Math is always available. + safe_exec("a = int(math.pi)", g) + self.assertEqual(g['a'], 3) + + def test_random_seeding(self): + g = {} + r = random.Random(17) + rnums = [r.randint(0, 999) for _ in xrange(100)] + + # Without a seed, the results are unpredictable + safe_exec("rnums = [random.randint(0, 999) for _ in xrange(100)]", g) + self.assertNotEqual(g['rnums'], rnums) + + # With a seed, the results are predictable + safe_exec("rnums = [random.randint(0, 999) for _ in xrange(100)]", g, random_seed=17) + self.assertEqual(g['rnums'], rnums) + + def test_random_is_still_importable(self): + g = {} + r = random.Random(17) + rnums = [r.randint(0, 999) for _ in xrange(100)] + + # With a seed, the results are predictable even from the random module + safe_exec( + "import random\n" + "rnums = [random.randint(0, 999) for _ in xrange(100)]\n", + g, random_seed=17) + self.assertEqual(g['rnums'], rnums) + + def test_python_lib(self): + pylib = os.path.dirname(__file__) + "/test_files/pylib" + g = {} + safe_exec( + "import constant; a = constant.THE_CONST", + g, python_path=[pylib] + ) + + def test_raising_exceptions(self): + g = {} + with self.assertRaises(SafeExecException) as cm: + safe_exec("1/0", g) + self.assertIn("ZeroDivisionError", cm.exception.message) + + +class DictCache(object): + """A cache implementation over a simple dict, for testing.""" + + def __init__(self, d): + self.cache = d + + def get(self, key): + # Actual cache implementations have limits on key length + assert len(key) <= 250 + return self.cache.get(key) + + def set(self, key, value): + # Actual cache implementations have limits on key length + assert len(key) <= 250 + self.cache[key] = value + + +class TestSafeExecCaching(unittest.TestCase): + """Test that caching works on safe_exec.""" + + def test_cache_miss_then_hit(self): + g = {} + cache = {} + + # Cache miss + safe_exec("a = int(math.pi)", g, cache=DictCache(cache)) + self.assertEqual(g['a'], 3) + # A result has been cached + self.assertEqual(cache.values()[0], (None, {'a': 3})) + + # Fiddle with the cache, then try it again. + cache[cache.keys()[0]] = (None, {'a': 17}) + + g = {} + safe_exec("a = int(math.pi)", g, cache=DictCache(cache)) + self.assertEqual(g['a'], 17) + + def test_cache_large_code_chunk(self): + # Caching used to die on memcache with more than 250 bytes of code. + # Check that it doesn't any more. + code = "a = 0\n" + ("a += 1\n" * 12345) + + g = {} + cache = {} + safe_exec(code, g, cache=DictCache(cache)) + self.assertEqual(g['a'], 12345) + + def test_cache_exceptions(self): + # Used to be that running code that raised an exception didn't cache + # the result. Check that now it does. + code = "1/0" + g = {} + cache = {} + with self.assertRaises(SafeExecException): + safe_exec(code, g, cache=DictCache(cache)) + + # The exception should be in the cache now. + self.assertEqual(len(cache), 1) + cache_exc_msg, cache_globals = cache.values()[0] + self.assertIn("ZeroDivisionError", cache_exc_msg) + + # Change the value stored in the cache, the result should change. + cache[cache.keys()[0]] = ("Hey there!", {}) + + with self.assertRaises(SafeExecException): + safe_exec(code, g, cache=DictCache(cache)) + + self.assertEqual(len(cache), 1) + cache_exc_msg, cache_globals = cache.values()[0] + self.assertEqual("Hey there!", cache_exc_msg) + + # Change it again, now no exception! + cache[cache.keys()[0]] = (None, {'a': 17}) + safe_exec(code, g, cache=DictCache(cache)) + self.assertEqual(g['a'], 17) + + def test_unicode_submission(self): + # Check that using non-ASCII unicode does not raise an encoding error. + # Try several non-ASCII unicode characters + for code in [129, 500, 2**8 - 1, 2**16 - 1]: + code_with_unichr = unicode("# ") + unichr(code) + try: + safe_exec(code_with_unichr, {}, cache=DictCache({})) + except UnicodeEncodeError: + self.fail("Tried executing code with non-ASCII unicode: {0}".format(code)) + + +class TestUpdateHash(unittest.TestCase): + """Test the safe_exec.update_hash function to be sure it canonicalizes properly.""" + + def hash_obj(self, obj): + """Return the md5 hash that `update_hash` makes us.""" + md5er = hashlib.md5() + update_hash(md5er, obj) + return md5er.hexdigest() + + def equal_but_different_dicts(self): + """ + Make two equal dicts with different key order. + + Simple literals won't do it. Filling one and then shrinking it will + make them different. + + """ + d1 = {k:1 for k in "abcdefghijklmnopqrstuvwxyz"} + d2 = dict(d1) + for i in xrange(10000): + d2[i] = 1 + for i in xrange(10000): + del d2[i] + + # Check that our dicts are equal, but with different key order. + self.assertEqual(d1, d2) + self.assertNotEqual(d1.keys(), d2.keys()) + + return d1, d2 + + def test_simple_cases(self): + h1 = self.hash_obj(1) + h10 = self.hash_obj(10) + hs1 = self.hash_obj("1") + + self.assertNotEqual(h1, h10) + self.assertNotEqual(h1, hs1) + + def test_list_ordering(self): + h1 = self.hash_obj({'a': [1,2,3]}) + h2 = self.hash_obj({'a': [3,2,1]}) + self.assertNotEqual(h1, h2) + + def test_dict_ordering(self): + d1, d2 = self.equal_but_different_dicts() + h1 = self.hash_obj(d1) + h2 = self.hash_obj(d2) + self.assertEqual(h1, h2) + + def test_deep_ordering(self): + d1, d2 = self.equal_but_different_dicts() + o1 = {'a':[1, 2, [d1], 3, 4]} + o2 = {'a':[1, 2, [d2], 3, 4]} + h1 = self.hash_obj(o1) + h2 = self.hash_obj(o2) + self.assertEqual(h1, h2) + + +class TestRealProblems(unittest.TestCase): + def test_802x(self): + code = textwrap.dedent("""\ + import math + import random + import numpy + e=1.602e-19 #C + me=9.1e-31 #kg + mp=1.672e-27 #kg + eps0=8.854e-12 #SI units + mu0=4e-7*math.pi #SI units + + Rd1=random.randrange(1,30,1) + Rd2=random.randrange(30,50,1) + Rd3=random.randrange(50,70,1) + Rd4=random.randrange(70,100,1) + Rd5=random.randrange(100,120,1) + + Vd1=random.randrange(1,20,1) + Vd2=random.randrange(20,40,1) + Vd3=random.randrange(40,60,1) + + #R=[0,10,30,50,70,100] #Ohm + #V=[0,12,24,36] # Volt + + R=[0,Rd1,Rd2,Rd3,Rd4,Rd5] #Ohms + V=[0,Vd1,Vd2,Vd3] #Volts + #here the currents IL and IR are defined as in figure ps3_p3_fig2 + a=numpy.array([ [ R[1]+R[4]+R[5],R[4] ],[R[4], R[2]+R[3]+R[4] ] ]) + b=numpy.array([V[1]-V[2],-V[3]-V[2]]) + x=numpy.linalg.solve(a,b) + IL='%.2e' % x[0] + IR='%.2e' % x[1] + ILR='%.2e' % (x[0]+x[1]) + def sign(x): + return abs(x)/x + + RW="Rightwards" + LW="Leftwards" + UW="Upwards" + DW="Downwards" + I1='%.2e' % abs(x[0]) + I1d=LW if sign(x[0])==1 else RW + I1not=LW if I1d==RW else RW + I2='%.2e' % abs(x[1]) + I2d=RW if sign(x[1])==1 else LW + I2not=LW if I2d==RW else RW + I3='%.2e' % abs(x[1]) + I3d=DW if sign(x[1])==1 else UW + I3not=DW if I3d==UW else UW + I4='%.2e' % abs(x[0]+x[1]) + I4d=UW if sign(x[1]+x[0])==1 else DW + I4not=DW if I4d==UW else UW + I5='%.2e' % abs(x[0]) + I5d=RW if sign(x[0])==1 else LW + I5not=LW if I5d==RW else RW + VAP=-x[0]*R[1]-(x[0]+x[1])*R[4] + VPN=-V[2] + VGD=+V[1]-x[0]*R[1]+V[3]+x[1]*R[2] + aVAP='%.2e' % VAP + aVPN='%.2e' % VPN + aVGD='%.2e' % VGD + """) + g = {} + safe_exec(code, g) + self.assertIn("aVAP", g) diff --git a/common/lib/capa/capa/tests/__init__.py b/common/lib/capa/capa/tests/__init__.py index 72d82c683b..ac81ff66c4 100644 --- a/common/lib/capa/capa/tests/__init__.py +++ b/common/lib/capa/capa/tests/__init__.py @@ -1,7 +1,7 @@ -import fs import fs.osfs -import os +import os, os.path +from capa.capa_problem import LoncapaProblem from mock import Mock, MagicMock import xml.sax.saxutils as saxutils @@ -22,16 +22,28 @@ def calledback_url(dispatch = 'score_update'): xqueue_interface = MagicMock() xqueue_interface.send_to_queue.return_value = (0, 'Success!') -test_system = Mock( - ajax_url='courses/course_id/modx/a_location', - track_function=Mock(), - get_module=Mock(), - render_template=tst_render_template, - replace_urls=Mock(), - user=Mock(), - filestore=fs.osfs.OSFS(os.path.join(TEST_DIR, "test_files")), - debug=True, - xqueue={'interface': xqueue_interface, 'construct_callback': calledback_url, 'default_queuename': 'testqueue', 'waittime': 10}, - node_path=os.environ.get("NODE_PATH", "/usr/local/lib/node_modules"), - anonymous_student_id='student' -) +def test_system(): + """ + Construct a mock ModuleSystem instance. + + """ + the_system = Mock( + ajax_url='courses/course_id/modx/a_location', + track_function=Mock(), + get_module=Mock(), + render_template=tst_render_template, + replace_urls=Mock(), + user=Mock(), + filestore=fs.osfs.OSFS(os.path.join(TEST_DIR, "test_files")), + debug=True, + xqueue={'interface': xqueue_interface, 'construct_callback': calledback_url, 'default_queuename': 'testqueue', 'waittime': 10}, + node_path=os.environ.get("NODE_PATH", "/usr/local/lib/node_modules"), + anonymous_student_id='student', + cache=None, + can_execute_unsafe_code=lambda: False, + ) + return the_system + +def new_loncapa_problem(xml, system=None): + """Construct a `LoncapaProblem` suitable for unit tests.""" + return LoncapaProblem(xml, id='1', seed=723, system=system or test_system()) diff --git a/common/lib/capa/capa/tests/response_xml_factory.py b/common/lib/capa/capa/tests/response_xml_factory.py index aa401b70cd..35c12800ae 100644 --- a/common/lib/capa/capa/tests/response_xml_factory.py +++ b/common/lib/capa/capa/tests/response_xml_factory.py @@ -221,6 +221,8 @@ class CustomResponseXMLFactory(ResponseXMLFactory): cfn = kwargs.get('cfn', None) expect = kwargs.get('expect', None) answer = kwargs.get('answer', None) + options = kwargs.get('options', None) + cfn_extra_args = kwargs.get('cfn_extra_args', None) # Create the response element response_element = etree.Element("customresponse") @@ -235,6 +237,33 @@ class CustomResponseXMLFactory(ResponseXMLFactory): answer_element = etree.SubElement(response_element, "answer") answer_element.text = str(answer) + if options: + response_element.set('options', str(options)) + + if cfn_extra_args: + response_element.set('cfn_extra_args', str(cfn_extra_args)) + + return response_element + + def create_input_element(self, **kwargs): + return ResponseXMLFactory.textline_input_xml(**kwargs) + + +class SymbolicResponseXMLFactory(ResponseXMLFactory): + """ Factory for creating XML trees """ + + def create_response_element(self, **kwargs): + cfn = kwargs.get('cfn', None) + answer = kwargs.get('answer', None) + options = kwargs.get('options', None) + + response_element = etree.Element("symbolicresponse") + if cfn: + response_element.set('cfn', str(cfn)) + if answer: + response_element.set('answer', str(answer)) + if options: + response_element.set('options', str(options)) return response_element def create_input_element(self, **kwargs): @@ -638,12 +667,16 @@ class StringResponseXMLFactory(ResponseXMLFactory): Where *hint_prompt* is the string for which we show the hint, *hint_name* is an internal identifier for the hint, and *hint_text* is the text we show for the hint. + + *hintfn*: The name of a function in the script to use for hints. + """ # Retrieve the **kwargs answer = kwargs.get("answer", None) case_sensitive = kwargs.get("case_sensitive", True) hint_list = kwargs.get('hints', None) - assert(answer) + hint_fn = kwargs.get('hintfn', None) + assert answer # Create the element response_element = etree.Element("stringresponse") @@ -655,18 +688,24 @@ class StringResponseXMLFactory(ResponseXMLFactory): response_element.set("type", "cs" if case_sensitive else "ci") # Add the hints if specified - if hint_list: + if hint_list or hint_fn: hintgroup_element = etree.SubElement(response_element, "hintgroup") - for (hint_prompt, hint_name, hint_text) in hint_list: - stringhint_element = etree.SubElement(hintgroup_element, "stringhint") - stringhint_element.set("answer", str(hint_prompt)) - stringhint_element.set("name", str(hint_name)) + if hint_list: + assert not hint_fn + for (hint_prompt, hint_name, hint_text) in hint_list: + stringhint_element = etree.SubElement(hintgroup_element, "stringhint") + stringhint_element.set("answer", str(hint_prompt)) + stringhint_element.set("name", str(hint_name)) - hintpart_element = etree.SubElement(hintgroup_element, "hintpart") - hintpart_element.set("on", str(hint_name)) + hintpart_element = etree.SubElement(hintgroup_element, "hintpart") + hintpart_element.set("on", str(hint_name)) - hint_text_element = etree.SubElement(hintpart_element, "text") - hint_text_element.text = str(hint_text) + hint_text_element = etree.SubElement(hintpart_element, "text") + hint_text_element.text = str(hint_text) + + if hint_fn: + assert not hint_list + hintgroup_element.set("hintfn", hint_fn) return response_element @@ -705,3 +744,38 @@ class AnnotationResponseXMLFactory(ResponseXMLFactory): option_element.text = description return input_element + + +class SymbolicResponseXMLFactory(ResponseXMLFactory): + """ Factory for producing xml """ + + def create_response_element(self, **kwargs): + """ Build the XML element. + + Uses **kwargs: + + *expect*: The correct answer (a sympy string) + + *options*: list of option strings to pass to symmath_check + (e.g. 'matrix', 'qbit', 'imaginary', 'numerical')""" + + # Retrieve **kwargs + expect = kwargs.get('expect', '') + options = kwargs.get('options', []) + + # Symmath check expects a string of options + options_str = ",".join(options) + + # Construct the element + response_element = etree.Element('symbolicresponse') + + if expect: + response_element.set('expect', str(expect)) + + if options_str: + response_element.set('options', str(options_str)) + + return response_element + + def create_input_element(self, **kwargs): + return ResponseXMLFactory.textline_input_xml(**kwargs) diff --git a/common/lib/capa/capa/tests/test_customrender.py b/common/lib/capa/capa/tests/test_customrender.py index eece275b05..8012804a40 100644 --- a/common/lib/capa/capa/tests/test_customrender.py +++ b/common/lib/capa/capa/tests/test_customrender.py @@ -26,7 +26,7 @@ class HelperTest(unittest.TestCase): Make sure that our helper function works! ''' def check(self, d): - xml = etree.XML(test_system.render_template('blah', d)) + xml = etree.XML(test_system().render_template('blah', d)) self.assertEqual(d, extract_context(xml)) def test_extract_context(self): @@ -46,11 +46,11 @@ class SolutionRenderTest(unittest.TestCase): xml_str = """{s}""".format(s=solution) element = etree.fromstring(xml_str) - renderer = lookup_tag('solution')(test_system, element) + renderer = lookup_tag('solution')(test_system(), element) self.assertEqual(renderer.id, 'solution_12') - # our test_system "renders" templates to a div with the repr of the context + # Our test_system "renders" templates to a div with the repr of the context. xml = renderer.get_html() context = extract_context(xml) self.assertEqual(context, {'id': 'solution_12'}) @@ -65,7 +65,7 @@ class MathRenderTest(unittest.TestCase): xml_str = """{tex}""".format(tex=latex_in) element = etree.fromstring(xml_str) - renderer = lookup_tag('math')(test_system, element) + renderer = lookup_tag('math')(test_system(), element) self.assertEqual(renderer.mathstr, mathjax_out) diff --git a/common/lib/capa/capa/tests/test_files/snuggletex_correct.html b/common/lib/capa/capa/tests/test_files/snuggletex_correct.html new file mode 100644 index 0000000000..0d10f7f56d --- /dev/null +++ b/common/lib/capa/capa/tests/test_files/snuggletex_correct.html @@ -0,0 +1,480 @@ + + + + + + + + + + + + SnuggleTeX - ASCIIMathML Enrichment Demo + + + + + + + +

    SnuggleTeX (1.2.2)

    +
    + + +
    + +
    +

    ASCIIMathML Enrichment Demo

    +

    Input

    +

    + This demo is similar to the + MathML Semantic Enrichnment Demo + but uses + ASCIIMathML as + an alternative input format, which provides real-time feedback as you + type but can often generate MathML with odd semantics in it. + SnuggleTeX includes some functionality that can to convert this raw MathML into + something equivalent to its own MathML output, thereby allowing you to + semantically enrich it in + certain simple cases, making ASCIIMathML a possibly viable input format + for simple semantic maths. + +

    +

    + To try the demo, simply enter some some ASCIIMathML into the box below. + You should see a real time preview of this while you type. + Then hit Go! to use SnuggleTeX to semantically enrich your + input. + +

    +
    +
    + ASCIIMath Input: +
    +
    +

    Live Preview

    +

    + This is a MathML rendering of your input, generated by ASCIIMathML as you type. + +

    +
    +
    +
    +

    + This is the underlying MathML source generated by ASCIIMathML, again updated in real time. + +

    +
    +

    Enhanced Presentation MathML

    +

    + This shows the result of attempting to enrich the raw Presentation MathML + generated by ASCIIMathML: + + 

    <math xmlns="http://www.w3.org/1998/Math/MathML">
+   <mrow>
+      <mrow>
+         <mrow>
+            <mi>cos</mi>
+            <mo>&ApplyFunction;</mo>
+            <mfenced close=")" open="(">
+               <mi>theta</mi>
+            </mfenced>
+         </mrow>
+         <mo>&sdot;</mo>
+         <mfenced close="]" open="[">
+            <mtable>
+               <mtr>
+                  <mtd>
+                     <mn>1</mn>
+                  </mtd>
+                  <mtd>
+                     <mn>0</mn>
+                  </mtd>
+               </mtr>
+               <mtr>
+                  <mtd>
+                     <mn>0</mn>
+                  </mtd>
+                  <mtd>
+                     <mn>1</mn>
+                  </mtd>
+               </mtr>
+            </mtable>
+         </mfenced>
+      </mrow>
+      <mo>+</mo>
+      <mrow>
+         <mi>i</mi>
+         <mo>&sdot;</mo>
+         <mrow>
+            <mi>sin</mi>
+            <mo>&ApplyFunction;</mo>
+            <mfenced close=")" open="(">
+               <mi>theta</mi>
+            </mfenced>
+         </mrow>
+         <mo>&sdot;</mo>
+         <mfenced close="]" open="[">
+            <mtable>
+               <mtr>
+                  <mtd>
+                     <mn>0</mn>
+                  </mtd>
+                  <mtd>
+                     <mn>1</mn>
+                  </mtd>
+               </mtr>
+               <mtr>
+                  <mtd>
+                     <mn>1</mn>
+                  </mtd>
+                  <mtd>
+                     <mn>0</mn>
+                  </mtd>
+               </mtr>
+            </mtable>
+         </mfenced>
+      </mrow>
+   </mrow>
+</math>

    Content MathML

    +

    + This shows the result of an attempted + conversion to Content MathML: + + 

    <math xmlns="http://www.w3.org/1998/Math/MathML">
+   <apply>
+      <plus/>
+      <apply>
+         <times/>
+         <apply>
+            <cos/>
+            <ci>theta</ci>
+         </apply>
+         <list>
+            <matrix>
+               <vector>
+                  <cn>1</cn>
+                  <cn>0</cn>
+               </vector>
+               <vector>
+                  <cn>0</cn>
+                  <cn>1</cn>
+               </vector>
+            </matrix>
+         </list>
+      </apply>
+      <apply>
+         <times/>
+         <ci>i</ci>
+         <apply>
+            <sin/>
+            <ci>theta</ci>
+         </apply>
+         <list>
+            <matrix>
+               <vector>
+                  <cn>0</cn>
+                  <cn>1</cn>
+               </vector>
+               <vector>
+                  <cn>1</cn>
+                  <cn>0</cn>
+               </vector>
+            </matrix>
+         </list>
+      </apply>
+   </apply>
+</math>

    Maxima Input Form

    +

    + This shows the result of an attempted + conversion to Maxima Input syntax: + +

    +

    + The conversion from Content MathML to Maxima Input was not successful for + this input. + +

    + + + + + + + + + + + + + + + + + + + + + + + +
    Failure CodeMessageXPathContext
    UMFG00Content MathML element matrix not supportedapply[1]/apply[1]/list[1]/matrix[1]
    <matrix>
+   <vector>
+      <cn>1</cn>
+      <cn>0</cn>
+   </vector>
+   <vector>
+      <cn>0</cn>
+      <cn>1</cn>
+   </vector>
+</matrix>
    UMFG00Content MathML element matrix not supportedapply[1]/apply[2]/list[1]/matrix[1]
    <matrix>
+   <vector>
+      <cn>0</cn>
+      <cn>1</cn>
+   </vector>
+   <vector>
+      <cn>1</cn>
+      <cn>0</cn>
+   </vector>
+</matrix>
    +

    MathML Parallel Markup

    +

    + This shows the enhanced Presentation MathML with other forms encapsulated + as annotations: + + 

    <math xmlns="http://www.w3.org/1998/Math/MathML">
+   <semantics>
+      <mrow>
+         <mrow>
+            <mrow>
+               <mi>cos</mi>
+               <mo>&ApplyFunction;</mo>
+               <mfenced close=")" open="(">
+                  <mi>theta</mi>
+               </mfenced>
+            </mrow>
+            <mo>&sdot;</mo>
+            <mfenced close="]" open="[">
+               <mtable>
+                  <mtr>
+                     <mtd>
+                        <mn>1</mn>
+                     </mtd>
+                     <mtd>
+                        <mn>0</mn>
+                     </mtd>
+                  </mtr>
+                  <mtr>
+                     <mtd>
+                        <mn>0</mn>
+                     </mtd>
+                     <mtd>
+                        <mn>1</mn>
+                     </mtd>
+                  </mtr>
+               </mtable>
+            </mfenced>
+         </mrow>
+         <mo>+</mo>
+         <mrow>
+            <mi>i</mi>
+            <mo>&sdot;</mo>
+            <mrow>
+               <mi>sin</mi>
+               <mo>&ApplyFunction;</mo>
+               <mfenced close=")" open="(">
+                  <mi>theta</mi>
+               </mfenced>
+            </mrow>
+            <mo>&sdot;</mo>
+            <mfenced close="]" open="[">
+               <mtable>
+                  <mtr>
+                     <mtd>
+                        <mn>0</mn>
+                     </mtd>
+                     <mtd>
+                        <mn>1</mn>
+                     </mtd>
+                  </mtr>
+                  <mtr>
+                     <mtd>
+                        <mn>1</mn>
+                     </mtd>
+                     <mtd>
+                        <mn>0</mn>
+                     </mtd>
+                  </mtr>
+               </mtable>
+            </mfenced>
+         </mrow>
+      </mrow>
+      <annotation-xml encoding="MathML-Content">
+         <apply>
+            <plus/>
+            <apply>
+               <times/>
+               <apply>
+                  <cos/>
+                  <ci>theta</ci>
+               </apply>
+               <list>
+                  <matrix>
+                     <vector>
+                        <cn>1</cn>
+                        <cn>0</cn>
+                     </vector>
+                     <vector>
+                        <cn>0</cn>
+                        <cn>1</cn>
+                     </vector>
+                  </matrix>
+               </list>
+            </apply>
+            <apply>
+               <times/>
+               <ci>i</ci>
+               <apply>
+                  <sin/>
+                  <ci>theta</ci>
+               </apply>
+               <list>
+                  <matrix>
+                     <vector>
+                        <cn>0</cn>
+                        <cn>1</cn>
+                     </vector>
+                     <vector>
+                        <cn>1</cn>
+                        <cn>0</cn>
+                     </vector>
+                  </matrix>
+               </list>
+            </apply>
+         </apply>
+      </annotation-xml>
+      <annotation encoding="ASCIIMathInput"/>
+      <annotation-xml encoding="Maxima-upconversion-failures">
+         <s:fail xmlns:s="http://www.ph.ed.ac.uk/snuggletex" code="UMFG00"
+                 message="Content MathML element matrix not supported">
+            <s:arg>matrix</s:arg>
+            <s:xpath>apply[1]/apply[1]/list[1]/matrix[1]</s:xpath>
+            <s:context>
+               <matrix>
+                  <vector>
+                     <cn>1</cn>
+                     <cn>0</cn>
+                  </vector>
+                  <vector>
+                     <cn>0</cn>
+                     <cn>1</cn>
+                  </vector>
+               </matrix>
+            </s:context>
+         </s:fail>
+         <s:fail xmlns:s="http://www.ph.ed.ac.uk/snuggletex" code="UMFG00"
+                 message="Content MathML element matrix not supported">
+            <s:arg>matrix</s:arg>
+            <s:xpath>apply[1]/apply[2]/list[1]/matrix[1]</s:xpath>
+            <s:context>
+               <matrix>
+                  <vector>
+                     <cn>0</cn>
+                     <cn>1</cn>
+                  </vector>
+                  <vector>
+                     <cn>1</cn>
+                     <cn>0</cn>
+                  </vector>
+               </matrix>
+            </s:context>
+         </s:fail>
+      </annotation-xml>
+   </semantics>
+</math>
    +
    +
    +
    + + + \ No newline at end of file diff --git a/common/lib/capa/capa/tests/test_files/snuggletex_wrong.html b/common/lib/capa/capa/tests/test_files/snuggletex_wrong.html new file mode 100644 index 0000000000..abd62ca4d2 --- /dev/null +++ b/common/lib/capa/capa/tests/test_files/snuggletex_wrong.html @@ -0,0 +1,187 @@ + + + + + + + + + + + + SnuggleTeX - ASCIIMathML Enrichment Demo + + + + + + + +

    SnuggleTeX (1.2.2)

    +
    + + +
    + +
    +

    ASCIIMathML Enrichment Demo

    +

    Input

    +

    + This demo is similar to the + MathML Semantic Enrichnment Demo + but uses + ASCIIMathML as + an alternative input format, which provides real-time feedback as you + type but can often generate MathML with odd semantics in it. + SnuggleTeX includes some functionality that can to convert this raw MathML into + something equivalent to its own MathML output, thereby allowing you to + semantically enrich it in + certain simple cases, making ASCIIMathML a possibly viable input format + for simple semantic maths. + +

    +

    + To try the demo, simply enter some some ASCIIMathML into the box below. + You should see a real time preview of this while you type. + Then hit Go! to use SnuggleTeX to semantically enrich your + input. + +

    +
    +
    + ASCIIMath Input: +
    +
    +

    Live Preview

    +

    + This is a MathML rendering of your input, generated by ASCIIMathML as you type. + +

    +
    +
    +
    +

    + This is the underlying MathML source generated by ASCIIMathML, again updated in real time. + +

    +
    +

    Enhanced Presentation MathML

    +

    + This shows the result of attempting to enrich the raw Presentation MathML + generated by ASCIIMathML: + + 

    <math xmlns="http://www.w3.org/1998/Math/MathML">
+   <mn>2</mn>
+</math>

    Content MathML

    +

    + This shows the result of an attempted + conversion to Content MathML: + + 

    <math xmlns="http://www.w3.org/1998/Math/MathML">
+   <cn>2</cn>
+</math>

    Maxima Input Form

    +

    + This shows the result of an attempted + conversion to Maxima Input syntax: + + 

    2

    MathML Parallel Markup

    +

    + This shows the enhanced Presentation MathML with other forms encapsulated + as annotations: + + 

    <math xmlns="http://www.w3.org/1998/Math/MathML">
+   <semantics>
+      <mn>2</mn>
+      <annotation-xml encoding="MathML-Content">
+         <cn>2</cn>
+      </annotation-xml>
+      <annotation encoding="ASCIIMathInput"/>
+      <annotation encoding="Maxima">2</annotation>
+   </semantics>
+</math>
    +
    +
    +
    + + + \ No newline at end of file diff --git a/common/lib/capa/capa/tests/test_html_render.py b/common/lib/capa/capa/tests/test_html_render.py index 492fcb2743..62605b48f5 100644 --- a/common/lib/capa/capa/tests/test_html_render.py +++ b/common/lib/capa/capa/tests/test_html_render.py @@ -6,12 +6,15 @@ import json import mock -from capa.capa_problem import LoncapaProblem from .response_xml_factory import StringResponseXMLFactory, CustomResponseXMLFactory -from . import test_system +from . import test_system, new_loncapa_problem class CapaHtmlRenderTest(unittest.TestCase): + def setUp(self): + super(CapaHtmlRenderTest, self).setUp() + self.system = test_system() + def test_blank_problem(self): """ It's important that blank problems don't break, since that's @@ -20,7 +23,7 @@ class CapaHtmlRenderTest(unittest.TestCase): xml_str = " " # Create the problem - problem = LoncapaProblem(xml_str, '1', system=test_system) + problem = new_loncapa_problem(xml_str) # Render the HTML rendered_html = etree.XML(problem.get_html()) @@ -39,7 +42,7 @@ class CapaHtmlRenderTest(unittest.TestCase): """) # Create the problem - problem = LoncapaProblem(xml_str, '1', system=test_system) + problem = new_loncapa_problem(xml_str, system=self.system) # Render the HTML rendered_html = etree.XML(problem.get_html()) @@ -49,9 +52,6 @@ class CapaHtmlRenderTest(unittest.TestCase): self.assertEqual(test_element.tag, "test") self.assertEqual(test_element.text, "Test include") - - - def test_process_outtext(self): # Generate some XML with and xml_str = textwrap.dedent(""" @@ -61,7 +61,7 @@ class CapaHtmlRenderTest(unittest.TestCase): """) # Create the problem - problem = LoncapaProblem(xml_str, '1', system=test_system) + problem = new_loncapa_problem(xml_str) # Render the HTML rendered_html = etree.XML(problem.get_html()) @@ -80,7 +80,7 @@ class CapaHtmlRenderTest(unittest.TestCase): """) # Create the problem - problem = LoncapaProblem(xml_str, '1', system=test_system) + problem = new_loncapa_problem(xml_str) # Render the HTML rendered_html = etree.XML(problem.get_html()) @@ -98,7 +98,7 @@ class CapaHtmlRenderTest(unittest.TestCase): """) # Create the problem - problem = LoncapaProblem(xml_str, '1', system=test_system) + problem = new_loncapa_problem(xml_str) # Render the HTML rendered_html = etree.XML(problem.get_html()) @@ -117,11 +117,12 @@ class CapaHtmlRenderTest(unittest.TestCase): xml_str = StringResponseXMLFactory().build_xml(**kwargs) # Mock out the template renderer - test_system.render_template = mock.Mock() - test_system.render_template.return_value = "
    Input Template Render
    " + the_system = test_system() + the_system.render_template = mock.Mock() + the_system.render_template.return_value = "
    Input Template Render
    " # Create the problem and render the HTML - problem = LoncapaProblem(xml_str, '1', system=test_system) + problem = new_loncapa_problem(xml_str, system=the_system) rendered_html = etree.XML(problem.get_html()) # Expect problem has been turned into a
    @@ -166,7 +167,7 @@ class CapaHtmlRenderTest(unittest.TestCase): mock.call('textline.html', expected_textline_context), mock.call('solutionspan.html', expected_solution_context)] - self.assertEqual(test_system.render_template.call_args_list, + self.assertEqual(the_system.render_template.call_args_list, expected_calls) @@ -184,7 +185,7 @@ class CapaHtmlRenderTest(unittest.TestCase): xml_str = CustomResponseXMLFactory().build_xml(**kwargs) # Create the problem and render the html - problem = LoncapaProblem(xml_str, '1', system=test_system) + problem = new_loncapa_problem(xml_str) # Grade the problem correctmap = problem.grade_answers({'1_2_1': 'test'}) @@ -219,7 +220,7 @@ class CapaHtmlRenderTest(unittest.TestCase): """) # Create the problem and render the HTML - problem = LoncapaProblem(xml_str, '1', system=test_system) + problem = new_loncapa_problem(xml_str) rendered_html = etree.XML(problem.get_html()) # Expect that the variable $test has been replaced with its value @@ -227,7 +228,7 @@ class CapaHtmlRenderTest(unittest.TestCase): self.assertEqual(span_element.get('attr'), "TEST") def _create_test_file(self, path, content_str): - test_fp = test_system.filestore.open(path, "w") + test_fp = self.system.filestore.open(path, "w") test_fp.write(content_str) test_fp.close() diff --git a/common/lib/capa/capa/tests/test_input_templates.py b/common/lib/capa/capa/tests/test_input_templates.py index 92c4d8b3b7..00a9b3f6c2 100644 --- a/common/lib/capa/capa/tests/test_input_templates.py +++ b/common/lib/capa/capa/tests/test_input_templates.py @@ -1,20 +1,27 @@ -"""Tests for the logic in input type mako templates.""" +""" +Tests for the logic in input type mako templates. +""" import unittest import capa import os.path +import json from lxml import etree from mako.template import Template as MakoTemplate from mako import exceptions class TemplateError(Exception): - """Error occurred while rendering a Mako template""" + """ + Error occurred while rendering a Mako template. + """ pass class TemplateTestCase(unittest.TestCase): - """Utilitites for testing templates""" + """ + Utilitites for testing templates. + """ # Subclasses override this to specify the file name of the template # to be loaded from capa/templates. @@ -23,7 +30,9 @@ class TemplateTestCase(unittest.TestCase): TEMPLATE_NAME = None def setUp(self): - """Load the template""" + """ + Load the template under test. + """ capa_path = capa.__path__[0] self.template_path = os.path.join(capa_path, 'templates', @@ -33,18 +42,31 @@ class TemplateTestCase(unittest.TestCase): template_file.close() def render_to_xml(self, context_dict): - """Render the template using the `context_dict` dict. - - Returns an `etree` XML element.""" + """ + Render the template using the `context_dict` dict. + Returns an `etree` XML element. + """ try: xml_str = self.template.render_unicode(**context_dict) except: raise TemplateError(exceptions.text_error_template().render()) - return etree.fromstring(xml_str) + # Attempt to construct an XML tree from the template + # This makes it easy to use XPath to make assertions, rather + # than dealing with a string. + # We modify the string slightly by wrapping it in + # tags, to ensure it has one root element. + try: + xml = etree.fromstring("" + xml_str + "") + except Exception as exc: + raise TemplateError("Could not parse XML from '{0}': {1}".format( + xml_str, str(exc))) + else: + return xml def assert_has_xpath(self, xml_root, xpath, context_dict, exact_num=1): - """Asserts that the xml tree has an element satisfying `xpath`. + """ + Asserts that the xml tree has an element satisfying `xpath`. `xml_root` is an etree XML element `xpath` is an XPath string, such as `'/foo/bar'` @@ -57,7 +79,8 @@ class TemplateTestCase(unittest.TestCase): self.assertEqual(len(xml_root.xpath(xpath)), exact_num, msg=message) def assert_no_xpath(self, xml_root, xpath, context_dict): - """Asserts that the xml tree does NOT have an element + """ + Asserts that the xml tree does NOT have an element satisfying `xpath`. `xml_root` is an etree XML element @@ -67,7 +90,8 @@ class TemplateTestCase(unittest.TestCase): self.assert_has_xpath(xml_root, xpath, context_dict, exact_num=0) def assert_has_text(self, xml_root, xpath, text, exact=True): - """Find the element at `xpath` in `xml_root` and assert + """ + Find the element at `xpath` in `xml_root` and assert that its text is `text`. `xml_root` is an etree XML element @@ -88,7 +112,9 @@ class TemplateTestCase(unittest.TestCase): class ChoiceGroupTemplateTest(TemplateTestCase): - """Test mako template for `` input""" + """ + Test mako template for `` input. + """ TEMPLATE_NAME = 'choicegroup.html' @@ -103,8 +129,10 @@ class ChoiceGroupTemplateTest(TemplateTestCase): super(ChoiceGroupTemplateTest, self).setUp() def test_problem_marked_correct(self): - """Test conditions under which the entire problem - (not a particular option) is marked correct""" + """ + Test conditions under which the entire problem + (not a particular option) is marked correct. + """ self.context['status'] = 'correct' self.context['input_type'] = 'checkbox' @@ -123,8 +151,10 @@ class ChoiceGroupTemplateTest(TemplateTestCase): self.context) def test_problem_marked_incorrect(self): - """Test all conditions under which the entire problem - (not a particular option) is marked incorrect""" + """ + Test all conditions under which the entire problem + (not a particular option) is marked incorrect. + """ conditions = [ {'status': 'incorrect', 'input_type': 'radio', 'value': ''}, {'status': 'incorrect', 'input_type': 'checkbox', 'value': []}, @@ -151,8 +181,10 @@ class ChoiceGroupTemplateTest(TemplateTestCase): self.context) def test_problem_marked_unsubmitted(self): - """Test all conditions under which the entire problem - (not a particular option) is marked unanswered""" + """ + Test all conditions under which the entire problem + (not a particular option) is marked unanswered. + """ conditions = [ {'status': 'unsubmitted', 'input_type': 'radio', 'value': ''}, {'status': 'unsubmitted', 'input_type': 'radio', 'value': []}, @@ -181,8 +213,10 @@ class ChoiceGroupTemplateTest(TemplateTestCase): self.context) def test_option_marked_correct(self): - """Test conditions under which a particular option - (not the entire problem) is marked correct.""" + """ + Test conditions under which a particular option + (not the entire problem) is marked correct. + """ conditions = [ {'input_type': 'radio', 'value': '2'}, {'input_type': 'radio', 'value': ['2']}] @@ -200,8 +234,10 @@ class ChoiceGroupTemplateTest(TemplateTestCase): self.assert_no_xpath(xml, xpath, self.context) def test_option_marked_incorrect(self): - """Test conditions under which a particular option - (not the entire problem) is marked incorrect.""" + """ + Test conditions under which a particular option + (not the entire problem) is marked incorrect. + """ conditions = [ {'input_type': 'radio', 'value': '2'}, {'input_type': 'radio', 'value': ['2']}] @@ -219,7 +255,8 @@ class ChoiceGroupTemplateTest(TemplateTestCase): self.assert_no_xpath(xml, xpath, self.context) def test_never_show_correctness(self): - """Test conditions under which we tell the template to + """ + Test conditions under which we tell the template to NOT show correct/incorrect, but instead show a message. This is used, for example, by the Justice course to ask @@ -268,8 +305,10 @@ class ChoiceGroupTemplateTest(TemplateTestCase): self.context['submitted_message']) def test_no_message_before_submission(self): - """Ensure that we don't show the `submitted_message` - before submitting""" + """ + Ensure that we don't show the `submitted_message` + before submitting. + """ conditions = [ {'input_type': 'radio', 'status': 'unsubmitted', 'value': ''}, @@ -298,7 +337,9 @@ class ChoiceGroupTemplateTest(TemplateTestCase): class TextlineTemplateTest(TemplateTestCase): - """Test mako template for `` input""" + """ + Test mako template for `` input. + """ TEMPLATE_NAME = 'textline.html' @@ -405,3 +446,271 @@ class TextlineTemplateTest(TemplateTestCase): xpath = "//span[@class='message']" self.assert_has_text(xml, xpath, self.context['msg']) + + +class AnnotationInputTemplateTest(TemplateTestCase): + """ + Test mako template for `` input. + """ + + TEMPLATE_NAME = 'annotationinput.html' + + def setUp(self): + self.context = {'id': 2, + 'value': '

    Test value

    ', + 'title': '

    This is a title

    ', + 'text': '

    This is a test.

    ', + 'comment': '

    This is a test comment

    ', + 'comment_prompt': '

    This is a test comment prompt

    ', + 'comment_value': '

    This is the value of a test comment

    ', + 'tag_prompt': '

    This is a tag prompt

    ', + 'options': [], + 'has_options_value': False, + 'debug': False, + 'status': 'unsubmitted', + 'return_to_annotation': False, + 'msg': '

    This is a test message

    ', } + super(AnnotationInputTemplateTest, self).setUp() + + def test_return_to_annotation(self): + """ + Test link for `Return to Annotation` appears if and only if + the flag is set. + """ + + xpath = "//a[@class='annotation-return']" + + # If return_to_annotation set, then show the link + self.context['return_to_annotation'] = True + xml = self.render_to_xml(self.context) + self.assert_has_xpath(xml, xpath, self.context) + + # Otherwise, do not show the links + self.context['return_to_annotation'] = False + xml = self.render_to_xml(self.context) + self.assert_no_xpath(xml, xpath, self.context) + + def test_option_selection(self): + """ + Test that selected options are selected. + """ + + # Create options 0-4 and select option 2 + self.context['options_value'] = [2] + self.context['options'] = [ + {'id': id_num, + 'choice': 'correct', + 'description': '

    Unescaped HTML {0}

    '.format(id_num)} + for id_num in range(0, 5)] + + xml = self.render_to_xml(self.context) + + # Expect that each option description is visible + # with unescaped HTML. + # Since the HTML is unescaped, we can traverse the XML tree + for id_num in range(0, 5): + xpath = "//span[@data-id='{0}']/p/b".format(id_num) + self.assert_has_text(xml, xpath, 'HTML {0}'.format(id_num), exact=False) + + # Expect that the correct option is selected + xpath = "//span[contains(@class,'selected')]/p/b" + self.assert_has_text(xml, xpath, 'HTML 2', exact=False) + + def test_submission_status(self): + """ + Test that the submission status displays correctly. + """ + + # Test cases of `(input_status, expected_css_class)` tuples + test_cases = [('unsubmitted', 'unanswered'), + ('incomplete', 'incorrect'), + ('incorrect', 'incorrect')] + + for (input_status, expected_css_class) in test_cases: + self.context['status'] = input_status + xml = self.render_to_xml(self.context) + + xpath = "//span[@class='{0}']".format(expected_css_class) + self.assert_has_xpath(xml, xpath, self.context) + + # If individual options are being marked, then expect + # just the option to be marked incorrect, not the whole problem + self.context['has_options_value'] = True + self.context['status'] = 'incorrect' + xpath = "//span[@class='incorrect']" + xml = self.render_to_xml(self.context) + self.assert_no_xpath(xml, xpath, self.context) + + def test_display_html_comment(self): + """ + Test that HTML comment and comment prompt render. + """ + self.context['comment'] = "

    Unescaped comment HTML

    " + self.context['comment_prompt'] = "

    Prompt prompt HTML

    " + self.context['text'] = "

    Unescaped text

    " + xml = self.render_to_xml(self.context) + + # Because the HTML is unescaped, we should be able to + # descend to the tag + xpath = "//div[@class='block']/p/b" + self.assert_has_text(xml, xpath, 'prompt HTML') + + xpath = "//div[@class='block block-comment']/p/b" + self.assert_has_text(xml, xpath, 'comment HTML') + + xpath = "//div[@class='block block-highlight']/p/b" + self.assert_has_text(xml, xpath, 'text') + + def test_display_html_tag_prompt(self): + """ + Test that HTML tag prompts render. + """ + self.context['tag_prompt'] = "

    Unescaped HTML

    " + xml = self.render_to_xml(self.context) + + # Because the HTML is unescaped, we should be able to + # descend to the tag + xpath = "//div[@class='block']/p/b" + self.assert_has_text(xml, xpath, 'HTML') + + +class MathStringTemplateTest(TemplateTestCase): + """ + Test mako template for `` input. + """ + + TEMPLATE_NAME = 'mathstring.html' + + def setUp(self): + self.context = {'isinline': False, 'mathstr': '', 'tail': ''} + super(MathStringTemplateTest, self).setUp() + + def test_math_string_inline(self): + self.context['isinline'] = True + self.context['mathstr'] = 'y = ax^2 + bx + c' + + xml = self.render_to_xml(self.context) + xpath = "//section[@class='math-string']/span[1]" + self.assert_has_text(xml, xpath, + '[mathjaxinline]y = ax^2 + bx + c[/mathjaxinline]') + + def test_math_string_not_inline(self): + self.context['isinline'] = False + self.context['mathstr'] = 'y = ax^2 + bx + c' + + xml = self.render_to_xml(self.context) + xpath = "//section[@class='math-string']/span[1]" + self.assert_has_text(xml, xpath, + '[mathjax]y = ax^2 + bx + c[/mathjax]') + + def test_tail_html(self): + self.context['tail'] = "

    This is some tail HTML

    " + xml = self.render_to_xml(self.context) + + # HTML from `tail` should NOT be escaped. + # We should be able to traverse it as part of the XML tree + xpath = "//section[@class='math-string']/span[2]/p/b" + self.assert_has_text(xml, xpath, 'tail') + + xpath = "//section[@class='math-string']/span[2]/p/em" + self.assert_has_text(xml, xpath, 'HTML') + + +class OptionInputTemplateTest(TemplateTestCase): + """ + Test mako template for `` input. + """ + + TEMPLATE_NAME = 'optioninput.html' + + def setUp(self): + self.context = {'id': 2, 'options': [], 'status': 'unsubmitted', 'value': 0} + super(OptionInputTemplateTest, self).setUp() + + def test_select_options(self): + + # Create options 0-4, and select option 2 + self.context['options'] = [(id_num, 'Option {0}'.format(id_num)) + for id_num in range(0, 5)] + self.context['value'] = 2 + + xml = self.render_to_xml(self.context) + + # Should have a dummy default + xpath = "//option[@value='option_2_dummy_default']" + self.assert_has_xpath(xml, xpath, self.context) + + # Should have each of the options, with the correct description + # The description HTML should NOT be escaped + # (that's why we descend into the tag) + for id_num in range(0, 5): + xpath = "//option[@value='{0}']/b".format(id_num) + self.assert_has_text(xml, xpath, 'Option {0}'.format(id_num)) + + # Should have the correct option selected + xpath = "//option[@selected='true']/b" + self.assert_has_text(xml, xpath, 'Option 2') + + def test_status(self): + + # Test cases, where each tuple represents + # `(input_status, expected_css_class)` + test_cases = [('unsubmitted', 'unanswered'), + ('correct', 'correct'), + ('incorrect', 'incorrect'), + ('incomplete', 'incorrect')] + + for (input_status, expected_css_class) in test_cases: + self.context['status'] = input_status + xml = self.render_to_xml(self.context) + + xpath = "//span[@class='{0}']".format(expected_css_class) + self.assert_has_xpath(xml, xpath, self.context) + + +class DragAndDropTemplateTest(TemplateTestCase): + """ + Test mako template for `` input. + """ + + TEMPLATE_NAME = 'drag_and_drop_input.html' + + def setUp(self): + self.context = {'id': 2, + 'drag_and_drop_json': '', + 'value': 0, + 'status': 'unsubmitted', + 'msg': ''} + super(DragAndDropTemplateTest, self).setUp() + + def test_status(self): + + # Test cases, where each tuple represents + # `(input_status, expected_css_class, expected_text)` + test_cases = [('unsubmitted', 'unanswered', 'unanswered'), + ('correct', 'correct', 'correct'), + ('incorrect', 'incorrect', 'incorrect'), + ('incomplete', 'incorrect', 'incomplete')] + + for (input_status, expected_css_class, expected_text) in test_cases: + self.context['status'] = input_status + xml = self.render_to_xml(self.context) + + # Expect a
    with the status + xpath = "//div[@class='{0}']".format(expected_css_class) + self.assert_has_xpath(xml, xpath, self.context) + + # Expect a

    with the status + xpath = "//p[@class='status']" + self.assert_has_text(xml, xpath, expected_text, exact=False) + + def test_drag_and_drop_json_html(self): + + json_with_html = json.dumps({'test': '

    Unescaped HTML

    '}) + self.context['drag_and_drop_json'] = json_with_html + xml = self.render_to_xml(self.context) + + # Assert that the JSON-encoded string was inserted without + # escaping the HTML. We should be able to traverse the XML tree. + xpath = "//div[@class='drag_and_drop_problem_json']/p/b" + self.assert_has_text(xml, xpath, 'HTML') diff --git a/common/lib/capa/capa/tests/test_inputtypes.py b/common/lib/capa/capa/tests/test_inputtypes.py index 54edb5bf9f..313eb28249 100644 --- a/common/lib/capa/capa/tests/test_inputtypes.py +++ b/common/lib/capa/capa/tests/test_inputtypes.py @@ -45,7 +45,7 @@ class OptionInputTest(unittest.TestCase): state = {'value': 'Down', 'id': 'sky_input', 'status': 'answered'} - option_input = lookup_tag('optioninput')(test_system, element, state) + option_input = lookup_tag('optioninput')(test_system(), element, state) context = option_input._get_render_context() @@ -92,7 +92,7 @@ class ChoiceGroupTest(unittest.TestCase): 'id': 'sky_input', 'status': 'answered'} - the_input = lookup_tag(tag)(test_system, element, state) + the_input = lookup_tag(tag)(test_system(), element, state) context = the_input._get_render_context() @@ -142,7 +142,7 @@ class JavascriptInputTest(unittest.TestCase): element = etree.fromstring(xml_str) state = {'value': '3', } - the_input = lookup_tag('javascriptinput')(test_system, element, state) + the_input = lookup_tag('javascriptinput')(test_system(), element, state) context = the_input._get_render_context() @@ -170,7 +170,7 @@ class TextLineTest(unittest.TestCase): element = etree.fromstring(xml_str) state = {'value': 'BumbleBee', } - the_input = lookup_tag('textline')(test_system, element, state) + the_input = lookup_tag('textline')(test_system(), element, state) context = the_input._get_render_context() @@ -198,7 +198,7 @@ class TextLineTest(unittest.TestCase): element = etree.fromstring(xml_str) state = {'value': 'BumbleBee', } - the_input = lookup_tag('textline')(test_system, element, state) + the_input = lookup_tag('textline')(test_system(), element, state) context = the_input._get_render_context() @@ -236,7 +236,7 @@ class TextLineTest(unittest.TestCase): element = etree.fromstring(xml_str) state = {'value': 'BumbleBee', } - the_input = lookup_tag('textline')(test_system, element, state) + the_input = lookup_tag('textline')(test_system(), element, state) context = the_input._get_render_context() @@ -274,7 +274,7 @@ class FileSubmissionTest(unittest.TestCase): 'status': 'incomplete', 'feedback': {'message': '3'}, } input_class = lookup_tag('filesubmission') - the_input = input_class(test_system, element, state) + the_input = input_class(test_system(), element, state) context = the_input._get_render_context() @@ -319,7 +319,7 @@ class CodeInputTest(unittest.TestCase): 'feedback': {'message': '3'}, } input_class = lookup_tag('codeinput') - the_input = input_class(test_system, element, state) + the_input = input_class(test_system(), element, state) context = the_input._get_render_context() @@ -368,7 +368,7 @@ class MatlabTest(unittest.TestCase): 'feedback': {'message': '3'}, } self.input_class = lookup_tag('matlabinput') - self.the_input = self.input_class(test_system, elt, state) + self.the_input = self.input_class(test_system(), elt, state) def test_rendering(self): context = self.the_input._get_render_context() @@ -396,7 +396,7 @@ class MatlabTest(unittest.TestCase): 'feedback': {'message': '3'}, } elt = etree.fromstring(self.xml) - the_input = self.input_class(test_system, elt, state) + the_input = self.input_class(test_system(), elt, state) context = the_input._get_render_context() expected = {'id': 'prob_1_2', @@ -423,7 +423,7 @@ class MatlabTest(unittest.TestCase): } elt = etree.fromstring(self.xml) - the_input = self.input_class(test_system, elt, state) + the_input = self.input_class(test_system(), elt, state) context = the_input._get_render_context() expected = {'id': 'prob_1_2', 'value': 'print "good evening"', @@ -448,7 +448,7 @@ class MatlabTest(unittest.TestCase): } elt = etree.fromstring(self.xml) - the_input = self.input_class(test_system, elt, state) + the_input = self.input_class(test_system(), elt, state) context = the_input._get_render_context() expected = {'id': 'prob_1_2', 'value': 'print "good evening"', @@ -470,7 +470,7 @@ class MatlabTest(unittest.TestCase): get = {'submission': 'x = 1234;'} response = self.the_input.handle_ajax("plot", get) - test_system.xqueue['interface'].send_to_queue.assert_called_with(header=ANY, body=ANY) + test_system().xqueue['interface'].send_to_queue.assert_called_with(header=ANY, body=ANY) self.assertTrue(response['success']) self.assertTrue(self.the_input.input_state['queuekey'] is not None) @@ -479,13 +479,12 @@ class MatlabTest(unittest.TestCase): def test_plot_data_failure(self): get = {'submission': 'x = 1234;'} error_message = 'Error message!' - test_system.xqueue['interface'].send_to_queue.return_value = (1, error_message) + test_system().xqueue['interface'].send_to_queue.return_value = (1, error_message) response = self.the_input.handle_ajax("plot", get) self.assertFalse(response['success']) self.assertEqual(response['message'], error_message) self.assertTrue('queuekey' not in self.the_input.input_state) self.assertTrue('queuestate' not in self.the_input.input_state) - test_system.xqueue['interface'].send_to_queue.return_value = (0, 'Success!') def test_ungraded_response_success(self): queuekey = 'abcd' @@ -496,7 +495,7 @@ class MatlabTest(unittest.TestCase): 'feedback': {'message': '3'}, } elt = etree.fromstring(self.xml) - the_input = self.input_class(test_system, elt, state) + the_input = self.input_class(test_system(), elt, state) inner_msg = 'hello!' queue_msg = json.dumps({'msg': inner_msg}) @@ -514,7 +513,7 @@ class MatlabTest(unittest.TestCase): 'feedback': {'message': '3'}, } elt = etree.fromstring(self.xml) - the_input = self.input_class(test_system, elt, state) + the_input = self.input_class(test_system(), elt, state) inner_msg = 'hello!' queue_msg = json.dumps({'msg': inner_msg}) @@ -553,7 +552,7 @@ class SchematicTest(unittest.TestCase): state = {'value': value, 'status': 'unsubmitted'} - the_input = lookup_tag('schematic')(test_system, element, state) + the_input = lookup_tag('schematic')(test_system(), element, state) context = the_input._get_render_context() @@ -592,7 +591,7 @@ class ImageInputTest(unittest.TestCase): state = {'value': value, 'status': 'unsubmitted'} - the_input = lookup_tag('imageinput')(test_system, element, state) + the_input = lookup_tag('imageinput')(test_system(), element, state) context = the_input._get_render_context() @@ -643,7 +642,7 @@ class CrystallographyTest(unittest.TestCase): state = {'value': value, 'status': 'unsubmitted'} - the_input = lookup_tag('crystallography')(test_system, element, state) + the_input = lookup_tag('crystallography')(test_system(), element, state) context = the_input._get_render_context() @@ -681,7 +680,7 @@ class VseprTest(unittest.TestCase): state = {'value': value, 'status': 'unsubmitted'} - the_input = lookup_tag('vsepr_input')(test_system, element, state) + the_input = lookup_tag('vsepr_input')(test_system(), element, state) context = the_input._get_render_context() @@ -708,7 +707,7 @@ class ChemicalEquationTest(unittest.TestCase): element = etree.fromstring(xml_str) state = {'value': 'H2OYeah', } - self.the_input = lookup_tag('chemicalequationinput')(test_system, element, state) + self.the_input = lookup_tag('chemicalequationinput')(test_system(), element, state) def test_rendering(self): ''' Verify that the render context matches the expected render context''' @@ -783,7 +782,7 @@ class DragAndDropTest(unittest.TestCase): ] } - the_input = lookup_tag('drag_and_drop_input')(test_system, element, state) + the_input = lookup_tag('drag_and_drop_input')(test_system(), element, state) context = the_input._get_render_context() expected = {'id': 'prob_1_2', @@ -832,7 +831,7 @@ class AnnotationInputTest(unittest.TestCase): tag = 'annotationinput' - the_input = lookup_tag(tag)(test_system, element, state) + the_input = lookup_tag(tag)(test_system(), element, state) context = the_input._get_render_context() diff --git a/common/lib/capa/capa/tests/test_responsetypes.py b/common/lib/capa/capa/tests/test_responsetypes.py index da3d45ad74..780c475b09 100644 --- a/common/lib/capa/capa/tests/test_responsetypes.py +++ b/common/lib/capa/capa/tests/test_responsetypes.py @@ -2,7 +2,6 @@ Tests of responsetypes """ - from datetime import datetime import json from nose.plugins.skip import SkipTest @@ -10,10 +9,10 @@ import os import random import unittest import textwrap +import mock -from . import test_system +from . import new_loncapa_problem, test_system -import capa.capa_problem as lcp from capa.responsetypes import LoncapaProblemError, \ StudentInputError, ResponseError from capa.correctmap import CorrectMap @@ -30,9 +29,9 @@ class ResponseTest(unittest.TestCase): if self.xml_factory_class: self.xml_factory = self.xml_factory_class() - def build_problem(self, **kwargs): + def build_problem(self, system=None, **kwargs): xml = self.xml_factory.build_xml(**kwargs) - return lcp.LoncapaProblem(xml, '1', system=test_system) + return new_loncapa_problem(xml, system=system) def assert_grade(self, problem, submission, expected_correctness, msg=None): input_dict = {'1_2_1': submission} @@ -184,94 +183,150 @@ class ImageResponseTest(ResponseTest): self.assert_answer_format(problem) -class SymbolicResponseTest(unittest.TestCase): - def test_sr_grade(self): - raise SkipTest() # This test fails due to dependencies on a local copy of snuggletex-webapp. Until we have figured that out, we'll just skip this test - symbolicresponse_file = os.path.dirname(__file__) + "/test_files/symbolicresponse.xml" - test_lcp = lcp.LoncapaProblem(open(symbolicresponse_file).read(), '1', system=test_system) - correct_answers = {'1_2_1': 'cos(theta)*[[1,0],[0,1]] + i*sin(theta)*[[0,1],[1,0]]', - '1_2_1_dynamath': ''' - - - - cos - - ( - θ - ) - - - ⋅ - - [ - - - - 1 - - - 0 - - - - - 0 - - - 1 - - - - ] - - + - i - ⋅ - - sin - - ( - θ - ) - - - ⋅ - - [ - - - - 0 - - - 1 - - - - - 1 - - - 0 - - - - ] - - - - ''', - } - wrong_answers = {'1_2_1': '2', - '1_2_1_dynamath': ''' - - - 2 - - ''', - } - self.assertEquals(test_lcp.grade_answers(correct_answers).get_correctness('1_2_1'), 'correct') - self.assertEquals(test_lcp.grade_answers(wrong_answers).get_correctness('1_2_1'), 'incorrect') +class SymbolicResponseTest(ResponseTest): + from response_xml_factory import SymbolicResponseXMLFactory + xml_factory_class = SymbolicResponseXMLFactory + + def test_grade_single_input(self): + problem = self.build_problem(math_display=True, + expect="2*x+3*y") + + # Correct answers + correct_inputs = [ + ('2x+3y', textwrap.dedent(""" + + + 2*x+3*y + """)), + + ('x+x+3y', textwrap.dedent(""" + + + x+x+3*y + """)), + ] + + for (input_str, input_mathml) in correct_inputs: + self._assert_symbolic_grade(problem, input_str, input_mathml, 'correct') + + # Incorrect answers + incorrect_inputs = [ + ('0', ''), + ('4x+3y', textwrap.dedent(""" + + + 4*x+3*y + """)), + ] + + for (input_str, input_mathml) in incorrect_inputs: + self._assert_symbolic_grade(problem, input_str, input_mathml, 'incorrect') + + def test_complex_number_grade(self): + problem = self.build_problem(math_display=True, + expect="[[cos(theta),i*sin(theta)],[i*sin(theta),cos(theta)]]", + options=["matrix", "imaginary"]) + + # For LaTeX-style inputs, symmath_check() will try to contact + # a server to convert the input to MathML. + # We mock out the server, simulating the response that it would give + # for this input. + import requests + dirpath = os.path.dirname(__file__) + correct_snuggletex_response = open(os.path.join(dirpath, "test_files/snuggletex_correct.html")).read().decode('utf8') + wrong_snuggletex_response = open(os.path.join(dirpath, "test_files/snuggletex_wrong.html")).read().decode('utf8') + + # Correct answer + with mock.patch.object(requests, 'post') as mock_post: + + # Simulate what the LaTeX-to-MathML server would + # send for the correct response input + mock_post.return_value.text = correct_snuggletex_response + + self._assert_symbolic_grade(problem, + "cos(theta)*[[1,0],[0,1]] + i*sin(theta)*[[0,1],[1,0]]", + textwrap.dedent(""" + + + + cos + (θ) + + ⋅ + + [ + + + 10 + + + 01 + + + ] + + + + i + ⋅ + + sin + + (θ) + + + ⋅ + + [ + + + 01 + + + 10 + + + ] + + + + """), + 'correct') + + # Incorrect answer + with mock.patch.object(requests, 'post') as mock_post: + + # Simulate what the LaTeX-to-MathML server would + # send for the incorrect response input + mock_post.return_value.text = wrong_snuggletex_response + + self._assert_symbolic_grade(problem, "2", + textwrap.dedent(""" + + 2 + + """), + 'incorrect') + + def test_multiple_inputs_exception(self): + + # Should not allow multiple inputs, since we specify + # only one "expect" value + with self.assertRaises(Exception): + problem = self.build_problem(math_display=True, + expect="2*x+3*y", + num_inputs=3) + + def _assert_symbolic_grade(self, problem, + student_input, + dynamath_input, + expected_correctness): + input_dict = {'1_2_1': str(student_input), + '1_2_1_dynamath': str(dynamath_input)} + + correct_map = problem.grade_answers(input_dict) + + self.assertEqual(correct_map.get_correctness('1_2_1'), + expected_correctness) class OptionResponseTest(ResponseTest): @@ -292,10 +347,18 @@ class OptionResponseTest(ResponseTest): class FormulaResponseTest(ResponseTest): + """ + Test the FormulaResponse class + """ from response_xml_factory import FormulaResponseXMLFactory xml_factory_class = FormulaResponseXMLFactory def test_grade(self): + """ + Test basic functionality of FormulaResponse + + Specifically, if it can understand equivalence of formulae + """ # Sample variables x and y in the range [-10, 10] sample_dict = {'x': (-10, 10), 'y': (-10, 10)} @@ -316,6 +379,9 @@ class FormulaResponseTest(ResponseTest): self.assert_grade(problem, input_formula, "incorrect") def test_hint(self): + """ + Test the hint-giving functionality of FormulaResponse + """ # Sample variables x and y in the range [-10, 10] sample_dict = {'x': (-10, 10), 'y': (-10, 10)} @@ -344,6 +410,10 @@ class FormulaResponseTest(ResponseTest): 'Try including the variable x') def test_script(self): + """ + Test if python script can be used to generate answers + """ + # Calculate the answer using a script script = "calculated_ans = 'x+x'" @@ -362,7 +432,9 @@ class FormulaResponseTest(ResponseTest): self.assert_grade(problem, '3*x', 'incorrect') def test_parallel_resistors(self): - """Test parallel resistors""" + """ + Test parallel resistors + """ sample_dict = {'R1': (10, 10), 'R2': (2, 2), 'R3': (5, 5), 'R4': (1, 1)} # Test problem @@ -383,8 +455,11 @@ class FormulaResponseTest(ResponseTest): self.assert_grade(problem, input_formula, "incorrect") def test_default_variables(self): - """Test the default variables provided in common/lib/capa/capa/calc.py""" - # which are: j (complex number), e, pi, k, c, T, q + """ + Test the default variables provided in calc.py + + which are: j (complex number), e, pi, k, c, T, q + """ # Sample x in the range [-10,10] sample_dict = {'x': (-10, 10)} @@ -407,11 +482,14 @@ class FormulaResponseTest(ResponseTest): msg="Failed on variable {0}; the given, incorrect answer was {1} but graded 'correct'".format(var, incorrect)) def test_default_functions(self): - """Test the default functions provided in common/lib/capa/capa/calc.py""" - # which are: sin, cos, tan, sqrt, log10, log2, ln, - # arccos, arcsin, arctan, abs, - # fact, factorial + """ + Test the default functions provided in common/lib/capa/capa/calc.py + which are: + sin, cos, tan, sqrt, log10, log2, ln, + arccos, arcsin, arctan, abs, + fact, factorial + """ w = random.randint(3, 10) sample_dict = {'x': (-10, 10), # Sample x in the range [-10,10] 'y': (1, 10), # Sample y in the range [1,10] - logs, arccos need positive inputs @@ -439,8 +517,10 @@ class FormulaResponseTest(ResponseTest): msg="Failed on function {0}; the given, incorrect answer was {1} but graded 'correct'".format(func, incorrect)) def test_grade_infinity(self): - # This resolves a bug where a problem with relative tolerance would - # pass with any arbitrarily large student answer. + """ + Test that a large input on a problem with relative tolerance isn't + erroneously marked as correct. + """ sample_dict = {'x': (1, 2)} @@ -457,8 +537,9 @@ class FormulaResponseTest(ResponseTest): self.assert_grade(problem, input_formula, "incorrect") def test_grade_nan(self): - # Attempt to produce a value which causes the student's answer to be - # evaluated to nan. See if this is resolved correctly. + """ + Test that expressions that evaluate to NaN are not marked as correct. + """ sample_dict = {'x': (1, 2)} @@ -475,6 +556,18 @@ class FormulaResponseTest(ResponseTest): input_formula = "x + 0*1e999" self.assert_grade(problem, input_formula, "incorrect") + def test_raises_zero_division_err(self): + """ + See if division by zero raises an error. + """ + sample_dict = {'x': (1, 2)} + problem = self.build_problem(sample_dict=sample_dict, + num_samples=10, + tolerance="1%", + answer="x") # Answer doesn't matter + input_dict = {'1_2_1': '1/0'} + self.assertRaises(StudentInputError, problem.grade_answers, input_dict) + class StringResponseTest(ResponseTest): from response_xml_factory import StringResponseXMLFactory @@ -531,6 +624,22 @@ class StringResponseTest(ResponseTest): correct_map = problem.grade_answers(input_dict) self.assertEquals(correct_map.get_hint('1_2_1'), "") + def test_computed_hints(self): + problem = self.build_problem( + answer="Michigan", + hintfn="gimme_a_hint", + script=textwrap.dedent(""" + def gimme_a_hint(answer_ids, student_answers, new_cmap, old_cmap): + aid = answer_ids[0] + answer = student_answers[aid] + new_cmap.set_hint_and_mode(aid, answer+"??", "always") + """) + ) + + input_dict = {'1_2_1': 'Hello'} + correct_map = problem.grade_answers(input_dict) + self.assertEquals(correct_map.get_hint('1_2_1'), "Hello??") + class CodeResponseTest(ResponseTest): from response_xml_factory import CodeResponseXMLFactory @@ -708,18 +817,39 @@ class JavascriptResponseTest(ResponseTest): def test_grade(self): # Compile coffee files into javascript used by the response coffee_file_path = os.path.dirname(__file__) + "/test_files/js/*.coffee" - os.system("coffee -c %s" % (coffee_file_path)) + os.system("node_modules/.bin/coffee -c %s" % (coffee_file_path)) - problem = self.build_problem(generator_src="test_problem_generator.js", - grader_src="test_problem_grader.js", - display_class="TestProblemDisplay", - display_src="test_problem_display.js", - param_dict={'value': '4'}) + system = test_system() + system.can_execute_unsafe_code = lambda: True + problem = self.build_problem( + system=system, + generator_src="test_problem_generator.js", + grader_src="test_problem_grader.js", + display_class="TestProblemDisplay", + display_src="test_problem_display.js", + param_dict={'value': '4'}, + ) # Test that we get graded correctly self.assert_grade(problem, json.dumps({0: 4}), "correct") self.assert_grade(problem, json.dumps({0: 5}), "incorrect") + def test_cant_execute_javascript(self): + # If the system says to disallow unsafe code execution, then making + # this problem will raise an exception. + system = test_system() + system.can_execute_unsafe_code = lambda: False + + with self.assertRaises(LoncapaProblemError): + problem = self.build_problem( + system=system, + generator_src="test_problem_generator.js", + grader_src="test_problem_grader.js", + display_class="TestProblemDisplay", + display_src="test_problem_display.js", + param_dict={'value': '4'}, + ) + class NumericalResponseTest(ResponseTest): from response_xml_factory import NumericalResponseXMLFactory @@ -804,6 +934,14 @@ class NumericalResponseTest(ResponseTest): incorrect_responses = ["", "3.9", "4.1", "0", "5.01e1"] self.assert_multiple_grade(problem, correct_responses, incorrect_responses) + def test_raises_zero_division_err(self): + """See if division by zero is handled correctly""" + problem = self.build_problem(question_text="What 5 * 10?", + explanation="The answer is 50", + answer="5e+1") # Answer doesn't matter + input_dict = {'1_2_1': '1/0'} + self.assertRaises(StudentInputError, problem.grade_answers, input_dict) + class CustomResponseTest(ResponseTest): from response_xml_factory import CustomResponseXMLFactory @@ -854,7 +992,6 @@ class CustomResponseTest(ResponseTest): # 'answer_given' is the answer the student gave (if there is just one input) # or an ordered list of answers (if there are multiple inputs) # - # # The function should return a dict of the form # { 'ok': BOOL, 'msg': STRING } # @@ -964,6 +1101,35 @@ class CustomResponseTest(ResponseTest): self.assertEqual(correct_map.get_msg('1_2_2'), 'Feedback 2') self.assertEqual(correct_map.get_msg('1_2_3'), 'Feedback 3') + def test_function_code_with_extra_args(self): + script = textwrap.dedent("""\ + def check_func(expect, answer_given, options, dynamath): + assert options == "xyzzy", "Options was %r" % options + return {'ok': answer_given == expect, 'msg': 'Message text'} + """) + + problem = self.build_problem(script=script, cfn="check_func", expect="42", options="xyzzy", cfn_extra_args="options dynamath") + + # Correct answer + input_dict = {'1_2_1': '42'} + correct_map = problem.grade_answers(input_dict) + + correctness = correct_map.get_correctness('1_2_1') + msg = correct_map.get_msg('1_2_1') + + self.assertEqual(correctness, 'correct') + self.assertEqual(msg, "Message text") + + # Incorrect answer + input_dict = {'1_2_1': '0'} + correct_map = problem.grade_answers(input_dict) + + correctness = correct_map.get_correctness('1_2_1') + msg = correct_map.get_msg('1_2_1') + + self.assertEqual(correctness, 'incorrect') + self.assertEqual(msg, "Message text") + def test_multiple_inputs_return_one_status(self): # When given multiple inputs, the 'answer_given' argument # to the check_func() is a list of inputs diff --git a/common/lib/capa/capa/util.py b/common/lib/capa/capa/util.py index 8b05ea717e..ec43da6093 100644 --- a/common/lib/capa/capa/util.py +++ b/common/lib/capa/capa/util.py @@ -1,4 +1,4 @@ -from .calc import evaluator, UndefinedVariable +from calc import evaluator, UndefinedVariable from cmath import isinf #----------------------------------------------------------------------------- diff --git a/common/lib/capa/setup.py b/common/lib/capa/setup.py index d9c813f55c..dcb631e376 100644 --- a/common/lib/capa/setup.py +++ b/common/lib/capa/setup.py @@ -4,5 +4,5 @@ setup( name="capa", version="0.1", packages=find_packages(exclude=["tests"]), - install_requires=['distribute==0.6.30', 'pyparsing==1.5.6'], + install_requires=["distribute>=0.6.28"], ) diff --git a/common/lib/chem/chem/__init__.py b/common/lib/chem/chem/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/common/lib/capa/capa/chem/chemcalc.py b/common/lib/chem/chem/chemcalc.py similarity index 100% rename from common/lib/capa/capa/chem/chemcalc.py rename to common/lib/chem/chem/chemcalc.py diff --git a/common/lib/capa/capa/chem/chemtools.py b/common/lib/chem/chem/chemtools.py similarity index 100% rename from common/lib/capa/capa/chem/chemtools.py rename to common/lib/chem/chem/chemtools.py diff --git a/common/lib/capa/capa/chem/miller.py b/common/lib/chem/chem/miller.py similarity index 100% rename from common/lib/capa/capa/chem/miller.py rename to common/lib/chem/chem/miller.py diff --git a/common/lib/capa/capa/chem/tests.py b/common/lib/chem/chem/tests.py similarity index 100% rename from common/lib/capa/capa/chem/tests.py rename to common/lib/chem/chem/tests.py diff --git a/common/lib/chem/setup.py b/common/lib/chem/setup.py new file mode 100644 index 0000000000..642c9a4fe5 --- /dev/null +++ b/common/lib/chem/setup.py @@ -0,0 +1,13 @@ +from setuptools import setup + +setup( + name="chem", + version="0.1.1", + packages=["chem"], + install_requires=[ + "pyparsing==1.5.6", + "numpy", + "scipy", + "nltk==2.0.4", + ], +) diff --git a/common/lib/sandbox-packages/README b/common/lib/sandbox-packages/README new file mode 100644 index 0000000000..706998b08e --- /dev/null +++ b/common/lib/sandbox-packages/README @@ -0,0 +1 @@ +This directory is in the Python path for sandboxed Python execution. diff --git a/common/lib/capa/capa/eia.py b/common/lib/sandbox-packages/eia.py similarity index 100% rename from common/lib/capa/capa/eia.py rename to common/lib/sandbox-packages/eia.py diff --git a/lms/lib/loncapa/__init__.py b/common/lib/sandbox-packages/loncapa/__init__.py similarity index 100% rename from lms/lib/loncapa/__init__.py rename to common/lib/sandbox-packages/loncapa/__init__.py diff --git a/lms/lib/loncapa/loncapa_check.py b/common/lib/sandbox-packages/loncapa/loncapa_check.py similarity index 100% rename from lms/lib/loncapa/loncapa_check.py rename to common/lib/sandbox-packages/loncapa/loncapa_check.py diff --git a/common/lib/sandbox-packages/setup.py b/common/lib/sandbox-packages/setup.py new file mode 100644 index 0000000000..c435114987 --- /dev/null +++ b/common/lib/sandbox-packages/setup.py @@ -0,0 +1,15 @@ +from setuptools import setup + +setup( + name="sandbox-packages", + version="0.1.1", + packages=[ + "loncapa", + "verifiers", + ], + py_modules=[ + "eia", + ], + install_requires=[ + ], +) diff --git a/common/lib/sandbox-packages/verifiers/__init__.py b/common/lib/sandbox-packages/verifiers/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/common/lib/capa/capa/verifiers/draganddrop.py b/common/lib/sandbox-packages/verifiers/draganddrop.py similarity index 100% rename from common/lib/capa/capa/verifiers/draganddrop.py rename to common/lib/sandbox-packages/verifiers/draganddrop.py diff --git a/common/lib/capa/capa/verifiers/tests_draganddrop.py b/common/lib/sandbox-packages/verifiers/tests_draganddrop.py similarity index 100% rename from common/lib/capa/capa/verifiers/tests_draganddrop.py rename to common/lib/sandbox-packages/verifiers/tests_draganddrop.py diff --git a/common/lib/symmath/setup.py b/common/lib/symmath/setup.py new file mode 100644 index 0000000000..5aa81f09bf --- /dev/null +++ b/common/lib/symmath/setup.py @@ -0,0 +1,10 @@ +from setuptools import setup + +setup( + name="symmath", + version="0.1", + packages=["symmath"], + install_requires=[ + "sympy", + ], +) diff --git a/common/lib/symmath/symmath/README.md b/common/lib/symmath/symmath/README.md new file mode 100644 index 0000000000..8da9aa87ee --- /dev/null +++ b/common/lib/symmath/symmath/README.md @@ -0,0 +1,30 @@ +(Originally written by Ike.) + +At a high level, the main challenges of checking symbolic math expressions are +(1) making sure the expression is mathematically legal, and (2) simplifying the +expression for comparison with what is expected. + +(1) Generation (and testing) of legal input is done by using MathJax to provide +input math in an XML format known as Presentation MathML (PMathML). Such +expressions typeset correctly, but may not be mathematically legal, like "5 / +(1 = 2)". The PMathML is converted into "Content MathML" (CMathML), which is +by definition mathematically legal, using an XSLT 2.0 stylesheet, via a module +in SnuggleTeX. CMathML is then converted into a sympy expression. This work is +all done in `symmath/formula.py`. + +(2) Simplifying the expression and checking against what is expected is done by +using sympy, and a set of heuristics based on options flags provided by the +problem author. For example, the problem author may specify that the expected +expression is a matrix, in which case the dimensionality of the input +expression is checked. Other options include specifying that the comparison be +checked numerically in addition to symbolically. The checking is done in +stages, first with no simplification, then with increasing levels of testing; +if a match is found at any stage, then an "ok" is returned. Helpful messages +are also returned, eg if the input expression is of a different type than the +expected. This work is all done in `symmath/symmath_check.py`. + +Links: + +SnuggleTex: http://www2.ph.ed.ac.uk/snuggletex/documentation/overview-and-features.html +MathML: http://www.w3.org/TR/MathML2/overview.html +SymPy: http://sympy.org/en/index.html diff --git a/lms/lib/symmath/__init__.py b/common/lib/symmath/symmath/__init__.py similarity index 100% rename from lms/lib/symmath/__init__.py rename to common/lib/symmath/symmath/__init__.py diff --git a/lms/lib/symmath/formula.py b/common/lib/symmath/symmath/formula.py similarity index 99% rename from lms/lib/symmath/formula.py rename to common/lib/symmath/symmath/formula.py index 604941ffdd..8369baa27c 100644 --- a/lms/lib/symmath/formula.py +++ b/common/lib/symmath/symmath/formula.py @@ -736,4 +736,4 @@ def test6(): # imaginary numbers ''' - return formula(xmlstr, options='imaginaryi') + return formula(xmlstr, options='imaginary') diff --git a/lms/lib/symmath/symmath_check.py b/common/lib/symmath/symmath/symmath_check.py similarity index 99% rename from lms/lib/symmath/symmath_check.py rename to common/lib/symmath/symmath/symmath_check.py index 151debee71..65a17883f5 100644 --- a/lms/lib/symmath/symmath_check.py +++ b/common/lib/symmath/symmath/symmath_check.py @@ -324,4 +324,5 @@ def symmath_check(expect, ans, dynamath=None, options=None, debug=None, xml=None msg += "

    Difference: %s

    " % to_latex(diff) msg += '
    ' - return {'ok': False, 'msg': msg, 'ex': fexpect, 'got': fsym} + # Used to return more keys: 'ex': fexpect, 'got': fsym + return {'ok': False, 'msg': msg} diff --git a/lms/lib/symmath/test_formula.py b/common/lib/symmath/symmath/test_formula.py similarity index 100% rename from lms/lib/symmath/test_formula.py rename to common/lib/symmath/symmath/test_formula.py diff --git a/lms/lib/symmath/test_symmath_check.py b/common/lib/symmath/symmath/test_symmath_check.py similarity index 100% rename from lms/lib/symmath/test_symmath_check.py rename to common/lib/symmath/symmath/test_symmath_check.py diff --git a/common/lib/xmodule/test_files/symbolicresponse.xml b/common/lib/xmodule/test_files/symbolicresponse.xml index 4dc2bc9d7b..8443366ffe 100644 --- a/common/lib/xmodule/test_files/symbolicresponse.xml +++ b/common/lib/xmodule/test_files/symbolicresponse.xml @@ -13,13 +13,10 @@ real time, next to the input box.

    This is a correct answer which may be entered below:

    cos(theta)*[[1,0],[0,1]] + i*sin(theta)*[[0,1],[1,0]]

    - Compute [mathjax] U = \exp\left( i \theta \left[ \begin{matrix} 0 & 1 \\ 1 & 0 \end{matrix} \right] \right) [/mathjax] and give the resulting \(2 \times 2\) matrix.
    Your input should be typed in as a list of lists, eg [[1,2],[3,4]].
    - [mathjax]U=[/mathjax] + [mathjax]U=[/mathjax]
    diff --git a/common/lib/xmodule/xmodule/capa_module.py b/common/lib/xmodule/xmodule/capa_module.py index 479cd5a759..9ac540138e 100644 --- a/common/lib/xmodule/xmodule/capa_module.py +++ b/common/lib/xmodule/xmodule/capa_module.py @@ -3,7 +3,9 @@ import datetime import hashlib import json import logging +import os import traceback +import struct import sys from pkg_resources import resource_string @@ -23,8 +25,10 @@ from xmodule.util.date_utils import time_to_datetime log = logging.getLogger("mitx.courseware") -# Generated this many different variants of problems with rerandomize=per_student +# Generate this many different variants of problems with rerandomize=per_student NUM_RANDOMIZATION_BINS = 20 +# Never produce more than this many different seeds, no matter what. +MAX_RANDOMIZATION_BINS = 1000 def randomization_bin(seed, problem_id): @@ -62,22 +66,51 @@ class ComplexEncoder(json.JSONEncoder): class CapaFields(object): attempts = StringyInteger(help="Number of attempts taken by the student on this problem", default=0, scope=Scope.user_state) - max_attempts = StringyInteger(help="Maximum number of attempts that a student is allowed", scope=Scope.settings) + max_attempts = StringyInteger( + display_name="Maximum Attempts", + help="Defines the number of times a student can try to answer this problem. If the value is not set, infinite attempts are allowed.", + values={"min": 1}, scope=Scope.settings + ) due = Date(help="Date that this problem is due by", scope=Scope.settings) graceperiod = Timedelta(help="Amount of time after the due date that submissions will be accepted", scope=Scope.settings) - showanswer = String(help="When to show the problem answer to the student", scope=Scope.settings, default="closed", - values=["answered", "always", "attempted", "closed", "never"]) + showanswer = String( + display_name="Show Answer", + help="Defines when to show the answer to the problem. A default value can be set in Advanced Settings.", + scope=Scope.settings, default="closed", + values=[ + {"display_name": "Always", "value": "always"}, + {"display_name": "Answered", "value": "answered"}, + {"display_name": "Attempted", "value": "attempted"}, + {"display_name": "Closed", "value": "closed"}, + {"display_name": "Finished", "value": "finished"}, + {"display_name": "Past Due", "value": "past_due"}, + {"display_name": "Never", "value": "never"}] + ) force_save_button = Boolean(help="Whether to force the save button to appear on the page", scope=Scope.settings, default=False) - rerandomize = Randomization(help="When to rerandomize the problem", default="always", scope=Scope.settings) + rerandomize = Randomization( + display_name="Randomization", help="Defines how often inputs are randomized when a student loads the problem. This setting only applies to problems that can have randomly generated numeric values. A default value can be set in Advanced Settings.", + default="always", scope=Scope.settings, values=[{"display_name": "Always", "value": "always"}, + {"display_name": "On Reset", "value": "onreset"}, + {"display_name": "Never", "value": "never"}, + {"display_name": "Per Student", "value": "per_student"}] + ) data = String(help="XML data for the problem", scope=Scope.content) correct_map = Object(help="Dictionary with the correctness of current student answers", scope=Scope.user_state, default={}) input_state = Object(help="Dictionary for maintaining the state of inputtypes", scope=Scope.user_state) student_answers = Object(help="Dictionary with the current student responses", scope=Scope.user_state) done = Boolean(help="Whether the student has answered the problem", scope=Scope.user_state) seed = StringyInteger(help="Random seed for this student", scope=Scope.user_state) - weight = StringyFloat(help="How much to weight this problem by", scope=Scope.settings) + weight = StringyFloat( + display_name="Problem Weight", + help="Defines the number of points each problem is worth. If the value is not set, each response field in the problem is worth one point.", + values={"min": 0, "step": .1}, + scope=Scope.settings + ) markdown = String(help="Markdown source of this module", scope=Scope.settings) - source_code = String(help="Source code for LaTeX and Word problems. This feature is not well-supported.", scope=Scope.settings) + source_code = String( + help="Source code for LaTeX and Word problems. This feature is not well-supported.", + scope=Scope.settings + ) class CapaModule(CapaFields, XModule): @@ -109,11 +142,7 @@ class CapaModule(CapaFields, XModule): self.close_date = due_date if self.seed is None: - if self.rerandomize == 'never': - self.seed = 1 - elif self.rerandomize == "per_student" and hasattr(self.system, 'seed'): - # see comment on randomization_bin - self.seed = randomization_bin(system.seed, self.location.url) + self.choose_new_seed() # Need the problem location in openendedresponse to send out. Adding # it to the system here seems like the least clunky way to get it @@ -157,6 +186,22 @@ class CapaModule(CapaFields, XModule): self.set_state_from_lcp() + assert self.seed is not None + + def choose_new_seed(self): + """Choose a new seed.""" + if self.rerandomize == 'never': + self.seed = 1 + elif self.rerandomize == "per_student" and hasattr(self.system, 'seed'): + # see comment on randomization_bin + self.seed = randomization_bin(self.system.seed, self.location.url) + else: + self.seed = struct.unpack('i', os.urandom(4))[0] + + # So that sandboxed code execution can be cached, but still have an interesting + # number of possibilities, cap the number of different random seeds. + self.seed %= MAX_RANDOMIZATION_BINS + def new_lcp(self, state, text=None): if text is None: text = self.data @@ -165,6 +210,7 @@ class CapaModule(CapaFields, XModule): problem_text=text, id=self.location.html_id(), state=state, + seed=self.seed, system=self.system, ) @@ -832,14 +878,11 @@ class CapaModule(CapaFields, XModule): 'error': "Refresh the page and make an attempt before resetting."} if self.rerandomize in ["always", "onreset"]: - # reset random number generator seed (note the self.lcp.get_state() - # in next line) - seed = None - else: - seed = self.lcp.seed + # Reset random number generator seed. + self.choose_new_seed() # Generate a new problem with either the previous seed or a new seed - self.lcp = self.new_lcp({'seed': seed}) + self.lcp = self.new_lcp(None) # Pull in the new problem seed self.set_state_from_lcp() diff --git a/common/lib/xmodule/xmodule/combined_open_ended_module.py b/common/lib/xmodule/xmodule/combined_open_ended_module.py index f4074283fe..b3f0e19109 100644 --- a/common/lib/xmodule/xmodule/combined_open_ended_module.py +++ b/common/lib/xmodule/xmodule/combined_open_ended_module.py @@ -5,10 +5,10 @@ from pkg_resources import resource_string from xmodule.raw_module import RawDescriptor from .x_module import XModule -from xblock.core import Integer, Scope, String, Boolean, List +from xblock.core import Integer, Scope, String, List from xmodule.open_ended_grading_classes.combined_open_ended_modulev1 import CombinedOpenEndedV1Module, CombinedOpenEndedV1Descriptor from collections import namedtuple -from .fields import Date, StringyFloat +from .fields import Date, StringyFloat, StringyInteger, StringyBoolean log = logging.getLogger("mitx.courseware") @@ -48,27 +48,50 @@ class VersionInteger(Integer): class CombinedOpenEndedFields(object): - display_name = String(help="Display name for this module", default="Open Ended Grading", scope=Scope.settings) - current_task_number = Integer(help="Current task that the student is on.", default=0, scope=Scope.user_state) + display_name = String( + display_name="Display Name", + help="This name appears in the horizontal navigation at the top of the page.", + default="Open Ended Grading", scope=Scope.settings + ) + current_task_number = StringyInteger(help="Current task that the student is on.", default=0, scope=Scope.user_state) task_states = List(help="List of state dictionaries of each task within this module.", scope=Scope.user_state) state = String(help="Which step within the current task that the student is on.", default="initial", scope=Scope.user_state) - student_attempts = Integer(help="Number of attempts taken by the student on this problem", default=0, - scope=Scope.user_state) - ready_to_reset = Boolean(help="If the problem is ready to be reset or not.", default=False, - scope=Scope.user_state) - attempts = Integer(help="Maximum number of attempts that a student is allowed.", default=1, scope=Scope.settings) - is_graded = Boolean(help="Whether or not the problem is graded.", default=False, scope=Scope.settings) - accept_file_upload = Boolean(help="Whether or not the problem accepts file uploads.", default=False, - scope=Scope.settings) - skip_spelling_checks = Boolean(help="Whether or not to skip initial spelling checks.", default=True, - scope=Scope.settings) + student_attempts = StringyInteger(help="Number of attempts taken by the student on this problem", default=0, + scope=Scope.user_state) + ready_to_reset = StringyBoolean( + help="If the problem is ready to be reset or not.", default=False, + scope=Scope.user_state + ) + attempts = StringyInteger( + display_name="Maximum Attempts", + help="The number of times the student can try to answer this problem.", default=1, + scope=Scope.settings, values = {"min" : 1 } + ) + is_graded = StringyBoolean(display_name="Graded", help="Whether or not the problem is graded.", default=False, scope=Scope.settings) + accept_file_upload = StringyBoolean( + display_name="Allow File Uploads", + help="Whether or not the student can submit files as a response.", default=False, scope=Scope.settings + ) + skip_spelling_checks = StringyBoolean( + display_name="Disable Quality Filter", + help="If False, the Quality Filter is enabled and submissions with poor spelling, short length, or poor grammar will not be peer reviewed.", + default=False, scope=Scope.settings + ) due = Date(help="Date that this problem is due by", default=None, scope=Scope.settings) - graceperiod = String(help="Amount of time after the due date that submissions will be accepted", default=None, - scope=Scope.settings) + graceperiod = String( + help="Amount of time after the due date that submissions will be accepted", + default=None, + scope=Scope.settings + ) version = VersionInteger(help="Current version number", default=DEFAULT_VERSION, scope=Scope.settings) data = String(help="XML data for the problem", scope=Scope.content) - weight = StringyFloat(help="How much to weight this problem by", scope=Scope.settings) + weight = StringyFloat( + display_name="Problem Weight", + help="Defines the number of points each problem is worth. If the value is not set, each problem is worth one point.", + scope=Scope.settings, values = {"min" : 0 , "step": ".1"} + ) + markdown = String(help="Markdown source of this module", scope=Scope.settings) class CombinedOpenEndedModule(CombinedOpenEndedFields, XModule): @@ -213,11 +236,36 @@ class CombinedOpenEndedDescriptor(CombinedOpenEndedFields, RawDescriptor): """ Module for adding combined open ended questions """ - mako_template = "widgets/raw-edit.html" + mako_template = "widgets/open-ended-edit.html" module_class = CombinedOpenEndedModule - filename_extension = "xml" stores_state = True has_score = True always_recalculate_grades = True template_dir_name = "combinedopenended" + + #Specify whether or not to pass in S3 interface + needs_s3_interface = True + + #Specify whether or not to pass in open ended interface + needs_open_ended_interface = True + + metadata_attributes = RawDescriptor.metadata_attributes + + js = {'coffee': [resource_string(__name__, 'js/src/combinedopenended/edit.coffee')]} + js_module_name = "OpenEndedMarkdownEditingDescriptor" + css = {'scss': [resource_string(__name__, 'css/editor/edit.scss'), resource_string(__name__, 'css/combinedopenended/edit.scss')]} + + def get_context(self): + _context = RawDescriptor.get_context(self) + _context.update({'markdown': self.markdown, + 'enable_markdown': self.markdown is not None}) + return _context + + @property + def non_editable_metadata_fields(self): + non_editable_fields = super(CombinedOpenEndedDescriptor, self).non_editable_metadata_fields + non_editable_fields.extend([CombinedOpenEndedDescriptor.due, CombinedOpenEndedDescriptor.graceperiod, + CombinedOpenEndedDescriptor.markdown, CombinedOpenEndedDescriptor.version]) + return non_editable_fields + diff --git a/common/lib/xmodule/xmodule/css/combinedopenended/edit.scss b/common/lib/xmodule/xmodule/css/combinedopenended/edit.scss new file mode 100644 index 0000000000..94515ff4b7 --- /dev/null +++ b/common/lib/xmodule/xmodule/css/combinedopenended/edit.scss @@ -0,0 +1,106 @@ +.editor-bar { + + .editor-tabs { + + .advanced-toggle { + @include white-button; + height: auto; + margin-top: -1px; + padding: 3px 9px; + font-size: 12px; + + &.current { + border: 1px solid $lightGrey !important; + border-radius: 3px !important; + background: $lightGrey !important; + color: $darkGrey !important; + pointer-events: none; + cursor: none; + + &:hover { + box-shadow: 0 0 0 0 !important; + } + } + } + + .cheatsheet-toggle { + width: 21px; + height: 21px; + padding: 0; + margin: 0 5px 0 15px; + border-radius: 22px; + border: 1px solid #a5aaaf; + background: #e5ecf3; + font-size: 13px; + font-weight: 700; + color: #565d64; + text-align: center; + } + } +} + +.simple-editor-open-ended-cheatsheet { + position: absolute; + top: 0; + left: 100%; + width: 0; + border-radius: 0 3px 3px 0; + @include linear-gradient(left, rgba(0, 0, 0, .1), rgba(0, 0, 0, 0) 4px); + background-color: #fff; + overflow: hidden; + @include transition(width .3s); + + &.shown { + width: 300px; + height: 100%; + overflow-y: scroll; + } + + .cheatsheet-wrapper { + width: 240px; + padding: 20px 30px; + } + + h6 { + margin-bottom: 7px; + font-size: 15px; + font-weight: 700; + } + + .row { + @include clearfix; + padding-bottom: 5px !important; + margin-bottom: 10px !important; + border-bottom: 1px solid #ddd !important; + + &:last-child { + border-bottom: none !important; + margin-bottom: 0 !important; + } + } + + .col { + float: left; + + &.sample { + width: 60px; + margin-right: 30px; + } + } + + pre { + font-size: 12px; + line-height: 18px; + } + + code { + padding: 0; + background: none; + } +} + +.combinedopenended-editor-icon { + display: inline-block; + vertical-align: middle; + color: #333; +} diff --git a/common/lib/xmodule/xmodule/css/editor/edit.scss b/common/lib/xmodule/xmodule/css/editor/edit.scss index ac53bb5a70..d30f69bcd2 100644 --- a/common/lib/xmodule/xmodule/css/editor/edit.scss +++ b/common/lib/xmodule/xmodule/css/editor/edit.scss @@ -10,8 +10,6 @@ position: relative; @include linear-gradient(top, #d4dee8, #c9d5e2); padding: 5px; - border: 1px solid #3c3c3c; - border-radius: 3px 3px 0 0; border-bottom-color: #a5aaaf; @include clearfix; diff --git a/common/lib/xmodule/xmodule/css/problem/edit.scss b/common/lib/xmodule/xmodule/css/problem/edit.scss index be5455e901..249b767e5e 100644 --- a/common/lib/xmodule/xmodule/css/problem/edit.scss +++ b/common/lib/xmodule/xmodule/css/problem/edit.scss @@ -5,7 +5,7 @@ .advanced-toggle { @include white-button; height: auto; - margin-top: -1px; + margin-top: -4px; padding: 3px 9px; font-size: 12px; @@ -16,7 +16,7 @@ color: $darkGrey !important; pointer-events: none; cursor: none; - + &:hover { box-shadow: 0 0 0 0 !important; } @@ -27,7 +27,7 @@ width: 21px; height: 21px; padding: 0; - margin: 0 5px 0 15px; + margin: -1px 5px 0 15px; border-radius: 22px; border: 1px solid #a5aaaf; background: #e5ecf3; @@ -99,6 +99,13 @@ } } +.problem-editor { +// adding padding to simple editor only - adjacent selector is needed since there are no toggles for CodeMirror + .markdown-box+.CodeMirror { + padding: 10px; + } +} + .problem-editor-icon { display: inline-block; width: 26px; diff --git a/common/lib/xmodule/xmodule/css/sequence/display.scss b/common/lib/xmodule/xmodule/css/sequence/display.scss index e006e02773..ed09d5cf0f 100644 --- a/common/lib/xmodule/xmodule/css/sequence/display.scss +++ b/common/lib/xmodule/xmodule/css/sequence/display.scss @@ -170,7 +170,7 @@ nav.sequence-nav { font-family: $sans-serif; line-height: lh(); left: 0px; - opacity: 0; + opacity: 0.0; padding: 6px; position: absolute; top: 48px; @@ -204,7 +204,7 @@ nav.sequence-nav { p { display: block; margin-top: 4px; - opacity: 1; + opacity: 1.0; } } } @@ -248,12 +248,12 @@ nav.sequence-nav { } &:hover { - opacity: .5; + opacity: 0.5; } &.disabled { cursor: normal; - opacity: .4; + opacity: 0.4; } } } @@ -320,12 +320,12 @@ nav.sequence-bottom { outline: 0; &:hover { - opacity: .5; + opacity: 0.5; background-position: center 15px; } &.disabled { - opacity: .4; + opacity: 0.4; } &:focus { diff --git a/common/lib/xmodule/xmodule/css/video/display.scss b/common/lib/xmodule/xmodule/css/video/display.scss index bf575e74a3..f3f76dc0d6 100644 --- a/common/lib/xmodule/xmodule/css/video/display.scss +++ b/common/lib/xmodule/xmodule/css/video/display.scss @@ -41,7 +41,7 @@ div.video { &:hover { ul, div { - opacity: 1; + opacity: 1.0; } } @@ -158,7 +158,7 @@ div.video { ol.video_speeds { display: block; - opacity: 1; + opacity: 1.0; padding: 0; margin: 0; list-style: none; @@ -208,7 +208,7 @@ div.video { } &:hover, &:active, &:focus { - opacity: 1; + opacity: 1.0; background-color: #444; } } @@ -221,7 +221,7 @@ div.video { border: 1px solid #000; bottom: 46px; display: none; - opacity: 0; + opacity: 0.0; position: absolute; width: 133px; z-index: 10; @@ -264,7 +264,7 @@ div.video { &.open { .volume-slider-container { display: block; - opacity: 1; + opacity: 1.0; } } @@ -302,7 +302,7 @@ div.video { border: 1px solid #000; bottom: 46px; display: none; - opacity: 0; + opacity: 0.0; position: absolute; width: 45px; height: 125px; @@ -395,7 +395,7 @@ div.video { font-weight: 800; line-height: 46px; //height of play pause buttons margin-left: 0; - opacity: 1; + opacity: 1.0; padding: 0 lh(.5); position: relative; text-indent: -9999px; @@ -410,7 +410,7 @@ div.video { } &.off { - opacity: .7; + opacity: 0.7; } } } @@ -418,7 +418,7 @@ div.video { &:hover section.video-controls { ul, div { - opacity: 1; + opacity: 1.0; } div.slider { diff --git a/common/lib/xmodule/xmodule/css/videoalpha/display.scss b/common/lib/xmodule/xmodule/css/videoalpha/display.scss index bf575e74a3..f3f76dc0d6 100644 --- a/common/lib/xmodule/xmodule/css/videoalpha/display.scss +++ b/common/lib/xmodule/xmodule/css/videoalpha/display.scss @@ -41,7 +41,7 @@ div.video { &:hover { ul, div { - opacity: 1; + opacity: 1.0; } } @@ -158,7 +158,7 @@ div.video { ol.video_speeds { display: block; - opacity: 1; + opacity: 1.0; padding: 0; margin: 0; list-style: none; @@ -208,7 +208,7 @@ div.video { } &:hover, &:active, &:focus { - opacity: 1; + opacity: 1.0; background-color: #444; } } @@ -221,7 +221,7 @@ div.video { border: 1px solid #000; bottom: 46px; display: none; - opacity: 0; + opacity: 0.0; position: absolute; width: 133px; z-index: 10; @@ -264,7 +264,7 @@ div.video { &.open { .volume-slider-container { display: block; - opacity: 1; + opacity: 1.0; } } @@ -302,7 +302,7 @@ div.video { border: 1px solid #000; bottom: 46px; display: none; - opacity: 0; + opacity: 0.0; position: absolute; width: 45px; height: 125px; @@ -395,7 +395,7 @@ div.video { font-weight: 800; line-height: 46px; //height of play pause buttons margin-left: 0; - opacity: 1; + opacity: 1.0; padding: 0 lh(.5); position: relative; text-indent: -9999px; @@ -410,7 +410,7 @@ div.video { } &.off { - opacity: .7; + opacity: 0.7; } } } @@ -418,7 +418,7 @@ div.video { &:hover section.video-controls { ul, div { - opacity: 1; + opacity: 1.0; } div.slider { diff --git a/common/lib/xmodule/xmodule/discussion_module.py b/common/lib/xmodule/xmodule/discussion_module.py index 98082ddea2..aef4821839 100644 --- a/common/lib/xmodule/xmodule/discussion_module.py +++ b/common/lib/xmodule/xmodule/discussion_module.py @@ -8,8 +8,16 @@ from xblock.core import String, Scope class DiscussionFields(object): discussion_id = String(scope=Scope.settings) - discussion_category = String(scope=Scope.settings) - discussion_target = String(scope=Scope.settings) + discussion_category = String( + display_name="Category", + help="A category name for the discussion. This name appears in the left pane of the discussion forum for the course.", + scope=Scope.settings + ) + discussion_target = String( + display_name="Subcategory", + help="A subcategory name for the discussion. This name appears in the left pane of the discussion forum for the course.", + scope=Scope.settings + ) sort_key = String(scope=Scope.settings) diff --git a/common/lib/xmodule/xmodule/error_module.py b/common/lib/xmodule/xmodule/error_module.py index ebb61b36f2..8014234f69 100644 --- a/common/lib/xmodule/xmodule/error_module.py +++ b/common/lib/xmodule/xmodule/error_module.py @@ -1,3 +1,8 @@ +""" +Modules that get shown to the users when an error has occured while +loading or rendering other modules +""" + import hashlib import logging import json @@ -22,12 +27,19 @@ log = logging.getLogger(__name__) class ErrorFields(object): + """ + XBlock fields used by the ErrorModules + """ contents = String(scope=Scope.content) error_msg = String(scope=Scope.content) display_name = String(scope=Scope.settings) class ErrorModule(ErrorFields, XModule): + """ + Module that gets shown to staff when there has been an error while + loading or rendering other modules + """ def get_html(self): '''Show an error to staff. @@ -42,6 +54,10 @@ class ErrorModule(ErrorFields, XModule): class NonStaffErrorModule(ErrorFields, XModule): + """ + Module that gets shown to students when there has been an error while + loading or rendering other modules + """ def get_html(self): '''Show an error to a student. TODO (vshnayder): proper style, divs, etc. @@ -61,7 +77,7 @@ class ErrorDescriptor(ErrorFields, JSONEditingDescriptor): module_class = ErrorModule @classmethod - def _construct(self, system, contents, error_msg, location): + def _construct(cls, system, contents, error_msg, location): if location.name is None: location = location._replace( @@ -80,7 +96,7 @@ class ErrorDescriptor(ErrorFields, JSONEditingDescriptor): 'contents': contents, 'display_name': 'Error: ' + location.name } - return ErrorDescriptor( + return cls( system, location, model_data, diff --git a/common/lib/xmodule/xmodule/foldit_module.py b/common/lib/xmodule/xmodule/foldit_module.py index d5afc15bc7..62c5ea416e 100644 --- a/common/lib/xmodule/xmodule/foldit_module.py +++ b/common/lib/xmodule/xmodule/foldit_module.py @@ -16,6 +16,8 @@ log = logging.getLogger(__name__) class FolditFields(object): # default to what Spring_7012x uses + required_level_half_credit = Integer(default=3, scope=Scope.settings) + required_sublevel_half_credit = Integer(default=5, scope=Scope.settings) required_level = Integer(default=4, scope=Scope.settings) required_sublevel = Integer(default=5, scope=Scope.settings) due = Date(help="Date that this problem is due by", scope=Scope.settings) @@ -36,6 +38,8 @@ class FolditModule(FolditFields, XModule): """ @@ -57,6 +61,22 @@ class FolditModule(FolditFields, XModule): self.due_time) return complete + def is_half_complete(self): + """ + Did the user reach the required level for half credit? + + Ideally this would be more flexible than just 0, 0.5, or 1 credit. On + the other hand, the xml attributes for specifying more specific + cut-offs and partial grades can get more confusing. + """ + from foldit.models import PuzzleComplete + complete = PuzzleComplete.is_level_complete( + self.system.anonymous_student_id, + self.required_level_half_credit, + self.required_sublevel_half_credit, + self.due_time) + return complete + def completed_puzzles(self): """ Return a list of puzzles that this user has completed, as an array of @@ -139,9 +159,18 @@ class FolditModule(FolditFields, XModule): def get_score(self): """ - 0 / 1 based on whether student has gotten far enough. + 0 if required_level_half_credit - required_sublevel_half_credit not + reached. + 0.5 if required_level_half_credit and required_sublevel_half_credit + reached. + 1 if requred_level and required_sublevel reached. """ - score = 1 if self.is_complete() else 0 + if self.is_complete(): + score = 1 + elif self.is_half_complete(): + score = 0.5 + else: + score = 0 return {'score': score, 'total': self.max_score()} diff --git a/common/lib/xmodule/xmodule/js/fixtures/combinedopenended-with-markdown.html b/common/lib/xmodule/xmodule/js/fixtures/combinedopenended-with-markdown.html new file mode 100644 index 0000000000..b5c74e00f9 --- /dev/null +++ b/common/lib/xmodule/xmodule/js/fixtures/combinedopenended-with-markdown.html @@ -0,0 +1,6 @@ +
    +
    + + +
    +
    diff --git a/common/lib/xmodule/xmodule/js/fixtures/combinedopenended-without-markdown.html b/common/lib/xmodule/xmodule/js/fixtures/combinedopenended-without-markdown.html new file mode 100644 index 0000000000..66d0fec2bc --- /dev/null +++ b/common/lib/xmodule/xmodule/js/fixtures/combinedopenended-without-markdown.html @@ -0,0 +1,5 @@ +
    +
    + +
    +
    diff --git a/common/lib/xmodule/xmodule/js/spec/combinedopenended/edit_spec.coffee b/common/lib/xmodule/xmodule/js/spec/combinedopenended/edit_spec.coffee new file mode 100644 index 0000000000..aa077da450 --- /dev/null +++ b/common/lib/xmodule/xmodule/js/spec/combinedopenended/edit_spec.coffee @@ -0,0 +1,127 @@ +describe 'OpenEndedMarkdownEditingDescriptor', -> + describe 'save stores the correct data', -> + it 'saves markdown from markdown editor', -> + loadFixtures 'combinedopenended-with-markdown.html' + @descriptor = new OpenEndedMarkdownEditingDescriptor($('.combinedopenended-editor')) + saveResult = @descriptor.save() + expect(saveResult.metadata.markdown).toEqual('markdown') + expect(saveResult.data).toEqual('\nmarkdown\n') + it 'clears markdown when xml editor is selected', -> + loadFixtures 'combinedopenended-with-markdown.html' + @descriptor = new OpenEndedMarkdownEditingDescriptor($('.combinedopenended-editor')) + @descriptor.createXMLEditor('replace with markdown') + saveResult = @descriptor.save() + expect(saveResult.metadata.markdown).toEqual(null) + expect(saveResult.data).toEqual('replace with markdown') + it 'saves xml from the xml editor', -> + loadFixtures 'combinedopenended-without-markdown.html' + @descriptor = new OpenEndedMarkdownEditingDescriptor($('.combinedopenended-editor')) + saveResult = @descriptor.save() + expect(saveResult.metadata.markdown).toEqual(null) + expect(saveResult.data).toEqual('xml only') + + describe 'insertPrompt', -> + it 'inserts the template if selection is empty', -> + revisedSelection = OpenEndedMarkdownEditingDescriptor.insertPrompt('') + expect(revisedSelection).toEqual(OpenEndedMarkdownEditingDescriptor.promptTemplate) + it 'recognizes html in the prompt', -> + revisedSelection = OpenEndedMarkdownEditingDescriptor.insertPrompt('[prompt]

    Hello

    [prompt]') + expect(revisedSelection).toEqual('[prompt]

    Hello

    [prompt]') + + describe 'insertRubric', -> + it 'inserts the template if selection is empty', -> + revisedSelection = OpenEndedMarkdownEditingDescriptor.insertRubric('') + expect(revisedSelection).toEqual(OpenEndedMarkdownEditingDescriptor.rubricTemplate) + it 'recognizes a proper rubric', -> + revisedSelection = OpenEndedMarkdownEditingDescriptor.insertRubric('[rubric]\n+1\n-1\n-2\n[rubric]') + expect(revisedSelection).toEqual('[rubric]\n+1\n-1\n-2\n[rubric]') + + describe 'insertTasks', -> + it 'inserts the template if selection is empty', -> + revisedSelection = OpenEndedMarkdownEditingDescriptor.insertTasks('') + expect(revisedSelection).toEqual(OpenEndedMarkdownEditingDescriptor.tasksTemplate) + it 'recognizes a proper task string', -> + revisedSelection = OpenEndedMarkdownEditingDescriptor.insertTasks('[tasks](Self)[tasks]') + expect(revisedSelection).toEqual('[tasks](Self)[tasks]') + + describe 'markdownToXml', -> + # test default templates + it 'converts prompt to xml', -> + data = OpenEndedMarkdownEditingDescriptor.markdownToXml("""[prompt] +

    Prompt!

    + This is my super awesome prompt. + [prompt] + """) + data = data.replace(/[\t\n\s]/gmi,'') + expect(data).toEqual(""" + + +

    Prompt!

    + This is my super awesome prompt. +     +     + """.replace(/[\t\n\s]/gmi,'')) + + it 'converts rubric to xml', -> + data = OpenEndedMarkdownEditingDescriptor.markdownToXml("""[rubric] + + 1 + -1 + -2 + + 2 + -1 + -2 + +3 + -1 + -2 + -3 + [rubric] + """) + data = data.replace(/[\t\n\s]/gmi,'') + expect(data).toEqual(""" + + + + + 1 + + + + + 2 + + + + + 3 + + + + + + + + """.replace(/[\t\n\s]/gmi,'')) + + it 'converts tasks to xml', -> + data = OpenEndedMarkdownEditingDescriptor.markdownToXml("""[tasks] + (Self), ({1-2}AI), ({1-4}AI), ({1-2}Peer + [tasks] + """) + data = data.replace(/[\t\n\s]/gmi,'') + equality_list = """ + + + + + + ml_grading.conf + + + ml_grading.conf + + + peer_grading.conf + + + """ + expect(data).toEqual(equality_list.replace(/[\t\n\s]/gmi,'')) diff --git a/common/lib/xmodule/xmodule/js/src/combinedopenended/display.coffee b/common/lib/xmodule/xmodule/js/src/combinedopenended/display.coffee index d4c2ff00ae..5939fbcdd8 100644 --- a/common/lib/xmodule/xmodule/js/src/combinedopenended/display.coffee +++ b/common/lib/xmodule/xmodule/js/src/combinedopenended/display.coffee @@ -289,6 +289,9 @@ class @CombinedOpenEnded if @child_type == "openended" @submit_button.hide() @queueing() + if @task_number==1 and @task_count==1 + @grader_status = $('.grader-status') + @grader_status.html("

    Response submitted for scoring.

    ") else if @child_state == 'post_assessment' if @child_type=="openended" @skip_button.show() @@ -311,6 +314,8 @@ class @CombinedOpenEnded if @task_number<@task_count @next_problem() else + if @task_number==1 and @task_count==1 + @show_combined_rubric_current() @show_results_current() @reset_button.show() diff --git a/common/lib/xmodule/xmodule/js/src/combinedopenended/edit.coffee b/common/lib/xmodule/xmodule/js/src/combinedopenended/edit.coffee new file mode 100644 index 0000000000..1b7f9bb4fb --- /dev/null +++ b/common/lib/xmodule/xmodule/js/src/combinedopenended/edit.coffee @@ -0,0 +1,282 @@ +class @OpenEndedMarkdownEditingDescriptor extends XModule.Descriptor + # TODO really, these templates should come from or also feed the cheatsheet + @rubricTemplate : """ + [rubric] + + Ideas + - Difficult for the reader to discern the main idea. Too brief or too repetitive to establish or maintain a focus. + - Attempts a main idea. Sometimes loses focus or ineffectively displays focus. + - Presents a unifying theme or main idea, but may include minor tangents. Stays somewhat focused on topic and task. + - Presents a unifying theme or main idea without going off on tangents. Stays completely focused on topic and task. + + Content + - Includes little information with few or no details or unrelated details. Unsuccessful in attempts to explore any facets of the topic. + - Includes little information and few or no details. Explores only one or two facets of the topic. + - Includes sufficient information and supporting details. (Details may not be fully developed; ideas may be listed.) Explores some facets of the topic. + - Includes in-depth information and exceptional supporting details that are fully developed. Explores all facets of the topic. + + Organization + - Ideas organized illogically, transitions weak, and response difficult to follow. + - Attempts to logically organize ideas. Attempts to progress in an order that enhances meaning, and demonstrates use of transitions. + - Ideas organized logically. Progresses in an order that enhances meaning. Includes smooth transitions. + + Style + - Contains limited vocabulary, with many words used incorrectly. Demonstrates problems with sentence patterns. + - Contains basic vocabulary, with words that are predictable and common. Contains mostly simple sentences (although there may be an attempt at more varied sentence patterns). + - Includes vocabulary to make explanations detailed and precise. Includes varied sentence patterns, including complex sentences. + + Voice + - Demonstrates language and tone that may be inappropriate to task and reader. + - Demonstrates an attempt to adjust language and tone to task and reader. + - Demonstrates effective adjustment of language and tone to task and reader. + [rubric] + """ + + @tasksTemplate: "[tasks]\n(Self), ({4-12}AI), ({9-12}Peer)\n[tasks]\n" + @promptTemplate: """ + [prompt]\n +

    Censorship in the Libraries

    + +

    'All of us can think of a book that we hope none of our children or any other children have taken off the shelf. But if I have the right to remove that book from the shelf -- that work I abhor -- then you also have exactly the same right and so does everyone else. And then we have no books left on the shelf for any of us.' --Katherine Paterson, Author +

    + +

    +Write a persuasive essay to a newspaper reflecting your vies on censorship in libraries. Do you believe that certain materials, such as books, music, movies, magazines, etc., should be removed from the shelves if they are found offensive? Support your position with convincing arguments from your own experience, observations, and/or reading. +

    + [prompt]\n + """ + + constructor: (element) -> + @element = element + + if $(".markdown-box", @element).length != 0 + @markdown_editor = CodeMirror.fromTextArea($(".markdown-box", element)[0], { + lineWrapping: true + mode: null + }) + @setCurrentEditor(@markdown_editor) + # Add listeners for toolbar buttons (only present for markdown editor) + @element.on('click', '.xml-tab', @onShowXMLButton) + @element.on('click', '.format-buttons a', @onToolbarButton) + @element.on('click', '.cheatsheet-toggle', @toggleCheatsheet) + # Hide the XML text area + $(@element.find('.xml-box')).hide() + else + @createXMLEditor() + + ### + Creates the XML Editor and sets it as the current editor. If text is passed in, + it will replace the text present in the HTML template. + + text: optional argument to override the text passed in via the HTML template + ### + createXMLEditor: (text) -> + @xml_editor = CodeMirror.fromTextArea($(".xml-box", @element)[0], { + mode: "xml" + lineNumbers: true + lineWrapping: true + }) + if text + @xml_editor.setValue(text) + @setCurrentEditor(@xml_editor) + + ### + User has clicked to show the XML editor. Before XML editor is swapped in, + the user will need to confirm the one-way conversion. + ### + onShowXMLButton: (e) => + e.preventDefault(); + if @confirmConversionToXml() + @createXMLEditor(OpenEndedMarkdownEditingDescriptor.markdownToXml(@markdown_editor.getValue())) + # Need to refresh to get line numbers to display properly (and put cursor position to 0) + @xml_editor.setCursor(0) + @xml_editor.refresh() + # Hide markdown-specific toolbar buttons + $(@element.find('.editor-bar')).hide() + + ### + Have the user confirm the one-way conversion to XML. + Returns true if the user clicked OK, else false. + ### + confirmConversionToXml: -> + # TODO: use something besides a JavaScript confirm dialog? + return confirm("If you use the Advanced Editor, this problem will be converted to XML and you will not be able to return to the Simple Editor Interface.\n\nProceed to the Advanced Editor and convert this problem to XML?") + + ### + Event listener for toolbar buttons (only possible when markdown editor is visible). + ### + onToolbarButton: (e) => + e.preventDefault(); + selection = @markdown_editor.getSelection() + revisedSelection = null + switch $(e.currentTarget).attr('class') + when "rubric-button" then revisedSelection = OpenEndedMarkdownEditingDescriptor.insertRubric(selection) + when "prompt-button" then revisedSelection = OpenEndedMarkdownEditingDescriptor.insertPrompt(selection) + when "tasks-button" then revisedSelection = OpenEndedMarkdownEditingDescriptor.insertTasks(selection) + else # ignore click + + if revisedSelection != null + @markdown_editor.replaceSelection(revisedSelection) + @markdown_editor.focus() + + ### + Event listener for toggling cheatsheet (only possible when markdown editor is visible). + ### + toggleCheatsheet: (e) => + e.preventDefault(); + if !$(@markdown_editor.getWrapperElement()).find('.simple-editor-open-ended-cheatsheet')[0] + @cheatsheet = $($('#simple-editor-open-ended-cheatsheet').html()) + $(@markdown_editor.getWrapperElement()).append(@cheatsheet) + + setTimeout (=> @cheatsheet.toggleClass('shown')), 10 + + ### + Stores the current editor and hides the one that is not displayed. + ### + setCurrentEditor: (editor) -> + if @current_editor + $(@current_editor.getWrapperElement()).hide() + @current_editor = editor + $(@current_editor.getWrapperElement()).show() + $(@current_editor).focus(); + + ### + Called when save is called. Listeners are unregistered because editing the block again will + result in a new instance of the descriptor. Note that this is NOT the case for cancel-- + when cancel is called the instance of the descriptor is reused if edit is selected again. + ### + save: -> + @element.off('click', '.xml-tab', @changeEditor) + @element.off('click', '.format-buttons a', @onToolbarButton) + @element.off('click', '.cheatsheet-toggle', @toggleCheatsheet) + if @current_editor == @markdown_editor + { + data: OpenEndedMarkdownEditingDescriptor.markdownToXml(@markdown_editor.getValue()) + metadata: + markdown: @markdown_editor.getValue() + } + else + { + data: @xml_editor.getValue() + metadata: + markdown: null + } + + @insertRubric: (selectedText) -> + return OpenEndedMarkdownEditingDescriptor.insertGenericInput(selectedText, '[rubric]', '[rubric]', OpenEndedMarkdownEditingDescriptor.rubricTemplate) + + @insertPrompt: (selectedText) -> + return OpenEndedMarkdownEditingDescriptor.insertGenericInput(selectedText, '[prompt]', '[prompt]', OpenEndedMarkdownEditingDescriptor.promptTemplate) + + @insertTasks: (selectedText) -> + return OpenEndedMarkdownEditingDescriptor.insertGenericInput(selectedText, '[tasks]', '[tasks]', OpenEndedMarkdownEditingDescriptor.tasksTemplate) + + @insertGenericInput: (selectedText, lineStart, lineEnd, template) -> + if selectedText.length > 0 + new_string = selectedText.replace(/^\s+|\s+$/g,'') + if new_string.substring(0,lineStart.length) != lineStart + new_string = lineStart + new_string + if new_string.substring((new_string.length)-lineEnd.length,new_string.length) != lineEnd + new_string = new_string + lineEnd + return new_string + else + return template + + @markdownToXml: (markdown)-> + toXml = `function(markdown) { + + function template(template_html,data){ + return template_html.replace(/%(\w*)%/g,function(m,key){return data.hasOwnProperty(key)?data[key]:"";}); + } + + var xml = markdown; + + // group rubrics + xml = xml.replace(/\[rubric\]\n?([^\]]*)\[\/?rubric\]/gmi, function(match, p) { + var groupString = '\n\n'; + var options = p.split('\n'); + var category_open = false; + for(var i = 0; i < options.length; i++) { + if(options[i].length > 0) { + var value = options[i].replace(/^\s+|\s+$/g,''); + if (value.charAt(0)=="+") { + if(i>0){ + if(category_open==true){ + groupString += "\n"; + category_open = false; + } + } + groupString += "\n\n"; + category_open = true; + text = value.substr(1); + text = text.replace(/^\s+|\s+$/g,''); + groupString += text; + groupString += "\n\n"; + } else if (value.charAt(0) == "-") { + groupString += "\n"; + } + } + if(i==options.length-1 && category_open == true){ + groupString += "\n\n"; + } + } + groupString += '\n\n'; + return groupString; + }); + + // group tasks + xml = xml.replace(/\[tasks\]\n?([^\]]*)\[\/?tasks\]/gmi, function(match, p) { + var open_ended_template = $('#open-ended-template').html(); + if(open_ended_template == null) { + open_ended_template = "%grading_config%"; + } + var groupString = ''; + var options = p.split(","); + for(var i = 0; i < options.length; i++) { + if(options[i].length > 0) { + var value = options[i].replace(/^\s+|\s+$/g,''); + var lower_option = value.toLowerCase(); + type = lower_option.match(/(peer|self|ai)/gmi) + if(type != null) { + type = type[0] + var min_max = value.match(/\{\n?([^\]]*)\}/gmi); + var min_max_string = ""; + if(min_max!=null) { + min_max = min_max[0].replace(/^{|}/gmi,''); + min_max = min_max.split("-"); + min = min_max[0]; + max = min_max[1]; + min_max_string = 'min_score_to_attempt="' + min + '" max_score_to_attempt="' + max + '" '; + } + groupString += "\n" + if(type=="self") { + groupString +="" + } else if (type=="peer") { + config = "peer_grading.conf" + groupString += template(open_ended_template,{min_max_string: min_max_string, grading_config: config}); + } else if (type=="ai") { + config = "ml_grading.conf" + groupString += template(open_ended_template,{min_max_string: min_max_string, grading_config: config}); + } + groupString += "\n" + } + } + } + return groupString; + }); + + // replace prompts + xml = xml.replace(/\[prompt\]\n?([^\]]*)\[\/?prompt\]/gmi, function(match, p1) { + var selectString = '\n' + p1 + '\n'; + return selectString; + }); + + // rid white space + xml = xml.replace(/\n\n\n/g, '\n'); + + // surround w/ combinedopenended tag + xml = '\n' + xml + '\n'; + + return xml; + } + ` + return toXml markdown diff --git a/common/lib/xmodule/xmodule/js/src/video/display/video_caption.coffee b/common/lib/xmodule/xmodule/js/src/video/display/video_caption.coffee index e840cd2a77..bf3ec1e102 100644 --- a/common/lib/xmodule/xmodule/js/src/video/display/video_caption.coffee +++ b/common/lib/xmodule/xmodule/js/src/video/display/video_caption.coffee @@ -27,16 +27,19 @@ class @VideoCaption extends Subview @fetchCaption() fetchCaption: -> - $.getWithPrefix @captionURL(), (captions) => - @captions = captions.text - @start = captions.start + $.ajaxWithPrefix + url: @captionURL() + notifyOnError: false + success: (captions) => + @captions = captions.text + @start = captions.start - @loaded = true + @loaded = true - if onTouchBasedDevice() - $('.subtitles li').html "Caption will be displayed when you start playing the video." - else - @renderCaption() + if onTouchBasedDevice() + $('.subtitles li').html "Caption will be displayed when you start playing the video." + else + @renderCaption() renderCaption: -> container = $('
      ') diff --git a/common/lib/xmodule/xmodule/js/src/video/display/video_player.coffee b/common/lib/xmodule/xmodule/js/src/video/display/video_player.coffee index 22308a5568..561ca07c8a 100644 --- a/common/lib/xmodule/xmodule/js/src/video/display/video_player.coffee +++ b/common/lib/xmodule/xmodule/js/src/video/display/video_player.coffee @@ -66,7 +66,7 @@ class @VideoPlayer extends Subview at: 'top center' onReady: (event) => - unless onTouchBasedDevice() + unless onTouchBasedDevice() or $('.video:first').data('autoplay') == 'False' $('.video-load-complete:first').data('video').player.play() onStateChange: (event) => diff --git a/common/lib/xmodule/xmodule/js/src/videoalpha/display/video_caption.coffee b/common/lib/xmodule/xmodule/js/src/videoalpha/display/video_caption.coffee index 9ecdaca474..b0adfbfd81 100644 --- a/common/lib/xmodule/xmodule/js/src/videoalpha/display/video_caption.coffee +++ b/common/lib/xmodule/xmodule/js/src/videoalpha/display/video_caption.coffee @@ -27,16 +27,19 @@ class @VideoCaptionAlpha extends SubviewAlpha @fetchCaption() fetchCaption: -> - $.getWithPrefix @captionURL(), (captions) => - @captions = captions.text - @start = captions.start + $.ajaxWithPrefix + url: @captionURL() + notifyOnError: false + success: (captions) => + @captions = captions.text + @start = captions.start - @loaded = true + @loaded = true - if onTouchBasedDevice() - $('.subtitles li').html "Caption will be displayed when you start playing the video." - else - @renderCaption() + if onTouchBasedDevice() + $('.subtitles li').html "Caption will be displayed when you start playing the video." + else + @renderCaption() renderCaption: -> container = $('
        ') diff --git a/common/lib/xmodule/xmodule/modulestore/__init__.py b/common/lib/xmodule/xmodule/modulestore/__init__.py index ae04e3aac4..33c7b61251 100644 --- a/common/lib/xmodule/xmodule/modulestore/__init__.py +++ b/common/lib/xmodule/xmodule/modulestore/__init__.py @@ -9,7 +9,7 @@ import re from collections import namedtuple from .exceptions import InvalidLocationError, InsufficientSpecificationError -from xmodule.errortracker import ErrorLog, make_error_tracker +from xmodule.errortracker import make_error_tracker from bson.son import SON log = logging.getLogger('mitx.' + 'modulestore') @@ -64,7 +64,6 @@ class Location(_LocationBase): """ return re.sub('_+', '_', invalid.sub('_', value)) - @staticmethod def clean(value): """ @@ -72,7 +71,6 @@ class Location(_LocationBase): """ return Location._clean(value, INVALID_CHARS) - @staticmethod def clean_keeping_underscores(value): """ @@ -82,7 +80,6 @@ class Location(_LocationBase): """ return INVALID_CHARS.sub('_', value) - @staticmethod def clean_for_url_name(value): """ @@ -154,9 +151,7 @@ class Location(_LocationBase): to mean wildcard selection. """ - - if (org is None and course is None and category is None and - name is None and revision is None): + if (org is None and course is None and category is None and name is None and revision is None): location = loc_or_tag else: location = (loc_or_tag, org, course, category, name, revision) @@ -191,7 +186,7 @@ class Location(_LocationBase): match = MISSING_SLASH_URL_RE.match(location) if match is None: log.debug('location is instance of %s but no URL match' % basestring) - raise InvalidLocationError(location) + raise InvalidLocationError(location) groups = match.groupdict() check_dict(groups) return _LocationBase.__new__(_cls, **groups) @@ -233,7 +228,7 @@ class Location(_LocationBase): html id attributes """ s = "-".join(str(v) for v in self.list() - if v is not None) + if v is not None) return Location.clean_for_html(s) def dict(self): @@ -258,6 +253,12 @@ class Location(_LocationBase): at the location URL hierachy""" return "/".join([self.org, self.course, self.name]) + def replace(self, **kwargs): + ''' + Expose a public method for replacing location elements + ''' + return self._replace(**kwargs) + class ModuleStore(object): """ @@ -382,12 +383,6 @@ class ModuleStore(object): ''' raise NotImplementedError - def get_course(self, course_id): - ''' - Look for a specific course id. Returns the course descriptor, or None if not found. - ''' - raise NotImplementedError - def get_parent_locations(self, location, course_id): '''Find all locations that are the parents of this location in this course. Needed for path_to_location(). @@ -406,8 +401,7 @@ class ModuleStore(object): courses = [ course for course in self.get_courses() - if course.location.org == location.org - and course.location.course == location.course + if course.location.org == location.org and course.location.course == location.course ] return courses diff --git a/common/lib/xmodule/xmodule/modulestore/draft.py b/common/lib/xmodule/xmodule/modulestore/draft.py index c3f1b23688..9262c5e9d6 100644 --- a/common/lib/xmodule/xmodule/modulestore/draft.py +++ b/common/lib/xmodule/xmodule/modulestore/draft.py @@ -13,11 +13,12 @@ def as_draft(location): """ return Location(location)._replace(revision=DRAFT) + def as_published(location): """ Returns the Location that is the published version for `location` """ - return Location(location)._replace(revision=None) + return Location(location)._replace(revision=None) def wrap_draft(item): diff --git a/common/lib/xmodule/xmodule/modulestore/mongo.py b/common/lib/xmodule/xmodule/modulestore/mongo.py index 24df17b15b..be01328733 100644 --- a/common/lib/xmodule/xmodule/modulestore/mongo.py +++ b/common/lib/xmodule/xmodule/modulestore/mongo.py @@ -268,7 +268,7 @@ class MongoModuleStore(ModuleStoreBase): query = {'_id.org': location.org, '_id.course': location.course, '_id.category': {'$in': ['course', 'chapter', 'sequential', 'vertical', - 'wrapper', 'problemset', 'conditional']} + 'wrapper', 'problemset', 'conditional', 'randomize']} } # we just want the Location, children, and inheritable metadata record_filter = {'_id': 1, 'definition.children': 1} diff --git a/common/lib/xmodule/xmodule/modulestore/tests/django_utils.py b/common/lib/xmodule/xmodule/modulestore/tests/django_utils.py index 98523e9b15..04e79ce521 100644 --- a/common/lib/xmodule/xmodule/modulestore/tests/django_utils.py +++ b/common/lib/xmodule/xmodule/modulestore/tests/django_utils.py @@ -31,11 +31,11 @@ class ModuleStoreTestCase(TestCase): @staticmethod def load_templates_if_necessary(): ''' - Load templates into the modulestore only if they do not already exist. + Load templates into the direct modulestore only if they do not already exist. We need the templates, because they are copied to create XModules such as sections and problems ''' - modulestore = xmodule.modulestore.django.modulestore() + modulestore = xmodule.modulestore.django.modulestore('direct') # Count the number of templates query = {"_id.course": "templates"} diff --git a/common/lib/xmodule/xmodule/modulestore/tests/factories.py b/common/lib/xmodule/xmodule/modulestore/tests/factories.py index 31237af7b9..8cf148f742 100644 --- a/common/lib/xmodule/xmodule/modulestore/tests/factories.py +++ b/common/lib/xmodule/xmodule/modulestore/tests/factories.py @@ -3,7 +3,6 @@ from time import gmtime from uuid import uuid4 from xmodule.modulestore import Location from xmodule.modulestore.django import modulestore -from xmodule.timeparse import stringify_time from xmodule.modulestore.inheritance import own_metadata diff --git a/common/lib/xmodule/xmodule/modulestore/xml.py b/common/lib/xmodule/xmodule/modulestore/xml.py index 114a3281c6..7128c04a88 100644 --- a/common/lib/xmodule/xmodule/modulestore/xml.py +++ b/common/lib/xmodule/xmodule/modulestore/xml.py @@ -290,7 +290,6 @@ class XMLModuleStore(ModuleStoreBase): if course_dirs is None: course_dirs = sorted([d for d in os.listdir(self.data_dir) if os.path.exists(self.data_dir / d / "course.xml")]) - for course_dir in course_dirs: self.try_load_course(course_dir) diff --git a/common/lib/xmodule/xmodule/open_ended_grading_classes/combined_open_ended_modulev1.py b/common/lib/xmodule/xmodule/open_ended_grading_classes/combined_open_ended_modulev1.py index 1404f52300..e289ba72f1 100644 --- a/common/lib/xmodule/xmodule/open_ended_grading_classes/combined_open_ended_modulev1.py +++ b/common/lib/xmodule/xmodule/open_ended_grading_classes/combined_open_ended_modulev1.py @@ -847,8 +847,8 @@ class CombinedOpenEndedV1Descriptor(): if len(xml_object.xpath(child)) == 0: #This is a staff_facing_error raise ValueError( - "Combined Open Ended definition must include at least one '{0}' tag. Contact the learning sciences group for assistance.".format( - child)) + "Combined Open Ended definition must include at least one '{0}' tag. Contact the learning sciences group for assistance. {1}".format( + child, xml_object)) def parse_task(k): """Assumes that xml_object has child k""" diff --git a/common/lib/xmodule/xmodule/open_ended_grading_classes/controller_query_service.py b/common/lib/xmodule/xmodule/open_ended_grading_classes/controller_query_service.py index 08f2a95387..3668cd6cc9 100644 --- a/common/lib/xmodule/xmodule/open_ended_grading_classes/controller_query_service.py +++ b/common/lib/xmodule/xmodule/open_ended_grading_classes/controller_query_service.py @@ -6,7 +6,7 @@ log = logging.getLogger(__name__) class ControllerQueryService(GradingService): """ - Interface to staff grading backend. + Interface to controller query backend. """ def __init__(self, config, system): @@ -77,6 +77,50 @@ class ControllerQueryService(GradingService): return response +class MockControllerQueryService(object): + """ + Mock controller query service for testing + """ + + def __init__(self, config, system): + pass + + def check_if_name_is_unique(self, *args, **kwargs): + """ + Mock later if needed. Stub function for now. + @param params: + @return: + """ + pass + + def check_for_eta(self, *args, **kwargs): + """ + Mock later if needed. Stub function for now. + @param params: + @return: + """ + pass + + def check_combined_notifications(self, *args, **kwargs): + combined_notifications = '{"flagged_submissions_exist": false, "version": 1, "new_student_grading_to_view": false, "success": true, "staff_needs_to_grade": false, "student_needs_to_peer_grade": true, "overall_need_to_check": true}' + return combined_notifications + + def get_grading_status_list(self, *args, **kwargs): + grading_status_list = '{"version": 1, "problem_list": [{"problem_name": "Science Question -- Machine Assessed", "grader_type": "NA", "eta_available": true, "state": "Waiting to be Graded", "eta": 259200, "location": "i4x://MITx/oe101x/combinedopenended/Science_SA_ML"}, {"problem_name": "Humanities Question -- Peer Assessed", "grader_type": "NA", "eta_available": true, "state": "Waiting to be Graded", "eta": 259200, "location": "i4x://MITx/oe101x/combinedopenended/Humanities_SA_Peer"}], "success": true}' + return grading_status_list + + def get_flagged_problem_list(self, *args, **kwargs): + flagged_problem_list = '{"version": 1, "success": false, "error": "No flagged submissions exist for course: MITx/oe101x/2012_Fall"}' + return flagged_problem_list + + def take_action_on_flags(self, *args, **kwargs): + """ + Mock later if needed. Stub function for now. + @param params: + @return: + """ + pass + def convert_seconds_to_human_readable(seconds): if seconds < 60: human_string = "{0} seconds".format(seconds) diff --git a/common/lib/xmodule/xmodule/open_ended_grading_classes/grading_service_module.py b/common/lib/xmodule/xmodule/open_ended_grading_classes/grading_service_module.py index b16f0618bb..3e3f943cd7 100644 --- a/common/lib/xmodule/xmodule/open_ended_grading_classes/grading_service_module.py +++ b/common/lib/xmodule/xmodule/open_ended_grading_classes/grading_service_module.py @@ -53,8 +53,9 @@ class GradingService(object): except (RequestException, ConnectionError, HTTPError) as err: # reraise as promised GradingServiceError, but preserve stacktrace. #This is a dev_facing_error - log.error("Problem posting data to the grading controller. URL: {0}, data: {1}".format(url, data)) - raise GradingServiceError, str(err), sys.exc_info()[2] + error_string = "Problem posting data to the grading controller. URL: {0}, data: {1}".format(url, data) + log.error(error_string) + raise GradingServiceError(error_string) return r.text @@ -71,8 +72,9 @@ class GradingService(object): except (RequestException, ConnectionError, HTTPError) as err: # reraise as promised GradingServiceError, but preserve stacktrace. #This is a dev_facing_error - log.error("Problem getting data from the grading controller. URL: {0}, params: {1}".format(url, params)) - raise GradingServiceError, str(err), sys.exc_info()[2] + error_string = "Problem getting data from the grading controller. URL: {0}, params: {1}".format(url, params) + log.error(error_string) + raise GradingServiceError(error_string) return r.text diff --git a/common/lib/xmodule/xmodule/open_ended_grading_classes/open_ended_module.py b/common/lib/xmodule/xmodule/open_ended_grading_classes/open_ended_module.py index 7ba046b2ad..4f772fe0a1 100644 --- a/common/lib/xmodule/xmodule/open_ended_grading_classes/open_ended_module.py +++ b/common/lib/xmodule/xmodule/open_ended_grading_classes/open_ended_module.py @@ -168,7 +168,10 @@ class OpenEndedModule(openendedchild.OpenEndedChild): #This is a student_facing_error return {'success': False, 'msg': "There was an error saving your feedback. Please contact course staff."} - qinterface = system.xqueue['interface'] + xqueue = system.get('xqueue') + if xqueue is None: + return {'success': False, 'msg': "Couldn't submit feedback."} + qinterface = xqueue['interface'] qtime = datetime.strftime(datetime.now(), xqueue_interface.dateformat) anonymous_student_id = system.anonymous_student_id queuekey = xqueue_interface.make_hashkey(str(system.seed) + qtime + @@ -176,7 +179,7 @@ class OpenEndedModule(openendedchild.OpenEndedChild): str(len(self.child_history))) xheader = xqueue_interface.make_xheader( - lms_callback_url=system.xqueue['construct_callback'](), + lms_callback_url=xqueue['construct_callback'](), lms_key=queuekey, queue_name=self.message_queue_name ) @@ -219,7 +222,10 @@ class OpenEndedModule(openendedchild.OpenEndedChild): # Prepare xqueue request #------------------------------------------------------------ - qinterface = system.xqueue['interface'] + xqueue = system.get('xqueue') + if xqueue is None: + return False + qinterface = xqueue['interface'] qtime = datetime.strftime(datetime.now(), xqueue_interface.dateformat) anonymous_student_id = system.anonymous_student_id @@ -230,7 +236,7 @@ class OpenEndedModule(openendedchild.OpenEndedChild): str(len(self.child_history))) xheader = xqueue_interface.make_xheader( - lms_callback_url=system.xqueue['construct_callback'](), + lms_callback_url=xqueue['construct_callback'](), lms_key=queuekey, queue_name=self.queue_name ) diff --git a/common/lib/xmodule/xmodule/peer_grading_module.py b/common/lib/xmodule/xmodule/peer_grading_module.py index eebfbe22e5..ccc3e31f51 100644 --- a/common/lib/xmodule/xmodule/peer_grading_module.py +++ b/common/lib/xmodule/xmodule/peer_grading_module.py @@ -10,7 +10,7 @@ from .x_module import XModule from xmodule.raw_module import RawDescriptor from xmodule.modulestore.django import modulestore from .timeinfo import TimeInfo -from xblock.core import Object, Integer, Boolean, String, Scope +from xblock.core import Object, String, Scope from xmodule.fields import Date, StringyFloat, StringyInteger, StringyBoolean from xmodule.open_ended_grading_classes.peer_grading_service import PeerGradingService, GradingServiceError, MockPeerGradingService @@ -22,24 +22,43 @@ USE_FOR_SINGLE_LOCATION = False LINK_TO_LOCATION = "" TRUE_DICT = [True, "True", "true", "TRUE"] MAX_SCORE = 1 -IS_GRADED = True +IS_GRADED = False EXTERNAL_GRADER_NO_CONTACT_ERROR = "Failed to contact external graders. Please notify course staff." class PeerGradingFields(object): - use_for_single_location = StringyBoolean(help="Whether to use this for a single location or as a panel.", - default=USE_FOR_SINGLE_LOCATION, scope=Scope.settings) - link_to_location = String(help="The location this problem is linked to.", default=LINK_TO_LOCATION, - scope=Scope.settings) - is_graded = StringyBoolean(help="Whether or not this module is scored.", default=IS_GRADED, scope=Scope.settings) + use_for_single_location = StringyBoolean( + display_name="Show Single Problem", + help='When True, only the single problem specified by "Link to Problem Location" is shown. ' + 'When False, a panel is displayed with all problems available for peer grading.', + default=USE_FOR_SINGLE_LOCATION, scope=Scope.settings + ) + link_to_location = String( + display_name="Link to Problem Location", + help='The location of the problem being graded. Only used when "Show Single Problem" is True.', + default=LINK_TO_LOCATION, scope=Scope.settings + ) + is_graded = StringyBoolean( + display_name="Graded", + help='Defines whether the student gets credit for grading this problem. Only used when "Show Single Problem" is True.', + default=IS_GRADED, scope=Scope.settings + ) due_date = Date(help="Due date that should be displayed.", default=None, scope=Scope.settings) grace_period_string = String(help="Amount of grace to give on the due date.", default=None, scope=Scope.settings) - max_grade = StringyInteger(help="The maximum grade that a student can receieve for this problem.", default=MAX_SCORE, - scope=Scope.settings) - student_data_for_location = Object(help="Student data for a given peer grading problem.", - scope=Scope.user_state) - weight = StringyFloat(help="How much to weight this problem by", scope=Scope.settings) + max_grade = StringyInteger( + help="The maximum grade that a student can receive for this problem.", default=MAX_SCORE, + scope=Scope.settings, values={"min": 0} + ) + student_data_for_location = Object( + help="Student data for a given peer grading problem.", + scope=Scope.user_state + ) + weight = StringyFloat( + display_name="Problem Weight", + help="Defines the number of points each problem is worth. If the value is not set, each problem is worth one point.", + scope=Scope.settings, values={"min": 0, "step": ".1"} + ) class PeerGradingModule(PeerGradingFields, XModule): @@ -587,3 +606,14 @@ class PeerGradingDescriptor(PeerGradingFields, RawDescriptor): has_score = True always_recalculate_grades = True template_dir_name = "peer_grading" + + #Specify whether or not to pass in open ended interface + needs_open_ended_interface = True + + @property + def non_editable_metadata_fields(self): + non_editable_fields = super(PeerGradingDescriptor, self).non_editable_metadata_fields + non_editable_fields.extend([PeerGradingFields.due_date, PeerGradingFields.grace_period_string, + PeerGradingFields.max_grade]) + return non_editable_fields + diff --git a/common/lib/xmodule/xmodule/randomize_module.py b/common/lib/xmodule/xmodule/randomize_module.py index 240f33e33e..434706530b 100644 --- a/common/lib/xmodule/xmodule/randomize_module.py +++ b/common/lib/xmodule/xmodule/randomize_module.py @@ -4,6 +4,8 @@ import random from xmodule.x_module import XModule from xmodule.seq_module import SequenceDescriptor +from lxml import etree + from xblock.core import Scope, Integer log = logging.getLogger('mitx.' + __name__) diff --git a/common/lib/xmodule/xmodule/templates.py b/common/lib/xmodule/xmodule/templates.py index f4e37ab0d5..6479b3df24 100644 --- a/common/lib/xmodule/xmodule/templates.py +++ b/common/lib/xmodule/xmodule/templates.py @@ -4,8 +4,18 @@ These templates are used by the CMS to provide baseline content that can be cloned when adding new modules to a course. `Template`s are defined in x_module. They contain 3 attributes: - metadata: A dictionary with the template metadata - data: A JSON value that defines the template content + metadata: A dictionary with the template metadata. This should contain + any values for fields + * with scope Scope.settings + * that have values different than the field defaults + * and that are to be editable in Studio + data: A JSON value that defines the template content. This should be a dictionary + containing values for fields + * with scope Scope.content + * that have values different than the field defaults + * and that are to be editable in Studio + or, if the module uses a single Scope.content String field named `data`, this + should be a string containing the contents of that field children: A list of Location urls that define the template children Templates are defined on XModuleDescriptor types, in the template attribute. diff --git a/common/lib/xmodule/xmodule/templates/combinedopenended/default.yaml b/common/lib/xmodule/xmodule/templates/combinedopenended/default.yaml index a11367b46f..f7d639ebfb 100644 --- a/common/lib/xmodule/xmodule/templates/combinedopenended/default.yaml +++ b/common/lib/xmodule/xmodule/templates/combinedopenended/default.yaml @@ -1,12 +1,7 @@ --- metadata: display_name: Open Ended Response - attempts: 1 - is_graded: False - version: 1 - skip_spelling_checks: False - accept_file_upload: False - weight: "" + markdown: "" data: | @@ -39,5 +34,4 @@ data: | - children: [] diff --git a/common/lib/xmodule/xmodule/templates/html/empty.yaml b/common/lib/xmodule/xmodule/templates/html/empty.yaml index b6d867d7d6..40b005af28 100644 --- a/common/lib/xmodule/xmodule/templates/html/empty.yaml +++ b/common/lib/xmodule/xmodule/templates/html/empty.yaml @@ -1,7 +1,6 @@ --- metadata: display_name: Blank HTML Page - empty: True data: | diff --git a/common/lib/xmodule/xmodule/templates/peer_grading/default.yaml b/common/lib/xmodule/xmodule/templates/peer_grading/default.yaml index 23d41d616f..5d88a18ad8 100644 --- a/common/lib/xmodule/xmodule/templates/peer_grading/default.yaml +++ b/common/lib/xmodule/xmodule/templates/peer_grading/default.yaml @@ -1,11 +1,7 @@ --- metadata: display_name: Peer Grading Interface - use_for_single_location: False - link_to_location: None - is_graded: False max_grade: 1 - weight: "" data: | diff --git a/common/lib/xmodule/xmodule/templates/problem/circuitschematic.yaml b/common/lib/xmodule/xmodule/templates/problem/circuitschematic.yaml index a94b824cfb..56f802a6a3 100644 --- a/common/lib/xmodule/xmodule/templates/problem/circuitschematic.yaml +++ b/common/lib/xmodule/xmodule/templates/problem/circuitschematic.yaml @@ -3,9 +3,7 @@ metadata: display_name: Circuit Schematic Builder rerandomize: never - showanswer: always - weight: "" - attempts: "" + showanswer: finished data: | Please make a voltage divider that splits the provided voltage evenly. diff --git a/common/lib/xmodule/xmodule/templates/problem/customgrader.yaml b/common/lib/xmodule/xmodule/templates/problem/customgrader.yaml index aadbe4075a..b5b0d71f4d 100644 --- a/common/lib/xmodule/xmodule/templates/problem/customgrader.yaml +++ b/common/lib/xmodule/xmodule/templates/problem/customgrader.yaml @@ -2,9 +2,7 @@ metadata: display_name: Custom Python-Evaluated Input rerandomize: never - showanswer: always - weight: "" - attempts: "" + showanswer: finished data: |

        diff --git a/common/lib/xmodule/xmodule/templates/problem/empty.yaml b/common/lib/xmodule/xmodule/templates/problem/empty.yaml index 39c9e7671c..97a2aef423 100644 --- a/common/lib/xmodule/xmodule/templates/problem/empty.yaml +++ b/common/lib/xmodule/xmodule/templates/problem/empty.yaml @@ -2,11 +2,8 @@ metadata: display_name: Blank Common Problem rerandomize: never - showanswer: always + showanswer: finished markdown: "" - weight: "" - empty: True - attempts: "" data: | diff --git a/common/lib/xmodule/xmodule/templates/problem/emptyadvanced.yaml b/common/lib/xmodule/xmodule/templates/problem/emptyadvanced.yaml index bba7b3a8ac..3d696ec2fd 100644 --- a/common/lib/xmodule/xmodule/templates/problem/emptyadvanced.yaml +++ b/common/lib/xmodule/xmodule/templates/problem/emptyadvanced.yaml @@ -2,10 +2,7 @@ metadata: display_name: Blank Advanced Problem rerandomize: never - showanswer: always - weight: "" - attempts: "" - empty: True + showanswer: finished data: | diff --git a/common/lib/xmodule/xmodule/templates/problem/forumularesponse.yaml b/common/lib/xmodule/xmodule/templates/problem/forumularesponse.yaml index b4c53a107b..0401a01c31 100644 --- a/common/lib/xmodule/xmodule/templates/problem/forumularesponse.yaml +++ b/common/lib/xmodule/xmodule/templates/problem/forumularesponse.yaml @@ -2,9 +2,7 @@ metadata: display_name: Math Expression Input rerandomize: never - showanswer: always - weight: "" - attempts: "" + showanswer: finished data: |

        diff --git a/common/lib/xmodule/xmodule/templates/problem/imageresponse.yaml b/common/lib/xmodule/xmodule/templates/problem/imageresponse.yaml index 3ef619d54b..ab1f22e3b2 100644 --- a/common/lib/xmodule/xmodule/templates/problem/imageresponse.yaml +++ b/common/lib/xmodule/xmodule/templates/problem/imageresponse.yaml @@ -2,9 +2,7 @@ metadata: display_name: Image Mapped Input rerandomize: never - showanswer: always - weight: "" - attempts: "" + showanswer: finished data: |

        diff --git a/common/lib/xmodule/xmodule/templates/problem/multiplechoice.yaml b/common/lib/xmodule/xmodule/templates/problem/multiplechoice.yaml index 3a35a35199..10d51de280 100644 --- a/common/lib/xmodule/xmodule/templates/problem/multiplechoice.yaml +++ b/common/lib/xmodule/xmodule/templates/problem/multiplechoice.yaml @@ -2,9 +2,7 @@ metadata: display_name: Multiple Choice rerandomize: never - showanswer: always - weight: "" - attempts: "" + showanswer: finished markdown: "A multiple choice problem presents radio buttons for student input. Students can only select a single option presented. Multiple Choice questions have been the subject of many areas of research due to the early diff --git a/common/lib/xmodule/xmodule/templates/problem/numericalresponse.yaml b/common/lib/xmodule/xmodule/templates/problem/numericalresponse.yaml index 1dc46f5f51..548fd94fab 100644 --- a/common/lib/xmodule/xmodule/templates/problem/numericalresponse.yaml +++ b/common/lib/xmodule/xmodule/templates/problem/numericalresponse.yaml @@ -2,9 +2,7 @@ metadata: display_name: Numerical Input rerandomize: never - showanswer: always - weight: "" - attempts: "" + showanswer: finished markdown: "A numerical input problem accepts a line of text input from the student, and evaluates the input for correctness based on its diff --git a/common/lib/xmodule/xmodule/templates/problem/optionresponse.yaml b/common/lib/xmodule/xmodule/templates/problem/optionresponse.yaml index f523c7fdc5..c2edfb1cbc 100644 --- a/common/lib/xmodule/xmodule/templates/problem/optionresponse.yaml +++ b/common/lib/xmodule/xmodule/templates/problem/optionresponse.yaml @@ -2,9 +2,7 @@ metadata: display_name: Dropdown rerandomize: never - showanswer: always - weight: "" - attempts: "" + showanswer: finished markdown: "Dropdown problems give a limited set of options for students to respond with, and present those options in a format that encourages them to search for a specific answer rather than being immediately presented diff --git a/common/lib/xmodule/xmodule/templates/problem/string_response.yaml b/common/lib/xmodule/xmodule/templates/problem/string_response.yaml index c018d3f6cf..64e3dc062f 100644 --- a/common/lib/xmodule/xmodule/templates/problem/string_response.yaml +++ b/common/lib/xmodule/xmodule/templates/problem/string_response.yaml @@ -2,9 +2,7 @@ metadata: display_name: Text Input rerandomize: never - showanswer: always - weight: "" - attempts: "" + showanswer: finished # Note, the extra newlines are needed to make the yaml parser add blank lines instead of folding markdown: "A text input problem accepts a line of text from the diff --git a/common/lib/xmodule/xmodule/templates/videoalpha/default.yaml b/common/lib/xmodule/xmodule/templates/videoalpha/default.yaml index 69ed22cc1e..dba8bbd0b4 100644 --- a/common/lib/xmodule/xmodule/templates/videoalpha/default.yaml +++ b/common/lib/xmodule/xmodule/templates/videoalpha/default.yaml @@ -1,7 +1,11 @@ --- metadata: - display_name: default - data_dir: a_made_up_name + display_name: Video Alpha 1 + version: 1 data: | - + + + + + children: [] diff --git a/common/lib/xmodule/xmodule/templates/word_cloud/default.yaml b/common/lib/xmodule/xmodule/templates/word_cloud/default.yaml index 7f1c838ca9..53e9eeaae4 100644 --- a/common/lib/xmodule/xmodule/templates/word_cloud/default.yaml +++ b/common/lib/xmodule/xmodule/templates/word_cloud/default.yaml @@ -1,9 +1,5 @@ --- metadata: display_name: Word cloud - version: 1 - num_inputs: 5 - num_top_words: 250 - display_student_percents: True data: {} children: [] diff --git a/common/lib/xmodule/xmodule/tests/__init__.py b/common/lib/xmodule/xmodule/tests/__init__.py index 0a2f22aa68..6af11a3ac8 100644 --- a/common/lib/xmodule/xmodule/tests/__init__.py +++ b/common/lib/xmodule/xmodule/tests/__init__.py @@ -14,7 +14,7 @@ import fs.osfs import numpy -import capa.calc as calc +import calc import xmodule from xmodule.x_module import ModuleSystem from mock import Mock @@ -33,15 +33,14 @@ def test_system(): """ Construct a test ModuleSystem instance. - By default, the render_template() method simply returns - the context it is passed as a string. - You can override this behavior by monkey patching: + By default, the render_template() method simply returns the context it is + passed as a string. You can override this behavior by monkey patching:: - system = test_system() - system.render_template = my_render_func + system = test_system() + system.render_template = my_render_func + + where `my_render_func` is a function of the form my_render_func(template, context). - where my_render_func is a function of the form - my_render_func(template, context) """ return ModuleSystem( ajax_url='courses/course_id/modx/a_location', @@ -86,10 +85,12 @@ class ModelsTest(unittest.TestCase): self.assertTrue(abs(calc.evaluator(variables, functions, "e^(j*pi)") + 1) < 0.00001) self.assertTrue(abs(calc.evaluator(variables, functions, "j||1") - 0.5 - 0.5j) < 0.00001) variables['t'] = 1.0 + # Use self.assertAlmostEqual here... self.assertTrue(abs(calc.evaluator(variables, functions, "t") - 1.0) < 0.00001) self.assertTrue(abs(calc.evaluator(variables, functions, "T") - 1.0) < 0.00001) self.assertTrue(abs(calc.evaluator(variables, functions, "t", cs=True) - 1.0) < 0.00001) self.assertTrue(abs(calc.evaluator(variables, functions, "T", cs=True) - 298) < 0.2) + # Use self.assertRaises here... exception_happened = False try: calc.evaluator({}, {}, "5+7 QWSEKO") diff --git a/common/lib/xmodule/xmodule/tests/test_capa_module.py b/common/lib/xmodule/xmodule/tests/test_capa_module.py index f948f5bdfe..61de21b129 100644 --- a/common/lib/xmodule/xmodule/tests/test_capa_module.py +++ b/common/lib/xmodule/xmodule/tests/test_capa_module.py @@ -550,6 +550,7 @@ class CapaModuleTest(unittest.TestCase): def test_reset_problem(self): module = CapaFactory.create(done=True) module.new_lcp = Mock(wraps=module.new_lcp) + module.choose_new_seed = Mock(wraps=module.choose_new_seed) # Stub out HTML rendering with patch('xmodule.capa_module.CapaModule.get_problem_html') as mock_html: @@ -567,7 +568,8 @@ class CapaModuleTest(unittest.TestCase): self.assertEqual(result['html'], "

        Test HTML
        ") # Expect that the problem was reset - module.new_lcp.assert_called_once_with({'seed': None}) + module.new_lcp.assert_called_once_with(None) + module.choose_new_seed.assert_called_once_with() def test_reset_problem_closed(self): module = CapaFactory.create() @@ -1033,3 +1035,13 @@ class CapaModuleTest(unittest.TestCase): self.assertTrue(module.seed is not None) msg = 'Could not get a new seed from reset after 5 tries' self.assertTrue(success, msg) + + def test_random_seed_bins(self): + # Assert that we are limiting the number of possible seeds. + + # Check the conditions that generate random seeds + for rerandomize in ['always', 'per_student', 'true', 'onreset']: + # Get a bunch of seeds, they should all be in 0-999. + for i in range(200): + module = CapaFactory.create(rerandomize=rerandomize) + assert 0 <= module.seed < 1000 diff --git a/common/lib/xmodule/xmodule/tests/test_combined_open_ended.py b/common/lib/xmodule/xmodule/tests/test_combined_open_ended.py index 917e90e575..409347882f 100644 --- a/common/lib/xmodule/xmodule/tests/test_combined_open_ended.py +++ b/common/lib/xmodule/xmodule/tests/test_combined_open_ended.py @@ -407,7 +407,7 @@ class CombinedOpenEndedModuleTest(unittest.TestCase): self.assertTrue(changed) def test_get_max_score(self): - changed = self.combinedoe.update_task_states() + self.combinedoe.update_task_states() self.combinedoe.state = "done" self.combinedoe.is_scored = True max_score = self.combinedoe.max_score() @@ -611,11 +611,11 @@ class OpenEndedModuleXmlTest(unittest.TestCase, DummyModulestore): self.assertEqual(module.current_task_number, 1) #Get html and other data client will request - html = module.get_html() + module.get_html() legend = module.handle_ajax("get_legend", {}) self.assertTrue(isinstance(legend, basestring)) - status = module.handle_ajax("get_status", {}) + module.handle_ajax("get_status", {}) module.handle_ajax("skip_post_assessment", {}) self.assertTrue(isinstance(legend, basestring)) diff --git a/common/lib/xmodule/xmodule/tests/test_error_module.py b/common/lib/xmodule/xmodule/tests/test_error_module.py new file mode 100644 index 0000000000..d6b6f77ae6 --- /dev/null +++ b/common/lib/xmodule/xmodule/tests/test_error_module.py @@ -0,0 +1,51 @@ +""" +Tests for ErrorModule and NonStaffErrorModule +""" +import unittest +from xmodule.tests import test_system +import xmodule.error_module as error_module + + +class TestErrorModule(unittest.TestCase): + """ + Tests for ErrorModule and ErrorDescriptor + """ + def setUp(self): + self.system = test_system() + self.org = "org" + self.course = "course" + self.fake_xml = "" + self.broken_xml = "" + self.error_msg = "Error" + + def test_error_module_create(self): + descriptor = error_module.ErrorDescriptor.from_xml( + self.fake_xml, self.system, self.org, self.course) + self.assertTrue(isinstance(descriptor, error_module.ErrorDescriptor)) + + def test_error_module_rendering(self): + descriptor = error_module.ErrorDescriptor.from_xml( + self.fake_xml, self.system, self.org, self.course, self.error_msg) + module = descriptor.xmodule(self.system) + rendered_html = module.get_html() + self.assertIn(self.error_msg, rendered_html) + self.assertIn(self.fake_xml, rendered_html) + + +class TestNonStaffErrorModule(TestErrorModule): + """ + Tests for NonStaffErrorModule and NonStaffErrorDescriptor + """ + + def test_non_staff_error_module_create(self): + descriptor = error_module.NonStaffErrorDescriptor.from_xml( + self.fake_xml, self.system, self.org, self.course) + self.assertTrue(isinstance(descriptor, error_module.NonStaffErrorDescriptor)) + + def test_non_staff_error_module_rendering(self): + descriptor = error_module.NonStaffErrorDescriptor.from_xml( + self.fake_xml, self.system, self.org, self.course) + module = descriptor.xmodule(self.system) + rendered_html = module.get_html() + self.assertNotIn(self.error_msg, rendered_html) + self.assertNotIn(self.fake_xml, rendered_html) diff --git a/common/lib/xmodule/xmodule/tests/test_import.py b/common/lib/xmodule/xmodule/tests/test_import.py index 5fe57892be..a75dfc8d20 100644 --- a/common/lib/xmodule/xmodule/tests/test_import.py +++ b/common/lib/xmodule/xmodule/tests/test_import.py @@ -460,8 +460,8 @@ class ImportTestCase(BaseCourseTestCase): ) module = modulestore.get_instance(course.id, location) self.assertEqual(len(module.get_children()), 0) - self.assertEqual(module.num_inputs, '5') - self.assertEqual(module.num_top_words, '250') + self.assertEqual(module.num_inputs, 5) + self.assertEqual(module.num_top_words, 250) def test_cohort_config(self): """ diff --git a/common/lib/xmodule/xmodule/tests/test_logic.py b/common/lib/xmodule/xmodule/tests/test_logic.py index 6cd46a26ee..e60af63921 100644 --- a/common/lib/xmodule/xmodule/tests/test_logic.py +++ b/common/lib/xmodule/xmodule/tests/test_logic.py @@ -4,10 +4,12 @@ import json import unittest +from lxml import etree + from xmodule.poll_module import PollDescriptor from xmodule.conditional_module import ConditionalDescriptor from xmodule.word_cloud_module import WordCloudDescriptor - +from xmodule.videoalpha_module import VideoAlphaDescriptor class PostData: """Class which emulate postdata.""" @@ -117,3 +119,33 @@ class WordCloudModuleTest(LogicTest): ) self.assertEqual(100.0, sum(i['percent'] for i in response['top_words']) ) + + +class VideoAlphaModuleTest(LogicTest): + descriptor_class = VideoAlphaDescriptor + + raw_model_data = { + 'data': '' + } + + def test_get_timeframe_no_parameters(self): + xmltree = etree.fromstring('test') + output = self.xmodule._get_timeframe(xmltree) + self.assertEqual(output, ('', '')) + + def test_get_timeframe_with_one_parameter(self): + xmltree = etree.fromstring( + 'test' + ) + output = self.xmodule._get_timeframe(xmltree) + self.assertEqual(output, (247, '')) + + def test_get_timeframe_with_two_parameters(self): + xmltree = etree.fromstring( + '''test''' + ) + output = self.xmodule._get_timeframe(xmltree) + self.assertEqual(output, (247, 47079)) diff --git a/common/lib/xmodule/xmodule/tests/test_progress.py b/common/lib/xmodule/xmodule/tests/test_progress.py index 0114ba4ad3..4bb663ad85 100644 --- a/common/lib/xmodule/xmodule/tests/test_progress.py +++ b/common/lib/xmodule/xmodule/tests/test_progress.py @@ -134,6 +134,6 @@ class ModuleProgressTest(unittest.TestCase): ''' def test_xmodule_default(self): '''Make sure default get_progress exists, returns None''' - xm = x_module.XModule(test_system, 'a://b/c/d/e', None, {}) + xm = x_module.XModule(test_system(), 'a://b/c/d/e', None, {}) p = xm.get_progress() self.assertEqual(p, None) diff --git a/common/lib/xmodule/xmodule/tests/test_randomize_module.py b/common/lib/xmodule/xmodule/tests/test_randomize_module.py index 59cf5a59f3..81935c4013 100644 --- a/common/lib/xmodule/xmodule/tests/test_randomize_module.py +++ b/common/lib/xmodule/xmodule/tests/test_randomize_module.py @@ -14,7 +14,6 @@ START = '2013-01-01T01:00:00' from .test_course_module import DummySystem as DummyImportSystem -from . import test_system class RandomizeModuleTestCase(unittest.TestCase): diff --git a/common/lib/xmodule/xmodule/tests/test_xml_module.py b/common/lib/xmodule/xmodule/tests/test_xml_module.py index e41bcdd73a..dd59ca2b48 100644 --- a/common/lib/xmodule/xmodule/tests/test_xml_module.py +++ b/common/lib/xmodule/xmodule/tests/test_xml_module.py @@ -1,69 +1,141 @@ +# disable missing docstring +#pylint: disable=C0111 + from xmodule.x_module import XModuleFields -from xblock.core import Scope, String, Object -from xmodule.fields import Date, StringyInteger +from xblock.core import Scope, String, Object, Boolean +from xmodule.fields import Date, StringyInteger, StringyFloat from xmodule.xml_module import XmlDescriptor import unittest -from . import test_system +from .import test_system from mock import Mock +class CrazyJsonString(String): + def to_json(self, value): + return value + " JSON" + + class TestFields(object): # Will be returned by editable_metadata_fields. - max_attempts = StringyInteger(scope=Scope.settings, default=1000) + max_attempts = StringyInteger(scope=Scope.settings, default=1000, values={'min': 1, 'max': 10}) # Will not be returned by editable_metadata_fields because filtered out by non_editable_metadata_fields. due = Date(scope=Scope.settings) # Will not be returned by editable_metadata_fields because is not Scope.settings. student_answers = Object(scope=Scope.user_state) # Will be returned, and can override the inherited value from XModule. - display_name = String(scope=Scope.settings, default='local default') + display_name = String(scope=Scope.settings, default='local default', display_name='Local Display Name', + help='local help') + # Used for testing select type, effect of to_json method + string_select = CrazyJsonString( + scope=Scope.settings, + default='default value', + values=[{'display_name': 'first', 'value': 'value a'}, + {'display_name': 'second', 'value': 'value b'}] + ) + # Used for testing select type + float_select = StringyFloat(scope=Scope.settings, default=.999, values=[1.23, 0.98]) + # Used for testing float type + float_non_select = StringyFloat(scope=Scope.settings, default=.999, values={'min': 0, 'step': .3}) + # Used for testing that Booleans get mapped to select type + boolean_select = Boolean(scope=Scope.settings) class EditableMetadataFieldsTest(unittest.TestCase): - def test_display_name_field(self): editable_fields = self.get_xml_editable_fields({}) # Tests that the xblock fields (currently tags and name) get filtered out. # Also tests that xml_attributes is filtered out of XmlDescriptor. self.assertEqual(1, len(editable_fields), "Expected only 1 editable field for xml descriptor.") - self.assert_field_values(editable_fields, 'display_name', XModuleFields.display_name, - explicitly_set=False, inheritable=False, value=None, default_value=None) + self.assert_field_values( + editable_fields, 'display_name', XModuleFields.display_name, + explicitly_set=False, inheritable=False, value=None, default_value=None + ) def test_override_default(self): # Tests that explicitly_set is correct when a value overrides the default (not inheritable). editable_fields = self.get_xml_editable_fields({'display_name': 'foo'}) - self.assert_field_values(editable_fields, 'display_name', XModuleFields.display_name, - explicitly_set=True, inheritable=False, value='foo', default_value=None) + self.assert_field_values( + editable_fields, 'display_name', XModuleFields.display_name, + explicitly_set=True, inheritable=False, value='foo', default_value=None + ) - def test_additional_field(self): - descriptor = self.get_descriptor({'max_attempts' : '7'}) + def test_integer_field(self): + descriptor = self.get_descriptor({'max_attempts': '7'}) editable_fields = descriptor.editable_metadata_fields - self.assertEqual(2, len(editable_fields)) - self.assert_field_values(editable_fields, 'max_attempts', TestFields.max_attempts, - explicitly_set=True, inheritable=False, value=7, default_value=1000) - self.assert_field_values(editable_fields, 'display_name', XModuleFields.display_name, - explicitly_set=False, inheritable=False, value='local default', default_value='local default') + self.assertEqual(6, len(editable_fields)) + self.assert_field_values( + editable_fields, 'max_attempts', TestFields.max_attempts, + explicitly_set=True, inheritable=False, value=7, default_value=1000, type='Integer', + options=TestFields.max_attempts.values + ) + self.assert_field_values( + editable_fields, 'display_name', TestFields.display_name, + explicitly_set=False, inheritable=False, value='local default', default_value='local default' + ) editable_fields = self.get_descriptor({}).editable_metadata_fields - self.assert_field_values(editable_fields, 'max_attempts', TestFields.max_attempts, - explicitly_set=False, inheritable=False, value=1000, default_value=1000) + self.assert_field_values( + editable_fields, 'max_attempts', TestFields.max_attempts, + explicitly_set=False, inheritable=False, value=1000, default_value=1000, type='Integer', + options=TestFields.max_attempts.values + ) def test_inherited_field(self): - model_val = {'display_name' : 'inherited'} + model_val = {'display_name': 'inherited'} descriptor = self.get_descriptor(model_val) # Mimic an inherited value for display_name (inherited and inheritable are the same in this case). descriptor._inherited_metadata = model_val descriptor._inheritable_metadata = model_val editable_fields = descriptor.editable_metadata_fields - self.assert_field_values(editable_fields, 'display_name', XModuleFields.display_name, - explicitly_set=False, inheritable=True, value='inherited', default_value='inherited') + self.assert_field_values( + editable_fields, 'display_name', TestFields.display_name, + explicitly_set=False, inheritable=True, value='inherited', default_value='inherited' + ) - descriptor = self.get_descriptor({'display_name' : 'explicit'}) + descriptor = self.get_descriptor({'display_name': 'explicit'}) # Mimic the case where display_name WOULD have been inherited, except we explicitly set it. - descriptor._inheritable_metadata = {'display_name' : 'inheritable value'} + descriptor._inheritable_metadata = {'display_name': 'inheritable value'} descriptor._inherited_metadata = {} editable_fields = descriptor.editable_metadata_fields - self.assert_field_values(editable_fields, 'display_name', XModuleFields.display_name, - explicitly_set=True, inheritable=True, value='explicit', default_value='inheritable value') + self.assert_field_values( + editable_fields, 'display_name', TestFields.display_name, + explicitly_set=True, inheritable=True, value='explicit', default_value='inheritable value' + ) + + def test_type_and_options(self): + # test_display_name_field verifies that a String field is of type "Generic". + # test_integer_field verifies that a StringyInteger field is of type "Integer". + + descriptor = self.get_descriptor({}) + editable_fields = descriptor.editable_metadata_fields + + # Tests for select + self.assert_field_values( + editable_fields, 'string_select', TestFields.string_select, + explicitly_set=False, inheritable=False, value='default value', default_value='default value', + type='Select', options=[{'display_name': 'first', 'value': 'value a JSON'}, + {'display_name': 'second', 'value': 'value b JSON'}] + ) + + self.assert_field_values( + editable_fields, 'float_select', TestFields.float_select, + explicitly_set=False, inheritable=False, value=.999, default_value=.999, + type='Select', options=[1.23, 0.98] + ) + + self.assert_field_values( + editable_fields, 'boolean_select', TestFields.boolean_select, + explicitly_set=False, inheritable=False, value=None, default_value=None, + type='Select', options=[{'display_name': "True", "value": True}, {'display_name': "False", "value": False}] + ) + + # Test for float + self.assert_field_values( + editable_fields, 'float_non_select', TestFields.float_non_select, + explicitly_set=False, inheritable=False, value=.999, default_value=.999, + type='Float', options={'min': 0, 'step': .3} + ) + # Start of helper methods def get_xml_editable_fields(self, model_data): @@ -73,7 +145,6 @@ class EditableMetadataFieldsTest(unittest.TestCase): def get_descriptor(self, model_data): class TestModuleDescriptor(TestFields, XmlDescriptor): - @property def non_editable_metadata_fields(self): non_editable_fields = super(TestModuleDescriptor, self).non_editable_metadata_fields @@ -84,10 +155,19 @@ class EditableMetadataFieldsTest(unittest.TestCase): system.render_template = Mock(return_value="
        Test Template HTML
        ") return TestModuleDescriptor(system=system, location=None, model_data=model_data) - def assert_field_values(self, editable_fields, name, field, explicitly_set, inheritable, value, default_value): + def assert_field_values(self, editable_fields, name, field, explicitly_set, inheritable, value, default_value, + type='Generic', options=[]): test_field = editable_fields[name] - self.assertEqual(field, test_field['field']) + + self.assertEqual(field.name, test_field['field_name']) + self.assertEqual(field.display_name, test_field['display_name']) + self.assertEqual(field.help, test_field['help']) + + self.assertEqual(field.to_json(value), test_field['value']) + self.assertEqual(field.to_json(default_value), test_field['default_value']) + + self.assertEqual(options, test_field['options']) + self.assertEqual(type, test_field['type']) + self.assertEqual(explicitly_set, test_field['explicitly_set']) self.assertEqual(inheritable, test_field['inheritable']) - self.assertEqual(value, test_field['value']) - self.assertEqual(default_value, test_field['default_value']) diff --git a/common/lib/xmodule/xmodule/videoalpha_module.py b/common/lib/xmodule/xmodule/videoalpha_module.py index 6754f8f664..16230480a7 100644 --- a/common/lib/xmodule/xmodule/videoalpha_module.py +++ b/common/lib/xmodule/xmodule/videoalpha_module.py @@ -93,7 +93,7 @@ class VideoAlphaModule(VideoAlphaFields, XModule): return result def _get_timeframe(self, xmltree): - """ Converts 'from' and 'to' parameters in video tag to seconds. + """ Converts 'start_time' and 'end_time' parameters in video tag to seconds. If there are no parameters, returns empty string. """ def parse_time(s): @@ -103,11 +103,13 @@ class VideoAlphaModule(VideoAlphaFields, XModule): return '' else: x = time.strptime(s, '%H:%M:%S') - return datetime.timedelta(hours=x.tm_hour, - minutes=x.tm_min, - seconds=x.tm_sec).total_seconds() + return datetime.timedelta( + hours=x.tm_hour, + minutes=x.tm_min, + seconds=x.tm_sec + ).total_seconds() - return parse_time(xmltree.get('from')), parse_time(xmltree.get('to')) + return parse_time(xmltree.get('start_time')), parse_time(xmltree.get('end_time')) def handle_ajax(self, dispatch, get): """Handle ajax calls to this video. diff --git a/common/lib/xmodule/xmodule/word_cloud_module.py b/common/lib/xmodule/xmodule/word_cloud_module.py index 440da8b887..e38b8cf195 100644 --- a/common/lib/xmodule/xmodule/word_cloud_module.py +++ b/common/lib/xmodule/xmodule/word_cloud_module.py @@ -2,7 +2,7 @@ generate and view word cloud. On the client side we show: -If student does not yet anwered - `num_inputs` numbers of text inputs. +If student does not yet answered - `num_inputs` numbers of text inputs. If student have answered - words he entered and cloud. """ @@ -14,7 +14,8 @@ from xmodule.raw_module import RawDescriptor from xmodule.editing_module import MetadataOnlyEditingDescriptor from xmodule.x_module import XModule -from xblock.core import Scope, String, Object, Boolean, List, Integer +from xblock.core import Scope, Object, Boolean, List +from fields import StringyBoolean, StringyInteger log = logging.getLogger(__name__) @@ -31,22 +32,23 @@ def pretty_bool(value): class WordCloudFields(object): """XFields for word cloud.""" - display_name = String( - help="Display name for this module", - scope=Scope.settings - ) - num_inputs = Integer( - help="Number of inputs.", + num_inputs = StringyInteger( + display_name="Inputs", + help="Number of text boxes available for students to input words/sentences.", scope=Scope.settings, - default=5 + default=5, + values={"min": 1} ) - num_top_words = Integer( - help="Number of max words, which will be displayed.", + num_top_words = StringyInteger( + display_name="Maximum Words", + help="Maximum number of words to be displayed in generated word cloud.", scope=Scope.settings, - default=250 + default=250, + values={"min": 1} ) - display_student_percents = Boolean( - help="Display usage percents for each word?", + display_student_percents = StringyBoolean( + display_name="Show Percents", + help="Statistics are shown for entered words near that word.", scope=Scope.settings, default=True ) @@ -205,7 +207,7 @@ class WordCloudModule(WordCloudFields, XModule): # Update top_words. self.top_words = self.top_dict( temp_all_words, - int(self.num_top_words) + self.num_top_words ) # Save all_words in database. @@ -226,7 +228,7 @@ class WordCloudModule(WordCloudFields, XModule): 'element_id': self.location.html_id(), 'element_class': self.location.category, 'ajax_url': self.system.ajax_url, - 'num_inputs': int(self.num_inputs), + 'num_inputs': self.num_inputs, 'submitted': self.submitted } self.content = self.system.render_template('word_cloud.html', context) diff --git a/common/lib/xmodule/xmodule/x_module.py b/common/lib/xmodule/xmodule/x_module.py index 7c24d593e3..3ae70543cb 100644 --- a/common/lib/xmodule/xmodule/x_module.py +++ b/common/lib/xmodule/xmodule/x_module.py @@ -1,4 +1,5 @@ import logging +import copy import yaml import os @@ -9,7 +10,7 @@ from pkg_resources import resource_listdir, resource_string, resource_isdir from xmodule.modulestore import Location from xmodule.modulestore.exceptions import ItemNotFoundError -from xblock.core import XBlock, Scope, String +from xblock.core import XBlock, Scope, String, Integer, Float log = logging.getLogger(__name__) @@ -75,12 +76,13 @@ class HTMLSnippet(object): """ raise NotImplementedError( "get_html() must be provided by specific modules - not present in {0}" - .format(self.__class__)) + .format(self.__class__)) class XModuleFields(object): display_name = String( - help="Display name for this module", + display_name="Display Name", + help="This name appears in the horizontal navigation at the top of the page.", scope=Scope.settings, default=None ) @@ -356,7 +358,7 @@ class XModuleDescriptor(XModuleFields, HTMLSnippet, ResourceTemplates, XBlock): metadata_translations = { 'slug': 'url_name', 'name': 'display_name', - } + } # ============================= STRUCTURAL MANIPULATION =================== def __init__(self, @@ -458,7 +460,6 @@ class XModuleDescriptor(XModuleFields, HTMLSnippet, ResourceTemplates, XBlock): """ return False - # ================================= JSON PARSING =========================== @staticmethod def load_from_json(json_data, system, default_class=None): @@ -523,10 +524,10 @@ class XModuleDescriptor(XModuleFields, HTMLSnippet, ResourceTemplates, XBlock): # ================================= XML PARSING ============================ @staticmethod def load_from_xml(xml_data, - system, - org=None, - course=None, - default_class=None): + system, + org=None, + course=None, + default_class=None): """ This method instantiates the correct subclass of XModuleDescriptor based on the contents of xml_data. @@ -541,7 +542,7 @@ class XModuleDescriptor(XModuleFields, HTMLSnippet, ResourceTemplates, XBlock): class_ = XModuleDescriptor.load_class( etree.fromstring(xml_data).tag, default_class - ) + ) # leave next line, commented out - useful for low-level debugging # log.debug('[XModuleDescriptor.load_from_xml] tag=%s, class_=%s' % ( # etree.fromstring(xml_data).tag,class_)) @@ -625,7 +626,7 @@ class XModuleDescriptor(XModuleFields, HTMLSnippet, ResourceTemplates, XBlock): """ inherited_metadata = getattr(self, '_inherited_metadata', {}) inheritable_metadata = getattr(self, '_inheritable_metadata', {}) - metadata = {} + metadata_fields = {} for field in self.fields: if field.scope != Scope.settings or field in self.non_editable_metadata_fields: @@ -641,13 +642,39 @@ class XModuleDescriptor(XModuleFields, HTMLSnippet, ResourceTemplates, XBlock): if field.name in inherited_metadata: explicitly_set = False - metadata[field.name] = {'field': field, - 'value': value, - 'default_value': default_value, - 'inheritable': inheritable, - 'explicitly_set': explicitly_set } + # We support the following editors: + # 1. A select editor for fields with a list of possible values (includes Booleans). + # 2. Number editors for integers and floats. + # 3. A generic string editor for anything else (editing JSON representation of the value). + type = "Generic" + values = [] if field.values is None else copy.deepcopy(field.values) + if isinstance(values, tuple): + values = list(values) + if isinstance(values, list): + if len(values) > 0: + type = "Select" + for index, choice in enumerate(values): + json_choice = copy.deepcopy(choice) + if isinstance(json_choice, dict) and 'value' in json_choice: + json_choice['value'] = field.to_json(json_choice['value']) + else: + json_choice = field.to_json(json_choice) + values[index] = json_choice + elif isinstance(field, Integer): + type = "Integer" + elif isinstance(field, Float): + type = "Float" + metadata_fields[field.name] = {'field_name': field.name, + 'type': type, + 'display_name': field.display_name, + 'value': field.to_json(value), + 'options': values, + 'default_value': field.to_json(default_value), + 'inheritable': inheritable, + 'explicitly_set': explicitly_set, + 'help': field.help} - return metadata + return metadata_fields class DescriptorSystem(object): @@ -737,7 +764,10 @@ class ModuleSystem(object): anonymous_student_id='', course_id=None, open_ended_grading_interface=None, - s3_interface=None): + s3_interface=None, + cache=None, + can_execute_unsafe_code=None, + ): ''' Create a closure around the system environment. @@ -779,6 +809,14 @@ class ModuleSystem(object): xblock_model_data - A dict-like object containing the all data available to this xblock + + cache - A cache object with two methods: + .get(key) returns an object from the cache or None. + .set(key, value, timeout_secs=None) stores a value in the cache with a timeout. + + can_execute_unsafe_code - A function returning a boolean, whether or + not to allow the execution of unsafe, unsandboxed code. + ''' self.ajax_url = ajax_url self.xqueue = xqueue @@ -803,6 +841,9 @@ class ModuleSystem(object): self.open_ended_grading_interface = open_ended_grading_interface self.s3_interface = s3_interface + self.cache = cache or DoNothingCache() + self.can_execute_unsafe_code = can_execute_unsafe_code or (lambda: False) + def get(self, attr): ''' provide uniform access to attributes (like etree).''' return self.__dict__.get(attr) @@ -816,3 +857,12 @@ class ModuleSystem(object): def __str__(self): return str(self.__dict__) + + +class DoNothingCache(object): + """A duck-compatible object to use in ModuleSystem when there's no cache.""" + def get(self, key): + return None + + def set(self, key, value, timeout=None): + pass diff --git a/common/lib/xmodule/xmodule/xml_module.py b/common/lib/xmodule/xmodule/xml_module.py index 7480cda0c5..2f54bbf405 100644 --- a/common/lib/xmodule/xmodule/xml_module.py +++ b/common/lib/xmodule/xmodule/xml_module.py @@ -136,6 +136,7 @@ class XmlDescriptor(XModuleDescriptor): 'hide_progress_tab': bool_map, 'allow_anonymous': bool_map, 'allow_anonymous_to_peers': bool_map, + 'show_timezone': bool_map, } diff --git a/common/static/coffee/spec/discussion/content_spec.coffee b/common/static/coffee/spec/discussion/content_spec.coffee new file mode 100644 index 0000000000..3a7cc35677 --- /dev/null +++ b/common/static/coffee/spec/discussion/content_spec.coffee @@ -0,0 +1,66 @@ +describe 'All Content', -> + beforeEach -> + # TODO: figure out a better way of handling this + # It is set up in main.coffee DiscussionApp.start + window.$$course_id = 'mitX/999/test' + window.user = new DiscussionUser {id: '567'} + + describe 'Content', -> + beforeEach -> + @content = new Content { + id: '01234567', + user_id: '567', + course_id: 'mitX/999/test', + body: 'this is some content', + abuse_flaggers: ['123'] + } + + it 'should exist', -> + expect(Content).toBeDefined() + + it 'is initialized correctly', -> + @content.initialize + expect(Content.contents['01234567']).toEqual @content + expect(@content.get 'id').toEqual '01234567' + expect(@content.get 'user_url').toEqual '/courses/mitX/999/test/discussion/forum/users/567' + expect(@content.get 'children').toEqual [] + expect(@content.get 'comments').toEqual(jasmine.any(Comments)) + + it 'can update info', -> + @content.updateInfo { + ability: 'can_endorse', + voted: true, + subscribed: true + } + expect(@content.get 'ability').toEqual 'can_endorse' + expect(@content.get 'voted').toEqual true + expect(@content.get 'subscribed').toEqual true + + it 'can be flagged for abuse', -> + @content.flagAbuse() + expect(@content.get 'abuse_flaggers').toEqual ['123', '567'] + + it 'can be unflagged for abuse', -> + temp_array = [] + temp_array.push(window.user.get('id')) + @content.set("abuse_flaggers",temp_array) + @content.unflagAbuse() + expect(@content.get 'abuse_flaggers').toEqual [] + + describe 'Comments', -> + beforeEach -> + @comment1 = new Comment {id: '123'} + @comment2 = new Comment {id: '345'} + + it 'can contain multiple comments', -> + myComments = new Comments + expect(myComments.length).toEqual 0 + myComments.add @comment1 + expect(myComments.length).toEqual 1 + myComments.add @comment2 + expect(myComments.length).toEqual 2 + + it 'returns results to the find method', -> + myComments = new Comments + myComments.add @comment1 + expect(myComments.find('123')).toBe @comment1 diff --git a/common/static/coffee/spec/discussion/view/discussion_content_view_spec.coffee b/common/static/coffee/spec/discussion/view/discussion_content_view_spec.coffee new file mode 100644 index 0000000000..85ab5ec254 --- /dev/null +++ b/common/static/coffee/spec/discussion/view/discussion_content_view_spec.coffee @@ -0,0 +1,58 @@ +describe "DiscussionContentView", -> + beforeEach -> + + setFixtures + ( + """ +
        +
        + + + 0 +

        Post Title

        +

        + robot + less than a minute ago +

        +
        +

        Post body.

        +
        + Report Misuse
        +
        + Pin Thread
        +
        + """ + ) + + @thread = new Thread { + id: '01234567', + user_id: '567', + course_id: 'mitX/999/test', + body: 'this is a thread', + created_at: '2013-04-03T20:08:39Z', + abuse_flaggers: ['123'] + roles: [] + } + @view = new DiscussionContentView({ model: @thread }) + + it 'defines the tag', -> + expect($('#jasmine-fixtures')).toExist + expect(@view.tagName).toBeDefined + expect(@view.el.tagName.toLowerCase()).toBe 'div' + + it "defines the class", -> + # spyOn @content, 'initialize' + expect(@view.model).toBeDefined(); + + it 'is tied to the model', -> + expect(@view.model).toBeDefined(); + + it 'can be flagged for abuse', -> + @thread.flagAbuse() + expect(@thread.get 'abuse_flaggers').toEqual ['123', '567'] + + it 'can be unflagged for abuse', -> + temp_array = [] + temp_array.push(window.user.get('id')) + @thread.set("abuse_flaggers",temp_array) + @thread.unflagAbuse() + expect(@thread.get 'abuse_flaggers').toEqual [] diff --git a/common/static/coffee/spec/discussion/view/response_comment_show_view_spec.coffee b/common/static/coffee/spec/discussion/view/response_comment_show_view_spec.coffee new file mode 100644 index 0000000000..f43a8807b6 --- /dev/null +++ b/common/static/coffee/spec/discussion/view/response_comment_show_view_spec.coffee @@ -0,0 +1,62 @@ +describe 'ResponseCommentShowView', -> + beforeEach -> + # set up the container for the response to go in + setFixtures """ +
          + + """ + + # set up a model for a new Comment + @response = new Comment { + id: '01234567', + user_id: '567', + course_id: 'mitX/999/test', + body: 'this is a response', + created_at: '2013-04-03T20:08:39Z', + abuse_flaggers: ['123'] + roles: [] + } + @view = new ResponseCommentShowView({ model: @response }) + + # spyOn(DiscussionUtil, 'loadRoles').andReturn [] + + it 'defines the tag', -> + expect($('#jasmine-fixtures')).toExist + expect(@view.tagName).toBeDefined + expect(@view.el.tagName.toLowerCase()).toBe 'li' + + it 'is tied to the model', -> + expect(@view.model).toBeDefined(); + + describe 'rendering', -> + + beforeEach -> + spyOn(@view, 'renderAttrs') + spyOn(@view, 'markAsStaff') + spyOn(@view, 'convertMath') + + it 'produces the correct HTML', -> + @view.render() + expect(@view.el.innerHTML).toContain('"discussion-flag-abuse notflagged"') + + it 'can be flagged for abuse', -> + @response.flagAbuse() + expect(@response.get 'abuse_flaggers').toEqual ['123', '567'] + + it 'can be unflagged for abuse', -> + temp_array = [] + temp_array.push(window.user.get('id')) + @response.set("abuse_flaggers",temp_array) + @response.unflagAbuse() + expect(@response.get 'abuse_flaggers').toEqual [] diff --git a/common/static/coffee/spec/logger_spec.coffee b/common/static/coffee/spec/logger_spec.coffee index 33f924362a..8fdfb99251 100644 --- a/common/static/coffee/spec/logger_spec.coffee +++ b/common/static/coffee/spec/logger_spec.coffee @@ -1,6 +1,5 @@ describe 'Logger', -> it 'expose window.log_event', -> - jasmine.stubRequests() expect(window.log_event).toBe Logger.log describe 'log', -> @@ -12,7 +11,8 @@ describe 'Logger', -> event: '"data"' page: window.location.href - describe 'bind', -> + # Broken with commit 9f75e64? Skipping for now. + xdescribe 'bind', -> beforeEach -> Logger.bind() Courseware.prefix = '/6002x' diff --git a/common/static/coffee/src/discussion/content.coffee b/common/static/coffee/src/discussion/content.coffee index 00c34df686..6361a4b76e 100644 --- a/common/static/coffee/src/discussion/content.coffee +++ b/common/static/coffee/src/discussion/content.coffee @@ -88,20 +88,32 @@ if Backbone? pinned = @get("pinned") @set("pinned",pinned) @trigger "change", @ + + flagAbuse: -> + temp_array = @get("abuse_flaggers") + temp_array.push(window.user.get('id')) + @set("abuse_flaggers",temp_array) + @trigger "change", @ + unflagAbuse: -> + @get("abuse_flaggers").pop(window.user.get('id')) + @trigger "change", @ + class @Thread extends @Content urlMappers: - 'retrieve' : -> DiscussionUtil.urlFor('retrieve_single_thread', @discussion.id, @id) - 'reply' : -> DiscussionUtil.urlFor('create_comment', @id) - 'unvote' : -> DiscussionUtil.urlFor("undo_vote_for_#{@get('type')}", @id) - 'upvote' : -> DiscussionUtil.urlFor("upvote_#{@get('type')}", @id) - 'downvote' : -> DiscussionUtil.urlFor("downvote_#{@get('type')}", @id) - 'close' : -> DiscussionUtil.urlFor('openclose_thread', @id) - 'update' : -> DiscussionUtil.urlFor('update_thread', @id) - 'delete' : -> DiscussionUtil.urlFor('delete_thread', @id) - 'follow' : -> DiscussionUtil.urlFor('follow_thread', @id) - 'unfollow' : -> DiscussionUtil.urlFor('unfollow_thread', @id) + 'retrieve' : -> DiscussionUtil.urlFor('retrieve_single_thread', @discussion.id, @id) + 'reply' : -> DiscussionUtil.urlFor('create_comment', @id) + 'unvote' : -> DiscussionUtil.urlFor("undo_vote_for_#{@get('type')}", @id) + 'upvote' : -> DiscussionUtil.urlFor("upvote_#{@get('type')}", @id) + 'downvote' : -> DiscussionUtil.urlFor("downvote_#{@get('type')}", @id) + 'close' : -> DiscussionUtil.urlFor('openclose_thread', @id) + 'update' : -> DiscussionUtil.urlFor('update_thread', @id) + 'delete' : -> DiscussionUtil.urlFor('delete_thread', @id) + 'follow' : -> DiscussionUtil.urlFor('follow_thread', @id) + 'unfollow' : -> DiscussionUtil.urlFor('unfollow_thread', @id) + 'flagAbuse' : -> DiscussionUtil.urlFor("flagAbuse_#{@get('type')}", @id) + 'unFlagAbuse' : -> DiscussionUtil.urlFor("unFlagAbuse_#{@get('type')}", @id) 'pinThread' : -> DiscussionUtil.urlFor("pin_thread", @id) 'unPinThread' : -> DiscussionUtil.urlFor("un_pin_thread", @id) @@ -157,6 +169,8 @@ if Backbone? 'endorse': -> DiscussionUtil.urlFor('endorse_comment', @id) 'update': -> DiscussionUtil.urlFor('update_comment', @id) 'delete': -> DiscussionUtil.urlFor('delete_comment', @id) + 'flagAbuse' : -> DiscussionUtil.urlFor("flagAbuse_#{@get('type')}", @id) + 'unFlagAbuse' : -> DiscussionUtil.urlFor("unFlagAbuse_#{@get('type')}", @id) getCommentsCount: -> count = 0 diff --git a/common/static/coffee/src/discussion/discussion.coffee b/common/static/coffee/src/discussion/discussion.coffee index 83e25e1da7..5a52cd4de0 100644 --- a/common/static/coffee/src/discussion/discussion.coffee +++ b/common/static/coffee/src/discussion/discussion.coffee @@ -37,6 +37,9 @@ if Backbone? data['commentable_ids'] = options.commentable_ids when 'all' url = DiscussionUtil.urlFor 'threads' + when 'flagged' + data['flagged'] = true + url = DiscussionUtil.urlFor 'search' when 'followed' url = DiscussionUtil.urlFor 'followed_threads', options.user_id if options['group_id'] diff --git a/common/static/coffee/src/discussion/utils.coffee b/common/static/coffee/src/discussion/utils.coffee index 41f52f1711..b7b7cb2550 100644 --- a/common/static/coffee/src/discussion/utils.coffee +++ b/common/static/coffee/src/discussion/utils.coffee @@ -18,8 +18,12 @@ class @DiscussionUtil @loadRoles: (roles)-> @roleIds = roles + @loadFlagModerator: (what)-> + @isFlagModerator = ((what=="True") or (what == 1)) + @loadRolesFromContainer: -> @loadRoles($("#discussion-container").data("roles")) + @loadFlagModerator($("#discussion-container").data("flag-moderator")) @isStaff: (user_id) -> staff = _.union(@roleIds['Staff'], @roleIds['Moderator'], @roleIds['Administrator']) @@ -48,9 +52,13 @@ class @DiscussionUtil update_thread : "/courses/#{$$course_id}/discussion/threads/#{param}/update" create_comment : "/courses/#{$$course_id}/discussion/threads/#{param}/reply" delete_thread : "/courses/#{$$course_id}/discussion/threads/#{param}/delete" + flagAbuse_thread : "/courses/#{$$course_id}/discussion/threads/#{param}/flagAbuse" + unFlagAbuse_thread : "/courses/#{$$course_id}/discussion/threads/#{param}/unFlagAbuse" + flagAbuse_comment : "/courses/#{$$course_id}/discussion/comments/#{param}/flagAbuse" + unFlagAbuse_comment : "/courses/#{$$course_id}/discussion/comments/#{param}/unFlagAbuse" upvote_thread : "/courses/#{$$course_id}/discussion/threads/#{param}/upvote" downvote_thread : "/courses/#{$$course_id}/discussion/threads/#{param}/downvote" - pin_thread : "/courses/#{$$course_id}/discussion/threads/#{param}/pin" + pin_thread : "/courses/#{$$course_id}/discussion/threads/#{param}/pin" un_pin_thread : "/courses/#{$$course_id}/discussion/threads/#{param}/unpin" undo_vote_for_thread : "/courses/#{$$course_id}/discussion/threads/#{param}/unvote" follow_thread : "/courses/#{$$course_id}/discussion/threads/#{param}/follow" @@ -72,7 +80,7 @@ class @DiscussionUtil permanent_link_thread : "/courses/#{$$course_id}/discussion/forum/#{param}/threads/#{param1}" permanent_link_comment : "/courses/#{$$course_id}/discussion/forum/#{param}/threads/#{param1}##{param2}" user_profile : "/courses/#{$$course_id}/discussion/forum/users/#{param}" - followed_threads : "/courses/#{$$course_id}/discussion/forum/users/#{param}/followed" + followed_threads : "/courses/#{$$course_id}/discussion/forum/users/#{param}/followed" threads : "/courses/#{$$course_id}/discussion/forum" }[name] diff --git a/common/static/coffee/src/discussion/views/discussion_content_view.coffee b/common/static/coffee/src/discussion/views/discussion_content_view.coffee index 9399d95398..9b2de1b198 100644 --- a/common/static/coffee/src/discussion/views/discussion_content_view.coffee +++ b/common/static/coffee/src/discussion/views/discussion_content_view.coffee @@ -1,6 +1,11 @@ if Backbone? class @DiscussionContentView extends Backbone.View + + events: + "click .discussion-flag-abuse": "toggleFlagAbuse" + + attrRenderer: endorsed: (endorsed) -> if endorsed @@ -94,7 +99,48 @@ if Backbone? setWmdContent: (cls_identifier, text) => DiscussionUtil.setWmdContent @$el, $.proxy(@$, @), cls_identifier, text + initialize: -> @initLocal() @model.bind('change', @renderPartialAttrs, @) + + + + toggleFlagAbuse: (event) -> + event.preventDefault() + if window.user.id in @model.get("abuse_flaggers") or (DiscussionUtil.isFlagModerator and @model.get("abuse_flaggers").length > 0) + @unFlagAbuse() + else + @flagAbuse() + + flagAbuse: -> + url = @model.urlFor("flagAbuse") + DiscussionUtil.safeAjax + $elem: @$(".discussion-flag-abuse") + url: url + type: "POST" + success: (response, textStatus) => + if textStatus == 'success' + ### + note, we have to clone the array in order to trigger a change event + ### + temp_array = _.clone(@model.get('abuse_flaggers')); + temp_array.push(window.user.id) + @model.set('abuse_flaggers', temp_array) + + unFlagAbuse: -> + url = @model.urlFor("unFlagAbuse") + DiscussionUtil.safeAjax + $elem: @$(".discussion-flag-abuse") + url: url + type: "POST" + success: (response, textStatus) => + if textStatus == 'success' + temp_array = _.clone(@model.get('abuse_flaggers')); + temp_array.pop(window.user.id) + # if you're an admin, clear this + if DiscussionUtil.isFlagModerator + temp_array = [] + + @model.set('abuse_flaggers', temp_array) diff --git a/common/static/coffee/src/discussion/views/discussion_thread_list_view.coffee b/common/static/coffee/src/discussion/views/discussion_thread_list_view.coffee index 8364963218..9aa4ba869d 100644 --- a/common/static/coffee/src/discussion/views/discussion_thread_list_view.coffee +++ b/common/static/coffee/src/discussion/views/discussion_thread_list_view.coffee @@ -276,6 +276,11 @@ if Backbone? @$(".post-search-field").val("") @$('.cohort').show() @retrieveAllThreads() + else if discussionId == "#flagged" + @discussionIds = "" + @$(".post-search-field").val("") + @$('.cohort').hide() + @retrieveFlaggedThreads() else if discussionId == "#following" @retrieveFollowed(event) @$('.cohort').hide() @@ -321,6 +326,12 @@ if Backbone? @collection.reset() @loadMorePages(event) + retrieveFlaggedThreads: (event)-> + @collection.current_page = 0 + @collection.reset() + @mode = 'flagged' + @loadMorePages(event) + sortThreads: (event) -> @$(".sort-bar a").removeClass("active") $(event.target).addClass("active") diff --git a/common/static/coffee/src/discussion/views/discussion_thread_show_view.coffee b/common/static/coffee/src/discussion/views/discussion_thread_show_view.coffee index 56525af347..49936c46e8 100644 --- a/common/static/coffee/src/discussion/views/discussion_thread_show_view.coffee +++ b/common/static/coffee/src/discussion/views/discussion_thread_show_view.coffee @@ -3,6 +3,7 @@ if Backbone? events: "click .discussion-vote": "toggleVote" + "click .discussion-flag-abuse": "toggleFlagAbuse" "click .admin-pin": "togglePin" "click .action-follow": "toggleFollowing" "click .action-edit": "edit" @@ -25,6 +26,7 @@ if Backbone? @delegateEvents() @renderDogear() @renderVoted() + @renderFlagged() @renderPinned() @renderAttrs() @$("span.timeago").timeago() @@ -42,6 +44,16 @@ if Backbone? @$("[data-role=discussion-vote]").addClass("is-cast") else @$("[data-role=discussion-vote]").removeClass("is-cast") + + renderFlagged: => + if window.user.id in @model.get("abuse_flaggers") or (DiscussionUtil.isFlagModerator and @model.get("abuse_flaggers").length > 0) + @$("[data-role=thread-flag]").addClass("flagged") + @$("[data-role=thread-flag]").removeClass("notflagged") + @$(".discussion-flag-abuse .flag-label").html("Misuse Reported") + else + @$("[data-role=thread-flag]").removeClass("flagged") + @$("[data-role=thread-flag]").addClass("notflagged") + @$(".discussion-flag-abuse .flag-label").html("Report Misuse") renderPinned: => if @model.get("pinned") @@ -56,6 +68,7 @@ if Backbone? updateModelDetails: => @renderVoted() + @renderFlagged() @renderPinned() @$("[data-role=discussion-vote] .votes-count-number").html(@model.get("votes")["up_count"]) @@ -96,6 +109,7 @@ if Backbone? if textStatus == 'success' @model.set(response, {silent: true}) + unvote: -> window.user.unvote(@model) url = @model.urlFor("unvote") @@ -107,6 +121,7 @@ if Backbone? if textStatus == 'success' @model.set(response, {silent: true}) + edit: (event) -> @trigger "thread:edit", event @@ -182,4 +197,4 @@ if Backbone? params = $.extend(params, user:{username: @model.username, user_url: @model.user_url}) Mustache.render(@template, params) - \ No newline at end of file + diff --git a/common/static/coffee/src/discussion/views/discussion_thread_view.coffee b/common/static/coffee/src/discussion/views/discussion_thread_view.coffee index cb549f1088..c3a793b478 100644 --- a/common/static/coffee/src/discussion/views/discussion_thread_view.coffee +++ b/common/static/coffee/src/discussion/views/discussion_thread_view.coffee @@ -91,7 +91,7 @@ if Backbone? body = @getWmdContent("reply-body") return if not body.trim().length @setWmdContent("reply-body", "") - comment = new Comment(body: body, created_at: (new Date()).toISOString(), username: window.user.get("username"), votes: { up_count: 0 }, endorsed: false, user_id: window.user.get("id")) + comment = new Comment(body: body, created_at: (new Date()).toISOString(), username: window.user.get("username"), votes: { up_count: 0 }, abuse_flaggers:[], endorsed: false, user_id: window.user.get("id")) comment.set('thread', @model.get('thread')) @renderResponse(comment) @model.addComment() diff --git a/common/static/coffee/src/discussion/views/response_comment_show_view.coffee b/common/static/coffee/src/discussion/views/response_comment_show_view.coffee index 84e7357e1f..6023964c75 100644 --- a/common/static/coffee/src/discussion/views/response_comment_show_view.coffee +++ b/common/static/coffee/src/discussion/views/response_comment_show_view.coffee @@ -1,8 +1,15 @@ if Backbone? class @ResponseCommentShowView extends DiscussionContentView + events: + "click .discussion-flag-abuse": "toggleFlagAbuse" + tagName: "li" + initialize: -> + super() + @model.on "change", @updateModelDetails + render: -> @template = _.template($("#response-comment-show-template").html()) params = @model.toJSON() @@ -11,6 +18,7 @@ if Backbone? @initLocal() @delegateEvents() @renderAttrs() + @renderFlagged() @markAsStaff() @$el.find(".timeago").timeago() @convertMath() @@ -34,3 +42,17 @@ if Backbone? @$el.find("a.profile-link").after('staff') else if DiscussionUtil.isTA(@model.get("user_id")) @$el.find("a.profile-link").after('Community  TA') + + + renderFlagged: => + if window.user.id in @model.get("abuse_flaggers") or (DiscussionUtil.isFlagModerator and @model.get("abuse_flaggers").length > 0) + @$("[data-role=thread-flag]").addClass("flagged") + @$("[data-role=thread-flag]").removeClass("notflagged") + else + @$("[data-role=thread-flag]").removeClass("flagged") + @$("[data-role=thread-flag]").addClass("notflagged") + + updateModelDetails: => + @renderFlagged() + + diff --git a/common/static/coffee/src/discussion/views/thread_response_show_view.coffee b/common/static/coffee/src/discussion/views/thread_response_show_view.coffee index 1f305ddf34..0e42b79b9a 100644 --- a/common/static/coffee/src/discussion/views/thread_response_show_view.coffee +++ b/common/static/coffee/src/discussion/views/thread_response_show_view.coffee @@ -5,6 +5,7 @@ if Backbone? "click .action-endorse": "toggleEndorse" "click .action-delete": "delete" "click .action-edit": "edit" + "click .discussion-flag-abuse": "toggleFlagAbuse" $: (selector) -> @$el.find(selector) @@ -23,6 +24,7 @@ if Backbone? if window.user.voted(@model) @$(".vote-btn").addClass("is-cast") @renderAttrs() + @renderFlagged() @$el.find(".posted-details").timeago() @convertMath() @markAsStaff() @@ -70,6 +72,7 @@ if Backbone? success: (response, textStatus) => if textStatus == 'success' @model.set(response) + edit: (event) -> @trigger "response:edit", event @@ -92,3 +95,17 @@ if Backbone? url: url data: data type: "POST" + + + renderFlagged: => + if window.user.id in @model.get("abuse_flaggers") or (DiscussionUtil.isFlagModerator and @model.get("abuse_flaggers").length > 0) + @$("[data-role=thread-flag]").addClass("flagged") + @$("[data-role=thread-flag]").removeClass("notflagged") + @$(".discussion-flag-abuse .flag-label").html("Misuse Reported") + else + @$("[data-role=thread-flag]").removeClass("flagged") + @$("[data-role=thread-flag]").addClass("notflagged") + @$(".discussion-flag-abuse .flag-label").html("Report Misuse") + + updateModelDetails: => + @renderFlagged() diff --git a/common/static/coffee/src/discussion/views/thread_response_view.coffee b/common/static/coffee/src/discussion/views/thread_response_view.coffee index 9b6800cdde..46a96a55ec 100644 --- a/common/static/coffee/src/discussion/views/thread_response_view.coffee +++ b/common/static/coffee/src/discussion/views/thread_response_view.coffee @@ -77,7 +77,7 @@ if Backbone? body = @getWmdContent("comment-body") return if not body.trim().length @setWmdContent("comment-body", "") - comment = new Comment(body: body, created_at: (new Date()).toISOString(), username: window.user.get("username"), user_id: window.user.get("id"), id:"unsaved") + comment = new Comment(body: body, created_at: (new Date()).toISOString(), username: window.user.get("username"), abuse_flaggers:[], user_id: window.user.get("id"), id:"unsaved") view = @renderComment(comment) @hideEditorChrome() @trigger "comment:add", comment diff --git a/common/static/css/vendor/html5-input-polyfills/number-polyfill.css b/common/static/css/vendor/html5-input-polyfills/number-polyfill.css new file mode 100644 index 0000000000..f3d8805739 --- /dev/null +++ b/common/static/css/vendor/html5-input-polyfills/number-polyfill.css @@ -0,0 +1,87 @@ +/* HTML5 Number polyfill | Jonathan Stipe | https://github.com/jonstipe/number-polyfill*/ +div.number-spin-btn-container { + display: inline-block; + position: absolute; + vertical-align: middle; + margin: 0 0 0 3px; + padding: 0; + left: 74%; + top: 6px; +} + +div.number-spin-btn { + -moz-box-sizing: border-box; + -webkit-box-sizing: border-box; + box-sizing: border-box; + border-width: 2px; + border-color: #ededed #777777 #777777 #ededed; + border-style: solid; + background-color: #eeeeee; + width: 1em; + font-size: 14px; } + div.number-spin-btn:hover { + /* added blue hover color */ + background-color: rgb(85, 151, 221); + cursor: pointer; } + div.number-spin-btn:active { + border-width: 2px; + border-color: #5e5e5e #d8d8d8 #d8d8d8 #5e5e5e; + border-style: solid; + background-color: #999999; } + +div.number-spin-btn-up { + border-bottom-width: 1px; + -moz-border-radius: 0px; + -webkit-border-radius: 0px; + border-radius: 0px; + font-size: 14px; } + div.number-spin-btn-up:before { + border-width: 0 0.3em 0.3em 0.3em; + border-color: transparent transparent black transparent; + top: 25%; } + div.number-spin-btn-up:active { + border-bottom-width: 1px; } + div.number-spin-btn-up:active:before { + border-bottom-color: white; + top: 26%; + left: 51%; } + +div.number-spin-btn-down { + border-top-width: 1px; + -moz-border-radius: 0px 0px 3px 3px; + -webkit-border-radius: 0px 0px 3px 3px; + border-radius: 0px 0px 3px 3px; } + div.number-spin-btn-down:before { + border-width: 0.3em 0.3em 0 0.3em; + border-color: black transparent transparent transparent; + top: 75%; } + div.number-spin-btn-down:active { + border-top-width: 1px; } + div.number-spin-btn-down:active:before { + border-top-color: white; + top: 76%; + left: 51%; } + +div.number-spin-btn-up:before, +div.number-spin-btn-down:before { + content: ""; + width: 0; + height: 0; + border-style: solid; + position: absolute; + left: 50%; + margin: -0.15em 0 0 -0.3em; + padding: 0; } + +input:disabled + div.number-spin-btn-container > div.number-spin-btn-up:active, input:disabled + div.number-spin-btn-container > div.number-spin-btn-down:active { + border-color: #ededed #777777 #777777 #ededed; + border-style: solid; + background-color: #cccccc; } +input:disabled + div.number-spin-btn-container > div.number-spin-btn-up:before, input:disabled + div.number-spin-btn-container > div.number-spin-btn-up:active:before { + border-bottom-color: #999999; + top: 25%; + left: 50%; } +input:disabled + div.number-spin-btn-container > div.number-spin-btn-down:before, input:disabled + div.number-spin-btn-container > div.number-spin-btn-down:active:before { + border-top-color: #999999; + top: 75%; + left: 50%; } diff --git a/common/static/js/test/i18n.js b/common/static/js/test/i18n.js new file mode 100644 index 0000000000..3cd6d52ae8 --- /dev/null +++ b/common/static/js/test/i18n.js @@ -0,0 +1 @@ +window.gettext = window.ngettext = function(){}; diff --git a/common/static/js/vendor/annotator.js b/common/static/js/vendor/annotator.js new file mode 100644 index 0000000000..f66baa2c7e --- /dev/null +++ b/common/static/js/vendor/annotator.js @@ -0,0 +1,1827 @@ +/* +** Annotator 1.2.6-dev-dc18206 +** https://github.com/okfn/annotator/ +** +** Copyright 2012 Aron Carroll, Rufus Pollock, and Nick Stenning. +** Dual licensed under the MIT and GPLv3 licenses. +** https://github.com/okfn/annotator/blob/master/LICENSE +** +** Built at: 2013-05-16 18:01:57Z +*/ + + +(function() { + var $, Annotator, Delegator, LinkParser, Range, findChild, fn, functions, g, getNodeName, getNodePosition, gettext, simpleXPathJQuery, simpleXPathPure, util, _Annotator, _gettext, _i, _j, _len, _len1, _ref, _ref1, _t, + __slice = [].slice, + __hasProp = {}.hasOwnProperty, + __extends = function(child, parent) { for (var key in parent) { if (__hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; }, + __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; }; + + simpleXPathJQuery = function(relativeRoot) { + var jq; + + jq = this.map(function() { + var elem, idx, path, tagName; + + path = ''; + elem = this; + while (elem && elem.nodeType === 1 && elem !== relativeRoot) { + tagName = elem.tagName.replace(":", "\\:"); + idx = $(elem.parentNode).children(tagName).index(elem) + 1; + idx = "[" + idx + "]"; + path = "/" + elem.tagName.toLowerCase() + idx + path; + elem = elem.parentNode; + } + return path; + }); + return jq.get(); + }; + + simpleXPathPure = function(relativeRoot) { + var getPathSegment, getPathTo, jq, rootNode; + + getPathSegment = function(node) { + var name, pos; + + name = getNodeName(node); + pos = getNodePosition(node); + return "" + name + "[" + pos + "]"; + }; + rootNode = relativeRoot; + getPathTo = function(node) { + var xpath; + + xpath = ''; + while (node !== rootNode) { + if (node == null) { + throw new Error("Called getPathTo on a node which was not a descendant of @rootNode. " + rootNode); + } + xpath = (getPathSegment(node)) + '/' + xpath; + node = node.parentNode; + } + xpath = '/' + xpath; + xpath = xpath.replace(/\/$/, ''); + return xpath; + }; + jq = this.map(function() { + var path; + + path = getPathTo(this); + return path; + }); + return jq.get(); + }; + + findChild = function(node, type, index) { + var child, children, found, name, _i, _len; + + if (!node.hasChildNodes()) { + throw new Error("XPath error: node has no children!"); + } + children = node.childNodes; + found = 0; + for (_i = 0, _len = children.length; _i < _len; _i++) { + child = children[_i]; + name = getNodeName(child); + if (name === type) { + found += 1; + if (found === index) { + return child; + } + } + } + throw new Error("XPath error: wanted child not found."); + }; + + getNodeName = function(node) { + var nodeName; + + nodeName = node.nodeName.toLowerCase(); + switch (nodeName) { + case "#text": + return "text()"; + case "#comment": + return "comment()"; + case "#cdata-section": + return "cdata-section()"; + default: + return nodeName; + } + }; + + getNodePosition = function(node) { + var pos, tmp; + + pos = 0; + tmp = node; + while (tmp) { + if (tmp.nodeName === node.nodeName) { + pos++; + } + tmp = tmp.previousSibling; + } + return pos; + }; + + gettext = null; + + if (typeof Gettext !== "undefined" && Gettext !== null) { + _gettext = new Gettext({ + domain: "annotator" + }); + gettext = function(msgid) { + return _gettext.gettext(msgid); + }; + } else { + gettext = function(msgid) { + return msgid; + }; + } + + _t = function(msgid) { + return gettext(msgid); + }; + + if (!(typeof jQuery !== "undefined" && jQuery !== null ? (_ref = jQuery.fn) != null ? _ref.jquery : void 0 : void 0)) { + console.error(_t("Annotator requires jQuery: have you included lib/vendor/jquery.js?")); + } + + if (!(JSON && JSON.parse && JSON.stringify)) { + console.error(_t("Annotator requires a JSON implementation: have you included lib/vendor/json2.js?")); + } + + $ = jQuery.sub(); + + $.flatten = function(array) { + var flatten; + + flatten = function(ary) { + var el, flat, _i, _len; + + flat = []; + for (_i = 0, _len = ary.length; _i < _len; _i++) { + el = ary[_i]; + flat = flat.concat(el && $.isArray(el) ? flatten(el) : el); + } + return flat; + }; + return flatten(array); + }; + + $.plugin = function(name, object) { + return jQuery.fn[name] = function(options) { + var args; + + args = Array.prototype.slice.call(arguments, 1); + return this.each(function() { + var instance; + + instance = $.data(this, name); + if (instance) { + return options && instance[options].apply(instance, args); + } else { + instance = new object(this, options); + return $.data(this, name, instance); + } + }); + }; + }; + + $.fn.textNodes = function() { + var getTextNodes; + + getTextNodes = function(node) { + var nodes; + + if (node && node.nodeType !== 3) { + nodes = []; + if (node.nodeType !== 8) { + node = node.lastChild; + while (node) { + nodes.push(getTextNodes(node)); + node = node.previousSibling; + } + } + return nodes.reverse(); + } else { + return node; + } + }; + return this.map(function() { + return $.flatten(getTextNodes(this)); + }); + }; + + $.fn.xpath = function(relativeRoot) { + var exception, result; + + try { + result = simpleXPathJQuery.call(this, relativeRoot); + } catch (_error) { + exception = _error; + console.log("jQuery-based XPath construction failed! Falling back to manual."); + result = simpleXPathPure.call(this, relativeRoot); + } + return result; + }; + + $.xpath = function(xp, root) { + var idx, name, node, step, steps, _i, _len, _ref1; + + steps = xp.substring(1).split("/"); + node = root; + for (_i = 0, _len = steps.length; _i < _len; _i++) { + step = steps[_i]; + _ref1 = step.split("["), name = _ref1[0], idx = _ref1[1]; + idx = idx != null ? parseInt((idx != null ? idx.split("]") : void 0)[0]) : 1; + node = findChild(node, name.toLowerCase(), idx); + } + return node; + }; + + $.escape = function(html) { + return html.replace(/&(?!\w+;)/g, '&').replace(//g, '>').replace(/"/g, '"'); + }; + + $.fn.escape = function(html) { + if (arguments.length) { + return this.html($.escape(html)); + } + return this.html(); + }; + + $.fn.reverse = []._reverse || [].reverse; + + functions = ["log", "debug", "info", "warn", "exception", "assert", "dir", "dirxml", "trace", "group", "groupEnd", "groupCollapsed", "time", "timeEnd", "profile", "profileEnd", "count", "clear", "table", "error", "notifyFirebug", "firebug", "userObjects"]; + + if (typeof console !== "undefined" && console !== null) { + if (console.group == null) { + console.group = function(name) { + return console.log("GROUP: ", name); + }; + } + if (console.groupCollapsed == null) { + console.groupCollapsed = console.group; + } + for (_i = 0, _len = functions.length; _i < _len; _i++) { + fn = functions[_i]; + if (console[fn] == null) { + console[fn] = function() { + return console.log(_t("Not implemented:") + (" console." + name)); + }; + } + } + } else { + this.console = {}; + for (_j = 0, _len1 = functions.length; _j < _len1; _j++) { + fn = functions[_j]; + this.console[fn] = function() {}; + } + this.console['error'] = function() { + var args; + + args = 1 <= arguments.length ? __slice.call(arguments, 0) : []; + return alert("ERROR: " + (args.join(', '))); + }; + this.console['warn'] = function() { + var args; + + args = 1 <= arguments.length ? __slice.call(arguments, 0) : []; + return alert("WARNING: " + (args.join(', '))); + }; + } + + Delegator = (function() { + Delegator.prototype.events = {}; + + Delegator.prototype.options = {}; + + Delegator.prototype.element = null; + + function Delegator(element, options) { + this.options = $.extend(true, {}, this.options, options); + this.element = $(element); + this.on = this.subscribe; + this.addEvents(); + } + + Delegator.prototype.addEvents = function() { + var event, functionName, sel, selector, _k, _ref1, _ref2, _results; + + _ref1 = this.events; + _results = []; + for (sel in _ref1) { + functionName = _ref1[sel]; + _ref2 = sel.split(' '), selector = 2 <= _ref2.length ? __slice.call(_ref2, 0, _k = _ref2.length - 1) : (_k = 0, []), event = _ref2[_k++]; + _results.push(this.addEvent(selector.join(' '), event, functionName)); + } + return _results; + }; + + Delegator.prototype.addEvent = function(bindTo, event, functionName) { + var closure, isBlankSelector, + _this = this; + + closure = function() { + return _this[functionName].apply(_this, arguments); + }; + isBlankSelector = typeof bindTo === 'string' && bindTo.replace(/\s+/g, '') === ''; + if (isBlankSelector) { + bindTo = this.element; + } + if (typeof bindTo === 'string') { + this.element.delegate(bindTo, event, closure); + } else { + if (this.isCustomEvent(event)) { + this.subscribe(event, closure); + } else { + $(bindTo).bind(event, closure); + } + } + return this; + }; + + Delegator.prototype.isCustomEvent = function(event) { + event = event.split('.')[0]; + return $.inArray(event, Delegator.natives) === -1; + }; + + Delegator.prototype.publish = function() { + this.element.triggerHandler.apply(this.element, arguments); + return this; + }; + + Delegator.prototype.subscribe = function(event, callback) { + var closure; + + closure = function() { + return callback.apply(this, [].slice.call(arguments, 1)); + }; + closure.guid = callback.guid = ($.guid += 1); + this.element.bind(event, closure); + return this; + }; + + Delegator.prototype.unsubscribe = function() { + this.element.unbind.apply(this.element, arguments); + return this; + }; + + return Delegator; + + })(); + + Delegator.natives = (function() { + var key, specials, val; + + specials = (function() { + var _ref1, _results; + + _ref1 = jQuery.event.special; + _results = []; + for (key in _ref1) { + if (!__hasProp.call(_ref1, key)) continue; + val = _ref1[key]; + _results.push(key); + } + return _results; + })(); + return "blur focus focusin focusout load resize scroll unload click dblclick\nmousedown mouseup mousemove mouseover mouseout mouseenter mouseleave\nchange select submit keydown keypress keyup error".split(/[^a-z]+/).concat(specials); + })(); + + Range = {}; + + Range.sniff = function(r) { + if (r.commonAncestorContainer != null) { + return new Range.BrowserRange(r); + } else if (typeof r.start === "string") { + return new Range.SerializedRange(r); + } else if (r.start && typeof r.start === "object") { + return new Range.NormalizedRange(r); + } else { + console.error(_t("Could not sniff range type")); + return false; + } + }; + + Range.nodeFromXPath = function(xpath, root) { + var customResolver, evaluateXPath, namespace, node, segment; + + if (root == null) { + root = document; + } + evaluateXPath = function(xp, nsResolver) { + var exception; + + if (nsResolver == null) { + nsResolver = null; + } + try { + return document.evaluate('.' + xp, root, nsResolver, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue; + } catch (_error) { + exception = _error; + console.log("XPath evaluation failed."); + console.log("Trying fallback..."); + return $.xpath(xp, root); + } + }; + if (!$.isXMLDoc(document.documentElement)) { + return evaluateXPath(xpath); + } else { + customResolver = document.createNSResolver(document.ownerDocument === null ? document.documentElement : document.ownerDocument.documentElement); + node = evaluateXPath(xpath, customResolver); + if (!node) { + xpath = ((function() { + var _k, _len2, _ref1, _results; + + _ref1 = xpath.split('/'); + _results = []; + for (_k = 0, _len2 = _ref1.length; _k < _len2; _k++) { + segment = _ref1[_k]; + if (segment && segment.indexOf(':') === -1) { + _results.push(segment.replace(/^([a-z]+)/, 'xhtml:$1')); + } else { + _results.push(segment); + } + } + return _results; + })()).join('/'); + namespace = document.lookupNamespaceURI(null); + customResolver = function(ns) { + if (ns === 'xhtml') { + return namespace; + } else { + return document.documentElement.getAttribute('xmlns:' + ns); + } + }; + node = evaluateXPath(xpath, customResolver); + } + return node; + } + }; + + Range.RangeError = (function(_super) { + __extends(RangeError, _super); + + function RangeError(type, message, parent) { + this.type = type; + this.message = message; + this.parent = parent != null ? parent : null; + RangeError.__super__.constructor.call(this, this.message); + } + + return RangeError; + + })(Error); + + Range.BrowserRange = (function() { + function BrowserRange(obj) { + this.commonAncestorContainer = obj.commonAncestorContainer; + this.startContainer = obj.startContainer; + this.startOffset = obj.startOffset; + this.endContainer = obj.endContainer; + this.endOffset = obj.endOffset; + } + + BrowserRange.prototype.normalize = function(root) { + var it, node, nr, offset, p, r, _k, _len2, _ref1; + + if (this.tainted) { + console.error(_t("You may only call normalize() once on a BrowserRange!")); + return false; + } else { + this.tainted = true; + } + r = {}; + nr = {}; + _ref1 = ['start', 'end']; + for (_k = 0, _len2 = _ref1.length; _k < _len2; _k++) { + p = _ref1[_k]; + node = this[p + 'Container']; + offset = this[p + 'Offset']; + if (node.nodeType === 1) { + it = node.childNodes[offset]; + node = it || node.childNodes[offset - 1]; + if (node.nodeType === 1 && !node.firstChild) { + it = null; + node = node.previousSibling; + } + while (node.nodeType !== 3) { + node = node.firstChild; + } + offset = it ? 0 : node.nodeValue.length; + } + r[p] = node; + r[p + 'Offset'] = offset; + } + nr.start = r.startOffset > 0 ? r.start.splitText(r.startOffset) : r.start; + if (r.start === r.end) { + if ((r.endOffset - r.startOffset) < nr.start.nodeValue.length) { + nr.start.splitText(r.endOffset - r.startOffset); + } + nr.end = nr.start; + } else { + if (r.endOffset < r.end.nodeValue.length) { + r.end.splitText(r.endOffset); + } + nr.end = r.end; + } + nr.commonAncestor = this.commonAncestorContainer; + while (nr.commonAncestor.nodeType !== 1) { + nr.commonAncestor = nr.commonAncestor.parentNode; + } + return new Range.NormalizedRange(nr); + }; + + BrowserRange.prototype.serialize = function(root, ignoreSelector) { + return this.normalize(root).serialize(root, ignoreSelector); + }; + + return BrowserRange; + + })(); + + Range.NormalizedRange = (function() { + function NormalizedRange(obj) { + this.commonAncestor = obj.commonAncestor; + this.start = obj.start; + this.end = obj.end; + } + + NormalizedRange.prototype.normalize = function(root) { + return this; + }; + + NormalizedRange.prototype.limit = function(bounds) { + var nodes, parent, startParents, _k, _len2, _ref1; + + nodes = $.grep(this.textNodes(), function(node) { + return node.parentNode === bounds || $.contains(bounds, node.parentNode); + }); + if (!nodes.length) { + return null; + } + this.start = nodes[0]; + this.end = nodes[nodes.length - 1]; + startParents = $(this.start).parents(); + _ref1 = $(this.end).parents(); + for (_k = 0, _len2 = _ref1.length; _k < _len2; _k++) { + parent = _ref1[_k]; + if (startParents.index(parent) !== -1) { + this.commonAncestor = parent; + break; + } + } + return this; + }; + + NormalizedRange.prototype.serialize = function(root, ignoreSelector) { + var end, serialization, start; + + serialization = function(node, isEnd) { + var n, nodes, offset, origParent, textNodes, xpath, _k, _len2; + + if (ignoreSelector) { + origParent = $(node).parents(":not(" + ignoreSelector + ")").eq(0); + } else { + origParent = $(node).parent(); + } + xpath = origParent.xpath(root)[0]; + textNodes = origParent.textNodes(); + nodes = textNodes.slice(0, textNodes.index(node)); + offset = 0; + for (_k = 0, _len2 = nodes.length; _k < _len2; _k++) { + n = nodes[_k]; + offset += n.nodeValue.length; + } + if (isEnd) { + return [xpath, offset + node.nodeValue.length]; + } else { + return [xpath, offset]; + } + }; + start = serialization(this.start); + end = serialization(this.end, true); + return new Range.SerializedRange({ + start: start[0], + end: end[0], + startOffset: start[1], + endOffset: end[1] + }); + }; + + NormalizedRange.prototype.text = function() { + var node; + + return ((function() { + var _k, _len2, _ref1, _results; + + _ref1 = this.textNodes(); + _results = []; + for (_k = 0, _len2 = _ref1.length; _k < _len2; _k++) { + node = _ref1[_k]; + _results.push(node.nodeValue); + } + return _results; + }).call(this)).join(''); + }; + + NormalizedRange.prototype.textNodes = function() { + var end, start, textNodes, _ref1; + + textNodes = $(this.commonAncestor).textNodes(); + _ref1 = [textNodes.index(this.start), textNodes.index(this.end)], start = _ref1[0], end = _ref1[1]; + return $.makeArray(textNodes.slice(start, +end + 1 || 9e9)); + }; + + NormalizedRange.prototype.toRange = function() { + var range; + + range = document.createRange(); + range.setStartBefore(this.start); + range.setEndAfter(this.end); + return range; + }; + + return NormalizedRange; + + })(); + + Range.SerializedRange = (function() { + function SerializedRange(obj) { + this.start = obj.start; + this.startOffset = obj.startOffset; + this.end = obj.end; + this.endOffset = obj.endOffset; + } + + SerializedRange.prototype.normalize = function(root) { + var contains, e, length, node, p, range, tn, _k, _l, _len2, _len3, _ref1, _ref2; + + range = {}; + _ref1 = ['start', 'end']; + for (_k = 0, _len2 = _ref1.length; _k < _len2; _k++) { + p = _ref1[_k]; + try { + node = Range.nodeFromXPath(this[p], root); + } catch (_error) { + e = _error; + throw new Range.RangeError(p, ("Error while finding " + p + " node: " + this[p] + ": ") + e, e); + } + if (!node) { + throw new Range.RangeError(p, "Couldn't find " + p + " node: " + this[p]); + } + length = 0; + _ref2 = $(node).textNodes(); + for (_l = 0, _len3 = _ref2.length; _l < _len3; _l++) { + tn = _ref2[_l]; + if (length + tn.nodeValue.length >= this[p + 'Offset']) { + range[p + 'Container'] = tn; + range[p + 'Offset'] = this[p + 'Offset'] - length; + break; + } else { + length += tn.nodeValue.length; + } + } + if (range[p + 'Offset'] == null) { + throw new Range.RangeError("" + p + "offset", "Couldn't find offset " + this[p + 'Offset'] + " in element " + this[p]); + } + } + contains = document.compareDocumentPosition == null ? function(a, b) { + return a.contains(b); + } : function(a, b) { + return a.compareDocumentPosition(b) & 16; + }; + $(range.startContainer).parents().each(function() { + if (contains(this, range.endContainer)) { + range.commonAncestorContainer = this; + return false; + } + }); + return new Range.BrowserRange(range).normalize(root); + }; + + SerializedRange.prototype.serialize = function(root, ignoreSelector) { + return this.normalize(root).serialize(root, ignoreSelector); + }; + + SerializedRange.prototype.toObject = function() { + return { + start: this.start, + startOffset: this.startOffset, + end: this.end, + endOffset: this.endOffset + }; + }; + + return SerializedRange; + + })(); + + util = { + uuid: (function() { + var counter; + + counter = 0; + return function() { + return counter++; + }; + })(), + getGlobal: function() { + return (function() { + return this; + })(); + }, + maxZIndex: function($elements) { + var all, el; + + all = (function() { + var _k, _len2, _results; + + _results = []; + for (_k = 0, _len2 = $elements.length; _k < _len2; _k++) { + el = $elements[_k]; + if ($(el).css('position') === 'static') { + _results.push(-1); + } else { + _results.push(parseInt($(el).css('z-index'), 10) || -1); + } + } + return _results; + })(); + return Math.max.apply(Math, all); + }, + mousePosition: function(e, offsetEl) { + var offset; + + offset = $(offsetEl).position(); + return { + top: e.pageY - offset.top, + left: e.pageX - offset.left + }; + }, + preventEventDefault: function(event) { + return event != null ? typeof event.preventDefault === "function" ? event.preventDefault() : void 0 : void 0; + } + }; + + _Annotator = this.Annotator; + + Annotator = (function(_super) { + __extends(Annotator, _super); + + Annotator.prototype.events = { + ".annotator-adder button click": "onAdderClick", + ".annotator-adder button mousedown": "onAdderMousedown", + ".annotator-hl mouseover": "onHighlightMouseover", + ".annotator-hl mouseout": "startViewerHideTimer" + }; + + Annotator.prototype.html = { + adder: '
          ', + wrapper: '
          ' + }; + + Annotator.prototype.options = { + readOnly: false + }; + + Annotator.prototype.plugins = {}; + + Annotator.prototype.editor = null; + + Annotator.prototype.viewer = null; + + Annotator.prototype.selectedRanges = null; + + Annotator.prototype.mouseIsDown = false; + + Annotator.prototype.ignoreMouseup = false; + + Annotator.prototype.viewerHideTimer = null; + + function Annotator(element, options) { + this.onDeleteAnnotation = __bind(this.onDeleteAnnotation, this); + this.onEditAnnotation = __bind(this.onEditAnnotation, this); + this.onAdderClick = __bind(this.onAdderClick, this); + this.onAdderMousedown = __bind(this.onAdderMousedown, this); + this.onHighlightMouseover = __bind(this.onHighlightMouseover, this); + this.checkForEndSelection = __bind(this.checkForEndSelection, this); + this.checkForStartSelection = __bind(this.checkForStartSelection, this); + this.clearViewerHideTimer = __bind(this.clearViewerHideTimer, this); + this.startViewerHideTimer = __bind(this.startViewerHideTimer, this); + this.showViewer = __bind(this.showViewer, this); + this.onEditorSubmit = __bind(this.onEditorSubmit, this); + this.onEditorHide = __bind(this.onEditorHide, this); + this.showEditor = __bind(this.showEditor, this); Annotator.__super__.constructor.apply(this, arguments); + this.plugins = {}; + if (!Annotator.supported()) { + return this; + } + if (!this.options.readOnly) { + this._setupDocumentEvents(); + } + this._setupWrapper()._setupViewer()._setupEditor(); + this._setupDynamicStyle(); + this.adder = $(this.html.adder).appendTo(this.wrapper).hide(); + } + + Annotator.prototype._setupWrapper = function() { + this.wrapper = $(this.html.wrapper); + this.element.find('script').remove(); + this.element.wrapInner(this.wrapper); + this.wrapper = this.element.find('.annotator-wrapper'); + return this; + }; + + Annotator.prototype._setupViewer = function() { + var _this = this; + + this.viewer = new Annotator.Viewer({ + readOnly: this.options.readOnly + }); + this.viewer.hide().on("edit", this.onEditAnnotation).on("delete", this.onDeleteAnnotation).addField({ + load: function(field, annotation) { + if (annotation.text) { + $(field).escape(annotation.text); + } else { + $(field).html("" + (_t('No Comment')) + ""); + } + return _this.publish('annotationViewerTextField', [field, annotation]); + } + }).element.appendTo(this.wrapper).bind({ + "mouseover": this.clearViewerHideTimer, + "mouseout": this.startViewerHideTimer + }); + return this; + }; + + Annotator.prototype._setupEditor = function() { + this.editor = new Annotator.Editor(); + this.editor.hide().on('hide', this.onEditorHide).on('save', this.onEditorSubmit).addField({ + type: 'textarea', + label: _t('Comments') + '\u2026', + load: function(field, annotation) { + return $(field).find('textarea').val(annotation.text || ''); + }, + submit: function(field, annotation) { + return annotation.text = $(field).find('textarea').val(); + } + }); + this.editor.element.appendTo(this.wrapper); + return this; + }; + + Annotator.prototype._setupDocumentEvents = function() { + $(document).bind({ + "mouseup": this.checkForEndSelection, + "mousedown": this.checkForStartSelection + }); + return this; + }; + + Annotator.prototype._setupDynamicStyle = function() { + var max, sel, style, x; + + style = $('#annotator-dynamic-style'); + if (!style.length) { + style = $('').appendTo(document.head); + } + sel = '*' + ((function() { + var _k, _len2, _ref1, _results; + + _ref1 = ['adder', 'outer', 'notice', 'filter']; + _results = []; + for (_k = 0, _len2 = _ref1.length; _k < _len2; _k++) { + x = _ref1[_k]; + _results.push(":not(.annotator-" + x + ")"); + } + return _results; + })()).join(''); + max = util.maxZIndex($(document.body).find(sel)); + max = Math.max(max, 1000); + style.text([".annotator-adder, .annotator-outer, .annotator-notice {", " z-index: " + (max + 20) + ";", "}", ".annotator-filter {", " z-index: " + (max + 10) + ";", "}"].join("\n")); + return this; + }; + + Annotator.prototype.getSelectedRanges = function() { + var browserRange, i, normedRange, r, ranges, rangesToIgnore, selection, _k, _len2; + + selection = util.getGlobal().getSelection(); + ranges = []; + rangesToIgnore = []; + if (!selection.isCollapsed) { + ranges = (function() { + var _k, _ref1, _results; + + _results = []; + for (i = _k = 0, _ref1 = selection.rangeCount; 0 <= _ref1 ? _k < _ref1 : _k > _ref1; i = 0 <= _ref1 ? ++_k : --_k) { + r = selection.getRangeAt(i); + browserRange = new Range.BrowserRange(r); + normedRange = browserRange.normalize().limit(this.wrapper[0]); + if (normedRange === null) { + rangesToIgnore.push(r); + } + _results.push(normedRange); + } + return _results; + }).call(this); + selection.removeAllRanges(); + } + for (_k = 0, _len2 = rangesToIgnore.length; _k < _len2; _k++) { + r = rangesToIgnore[_k]; + selection.addRange(r); + } + return $.grep(ranges, function(range) { + if (range) { + selection.addRange(range.toRange()); + } + return range; + }); + }; + + Annotator.prototype.createAnnotation = function() { + var annotation; + + annotation = {}; + this.publish('beforeAnnotationCreated', [annotation]); + return annotation; + }; + + Annotator.prototype.setupAnnotation = function(annotation) { + var e, normed, normedRanges, r, root, _k, _l, _len2, _len3, _ref1; + + root = this.wrapper[0]; + annotation.ranges || (annotation.ranges = this.selectedRanges); + normedRanges = []; + _ref1 = annotation.ranges; + for (_k = 0, _len2 = _ref1.length; _k < _len2; _k++) { + r = _ref1[_k]; + try { + normedRanges.push(Range.sniff(r).normalize(root)); + } catch (_error) { + e = _error; + if (e instanceof Range.RangeError) { + this.publish('rangeNormalizeFail', [annotation, r, e]); + } else { + throw e; + } + } + } + annotation.quote = []; + annotation.ranges = []; + annotation.highlights = []; + for (_l = 0, _len3 = normedRanges.length; _l < _len3; _l++) { + normed = normedRanges[_l]; + annotation.quote.push($.trim(normed.text())); + annotation.ranges.push(normed.serialize(this.wrapper[0], '.annotator-hl')); + $.merge(annotation.highlights, this.highlightRange(normed)); + } + annotation.quote = annotation.quote.join(' / '); + $(annotation.highlights).data('annotation', annotation); + return annotation; + }; + + Annotator.prototype.updateAnnotation = function(annotation) { + this.publish('beforeAnnotationUpdated', [annotation]); + this.publish('annotationUpdated', [annotation]); + return annotation; + }; + + Annotator.prototype.deleteAnnotation = function(annotation) { + var child, h, _k, _len2, _ref1; + + if (annotation.highlights != null) { + _ref1 = annotation.highlights; + for (_k = 0, _len2 = _ref1.length; _k < _len2; _k++) { + h = _ref1[_k]; + if (!(h.parentNode != null)) { + continue; + } + child = h.childNodes[0]; + $(h).replaceWith(h.childNodes); + } + } + this.publish('annotationDeleted', [annotation]); + return annotation; + }; + + Annotator.prototype.loadAnnotations = function(annotations) { + var clone, loader, + _this = this; + + if (annotations == null) { + annotations = []; + } + loader = function(annList) { + var n, now, _k, _len2; + + if (annList == null) { + annList = []; + } + now = annList.splice(0, 10); + for (_k = 0, _len2 = now.length; _k < _len2; _k++) { + n = now[_k]; + _this.setupAnnotation(n); + } + if (annList.length > 0) { + return setTimeout((function() { + return loader(annList); + }), 10); + } else { + return _this.publish('annotationsLoaded', [clone]); + } + }; + clone = annotations.slice(); + if (annotations.length) { + loader(annotations); + } + return this; + }; + + Annotator.prototype.dumpAnnotations = function() { + if (this.plugins['Store']) { + return this.plugins['Store'].dumpAnnotations(); + } else { + console.warn(_t("Can't dump annotations without Store plugin.")); + return false; + } + }; + + Annotator.prototype.highlightRange = function(normedRange, cssClass) { + var hl, node, white, _k, _len2, _ref1, _results; + + if (cssClass == null) { + cssClass = 'annotator-hl'; + } + white = /^\s*$/; + hl = $(""); + _ref1 = normedRange.textNodes(); + _results = []; + for (_k = 0, _len2 = _ref1.length; _k < _len2; _k++) { + node = _ref1[_k]; + if (!white.test(node.nodeValue)) { + _results.push($(node).wrapAll(hl).parent().show()[0]); + } + } + return _results; + }; + + Annotator.prototype.highlightRanges = function(normedRanges, cssClass) { + var highlights, r, _k, _len2; + + if (cssClass == null) { + cssClass = 'annotator-hl'; + } + highlights = []; + for (_k = 0, _len2 = normedRanges.length; _k < _len2; _k++) { + r = normedRanges[_k]; + $.merge(highlights, this.highlightRange(r, cssClass)); + } + return highlights; + }; + + Annotator.prototype.addPlugin = function(name, options) { + var klass, _base; + + if (this.plugins[name]) { + console.error(_t("You cannot have more than one instance of any plugin.")); + } else { + klass = Annotator.Plugin[name]; + if (typeof klass === 'function') { + this.plugins[name] = new klass(this.element[0], options); + this.plugins[name].annotator = this; + if (typeof (_base = this.plugins[name]).pluginInit === "function") { + _base.pluginInit(); + } + } else { + console.error(_t("Could not load ") + name + _t(" plugin. Have you included the appropriate + {% load compressed %} {# static files #} @@ -37,15 +38,14 @@ + - + + + + + + + + - - + + diff --git a/common/test/data/embedded_python/course.xml b/common/test/data/embedded_python/course.xml new file mode 100644 index 0000000000..1662543b4d --- /dev/null +++ b/common/test/data/embedded_python/course.xml @@ -0,0 +1 @@ + diff --git a/common/test/data/embedded_python/course/2013_Spring.xml b/common/test/data/embedded_python/course/2013_Spring.xml new file mode 100644 index 0000000000..fa6881c37b --- /dev/null +++ b/common/test/data/embedded_python/course/2013_Spring.xml @@ -0,0 +1,111 @@ + + + + + + +
          + +
          + +# for a schematic response, submission[i] is the json representation +# of the diagram and analysis results for the i-th schematic tag + +def get_tran(json,signal): + for element in json: + if element[0] == 'transient': + return element[1].get(signal,[]) + return [] + +def get_value(at,output): + for (t,v) in output: + if at == t: return v + return None + +output = get_tran(submission[0],'Z') +okay = True + +# output should be 1, 1, 1, 1, 1, 0, 0, 0 +if get_value(0.0000004,output) < 2.7: okay = False; +if get_value(0.0000009,output) < 2.7: okay = False; +if get_value(0.0000014,output) < 2.7: okay = False; +if get_value(0.0000019,output) < 2.7: okay = False; +if get_value(0.0000024,output) < 2.7: okay = False; +if get_value(0.0000029,output) > 0.25: okay = False; +if get_value(0.0000034,output) > 0.25: okay = False; +if get_value(0.0000039,output) > 0.25: okay = False; + +correct = ['correct' if okay else 'incorrect'] + +           + + + + +           + + + + + + +
            +
          1. + 
            +num = 0
+while num <= 5:
+    print(num)
+    num += 1
+
+print("Outside of loop")
+print(num)
+
            +

            + + + +

            +
            2. +
          +           +           + + + + + + +if submission[0] == "Xyzzy": + correct = ['correct'] +else: + correct = ['incorrect'] + + + + + +           +           +           diff --git a/common/test/data/embedded_python/roots/2013_Spring.xml b/common/test/data/embedded_python/roots/2013_Spring.xml new file mode 100644 index 0000000000..1662543b4d --- /dev/null +++ b/common/test/data/embedded_python/roots/2013_Spring.xml @@ -0,0 +1 @@ + diff --git a/common/test/data/full/course.xml b/common/test/data/full/course.xml index 7a05db42f2..b2f9097020 100644 --- a/common/test/data/full/course.xml +++ b/common/test/data/full/course.xml @@ -1 +1 @@ - + diff --git a/common/test/data/full/problem/test_files/symbolicresponse.xml b/common/test/data/full/problem/test_files/symbolicresponse.xml index 4dc2bc9d7b..85945b1d8c 100644 --- a/common/test/data/full/problem/test_files/symbolicresponse.xml +++ b/common/test/data/full/problem/test_files/symbolicresponse.xml @@ -19,7 +19,7 @@ from symmath import * Compute [mathjax] U = \exp\left( i \theta \left[ \begin{matrix} 0 & 1 \\ 1 & 0 \end{matrix} \right] \right) [/mathjax] and give the resulting \(2 \times 2\) matrix.
          Your input should be typed in as a list of lists, eg [[1,2],[3,4]].
          - [mathjax]U=[/mathjax] + [mathjax]U=[/mathjax]
          diff --git a/common/test/data/full/sequential/Administrivia_and_Circuit_Elements.xml b/common/test/data/full/sequential/Administrivia_and_Circuit_Elements.xml index 26f8f5a08d..47b19f75ed 100644 --- a/common/test/data/full/sequential/Administrivia_and_Circuit_Elements.xml +++ b/common/test/data/full/sequential/Administrivia_and_Circuit_Elements.xml @@ -12,4 +12,13 @@ Minor correction: Six elements (five resistors)… + + + + + +

          Inline content…

          + +           +           diff --git a/common/test/phantom-jasmine b/common/test/phantom-jasmine deleted file mode 160000 index a54d435b55..0000000000 --- a/common/test/phantom-jasmine +++ /dev/null @@ -1 +0,0 @@ -Subproject commit a54d435b5556650efbcdb0490e6c7928ac75238a diff --git a/distribute-0.6.32.tar.gz b/distribute-0.6.32.tar.gz deleted file mode 100644 index 2438db60fa..0000000000 Binary files a/distribute-0.6.32.tar.gz and /dev/null differ diff --git a/distribute-0.6.34.tar.gz b/distribute-0.6.34.tar.gz deleted file mode 100644 index 4e91b3af62..0000000000 Binary files a/distribute-0.6.34.tar.gz and /dev/null differ diff --git a/doc/README b/doc/README index d40f5d988d..395fc07dc5 100644 --- a/doc/README +++ b/doc/README @@ -1,3 +1,3 @@ -This directory contains some high level documentation for the code. We should strive to keep it up-to-date, but don't take it as the absolute truth. +This directory contains some high level documentation for the code. -A good place to start is 'overview.md' +WARNING: much of this is out-of-date. It stil may be helpful, though. diff --git a/doc/development.md b/doc/development.md index a6a1de4ef7..c99e99f906 100644 --- a/doc/development.md +++ b/doc/development.md @@ -36,7 +36,7 @@ Check out the course data directories that you want to work with into the To create your development environment, run the shell script in the root of the repo: - create-dev-env.sh + scripts/create-dev-env.sh ## Starting development servers diff --git a/doc/overview.md b/doc/overview.md index f64d12920d..4d074dfaf3 100644 --- a/doc/overview.md +++ b/doc/overview.md @@ -1,4 +1,4 @@ -# Documentation for edX code (mitx repo) +# Documentation for edX code (edx-platform repo) This document explains the general structure of the edX platform, and defines some of the acronyms and terms you'll see flying around in the code. diff --git a/doc/testing.md b/doc/testing.md index 84175fee3d..4d286b1bcc 100644 --- a/doc/testing.md +++ b/doc/testing.md @@ -8,7 +8,7 @@ and acceptance tests. ### Unit Tests * Each test case should be concise: setup, execute, check, and teardown. -If you find yourself writing tests with many steps, consider refactoring +If you find yourself writing tests with many steps, consider refactoring the unit under tests into smaller units, and then testing those individually. * As a rule of thumb, your unit tests should cover every code branch. @@ -16,19 +16,19 @@ the unit under tests into smaller units, and then testing those individually. * Mock or patch external dependencies. We use [voidspace mock](http://www.voidspace.org.uk/python/mock/). -* We unit test Python code (using [unittest](http://docs.python.org/2/library/unittest.html)) and +* We unit test Python code (using [unittest](http://docs.python.org/2/library/unittest.html)) and Javascript (using [Jasmine](http://pivotal.github.io/jasmine/)) ### Integration Tests * Test several units at the same time. Note that you can still mock or patch dependencies -that are not under test! For example, you might test that -`LoncapaProblem`, `NumericalResponse`, and `CorrectMap` in the +that are not under test! For example, you might test that +`LoncapaProblem`, `NumericalResponse`, and `CorrectMap` in the `capa` package work together, while still mocking out template rendering. * Use integration tests to ensure that units are hooked up correctly. -You do not need to test every possible input--that's what unit -tests are for. Instead, focus on testing the "happy path" +You do not need to test every possible input--that's what unit +tests are for. Instead, focus on testing the "happy path" to verify that the components work together correctly. * Many of our tests use the [Django test client](https://docs.djangoproject.com/en/dev/topics/testing/overview/) to simulate @@ -43,8 +43,8 @@ these tests simulate user interactions through the browser using Overall, you want to write the tests that **maximize coverage** while **minimizing maintenance**. -In practice, this usually means investing heavily -in unit tests, which tend to be the most robust to changes in the code base. +In practice, this usually means investing heavily +in unit tests, which tend to be the most robust to changes in the code base. ![Test Pyramid](test_pyramid.png) @@ -53,13 +53,13 @@ and acceptance tests. Most of our tests are unit tests or integration tests. ## Test Locations -* Python unit and integration tests: Located in +* Python unit and integration tests: Located in subpackages called `tests`. -For example, the tests for the `capa` package are located in +For example, the tests for the `capa` package are located in `common/lib/capa/capa/tests`. * Javascript unit tests: Located in `spec` folders. For example, -`common/lib/xmodule/xmodule/js/spec` and `{cms,lms}/static/coffee/spec` +`common/lib/xmodule/xmodule/js/spec` and `{cms,lms}/static/coffee/spec` For consistency, you should use the same directory structure for implementation and test. For example, the test for `src/views/module.coffee` should be written in `spec/views/module_spec.coffee`. @@ -88,7 +88,7 @@ because the `capa` package handles problem XML. Before running tests, ensure that you have all the dependencies. You can install dependencies using: - pip install -r requirements.txt + rake install_prereqs ## Running Python Unit tests @@ -101,7 +101,7 @@ You can run tests using `rake` commands. For example, rake test -runs all the tests. It also runs `collectstatic`, which prepares the static files used by the site (for example, compiling Coffeescript to Javascript). +runs all the tests. It also runs `collectstatic`, which prepares the static files used by the site (for example, compiling Coffeescript to Javascript). You can also run the tests without `collectstatic`, which tends to be faster: @@ -115,14 +115,18 @@ xmodule can be tested independently, with this: rake test_common/lib/xmodule +other module level tests include + +* `rake test_common/lib/capa` +* `rake test_common/lib/calc` + To run a single django test class: - django-admin.py test --settings=lms.envs.test --pythonpath=. lms/djangoapps/courseware/tests/tests.py:TestViewAuth + rake test_lms[courseware.tests.tests:testViewAuth] To run a single django test: - django-admin.py test --settings=lms.envs.test --pythonpath=. lms/djangoapps/courseware/tests/tests.py:TestViewAuth.test_dark_launch - + rake test_lms[courseware.tests.tests:TestViewAuth.test_dark_launch] To run a single nose test file: @@ -150,7 +154,7 @@ If the `phantomjs` binary is not on the path, set the `PHANTOMJS_PATH` environme PHANTOMJS_PATH=/path/to/phantomjs rake phantomjs_jasmine_{lms,cms} -Once you have run the `rake` command, your browser should open to +Once you have run the `rake` command, your browser should open to to `http://localhost/_jasmine/`, which displays the test results. **Troubleshooting**: If you get an error message while running the `rake` task, @@ -161,36 +165,30 @@ try running `bundle install` to install the required ruby gems. We use [Lettuce](http://lettuce.it/) for acceptance testing. Most of our tests use [Splinter](http://splinter.cobrateam.info/) to simulate UI browser interactions. Splinter, in turn, -uses [Selenium](http://docs.seleniumhq.org/) to control the browser. +uses [Selenium](http://docs.seleniumhq.org/) to control the Chrome browser. -**Prerequisite**: You must have [ChromeDriver](https://code.google.com/p/selenium/wiki/ChromeDriver) -installed to run the tests in Chrome. +**Prerequisite**: You must have [ChromeDriver](https://code.google.com/p/selenium/wiki/ChromeDriver) +installed to run the tests in Chrome. The tests are confirmed to run +with Chrome (not Chromium) version 26.0.0.1410.63 with ChromeDriver +version r195636. -Before running the tests, you need to set up the test database: +To run all the acceptance tests: - rm ../db/test_mitx.db - rake django-admin[syncdb,lms,acceptance,--noinput] - rake django-admin[migrate,lms,acceptance,--noinput] - -To run the acceptance tests: - -1. Start the Django server locally using the settings in **acceptance.py**: - - rake lms[acceptance] - -2. In another shell, run the tests: - - django-admin.py harvest --no-server --settings=lms.envs.acceptance --pythonpath=. lms/djangoapps/portal/features/ + rake test_acceptance_lms + rake test_acceptance_cms To test only a specific feature: - django-admin.py harvest --no-server --settings=lms.envs.acceptance --pythonpath=. lms/djangoapps/courseware/features/high-level-tabs.feature + rake test_acceptance_lms[lms/djangoapps/courseware/features/problems.feature] -**Troubleshooting**: If you get an error message that says something about harvest not being a command, you probably are missing a requirement. -Try running: +To start the debugger on failure, add the `--pdb` option: - pip install -r requirements.txt + rake test_acceptance_lms["lms/djangoapps/courseware/features/problems.feature --pdb"] +To run tests faster by not collecting static files, you can use +`rake fasttest_acceptance_lms` and `rake fasttest_acceptance_cms`. + +**Note**: The acceptance tests can *not* currently run in parallel. ## Viewing Test Coverage diff --git a/fixtures/anonymize_fixtures.py b/fixtures/anonymize_fixtures.py deleted file mode 100755 index ba62652de5..0000000000 --- a/fixtures/anonymize_fixtures.py +++ /dev/null @@ -1,98 +0,0 @@ -#! /usr/bin/env python - -import sys -import json -import random -import copy -from collections import defaultdict -from argparse import ArgumentParser, FileType -from datetime import datetime - -def generate_user(user_number): - return { - "pk": user_number, - "model": "auth.user", - "fields": { - "status": "w", - "last_name": "Last", - "gold": 0, - "is_staff": False, - "user_permissions": [], - "interesting_tags": "", - "email_key": None, - "date_joined": "2012-04-26 11:36:39", - "first_name": "", - "email_isvalid": False, - "avatar_type": "n", - "website": "", - "is_superuser": False, - "date_of_birth": None, - "last_login": "2012-04-26 11:36:48", - "location": "", - "new_response_count": 0, - "email": "user{num}@example.com".format(num=user_number), - "username": "user{num}".format(num=user_number), - "is_active": True, - "consecutive_days_visit_count": 0, - "email_tag_filter_strategy": 1, - "groups": [], - "password": "sha1$90e6f$562a1d783a0c47ce06ebf96b8c58123a0671bbf0", - "silver": 0, - "bronze": 0, - "questions_per_page": 10, - "about": "", - "show_country": True, - "country": "", - "display_tag_filter_strategy": 0, - "seen_response_count": 0, - "real_name": "", - "ignored_tags": "", - "reputation": 1, - "gravatar": "366d981a10116969c568a18ee090f44c", - "last_seen": "2012-04-26 11:36:39" - } - } - - -def parse_args(args=sys.argv[1:]): - parser = ArgumentParser() - parser.add_argument('-d', '--data', type=FileType('r'), default=sys.stdin) - parser.add_argument('-o', '--output', type=FileType('w'), default=sys.stdout) - parser.add_argument('count', type=int) - return parser.parse_args(args) - - -def main(args=sys.argv[1:]): - args = parse_args(args) - - data = json.load(args.data) - unique_students = set(entry['fields']['student'] for entry in data) - if args.count > len(unique_students) * 0.1: - raise Exception("Can't be sufficiently anonymous selecting {count} of {unique} students".format( - count=args.count, unique=len(unique_students))) - - by_problems = defaultdict(list) - for entry in data: - by_problems[entry['fields']['module_id']].append(entry) - - out_data = [] - out_pk = 1 - for name, answers in by_problems.items(): - for student_id in xrange(args.count): - sample = random.choice(answers) - data = copy.deepcopy(sample) - data["fields"]["student"] = student_id + 1 - data["fields"]["created"] = datetime.now().strftime("%Y-%m-%d %H:%M:%S") - data["fields"]["modified"] = datetime.now().strftime("%Y-%m-%d %H:%M:%S") - data["pk"] = out_pk - out_pk += 1 - out_data.append(data) - - for student_id in xrange(args.count): - out_data.append(generate_user(student_id)) - - json.dump(out_data, args.output, indent=2) - - -if __name__ == "__main__": - sys.exit(main()) diff --git a/fixtures/pm.json b/fixtures/pm.json deleted file mode 100644 index 5ecb839093..0000000000 --- a/fixtures/pm.json +++ /dev/null @@ -1 +0,0 @@ -[{"pk": 1, "model": "user.userprofile", "fields": {"name": "pm", "language": "pm", "courseware": "course.xml", "meta": "", "location": "pm", "user": 1}}, {"pk": 1, "model": "auth.user", "fields": {"status": "w", "last_name": "", "gold": 0, "is_staff": true, "user_permissions": [], "interesting_tags": "", "email_key": null, "date_joined": "2012-01-23 17:03:54", "first_name": "", "email_isvalid": false, "avatar_type": "n", "website": "", "is_superuser": true, "date_of_birth": null, "last_login": "2012-01-23 17:04:16", "location": "", "new_response_count": 0, "email": "pmitros@csail.mit.edu", "username": "pm", "is_active": true, "consecutive_days_visit_count": 0, "email_tag_filter_strategy": 1, "groups": [], "password": "sha1$a3e96$dbabbd114f0da01bce2cc2adcafa2ca651c7ae0a", "silver": 0, "bronze": 0, "questions_per_page": 10, "about": "", "show_country": false, "country": "", "display_tag_filter_strategy": 0, "seen_response_count": 0, "real_name": "", "ignored_tags": "", "reputation": 1, "gravatar": "7a591afd0cc7972fdbe5e12e26af352a", "last_seen": "2012-01-23 17:04:41"}}, {"pk": 1, "model": "user.userprofile", "fields": {"name": "pm", "language": "pm", "courseware": "course.xml", "meta": "", "location": "pm", "user": 1}}, {"pk": 1, "model": "auth.user", "fields": {"status": "w", "last_name": "", "gold": 0, "is_staff": true, "user_permissions": [], "interesting_tags": "", "email_key": null, "date_joined": "2012-01-23 17:03:54", "first_name": "", "email_isvalid": false, "avatar_type": "n", "website": "", "is_superuser": true, "date_of_birth": null, "last_login": "2012-01-23 17:04:16", "location": "", "new_response_count": 0, "email": "pmitros@csail.mit.edu", "username": "pm", "is_active": true, "consecutive_days_visit_count": 0, "email_tag_filter_strategy": 1, "groups": [], "password": "sha1$a3e96$dbabbd114f0da01bce2cc2adcafa2ca651c7ae0a", "silver": 0, "bronze": 0, "questions_per_page": 10, "about": "", "show_country": false, "country": "", "display_tag_filter_strategy": 0, "seen_response_count": 0, "real_name": "", "ignored_tags": "", "reputation": 1, "gravatar": "7a591afd0cc7972fdbe5e12e26af352a", "last_seen": "2012-01-23 17:04:41"}}] \ No newline at end of file diff --git a/jenkins/base.sh b/jenkins/base.sh deleted file mode 100644 index 7eb4802b8f..0000000000 --- a/jenkins/base.sh +++ /dev/null @@ -1,25 +0,0 @@ -## -## requires >= 1.3.0 of the Jenkins git plugin -## - -function github_status { - - if [[ ! ${GIT_URL} =~ git@github.com:([^/]+)/([^\.]+).git ]]; then - echo "Cannot parse Github org or repo from URL, using defaults." - ORG="edx" - REPO="mitx" - else - ORG=${BASH_REMATCH[1]} - REPO=${BASH_REMATCH[2]} - fi - - gcli status create $ORG $REPO $GIT_COMMIT \ - --params=$1 \ - target_url:$BUILD_URL \ - description:"Build #$BUILD_NUMBER is running" \ - -f csv -} - -function github_mark_failed_on_exit { - trap '[ $? == "0" ] || github_status state:failed' EXIT -} diff --git a/jenkins/test.sh b/jenkins/test.sh index a90cc8e806..35be3a0121 100755 --- a/jenkins/test.sh +++ b/jenkins/test.sh @@ -3,8 +3,21 @@ set -e set -x +## +## requires >= 1.3.0 of the Jenkins git plugin +## + function github_status { - gcli status create edx edx-platform $GIT_COMMIT \ + if [[ ! ${GIT_URL} =~ git@github.com:([^/]+)/([^\.]+).git ]]; then + echo "Cannot parse Github org or repo from URL, using defaults." + ORG="edx" + REPO="edx-platform" + else + ORG=${BASH_REMATCH[1]} + REPO=${BASH_REMATCH[2]} + fi + + gcli status create $ORG $REPO $GIT_COMMIT \ --params=$1 \ target_url:$BUILD_URL \ description:"Build #$BUILD_NUMBER $2" \ @@ -27,21 +40,32 @@ git submodule foreach 'git reset --hard HEAD' export PYTHONIOENCODING=UTF-8 GIT_BRANCH=${GIT_BRANCH/HEAD/master} -if [ ! -d /mnt/virtualenvs/"$JOB_NAME" ]; then - mkdir -p /mnt/virtualenvs/"$JOB_NAME" - virtualenv /mnt/virtualenvs/"$JOB_NAME" + +# When running in parallel on jenkins, workspace could be suffixed by @x +# In that case, we want to use a separate virtualenv that matches up with +# workspace +# +# We need to handle both the case of /path/to/workspace +# and /path/to/workspace@2, which is why we use the following substitutions +# +# $WORKSPACE is the absolute path for the workspace +WORKSPACE_SUFFIX=$(expr "$WORKSPACE" : '.*\(@.*\)') || true + +VIRTUALENV_DIR="/mnt/virtualenvs/${JOB_NAME}${WORKSPACE_SUFFIX}" + +if [ ! -d "$VIRTUALENV_DIR" ]; then + mkdir -p "$VIRTUALENV_DIR" + virtualenv "$VIRTUALENV_DIR" fi export PIP_DOWNLOAD_CACHE=/mnt/pip-cache +# Allow django liveserver tests to use a range of ports +export DJANGO_LIVE_TEST_SERVER_ADDRESS=${DJANGO_LIVE_TEST_SERVER_ADDRESS-localhost:8000-9000} + source /mnt/virtualenvs/"$JOB_NAME"/bin/activate -pip install -q -r pre-requirements.txt -yes w | pip install -q -r requirements.txt - -bundle install - -npm install +rake install_prereqs rake clobber rake pep8 > pep8.log || cat pep8.log rake pylint > pylint.log || cat pylint.log @@ -49,15 +73,16 @@ rake pylint > pylint.log || cat pylint.log TESTS_FAILED=0 # Run the python unit tests -rake test_cms[false] || TESTS_FAILED=1 -rake test_lms[false] || TESTS_FAILED=1 +rake test_cms || TESTS_FAILED=1 +rake test_lms || TESTS_FAILED=1 rake test_common/lib/capa || TESTS_FAILED=1 rake test_common/lib/xmodule || TESTS_FAILED=1 -# Run the jaavascript unit tests +# Run the javascript unit tests rake phantomjs_jasmine_lms || TESTS_FAILED=1 rake phantomjs_jasmine_cms || TESTS_FAILED=1 rake phantomjs_jasmine_common/lib/xmodule || TESTS_FAILED=1 +rake phantomjs_jasmine_common/static/coffee || TESTS_FAILED=1 rake coverage:xml coverage:html diff --git a/jenkins/test_acceptance.sh b/jenkins/test_acceptance.sh new file mode 100755 index 0000000000..1d11265d08 --- /dev/null +++ b/jenkins/test_acceptance.sh @@ -0,0 +1,39 @@ +#! /bin/bash + +set -e +set -x + +git remote prune origin + +# Reset the submodule, in case it changed +git submodule foreach 'git reset --hard HEAD' + +# Set the IO encoding to UTF-8 so that askbot will start +export PYTHONIOENCODING=UTF-8 + +if [ ! -d /mnt/virtualenvs/"$JOB_NAME" ]; then + mkdir -p /mnt/virtualenvs/"$JOB_NAME" + virtualenv /mnt/virtualenvs/"$JOB_NAME" +fi + +export PIP_DOWNLOAD_CACHE=/mnt/pip-cache + +source /mnt/virtualenvs/"$JOB_NAME"/bin/activate +rake install_prereqs +rake clobber + +TESTS_FAILED=0 + +# Assumes that Xvfb has been started by upstart +# and is capturing display :1 +# The command for this is: +# /usr/bin/Xvfb :1 -screen 0 1024x268x24 +# This allows us to run Chrome without a display +export DISPLAY=:1 + +# Run the lms and cms acceptance tests +# (the -v flag turns off color in the output) +rake test_acceptance_lms["-v 3"] || TESTS_FAILED=1 +rake test_acceptance_cms["-v 3"] || TESTS_FAILED=1 + +[ $TESTS_FAILED == '0' ] diff --git a/lms/djangoapps/branding/views.py b/lms/djangoapps/branding/views.py index 9fe912e947..dd57e8d4d4 100644 --- a/lms/djangoapps/branding/views.py +++ b/lms/djangoapps/branding/views.py @@ -6,6 +6,7 @@ from django_future.csrf import ensure_csrf_cookie import student.views import branding import courseware.views +from mitxmako.shortcuts import marketing_link from util.cache import cache_if_anonymous @@ -22,6 +23,8 @@ def index(request): if settings.MITX_FEATURES.get('AUTH_USE_MIT_CERTIFICATES'): from external_auth.views import ssl_login return ssl_login(request) + if settings.MITX_FEATURES.get('ENABLE_MKTG_SITE'): + return redirect(settings.MKTG_URLS.get('ROOT')) university = branding.get_university(request.META.get('HTTP_HOST')) if university is None: @@ -34,9 +37,12 @@ def index(request): @cache_if_anonymous def courses(request): """ - Render the "find courses" page. If subdomain branding is on, this is the - university profile page, otherwise it's the edX courseware.views.courses page + Render the "find courses" page. If the marketing site is enabled, redirect + to that. Otherwise, if subdomain branding is on, this is the university + profile page. Otherwise, it's the edX courseware.views.courses page """ + if settings.MITX_FEATURES.get('ENABLE_MKTG_SITE', False): + return redirect(marketing_link('COURSES'), permanent=True) university = branding.get_university(request.META.get('HTTP_HOST')) if university is None: diff --git a/lms/djangoapps/courseware/features/common.py b/lms/djangoapps/courseware/features/common.py index e81568ae4b..874ba0142a 100644 --- a/lms/djangoapps/courseware/features/common.py +++ b/lms/djangoapps/courseware/features/common.py @@ -20,7 +20,7 @@ logger = getLogger(__name__) TEST_COURSE_ORG = 'edx' TEST_COURSE_NAME = 'Test Course' -TEST_SECTION_NAME = "Problem" +TEST_SECTION_NAME = 'Test Section' @step(u'The course "([^"]*)" exists$') diff --git a/lms/djangoapps/courseware/features/courseware_common.py b/lms/djangoapps/courseware/features/courseware_common.py index 4e9aa3fb7b..aff49d2f9d 100644 --- a/lms/djangoapps/courseware/features/courseware_common.py +++ b/lms/djangoapps/courseware/features/courseware_common.py @@ -12,7 +12,6 @@ def i_click_on_view_courseware(step): @step('I click on the "([^"]*)" tab$') def i_click_on_the_tab(step, tab_text): world.click_link(tab_text) - world.save_the_html() @step('I visit the courseware URL$') @@ -20,11 +19,6 @@ def i_visit_the_course_info_url(step): world.visit('/courses/MITx/6.002x/2012_Fall/courseware') -@step(u'I do not see "([^"]*)" anywhere on the page') -def i_do_not_see_text_anywhere_on_the_page(step, text): - assert world.browser.is_text_not_present(text) - - @step(u'I am on the dashboard page$') def i_am_on_the_dashboard_page(step): assert world.is_css_present('section.courses') diff --git a/lms/djangoapps/courseware/features/high-level-tabs.feature b/lms/djangoapps/courseware/features/high-level-tabs.feature index c60ec7b374..adbe5ec8a3 100644 --- a/lms/djangoapps/courseware/features/high-level-tabs.feature +++ b/lms/djangoapps/courseware/features/high-level-tabs.feature @@ -8,10 +8,7 @@ Scenario: I can navigate to all high - level tabs in a course And The course "6.002x" has extra tab "Custom Tab" And I am logged in And I click on View Courseware - When I click on the "" tab - Then the page title should contain "" - - Examples: + When I click on the tabs then the page title should contain the following titles: | TabName | PageTitle | | Courseware | 6.002x Courseware | | Course Info | 6.002x Course Info | diff --git a/lms/djangoapps/courseware/features/high-level-tabs.py b/lms/djangoapps/courseware/features/high-level-tabs.py new file mode 100644 index 0000000000..056c627803 --- /dev/null +++ b/lms/djangoapps/courseware/features/high-level-tabs.py @@ -0,0 +1,11 @@ +from lettuce import world, step +from nose.tools import assert_equals + + +@step(u'I click on the tabs then the page title should contain the following titles:') +def i_click_on_the_tab_and_check(step): + for tab_title in step.hashes: + tab_text = tab_title['TabName'] + title = tab_title['PageTitle'] + world.click_link(tab_text) + assert(title in world.browser.title) diff --git a/lms/djangoapps/courseware/features/homepage.feature b/lms/djangoapps/courseware/features/homepage.feature index c0c1c32f02..140f1f8b5f 100644 --- a/lms/djangoapps/courseware/features/homepage.feature +++ b/lms/djangoapps/courseware/features/homepage.feature @@ -5,36 +5,27 @@ Feature: Homepage for web users Scenario: User can see the "Login" button Given I visit the homepage - Then I should see a link called "Log In" + Then I should see a link called "Log in" - Scenario: User can see the "Sign up" button + Scenario: User can see the "Register Now" button Given I visit the homepage - Then I should see a link called "Sign Up" + Then I should see a link called "Register Now" Scenario Outline: User can see main parts of the page Given I visit the homepage - Then I should see a link called "" - When I click the link with the text "" - Then I should see that the path is "" + Then I should see the following links and ids + | id | Link | + | about | About | + | jobs | Jobs | + | faq | FAQ | + | contact | Contact| + | press | Press | - Examples: - | Link | Path | - | Find Courses | /courses | - | About | /about | - | Jobs | /jobs | - | Contact | /contact | - - Scenario: User can visit the blog - Given I visit the homepage - When I click the link with the text "Blog" - Then I should see that the url is "http://blog.edx.org/" # TODO: test according to domain or policy Scenario: User can see the partner institutions Given I visit the homepage - Then I should see "" in the Partners section - - Examples: + Then I should see the following Partners in the Partners section | Partner | | MITx | | HarvardX | diff --git a/lms/djangoapps/courseware/features/homepage.py b/lms/djangoapps/courseware/features/homepage.py index 62e9096e70..585d1582d7 100644 --- a/lms/djangoapps/courseware/features/homepage.py +++ b/lms/djangoapps/courseware/features/homepage.py @@ -2,11 +2,22 @@ #pylint: disable=W0621 from lettuce import world, step -from nose.tools import assert_in +from nose.tools import assert_in, assert_equals -@step('I should see "([^"]*)" in the Partners section$') -def i_should_see_partner(step, partner): +@step(u'I should see the following Partners in the Partners section') +def i_should_see_partner(step): partners = world.browser.find_by_css(".partner .name span") names = set(span.text for span in partners) - assert_in(partner, names) + for partner in step.hashes: + assert_in(partner['Partner'], names) + + +@step(u'I should see the following links and ids') +def should_see_a_link_called(step): + for link_id_pair in step.hashes: + link_id = link_id_pair['id'] + text = link_id_pair['Link'] + link = world.browser.find_by_id(link_id) + assert len(link) > 0 + assert_equals(link.text, text) diff --git a/lms/djangoapps/courseware/features/login.feature b/lms/djangoapps/courseware/features/login.feature index 23317b4876..a1b788a7b2 100644 --- a/lms/djangoapps/courseware/features/login.feature +++ b/lms/djangoapps/courseware/features/login.feature @@ -7,7 +7,7 @@ Feature: Login in as a registered user Given I am an edX user And I am an unactivated user And I visit the homepage - When I click the link with the text "Log In" + When I click the link with the text "Log in" And I submit my credentials on the login form Then I should see the login error message "This account has not been activated" @@ -15,7 +15,7 @@ Feature: Login in as a registered user Given I am an edX user And I am an activated user And I visit the homepage - When I click the link with the text "Log In" + When I click the link with the text "Log in" And I submit my credentials on the login form Then I should be on the dashboard page @@ -23,5 +23,5 @@ Feature: Login in as a registered user Given I am logged in When I click the dropdown arrow And I click the link with the text "Log Out" - Then I should see a link with the text "Log In" + Then I should see a link with the text "Log in" And I should see that the path is "/" diff --git a/lms/djangoapps/courseware/features/login.py b/lms/djangoapps/courseware/features/login.py index bc90ea301c..857b70fa5d 100644 --- a/lms/djangoapps/courseware/features/login.py +++ b/lms/djangoapps/courseware/features/login.py @@ -19,13 +19,13 @@ def i_am_an_activated_user(step): def i_submit_my_credentials_on_the_login_form(step): fill_in_the_login_form('email', 'robot@edx.org') fill_in_the_login_form('password', 'test') - login_form = world.browser.find_by_css('form#login_form') - login_form.find_by_value('Access My Courses').click() + login_form = world.browser.find_by_css('form#login-form') + login_form.find_by_name('submit').click() @step(u'I should see the login error message "([^"]*)"$') def i_should_see_the_login_error_message(step, msg): - login_error_div = world.browser.find_by_css('form#login_form #login_error') + login_error_div = world.browser.find_by_css('.submission-error.is-shown') assert (msg in login_error_div.text) @@ -49,6 +49,6 @@ def user_is_an_activated_user(uname): def fill_in_the_login_form(field, value): - login_form = world.browser.find_by_css('form#login_form') + login_form = world.browser.find_by_css('form#login-form') form_field = login_form.find_by_name(field) form_field.fill(value) diff --git a/lms/djangoapps/courseware/features/problems.feature b/lms/djangoapps/courseware/features/problems.feature index 266ffa3680..44d47fcec4 100644 --- a/lms/djangoapps/courseware/features/problems.feature +++ b/lms/djangoapps/courseware/features/problems.feature @@ -84,3 +84,38 @@ Feature: Answer problems | formula | incorrect | | script | correct | | script | incorrect | + + + Scenario: I can answer a problem with one attempt correctly and not reset + Given I am viewing a "multiple choice" problem with "1" attempt + When I answer a "multiple choice" problem "correctly" + Then The "Reset" button does not appear + + Scenario: I can answer a problem with multiple attempts correctly and still reset the problem + Given I am viewing a "multiple choice" problem with "3" attempts + Then I should see "You have used 0 of 3 submissions" somewhere in the page + When I answer a "multiple choice" problem "correctly" + Then The "Reset" button does appear + + Scenario: I can view how many attempts I have left on a problem + Given I am viewing a "multiple choice" problem with "3" attempts + Then I should see "You have used 0 of 3 submissions" somewhere in the page + When I answer a "multiple choice" problem "incorrectly" + And I reset the problem + Then I should see "You have used 1 of 3 submissions" somewhere in the page + When I answer a "multiple choice" problem "incorrectly" + And I reset the problem + Then I should see "You have used 2 of 3 submissions" somewhere in the page + And The "Final Check" button does appear + When I answer a "multiple choice" problem "correctly" + Then The "Reset" button does not appear + + Scenario: I can view and hide the answer if the problem has it: + Given I am viewing a "numerical" that shows the answer "always" + When I press the "Show Answer" button + Then The "Hide Answer" button does appear + And The "Show Answer" button does not appear + And I should see "4.14159" somewhere in the page + When I press the "Hide Answer" button + Then The "Show Answer" button does appear + And I should not see "4.14159" anywhere on the page diff --git a/lms/djangoapps/courseware/features/problems.py b/lms/djangoapps/courseware/features/problems.py index 3d538d7ae1..763914763a 100644 --- a/lms/djangoapps/courseware/features/problems.py +++ b/lms/djangoapps/courseware/features/problems.py @@ -7,119 +7,42 @@ Steps for problem.feature lettuce tests from lettuce import world, step from lettuce.django import django_url -import random -import textwrap -from common import i_am_registered_for_the_course, \ - TEST_SECTION_NAME, section_location -from capa.tests.response_xml_factory import OptionResponseXMLFactory, \ - ChoiceResponseXMLFactory, MultipleChoiceResponseXMLFactory, \ - StringResponseXMLFactory, NumericalResponseXMLFactory, \ - FormulaResponseXMLFactory, CustomResponseXMLFactory, \ - CodeResponseXMLFactory - -# Factories from capa.tests.response_xml_factory that we will use -# to generate the problem XML, with the keyword args used to configure -# the output. -PROBLEM_FACTORY_DICT = { - 'drop down': { - 'factory': OptionResponseXMLFactory(), - 'kwargs': { - 'question_text': 'The correct answer is Option 2', - 'options': ['Option 1', 'Option 2', 'Option 3', 'Option 4'], - 'correct_option': 'Option 2'}}, - - 'multiple choice': { - 'factory': MultipleChoiceResponseXMLFactory(), - 'kwargs': { - 'question_text': 'The correct answer is Choice 3', - 'choices': [False, False, True, False], - 'choice_names': ['choice_0', 'choice_1', 'choice_2', 'choice_3']}}, - - 'checkbox': { - 'factory': ChoiceResponseXMLFactory(), - 'kwargs': { - 'question_text': 'The correct answer is Choices 1 and 3', - 'choice_type': 'checkbox', - 'choices': [True, False, True, False, False], - 'choice_names': ['Choice 1', 'Choice 2', 'Choice 3', 'Choice 4']}}, - 'radio': { - 'factory': ChoiceResponseXMLFactory(), - 'kwargs': { - 'question_text': 'The correct answer is Choice 3', - 'choice_type': 'radio', - 'choices': [False, False, True, False], - 'choice_names': ['Choice 1', 'Choice 2', 'Choice 3', 'Choice 4']}}, - 'string': { - 'factory': StringResponseXMLFactory(), - 'kwargs': { - 'question_text': 'The answer is "correct string"', - 'case_sensitive': False, - 'answer': 'correct string'}}, - - 'numerical': { - 'factory': NumericalResponseXMLFactory(), - 'kwargs': { - 'question_text': 'The answer is pi + 1', - 'answer': '4.14159', - 'tolerance': '0.00001', - 'math_display': True}}, - - 'formula': { - 'factory': FormulaResponseXMLFactory(), - 'kwargs': { - 'question_text': 'The solution is [mathjax]x^2+2x+y[/mathjax]', - 'sample_dict': {'x': (-100, 100), 'y': (-100, 100)}, - 'num_samples': 10, - 'tolerance': 0.00001, - 'math_display': True, - 'answer': 'x^2+2*x+y'}}, - - 'script': { - 'factory': CustomResponseXMLFactory(), - 'kwargs': { - 'question_text': 'Enter two integers that sum to 10.', - 'cfn': 'test_add_to_ten', - 'expect': '10', - 'num_inputs': 2, - 'script': textwrap.dedent(""" - def test_add_to_ten(expect,ans): - try: - a1=int(ans[0]) - a2=int(ans[1]) - except ValueError: - a1=0 - a2=0 - return (a1+a2)==int(expect) - """)}}, - 'code': { - 'factory': CodeResponseXMLFactory(), - 'kwargs': { - 'question_text': 'Submit code to an external grader', - 'initial_display': 'print "Hello world!"', - 'grader_payload': '{"grader": "ps1/Spring2013/test_grader.py"}', }}, - } +from common import i_am_registered_for_the_course, TEST_SECTION_NAME +from problems_setup import PROBLEM_DICT, answer_problem, problem_has_answer, add_problem_to_course -def add_problem_to_course(course, problem_type): - ''' - Add a problem to the course we have created using factories. - ''' +@step(u'I am viewing a "([^"]*)" problem with "([^"]*)" attempt') +def view_problem_with_attempts(step, problem_type, attempts): + i_am_registered_for_the_course(step, 'model_course') - assert(problem_type in PROBLEM_FACTORY_DICT) + # Ensure that the course has this problem type + add_problem_to_course('model_course', problem_type, {'attempts': attempts}) - # Generate the problem XML using capa.tests.response_xml_factory - factory_dict = PROBLEM_FACTORY_DICT[problem_type] - problem_xml = factory_dict['factory'].build_xml(**factory_dict['kwargs']) + # Go to the one section in the factory-created course + # which should be loaded with the correct problem + chapter_name = TEST_SECTION_NAME.replace(" ", "_") + section_name = chapter_name + url = django_url('/courses/edx/model_course/Test_Course/courseware/%s/%s' % + (chapter_name, section_name)) - # Create a problem item using our generated XML - # We set rerandomize=always in the metadata so that the "Reset" button - # will appear. - template_name = "i4x://edx/templates/problem/Blank_Common_Problem" - world.ItemFactory.create(parent_location=section_location(course), - template=template_name, - display_name=str(problem_type), - data=problem_xml, - metadata={'rerandomize': 'always'}) + world.browser.visit(url) + + +@step(u'I am viewing a "([^"]*)" that shows the answer "([^"]*)"') +def view_problem_with_show_answer(step, problem_type, answer): + i_am_registered_for_the_course(step, 'model_course') + + # Ensure that the course has this problem type + add_problem_to_course('model_course', problem_type, {'showanswer': answer}) + + # Go to the one section in the factory-created course + # which should be loaded with the correct problem + chapter_name = TEST_SECTION_NAME.replace(" ", "_") + section_name = chapter_name + url = django_url('/courses/edx/model_course/Test_Course/courseware/%s/%s' % + (chapter_name, section_name)) + + world.browser.visit(url) @step(u'I am viewing a "([^"]*)" problem') @@ -153,7 +76,7 @@ def set_external_grader_response(step, correctness): @step(u'I answer a "([^"]*)" problem "([^"]*)ly"') -def answer_problem(step, problem_type, correctness): +def answer_problem_step(step, problem_type, correctness): """ Mark a given problem type correct or incorrect, then submit it. *problem_type* is a string representing the type of problem (e.g. 'drop down') @@ -161,73 +84,18 @@ def answer_problem(step, problem_type, correctness): """ assert(correctness in ['correct', 'incorrect']) - - if problem_type == "drop down": - select_name = "input_i4x-edx-model_course-problem-drop_down_2_1" - option_text = 'Option 2' if correctness == 'correct' else 'Option 3' - world.browser.select(select_name, option_text) - - elif problem_type == "multiple choice": - if correctness == 'correct': - inputfield('multiple choice', choice='choice_2').check() - else: - inputfield('multiple choice', choice='choice_1').check() - - elif problem_type == "checkbox": - if correctness == 'correct': - inputfield('checkbox', choice='choice_0').check() - inputfield('checkbox', choice='choice_2').check() - else: - inputfield('checkbox', choice='choice_3').check() - - elif problem_type == 'radio': - if correctness == 'correct': - inputfield('radio', choice='choice_2').check() - else: - inputfield('radio', choice='choice_1').check() - - elif problem_type == 'string': - textvalue = 'correct string' if correctness == 'correct' \ - else 'incorrect' - inputfield('string').fill(textvalue) - - elif problem_type == 'numerical': - textvalue = "pi + 1" if correctness == 'correct' \ - else str(random.randint(-2, 2)) - inputfield('numerical').fill(textvalue) - - elif problem_type == 'formula': - textvalue = "x^2+2*x+y" if correctness == 'correct' else 'x^2' - inputfield('formula').fill(textvalue) - - elif problem_type == 'script': - # Correct answer is any two integers that sum to 10 - first_addend = random.randint(-100, 100) - second_addend = 10 - first_addend - - # If we want an incorrect answer, then change - # the second addend so they no longer sum to 10 - if correctness == 'incorrect': - second_addend += random.randint(1, 10) - - inputfield('script', input_num=1).fill(str(first_addend)) - inputfield('script', input_num=2).fill(str(second_addend)) - - elif problem_type == 'code': - # The fake xqueue server is configured to respond - # correct / incorrect no matter what we submit. - # Furthermore, since the inline code response uses - # JavaScript to make the code display nicely, it's difficult - # to programatically input text - # (there's not +
      + + +
      +%if results: +
      +

      Results:

      + 
      +${results|h}
+
      +
      +%endif diff --git a/lms/templates/discussion/_filter_dropdown.html b/lms/templates/discussion/_filter_dropdown.html index fef4abb11f..dd5b94f910 100644 --- a/lms/templates/discussion/_filter_dropdown.html +++ b/lms/templates/discussion/_filter_dropdown.html @@ -33,6 +33,14 @@ Show All Discussions + %if flag_moderator: +
    1. + + Show Flagged Discussions + +
      2. + + %endif
    2. Following diff --git a/lms/templates/discussion/_underscore_templates.html b/lms/templates/discussion/_underscore_templates.html index 24e3b467be..fcbcf1a52c 100644 --- a/lms/templates/discussion/_underscore_templates.html +++ b/lms/templates/discussion/_underscore_templates.html @@ -3,6 +3,7 @@ + + +
      +
      +

      ${_("Log Into Your Account")}

      +
      +
      + +       + diff --git a/lms/templates/main.html b/lms/templates/main.html index 42d5a71228..313025d09a 100644 --- a/lms/templates/main.html +++ b/lms/templates/main.html @@ -1,8 +1,18 @@ <%namespace name='static' file='static_content.html'/> +<%! from django.utils import html %> <%block name="title">edX + @@ -48,3 +58,10 @@ <%block name="js_extra"/> + +<%def name="login_query()">${ + "?course_id={0}&enrollment_action={1}".format( + html.escape(course_id), + html.escape(enrollment_action) + ) if course_id and enrollment_action else "" +} diff --git a/lms/templates/mktg_iframe.html b/lms/templates/mktg_iframe.html new file mode 100644 index 0000000000..6d02f3fcc5 --- /dev/null +++ b/lms/templates/mktg_iframe.html @@ -0,0 +1,53 @@ +<%namespace name='static' file='static_content.html'/> + + + + <%block name="title"> + + + + + + <%static:css group='application'/> + <%static:js group='main_vendor'/> + + + + + + <%block name="headextra"/> + + % if not course: + <%include file="google_analytics.html" /> + % endif + + + + + + + + +
      + + <%block name="content"> +
      + + <%static:js group='application'/> + <%block name="js_extra"> + + diff --git a/lms/templates/navigation.html b/lms/templates/navigation.html index 4bb99d1ebd..82d08f6ca9 100644 --- a/lms/templates/navigation.html +++ b/lms/templates/navigation.html @@ -1,8 +1,6 @@ ## mako -## TODO: Split this into two files, one for people who are authenticated, and -## one for people who aren't. Assume a Course object is passed to the former, -## instead of using settings.COURSE_TITLE <%namespace name='static' file='static_content.html'/> +<%namespace file='main.html' import="login_query"/> <%! from django.core.urlresolvers import reverse @@ -38,19 +36,23 @@ site_status_msg = get_site_status_msg(course_id)
      % endif
      % if course: @@ -92,8 +107,6 @@ site_status_msg = get_site_status_msg(course_id) % endif %if not user.is_authenticated(): - <%include file="login_modal.html" /> - <%include file="signup_modal.html" /> <%include file="forgot_password_modal.html" /> %endif diff --git a/lms/templates/notes.html b/lms/templates/notes.html new file mode 100644 index 0000000000..3fea6faa3e --- /dev/null +++ b/lms/templates/notes.html @@ -0,0 +1,81 @@ +<%namespace name='static' file='static_content.html'/> +<%inherit file="main.html" /> +<%! + from django.core.urlresolvers import reverse +%> + +<%block name="headextra"> + <%static:css group='course'/> + <%static:js group='courseware'/> + + + + +<%block name="js_extra"> + + + +<%include file="/courseware/course_navigation.html" args="active_page='notes'" /> + +
      +
      +

      My Notes

      + % for note in notes: +
      +
      ${note.quote|h}
      +
      ${note.text.replace("\n", "
      ") | n,h}
      +
        + % if note.tags: +
      • Tags: ${note.tags|h}
        • + % endif +
      • Author: ${note.user.username}
        • +
      • Created: ${note.created.strftime('%m/%d/%Y %H:%m')}
        • +
      • Source: ${note.uri|h}
        • +
      +
      + % endfor + % if notes is UNDEFINED or len(notes) == 0: +

      You do not have any notes.

      + % endif +
      +
      + + + + diff --git a/lms/templates/register.html b/lms/templates/register.html new file mode 100644 index 0000000000..61328bffa0 --- /dev/null +++ b/lms/templates/register.html @@ -0,0 +1,274 @@ +<%inherit file="main.html" /> + +<%namespace name='static' file='static_content.html'/> +<%namespace file='main.html' import="login_query"/> + +<%! from django.core.urlresolvers import reverse %> +<%! from django.utils import html %> +<%! from django_countries.countries import COUNTRIES %> +<%! from django.utils.translation import ugettext as _ %> +<%! from student.models import UserProfile %> +<%! from datetime import date %> +<%! import calendar %> + +<%block name="title">Register for edX + +<%block name="js_extra"> + + + +
      +
      +

      ${_("Register for edX")}

      +
      +
      + +
      +
      +
      +

      ${_("Welcome! Register below to create your edX account")}

      +
      + +
      + + + + + + +

      + Please complete the following fields to register for an edX account.
      + Required fields are noted by bold text and an asterisk (*). +

      + +
      + Required Information + + % if has_extauth_info is UNDEFINED: + +
        +
      1. + + +
        2. +
      2. + + +
        3. +
      3. + + + Will be shown in any discussions or forums you participate in +
        4. +
      4. + + + Needed for any certificates you may earn (cannot be changed later) +
        5. +
      + + % else: + +
      +

      Welcome ${extauth_email}

      +

      Enter a public username:

      +
      + +
        +
      1. + + + Will be shown in any discussions or forums you participate in +
        2. +
      + + % endif +
      + +
      + Optional Personal Information + +
        +
      1. +
        + + +
        + +
        + + +
        + +
        + + +
        +
        2. +
      +
      + +
      + Optional Personal Information + +
        +
      1. + + +
        2. + +
      2. + + +
        3. +
      +
      + +
      + Account Acknowledgements + +
        +
      1. +
        + + +
        + +
        + + +
        +
        2. +
      +
      + +% if course_id and enrollment_action: + + +% endif + +
      + +
      +
      +
      + + +
      diff --git a/lms/templates/registration/activation_complete.html b/lms/templates/registration/activation_complete.html index 7d3579b34e..7eb805e730 100644 --- a/lms/templates/registration/activation_complete.html +++ b/lms/templates/registration/activation_complete.html @@ -23,7 +23,7 @@ %if user_logged_in: Visit your dashboard to see your courses. %else: - You can now login. + You can now log in. %endif

      3. diff --git a/lms/templates/registration/password_reset_complete.html b/lms/templates/registration/password_reset_complete.html index 0338ce57b0..3847f615b9 100644 --- a/lms/templates/registration/password_reset_complete.html +++ b/lms/templates/registration/password_reset_complete.html @@ -1,9 +1,66 @@ {% load i18n %} +{% load compressed %} +{% load staticfiles %} + + + -

      Password reset complete

      + Your Password Reset is Complete -{% block content %} + {% compressed_css 'application' %} -Your password has been set. You may go ahead and log in now. + -{% endblock %} + + + + + + +
      + +
      + +
      +
      +
      +
      +

      Your Password Reset is Complete

      +
      +
      + + {% block content %} +
      +

      Your password has been set. You may go ahead and log in now..

      +
      + {% endblock %} +
      +
      diff --git a/lms/templates/registration/password_reset_confirm.html b/lms/templates/registration/password_reset_confirm.html index e80955180c..5809408dad 100644 --- a/lms/templates/registration/password_reset_confirm.html +++ b/lms/templates/registration/password_reset_confirm.html @@ -1,10 +1,10 @@ {% load compressed %} {% load staticfiles %} - - Reset password - MITx 6.002x + + Reset Your edX Password {% compressed_css 'application' %} @@ -12,55 +12,120 @@ + + - + -
      - -
      +
      + +
      - {% block content %} -
      +
      +
      +
      +
      +

      Reset Your edX Password

      +
      +
      - {% if validlink %} +
      + {% if validlink %} +
      +

      Password Reset Form

      +
      -
      -

      Enter new password

      -
      -
      +
      {% csrf_token %} + + -

      Please enter your new password twice so we can verify you typed it in correctly.

      + - {% csrf_token %} - {{ form.new_password1.errors }} - - {{ form.new_password1 }} + - {{ form.new_password2.errors }} - - {{ form.new_password2 }} +

      + Please enter your new password twice so we can verify you typed it in correctly.
      + Required fields are noted by bold text and an asterisk (*). +

      -
      - +
      + Required Information + +
        +
      1. + + +
        2. +
      2. + + +
        3. +
      +
      + +
      + +
      + + + {% else %} + +
      +

      Your Password Reset Was Unsuccessful

      +
      +

      The password reset link was invalid, possibly because the link has already been used. Please return to the login page and start the password reset process again.

      + + {% endif %} +
      + +
      - {% endblock %} - - - +
      diff --git a/lms/templates/static_htmlbook.html b/lms/templates/static_htmlbook.html index 830ddddca9..8a3c50f680 100644 --- a/lms/templates/static_htmlbook.html +++ b/lms/templates/static_htmlbook.html @@ -26,22 +26,41 @@ // chapters, and it should be in-bounds. chapterToLoad = options.chapterNum; } + var anchorToLoad = null; + if (options.chapters) { + anchorToLoad = options.anchor_id; + } - loadUrl = function htmlViewLoadUrl(url) { + var onComplete = function() {}; + if(options.notesEnabled) { + onComplete = function(url) { + return function() { + $('#viewerContainer').trigger('notes:init', [url]); + } + }; + } + + loadUrl = function htmlViewLoadUrl(url, anchorId) { // clear out previous load, if any: parentElement = document.getElementById('bookpage'); while (parentElement.hasChildNodes()) parentElement.removeChild(parentElement.lastChild); // load new URL in: - $('#bookpage').load(url); - }; + $('#bookpage').load(url, null, onComplete(url)); - loadChapterUrl = function htmlViewLoadChapterUrl(chapterNum) { + // if there is an anchor set, then go to that location: + if (anchorId != null) { + // TODO: add implementation.... + } + + }; + + loadChapterUrl = function htmlViewLoadChapterUrl(chapterNum, anchorId) { if (chapterNum < 1 || chapterNum > chapterUrls.length) { return; } var chapterUrl = chapterUrls[chapterNum-1]; - loadUrl(chapterUrl); + loadUrl(chapterUrl, anchorId); }; // define navigation links for chapters: @@ -54,15 +73,15 @@ }; for (var index = 1; index <= chapterUrls.length; index += 1) { $("#htmlchapter-" + index).click(loadChapterUrlHelper(index)); - } + } } // finally, load the appropriate url/page if (urlToLoad != null) { - loadUrl(urlToLoad); + loadUrl(urlToLoad, anchorToLoad); } else { - loadChapterUrl(chapterToLoad); - } + loadChapterUrl(chapterToLoad, anchorToLoad); + } } })(jQuery); @@ -82,6 +101,14 @@ %if chapter is not None: options.chapterNum = ${chapter}; %endif + %if anchor_id is not UNDEFINED and anchor_id is not None: + options.anchor_id = ${anchor_id}; + %endif + + options.notesEnabled = false; + %if notes_enabled is not UNDEFINED and notes_enabled: + options.notesEnabled = true; + %endif $('#outerContainer').myHTMLViewer(options); }); diff --git a/lms/templates/static_templates/server-error.html b/lms/templates/static_templates/server-error.html index 88ca32ff80..5564ea082e 100644 --- a/lms/templates/static_templates/server-error.html +++ b/lms/templates/static_templates/server-error.html @@ -2,5 +2,5 @@

      There has been a 500 error on the edX servers

      -

      Our staff is currently working to get the site back up as soon as possible. Please email us at technical@edx.org to report any problems or downtime.

      +

      Please wait a few seconds and then reload the page. If the problem persists, please email us at technical@edx.org.

      diff --git a/lms/templates/university_profile/edge.html b/lms/templates/university_profile/edge.html index a3e115ddd8..9e6adfe3d8 100644 --- a/lms/templates/university_profile/edge.html +++ b/lms/templates/university_profile/edge.html @@ -9,7 +9,7 @@