New tests for messages in standard mode

problem_builder/tests/integration/base_test.py

@@ -65,13 +65,32 @@ class MentoringBaseTest(SeleniumBaseTest, PopupCheckMixin):
     default_css_selector = 'div.mentoring'
 
 
-class MentoringAssessmentBaseTest(SeleniumXBlockTest, PopupCheckMixin):
+class MentoringBaseTemplateTest(SeleniumXBlockTest, PopupCheckMixin):
     """
-    Base class for tests of assessment mode
+    Base class for mentoring tests that use templated XML.
+    All new tests should inherit from this rather than MentoringBaseTest
     """
     module_name = __name__
     default_css_selector = 'div.mentoring'
 
+    def load_scenario(self, xml_file, params=None):
+        params = params or {}
+        scenario = loader.render_template("xml_templates/{}".format(xml_file), params)
+        self.set_scenario_xml(scenario)
+        return self.go_to_view("student_view")
+
+    def click_submit(self, mentoring):
+        """ Click the submit button and wait for the response """
+        submit = mentoring.find_element_by_css_selector('.submit input.input-main')
+        self.assertTrue(submit.is_displayed() and submit.is_enabled())
+        submit.click()
+        self.wait_until_disabled(submit)
+
+
+class MentoringAssessmentBaseTest(MentoringBaseTemplateTest):
+    """
+    Base class for tests of assessment mode
+    """
     @staticmethod
     def question_text(number):
         if number:

problem_builder/tests/integration/test_messages.py

+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2014-2015 Harvard, edX & OpenCraft
+#
+# This software's license gives you freedom; you can copy, convey,
+# propagate, redistribute and/or modify this program under the terms of
+# the GNU Affero General Public License (AGPL) as published by the Free
+# Software Foundation (FSF), either version 3 of the License, or (at your
+# option) any later version of the AGPL published by the FSF.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero
+# General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program in a file in the toplevel directory called
+# "AGPLv3".  If not, see <http://www.gnu.org/licenses/>.
+#
+from .base_test import MentoringBaseTemplateTest
+import ddt
+
+
+COMPLETED, INCOMPLETE, MAX_REACHED = "completed", "incomplete", "max_attempts_reached"
+MESSAGES = {
+    COMPLETED: u"Great job! (completed message)",
+    INCOMPLETE: u"Not quite! You can try again, though. (incomplete message)",
+    MAX_REACHED: (
+        u"Sorry, you have used up all of your allowed submissions. (max_attempts_reached message)"
+    ),
+}
+
+
+@ddt.ddt
+class MessagesTest(MentoringBaseTemplateTest):
+    """
+    Test the various types of message that can be added to a problem.
+    """
+    def expect_message(self, msg_type, mentoring):
+        """
+        Assert that the message of the specified type is shown to the user.
+        """
+        messages_element = mentoring.find_element_by_css_selector('.messages')
+        if msg_type is None:
+            self.assertFalse(messages_element.is_displayed())
+        else:
+            self.assertTrue(messages_element.is_displayed())
+            message_text = messages_element.text.strip()
+            self.assertTrue(message_text.startswith("FEEDBACK"))
+            message_text = message_text[8:].lstrip()
+            self.assertEqual(MESSAGES[msg_type], message_text)
+
+    def click_choice(self, container, choice_text):
+        """ Click on the choice label with the specified text """
+        for label in container.find_elements_by_css_selector('.choices .choice label'):
+            if choice_text in label.text:
+                label.click()
+                break
+
+    @ddt.data(
+        ("One", COMPLETED),
+        ("Two", COMPLETED),
+        ("I don't understand", MAX_REACHED),
+    )
+    @ddt.unpack
+    def test_one_shot(self, choice_text, expected_message_type):
+        """
+        Test a question that has max_attempts set to 1
+        """
+        mentoring = self.load_scenario("messages.xml", {"max_attempts": 1})
+        self.expect_message(None, mentoring)
+        self.click_choice(mentoring, choice_text)
+        self.click_submit(mentoring)
+        self.expect_message(expected_message_type, mentoring)
+
+    @ddt.data(
+        (2, "One", COMPLETED),
+        (2, "I don't understand", MAX_REACHED),
+        (0, "I don't understand", INCOMPLETE),
+        (10, "I don't understand", INCOMPLETE),
+    )
+    @ddt.unpack
+    def test_retry(self, max_attempts, choice_text, expected_message_type):
+        """
+        Test submitting a wrong answer, seeing a message, then submitting another answer.
+        In each case, max_attempts is not 1.
+        """
+        mentoring = self.load_scenario("messages.xml", {"max_attempts": max_attempts})
+        # First, there should be no message.
+        self.expect_message(None, mentoring)
+        # Let's get the question wrong:
+        self.click_choice(mentoring, "I don't understand")
+        self.click_submit(mentoring)
+        # We should now see the INCOMPLETE message:
+        self.expect_message(INCOMPLETE, mentoring)
+
+        # Now, answer as directed and expect the given message:
+        self.click_choice(mentoring, "One")  # Make sure we change our choice so we will be able to submit
+        self.click_choice(mentoring, choice_text)
+        self.click_submit(mentoring)
+        self.expect_message(expected_message_type, mentoring)

problem_builder/tests/integration/xml_templates/messages.xml

+<problem-builder url_name="messages-test" display_name="A Simple Problem Set" max_attempts="{{max_attempts}}">
+    <html_demo>
+        <p>This is a test of messages</p>
+    </html_demo>
+
+    <pb-mcq name="mcq_1_1" question="What is 1+0x1?" correct_choices='["one", "two"]'>
+        <pb-choice value="one">One</pb-choice>
+        <pb-choice value="two">Two</pb-choice>
+        <pb-choice value="huh">I don't understand</pb-choice>
+
+        <pb-tip values='["one"]'>Yep, if you interpret 'x' as multiplication, this equals one.</pb-tip>
+        <pb-tip values='["two"]'>You must be a programmer. If you interpret '0x' as a hexadecimal prefix, this equals two.</pb-tip>
+    </pb-mcq>
+
+    <pb-message type="completed">Great job! (completed message)</pb-message>
+    <pb-message type="incomplete">Not quite! You can try again, though. (incomplete message)</pb-message>
+    <pb-message type="max_attempts_reached">Sorry, you have used up all of your allowed submissions. (max_attempts_reached message)</pb-message>
+    <pb-message type="on-assessment-review">You may try this assessment again, and only the latest score will be used. (on-assessment-review message)</pb-message>
+</problem-builder>