# pylint: disable=too-many-lines
# -*- coding: utf-8 -*-
"""
Tests of extended hints
"""
import unittest
import pytest
from ddt import data, ddt, unpack
from xmodule.capa.tests.helpers import load_fixture, new_loncapa_problem
# With the use of ddt, some of the data expected_string cases below are naturally long stretches
# of text text without whitespace. I think it's best to leave such lines intact
# in the test code. Therefore:
# For out many ddt data cases, prefer a compact form of { .. }
class HintTest(unittest.TestCase):
"""Base class for tests of extended hinting functionality."""
def correctness(self, problem_id, choice):
"""Grades the problem and returns the 'correctness' string from cmap."""
student_answers = {problem_id: choice}
cmap = self.problem.grade_answers(answers=student_answers) # pylint: disable=no-member
return cmap[problem_id]["correctness"]
def get_hint(self, problem_id, choice):
"""Grades the problem and returns its hint from cmap or the empty string."""
student_answers = {problem_id: choice}
cmap = self.problem.grade_answers(answers=student_answers) # pylint: disable=no-member
adict = cmap.cmap.get(problem_id)
if adict:
return adict["msg"]
return ""
# It is a little surprising how much more complicated TextInput is than all the other cases.
@ddt
class TextInputHintsTest(HintTest):
"""
Test Text Input Hints Test
"""
xml = load_fixture("extended_hints_text_input.xml")
problem = new_loncapa_problem(xml)
def test_tracking_log(self):
"""Test that the tracking log comes out right."""
self.problem.capa_block.reset_mock()
self.get_hint("1_3_1", "Blue")
self.problem.capa_block.runtime.publish.assert_called_with(
self.problem.capa_block,
"edx.problem.hint.feedback_displayed",
{
"module_id": "i4x://Foo/bar/mock/abc",
"problem_part_id": "1_2",
"trigger_type": "single",
"hint_label": "Correct:",
"correctness": True,
"student_answer": ["Blue"],
"question_type": "stringresponse",
"hints": [{"text": "The red light is scattered by water molecules leaving only blue light."}],
},
)
@data(
{
"problem_id": "1_2_1",
"choice": "GermanyΩ",
"expected_string": (
'Answer
'
'
Incorrect: '
'
I do not think so.Ω
Answer
'
'
Correct: '
'
Viva la France!Ω
Answer
'
'
Correct: '
'
Viva la France!Ω
Answer
'
'
Correct: '
"Less well known, but yes, there is a Paris, Texas.Ω
Answer
'
'
Correct: '
"Less well known, but yes, there is a Paris, Texas.Ω
Answer
'
'
Incorrect: '
'
The country name does not end in LANDΩ
Answer
'
'
Correct: '
"The red light is scattered by water molecules leaving only blue light.
Answer
'
'
Incorrect: '
'
hint4
Answer
'
'
Incorrect: '
'
hint6
Answer
'
'
Correct: '
'
hint1
Answer
'
'
Correct: '
'
hint2
Answer
'
'
Correct: '
'
hint1
Answer
'
'
Correct: '
'
hint1
Answer
'
'
Correct: '
'
hint1
Answer
'
'
Correct: '
'
hint2
Answer
'
'
Correct: '
'
hint2
Answer
'
'
Incorrect: '
'
hint4
Answer
'
'
Incorrect: '
'
hint4
Answer
'
'
Incorrect: '
'
hint6
Answer
'
'
Incorrect: '
'
hint6
Answer
'
'
Nice '
"The square root of two turns up in the strangest places.
Answer
'
'
Correct: '
'
This is an additional hint.
Answer
'
'
Correct: '
'
Pretty easy, uh?.
Answer
'
'
Nice '
"The square root of two turns up in the strangest places.
Answer
'
'
Incorrect: '
'
You are right that apple is a fruit.
'
'
You are right that mushrooms are not fruit
'
'
Remember that grape is also a fruit.
'
'
What is a camero anyway?
Answer
'
'
Incorrect: '
'
Remember that apple is also a fruit.
'
'
Mushroom is a fungus, not a fruit.
'
'
Remember that grape is also a fruit.
'
'
What is a camero anyway?
Answer
'
'
Incorrect: '
'
Remember that apple is also a fruit.
'
'
You are right that mushrooms are not fruit
'
'
You are right that grape is a fruit
'
'
What is a camero anyway?
Answer
'
'
Incorrect: '
'
Remember that apple is also a fruit.
'
'
You are right that mushrooms are not fruit
'
'
Remember that grape is also a fruit.
'
'
What is a camero anyway?
Answer
'
'
Incorrect: '
'
Remember that apple is also a fruit.
'
'
You are right that mushrooms are not fruit
'
'
Remember that grape is also a fruit.
'
'
I do not know what a Camero is but it is not a fruit.'
"
Answer
'
'
Almost right '
"You are right that apple is a fruit, but there is one you are missing. "
"Also, mushroom is not a fruit.
Answer
'
'
Incorrect: '
"You are right that grape is a fruit, but there is one you are missing. "
"Also, mushroom is not a fruit.
Answer
'
'
Correct: '
'
You are right that apple is a fruit.
'
'
You are right that mushrooms are not fruit
'
'
You are right that grape is a fruit
'
'
What is a camero anyway?
Answer
'
'
Incorrect: '
'
No, sorry, a banana is a fruit.
'
'
You are right that mushrooms are not vegatbles
'
'
Brussel sprout is the only vegetable in this list.'
"
Answer
'
'
Incorrect: '
'
poor banana.
'
'
You are right that mushrooms are not vegatbles
'
'
Brussel sprout is the only vegetable in this list.'
"
Answer
'
'
Incorrect: '
'
poor banana.
'
'
Mushroom is a fungus, not a vegetable.
'
'
Brussel sprout is the only vegetable in this list.'
"
Answer
'
'
Correct: '
'
poor banana.
'
'
You are right that mushrooms are not vegatbles
'
'
Brussel sprouts are vegetables.
Answer
'
'
Very funny '
'
Making a banana split?
Answer
'
'
Incorrect: '
'
poor banana.
'
'
Mushroom is a fungus, not a vegetable.
'
'
Brussel sprout is the only vegetable in this list.'
"
Answer
'
'
Incorrect: '
'
No, sorry, a banana is a fruit.
'
'
Mushroom is a fungus, not a vegetable.
'
'
Brussel sprout is the only vegetable in this list.'
"
question
Apple
A true
A false
Banana
Cronut
C true
A C Compound
"""
problem = new_loncapa_problem(xml)
def test_tracking_log(self):
"""Test checkbox tracking log - by far the most complicated case"""
# A -> 1 hint
self.get_hint("1_2_1", ["choice_0"])
self.problem.capa_block.runtime.publish.assert_called_with(
self.problem.capa_block,
"edx.problem.hint.feedback_displayed",
{
"hint_label": "Incorrect:",
"module_id": "i4x://Foo/bar/mock/abc",
"problem_part_id": "1_1",
"choice_all": ["choice_0", "choice_1", "choice_2"],
"correctness": False,
"trigger_type": "single",
"student_answer": ["choice_0"],
"hints": [{"text": "A true", "trigger": [{"choice": "choice_0", "selected": True}]}],
"question_type": "choiceresponse",
},
)
# B C -> 2 hints
self.problem.capa_block.runtime.publish.reset_mock()
self.get_hint("1_2_1", ["choice_1", "choice_2"])
self.problem.capa_block.runtime.publish.assert_called_with(
self.problem.capa_block,
"edx.problem.hint.feedback_displayed",
{
"hint_label": "Incorrect:",
"module_id": "i4x://Foo/bar/mock/abc",
"problem_part_id": "1_1",
"choice_all": ["choice_0", "choice_1", "choice_2"],
"correctness": False,
"trigger_type": "single",
"student_answer": ["choice_1", "choice_2"],
"hints": [
{"text": "A false", "trigger": [{"choice": "choice_0", "selected": False}]},
{"text": "C true", "trigger": [{"choice": "choice_2", "selected": True}]},
],
"question_type": "choiceresponse",
},
)
# A C -> 1 Compound hint
self.problem.capa_block.runtime.publish.reset_mock()
self.get_hint("1_2_1", ["choice_0", "choice_2"])
self.problem.capa_block.runtime.publish.assert_called_with(
self.problem.capa_block,
"edx.problem.hint.feedback_displayed",
{
"hint_label": "Correct:",
"module_id": "i4x://Foo/bar/mock/abc",
"problem_part_id": "1_1",
"choice_all": ["choice_0", "choice_1", "choice_2"],
"correctness": True,
"trigger_type": "compound",
"student_answer": ["choice_0", "choice_2"],
"hints": [
{
"text": "A C Compound",
"trigger": [{"choice": "choice_0", "selected": True}, {"choice": "choice_2", "selected": True}],
}
],
"question_type": "choiceresponse",
},
)
@ddt
class MultpleChoiceHintsTest(HintTest):
"""
This class consists of a suite of test cases to be run on the multiple choice problem represented by the XML below.
"""
xml = load_fixture("extended_hints_multiple_choice.xml")
problem = new_loncapa_problem(xml)
def test_tracking_log(self):
"""Test that the tracking log comes out right."""
self.problem.capa_block.reset_mock()
self.get_hint("1_3_1", "choice_2")
self.problem.capa_block.runtime.publish.assert_called_with(
self.problem.capa_block,
"edx.problem.hint.feedback_displayed",
{
"module_id": "i4x://Foo/bar/mock/abc",
"problem_part_id": "1_2",
"trigger_type": "single",
"student_answer": ["choice_2"],
"correctness": False,
"question_type": "multiplechoiceresponse",
"hint_label": "OOPS",
"hints": [{"text": "Apple is a fruit."}],
},
)
@data(
{
"problem_id": "1_2_1",
"choice": "choice_0",
"expected_string": (
'Answer
'
'
Mushroom is a fungus, not a fruit.
Answer
'
'
Correct: '
'
Potato is a root vegetable.
Answer
'
'
OUTSTANDING '
'
Apple is indeed a fruit.
Answer
'
'
OOPS '
'
Apple is a fruit.
is a fungus, not a fruit.'}],
},
)
@data(
{
"problem_id": "1_2_1",
"choice": "choice_0",
"expected_string": (
'Answer
'
'
Incorrect: '
'Mushroom
is a fungus, not a fruit.
Answer
'
'
Incorrect: '
'Potato is
not a fruit.
Answer
'
'
Good Job '
"Yes, multiple choice is the right answer.
Answer
'
'
Incorrect: '
"No, text input problems do not present options.
Answer
'
'
Incorrect: '
"No, numerical input problems do not present options.
Answer
'
'
Correct: '
"With lots of makeup, doncha know?
Answer
'
'
NOPE '
"Not dogs, not cats, not toads
Answer
'
'
Incorrect: '
'
AAABBB1
Answer
'
'
Correct: '
'
AAABBB2