Merge pull request #1739 from MITx/bug/christina/studio

Allow clearing of dates (except for course start date).

cms/djangoapps/contentstore/features/course-settings.feature

+Feature: Course Settings
+  As a course author, I want to be able to configure my course settings.
+
+  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
+
+  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
+
+  Scenario: User cannot clear the course start date
+    Given I have set course dates
+    And I clear the course start date
+    Then I receive a warning about course start date
+    And The previously set start date is shown on refresh
+
+  Scenario: User can correct the course start date warning
+    Given I have tried to clear the course start
+    And I have entered a new course start date
+    Then The warning about course start date goes away
+    And My new course start date is shown on refresh

cms/djangoapps/contentstore/features/course-settings.py

+from lettuce import world, step
+from common import *
+from terrain.steps import reload_the_page
+from selenium.webdriver.common.keys import Keys
+import time
+
+from nose.tools import assert_true, assert_false, assert_equal
+
+COURSE_START_DATE_CSS = "#course-start-date"
+COURSE_END_DATE_CSS = "#course-end-date"
+ENROLLMENT_START_DATE_CSS = "#course-enrollment-start-date"
+ENROLLMENT_END_DATE_CSS = "#course-enrollment-end-date"
+
+COURSE_START_TIME_CSS = "#course-start-time"
+COURSE_END_TIME_CSS = "#course-end-time"
+ENROLLMENT_START_TIME_CSS = "#course-enrollment-start-time"
+ENROLLMENT_END_TIME_CSS = "#course-enrollment-end-time"
+
+DUMMY_TIME = "3:30pm"
+DEFAULT_TIME = "12:00am"
+
+
+############### 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):
+        css_click(expand_icon_css)
+    link_css = 'li.nav-course-settings-schedule a'
+    css_click(link_css)
+
+
+@step('I have set course dates$')
+def test_i_have_set_course_dates(step):
+    step.given('I have opened a new course in Studio')
+    step.given('I select Schedule and Details')
+    step.given('And I set course dates')
+
+
+@step('And I set course dates$')
+def test_and_i_set_course_dates(step):
+    set_date_or_time(COURSE_START_DATE_CSS, '12/20/2013')
+    set_date_or_time(COURSE_END_DATE_CSS, '12/26/2013')
+    set_date_or_time(ENROLLMENT_START_DATE_CSS, '12/1/2013')
+    set_date_or_time(ENROLLMENT_END_DATE_CSS, '12/10/2013')
+
+    set_date_or_time(COURSE_START_TIME_CSS, DUMMY_TIME)
+    set_date_or_time(ENROLLMENT_END_TIME_CSS, DUMMY_TIME)
+
+    pause()
+
+
+@step('Then I see the set dates on refresh$')
+def test_then_i_see_the_set_dates_on_refresh(step):
+    reload_the_page(step)
+    verify_date_or_time(COURSE_START_DATE_CSS, '12/20/2013')
+    verify_date_or_time(COURSE_END_DATE_CSS, '12/26/2013')
+    verify_date_or_time(ENROLLMENT_START_DATE_CSS, '12/01/2013')
+    verify_date_or_time(ENROLLMENT_END_DATE_CSS, '12/10/2013')
+
+    verify_date_or_time(COURSE_START_TIME_CSS, DUMMY_TIME)
+    # Unset times get set to 12 AM once the corresponding date has been set.
+    verify_date_or_time(COURSE_END_TIME_CSS, DEFAULT_TIME)
+    verify_date_or_time(ENROLLMENT_START_TIME_CSS, DEFAULT_TIME)
+    verify_date_or_time(ENROLLMENT_END_TIME_CSS, DUMMY_TIME)
+
+
+@step('And I clear all the dates except start$')
+def test_and_i_clear_all_the_dates_except_start(step):
+    set_date_or_time(COURSE_END_DATE_CSS, '')
+    set_date_or_time(ENROLLMENT_START_DATE_CSS, '')
+    set_date_or_time(ENROLLMENT_END_DATE_CSS, '')
+
+    pause()
+
+
+@step('Then I see cleared dates on refresh$')
+def test_then_i_see_cleared_dates_on_refresh(step):
+    reload_the_page(step)
+    verify_date_or_time(COURSE_END_DATE_CSS, '')
+    verify_date_or_time(ENROLLMENT_START_DATE_CSS, '')
+    verify_date_or_time(ENROLLMENT_END_DATE_CSS, '')
+
+    verify_date_or_time(COURSE_END_TIME_CSS, '')
+    verify_date_or_time(ENROLLMENT_START_TIME_CSS, '')
+    verify_date_or_time(ENROLLMENT_END_TIME_CSS, '')
+
+    # Verify course start date (required) and time still there
+    verify_date_or_time(COURSE_START_DATE_CSS, '12/20/2013')
+    verify_date_or_time(COURSE_START_TIME_CSS, DUMMY_TIME)
+
+
+@step('I clear the course start date$')
+def test_i_clear_the_course_start_date(step):
+    set_date_or_time(COURSE_START_DATE_CSS, '')
+
+
+@step('I receive a warning about course start date$')
+def test_i_receive_a_warning_about_course_start_date(step):
+    assert_css_with_text('.message-error', 'The course must have an assigned start date.')
+    assert_true('error' in css_find(COURSE_START_DATE_CSS).first._element.get_attribute('class'))
+    assert_true('error' in css_find(COURSE_START_TIME_CSS).first._element.get_attribute('class'))
+
+
+@step('The previously set start date is shown on refresh$')
+def test_the_previously_set_start_date_is_shown_on_refresh(step):
+    reload_the_page(step)
+    verify_date_or_time(COURSE_START_DATE_CSS, '12/20/2013')
+    verify_date_or_time(COURSE_START_TIME_CSS, DUMMY_TIME)
+
+
+@step('Given I have tried to clear the course start$')
+def test_i_have_tried_to_clear_the_course_start(step):
+    step.given("I have set course dates")
+    step.given("I clear the course start date")
+    step.given("I receive a warning about course start date")
+
+
+@step('I have entered a new course start date$')
+def test_i_have_entered_a_new_course_start_date(step):
+    set_date_or_time(COURSE_START_DATE_CSS, '12/22/2013')
+    pause()
+
+
+@step('The warning about course start date goes away$')
+def test_the_warning_about_course_start_date_goes_away(step):
+    assert_equal(0, len(css_find('.message-error')))
+    assert_false('error' in css_find(COURSE_START_DATE_CSS).first._element.get_attribute('class'))
+    assert_false('error' in css_find(COURSE_START_TIME_CSS).first._element.get_attribute('class'))
+
+
+@step('My new course start date is shown on refresh$')
+def test_my_new_course_start_date_is_shown_on_refresh(step):
+    reload_the_page(step)
+    verify_date_or_time(COURSE_START_DATE_CSS, '12/22/2013')
+    # Time should have stayed from before attempt to clear date.
+    verify_date_or_time(COURSE_START_TIME_CSS, DUMMY_TIME)
+
+
+############### HELPER METHODS ####################
+def set_date_or_time(css, date_or_time):
+    """
+    Sets date or time field.
+    """
+    css_fill(css, date_or_time)
+    e = css_find(css).first
+    # hit Enter to apply the changes
+    e._element.send_keys(Keys.ENTER)
+
+
+def verify_date_or_time(css, date_or_time):
+    """
+    Verifies date or time field.
+    """
+    assert_equal(date_or_time, css_find(css).first.value)
+
+
+def pause():
+    """
+    Must sleep briefly to allow last time save to finish,
+    else refresh of browser will fail.
+    """
+    time.sleep(float(1))

cms/static/js/base.js

@@ -236,7 +236,7 @@ function getEdxTimeFromDateTimeVals(date_val, time_val, format) {
             time_val = '00:00';
 
         // Note, we are using date.js utility which has better parsing abilities than the built in JS date parsing
-        date = Date.parse(date_val + " " + time_val);
+        var date = Date.parse(date_val + " " + time_val);
         if (format == null)
             format = 'yyyy-MM-ddTHH:mm';
 
@@ -254,6 +254,7 @@ function getEdxTimeFromDateTimeInputs(date_id, time_id, format) {
 }
 
 function autosaveInput(e) {
+    var self = this;
     if (this.saveTimer) {
         clearTimeout(this.saveTimer);
     }
@@ -261,7 +262,7 @@ function autosaveInput(e) {
     this.saveTimer = setTimeout(function () {
         $changedInput = $(e.target);
         saveSubsection();
-        this.saveTimer = null;
+        self.saveTimer = null;
     }, 500);
 }
 
@@ -303,6 +304,7 @@ function saveSubsection() {
         data: JSON.stringify({ 'id': id, 'metadata': metadata}),
         success: function () {
             $spinner.delay(500).fadeOut(150);
+            $changedInput = null;
         },
         error: function () {
             showToastMessage('There has been an error while saving your changes.');

cms/static/js/models/settings/course_details.js

@@ -37,6 +37,9 @@ CMS.Models.Settings.CourseDetails = Backbone.Model.extend({
         // Returns either nothing (no return call) so that validate works or an object of {field: errorstring} pairs
         // A bit funny in that the video key validation is asynchronous; so, it won't stop the validation.
         var errors = {};
+        if (newattrs.start_date === null) {
+            errors.start_date = "The course must have an assigned start date.";
+        }
         if (newattrs.start_date && newattrs.end_date && newattrs.start_date >= newattrs.end_date) {
             errors.end_date = "The course end date cannot be before the course start date.";
         }

cms/static/js/views/settings/main_settings_view.js

@@ -101,6 +101,12 @@ CMS.Views.Settings.Details = CMS.Views.ValidatingView.extend({
                     cacheModel.save(fieldName, newVal);
                 }
             }
+            else {
+                // Clear date (note that this clears the time as well, as date and time are linked).
+                // Note also that the validation logic prevents us from clearing the start date
+                // (start date is required by the back end).
+                cacheModel.save(fieldName, null);
+            }
         };
 
         // instrument as date and time pickers