Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
|
Steps definitions related to mod_quiz. More...
Public Member Functions | |
getSession ($name=null) | |
Returns the Mink session. More... | |
i_add_question_to_the_quiz_with ($questiontype, $quizname, TableNode $questiondata) | |
Adds a question to the existing quiz with filling the form. More... | |
i_click_on_shuffle_for_section ($heading) | |
Set Shuffle for shuffling questions within sections. More... | |
i_click_on_the_page_break_icon_after_question ($addorremoves, $questionname) | |
Click the add or remove page-break icon after a particular question. More... | |
i_delete_question_by_clicking_the_delete_icon ($questionname) | |
Delete a question on the Edit quiz page by first clicking on the Delete icon, then clicking one of the "After ..." links. More... | |
i_move_question_after_item_by_clicking_the_move_icon ($questionname, $target) | |
Move a question on the Edit quiz page by first clicking on the Move icon, then clicking one of the "After ..." links. More... | |
i_move_question_after_item_by_dragging ($questionname, $target) | |
Move a question on the Edit quiz page by dragging a given question on top of another item. More... | |
i_open_the_add_to_quiz_menu_for ($pageorlast) | |
Open the add menu on a given page, or at the end of the Edit quiz page. More... | |
i_set_the_max_mark_for_quiz_question ($questionname, $newmark) | |
Set the max mark for a question on the Edit quiz page. More... | |
i_set_the_section_heading_for ($sectionname, $sectionheading) | |
Set the section heading for a given section on the Edit quiz page. More... | |
i_should_not_see_on_quiz_page ($questionname, $pagenumber) | |
Check whether a particular question is not on a particular page of the quiz on the Edit quiz page. More... | |
i_should_see_before_on_the_edit_quiz_page ($firstquestionname, $secondquestionname) | |
Check whether one question comes before another on the Edit quiz page. More... | |
i_should_see_on_quiz_page ($questionname, $pagenumber) | |
Check whether a particular question is on a particular page of the quiz on the Edit quiz page. More... | |
i_should_see_question_in_section_in_the_quiz_navigation ($questionnumber, $sectionheading) | |
Check that a given question comes after a given section heading in the quiz navigation block. More... | |
quiz_contains_the_following_questions ($quizname, TableNode $data) | |
Put the specified questions on the specified pages of a given quiz. More... | |
quiz_contains_the_following_sections ($quizname, TableNode $data) | |
Put the specified section headings to start at specified pages of a given quiz. More... | |
should_have_number_on_the_edit_quiz_page ($questionname, $number) | |
Check the number displayed alongside a question on the Edit quiz page. More... | |
shuffle_for_section_should_be ($heading, $value) | |
Check the shuffle checkbox for a particular section. More... | |
the_page_break_icon_after_question_should_exist ($addorremoves, $questionname) | |
Assert the add or remove page-break icon after a particular question exists. More... | |
the_page_break_icon_after_question_should_not_exist ($addorremoves, $questionname) | |
Assert the add or remove page-break icon after a particular question does not exist. More... | |
the_page_break_link_after_question_should_contain ($addorremoves, $questionname, $paramdata) | |
Check the add or remove page-break link after a particular question contains the given parameters in its url. More... | |
user_has_attempted_with_responses ($username, $quizname, TableNode $attemptinfo) | |
Attempt a quiz. More... | |
user_has_checked_answers_in_their_attempt_at_quiz ($username, $quizname, TableNode $attemptinfo) | |
Submit answers to questions an existing quiz attempt, with a simulated click on the 'Check' button. More... | |
user_has_finished_an_attempt_at_quiz ($username, $quizname) | |
Finish an existing quiz attempt. More... | |
user_has_input_answers_in_their_attempt_at_quiz ($username, $quizname, TableNode $attemptinfo) | |
Input answers to particular questions an existing quiz attempt, without simulating a click of the 'Check' button, if any. More... | |
user_has_started_an_attempt_at_quiz ($username, $quizname) | |
Start a quiz attempt without answers. More... | |
user_has_started_an_attempt_at_quiz_with_details ($username, $quizname, TableNode $attemptinfo) | |
Start a quiz attempt without answers. More... | |
Public Attributes | |
const | EXTENDED_TIMEOUT = 10 |
And extended timeout for specific cases. More... | |
const | PAGE_READY_JS |
The JS code to check that the page is ready. More... | |
const | REDUCED_TIMEOUT = 2 |
Small timeout. More... | |
const | TIMEOUT = 6 |
The timeout for each Behat step (load page, wait for an element to load...). More... | |
Protected Member Functions | |
extract_forced_randomisation_from_attempt_info (TableNode $attemptinfo) | |
Helper used by user_has_attempted_with_responses, user_has_started_an_attempt_at_quiz_with_details, etc. More... | |
extract_responses_from_attempt_info (TableNode $attemptinfo) | |
Helper used by user_has_attempted_with_responses, user_has_checked_answers_in_their_attempt_at_quiz, user_has_input_answers_in_their_attempt_at_quiz, etc. More... | |
finish_adding_question ($questiontypename, TableNode $questiondata) | |
Helper used by i_add_a_question_filling_the_form_with() and to finish creating() . More... | |
get_cm_by_quiz_name (string $name) | |
Get a quiz cmid from the quiz name. More... | |
get_quiz_by_name (string $name) | |
Get a quiz by name. More... | |
get_xpath_for_shuffle_checkbox ($heading) | |
Return the xpath for shuffle checkbox in section heading. More... | |
get_xpath_page_break_icon_after_question ($addorremoves, $questionname) | |
Get the xpath for a partcular add/remove page-break icon. More... | |
resolve_page_instance_url (string $type, string $identifier) | |
Convert page names to URLs for steps like 'When I am on the "[identifier]" "[page type]" page'. More... | |
resolve_page_url (string $page) | |
Convert page names to URLs for steps like 'When I am on the "[page name]" page'. More... | |
Steps definitions related to mod_quiz.
|
protected |
Helper used by user_has_attempted_with_responses, user_has_started_an_attempt_at_quiz_with_details, etc.
TableNode | $attemptinfo | data table from the Behat step |
array | with two elements, $forcedrandomquestions, $forcedvariants, that can be passed to $quizgenerator->create_attempt. |
|
protected |
Helper used by user_has_attempted_with_responses, user_has_checked_answers_in_their_attempt_at_quiz, user_has_input_answers_in_their_attempt_at_quiz, etc.
TableNode | $attemptinfo | data table from the Behat step |
array | of responses that can be passed to $quizgenerator->submit_responses. |
|
protectedinherited |
Helper used by i_add_a_question_filling_the_form_with() and to finish creating()
.
string | $questiontypename | The question type name |
TableNode | $questiondata | The data to fill the question type form |
|
protected |
Get a quiz cmid from the quiz name.
string | $name | quiz name. |
stdClass | cm from get_coursemodule_from_instance. |
|
protected |
Get a quiz by name.
string | $name | quiz name. |
stdClass | the corresponding DB row. |
|
protected |
Return the xpath for shuffle checkbox in section heading.
string | $heading |
string |
|
protected |
Get the xpath for a partcular add/remove page-break icon.
string | $addorremoves | 'Add' or 'Remove'. |
string | $questionname | the name of the question before the icon. |
string | the requried xpath. |
|
inherited |
Returns the Mink session.
string | null | $name | name of the session OR active session will be used |
Behat::Mink::Session |
Implemented in behat_form_field.
behat_mod_quiz::i_add_question_to_the_quiz_with | ( | $questiontype, | |
$quizname, | |||
TableNode | $questiondata | ||
) |
Adds a question to the existing quiz with filling the form.
The form for creating a question should be on one page.
@When /^I add a "(?P<question_type_string>(?:[^"]|::")*)" question to the "(?P<quiz_name_string>(?:[^"]|")*)" quiz with:$/
string | $questiontype | |
string | $quizname | |
TableNode | $questiondata | with data for filling the add question form |
Reimplemented in behat_theme_classic_behat_mod_quiz.
behat_mod_quiz::i_click_on_shuffle_for_section | ( | $heading | ) |
Set Shuffle for shuffling questions within sections.
string | $heading | the heading of the section to change shuffle for. |
@Given /^I click on shuffle for section "([^"]*)" on the quiz edit page$/
behat_mod_quiz::i_click_on_the_page_break_icon_after_question | ( | $addorremoves, | |
$questionname | |||
) |
Click the add or remove page-break icon after a particular question.
@When /^I click on the "(Add|Remove)" page break icon after question "(?P<question_name>(?:[^"]|::")*)"$/
string | $addorremoves | 'Add' or 'Remove'. |
string | $questionname | the name of the question before the icon to click. |
behat_mod_quiz::i_delete_question_by_clicking_the_delete_icon | ( | $questionname | ) |
Delete a question on the Edit quiz page by first clicking on the Delete icon, then clicking one of the "After ..." links.
@When /^I delete "(?P<question_name>(?:[^"]|::")*)" in the quiz by clicking the delete icon$/
string | $questionname | the name of the question we are looking for. |
array | of steps. |
behat_mod_quiz::i_move_question_after_item_by_clicking_the_move_icon | ( | $questionname, | |
$target | |||
) |
Move a question on the Edit quiz page by first clicking on the Move icon, then clicking one of the "After ..." links.
@When /^I move "(?P<question_name>(?:[^"]|::")*)" to "(?P<target>(?:[^"]|")*)" in the quiz by clicking the move icon$/ @param string $questionname the name of the question we are looking for. @param string $target the target place to move to. One of the links in the pop-up like "After Page 1" or "After Question N".
behat_mod_quiz::i_move_question_after_item_by_dragging | ( | $questionname, | |
$target | |||
) |
Move a question on the Edit quiz page by dragging a given question on top of another item.
@When /^I move "(?P<question_name>(?:[^"]|::")*)" to "(?P<target>(?:[^"]|")*)" in the quiz by dragging$/ @param string $questionname the name of the question we are looking for. @param string $target the target place to move to. Ether a question name, or "Page N"
behat_mod_quiz::i_open_the_add_to_quiz_menu_for | ( | $pageorlast | ) |
Open the add menu on a given page, or at the end of the Edit quiz page.
@Given /^I open the "(?P<page_n_or_last_string>(?:[^"]|::")*)" add to quiz menu$/
string | $pageorlast | either "Page n" or "last". |
behat_mod_quiz::i_set_the_max_mark_for_quiz_question | ( | $questionname, | |
$newmark | |||
) |
Set the max mark for a question on the Edit quiz page.
@When /^I set the max mark for question "(?P<question_name_string>(?:[^"]|::")*)" to "(?P<new_mark_string>(?:[^"]|")*)"$/
string | $questionname | the name of the question to set the max mark for. |
string | $newmark | the mark to set |
behat_mod_quiz::i_set_the_section_heading_for | ( | $sectionname, | |
$sectionheading | |||
) |
Set the section heading for a given section on the Edit quiz page.
@When /^I change quiz section heading "(?P<section_name_string>(?:[^"]|::")*)" to "(?P<new_section_heading_string>(?:[^"]|")*)"$/
string | $sectionname | the heading to change. |
string | $sectionheading | the new heading to set. |
behat_mod_quiz::i_should_not_see_on_quiz_page | ( | $questionname, | |
$pagenumber | |||
) |
Check whether a particular question is not on a particular page of the quiz on the Edit quiz page.
@Given /^I should not see "(?P<question_name>(?:[^"]|::")*)" on quiz page "(?P<page_number>\d+)"$/
string | $questionname | the name of the question we are looking for. |
number | $pagenumber | the page it should be found on. |
behat_mod_quiz::i_should_see_before_on_the_edit_quiz_page | ( | $firstquestionname, | |
$secondquestionname | |||
) |
Check whether one question comes before another on the Edit quiz page.
The two questions must be on the same page. @Given /^I should see "(?P<first_q_name>(?:[^"]|::")*)" before "(?P<second_q_name>(?:[^"]|")*)" on the edit quiz page$/
string | $firstquestionname | the name of the question that should come first in order. |
string | $secondquestionname | the name of the question that should come immediately after it in order. |
behat_mod_quiz::i_should_see_on_quiz_page | ( | $questionname, | |
$pagenumber | |||
) |
Check whether a particular question is on a particular page of the quiz on the Edit quiz page.
@Given /^I should see "(?P<question_name>(?:[^"]|::")*)" on quiz page "(?P<page_number>\d+)"$/
string | $questionname | the name of the question we are looking for. |
number | $pagenumber | the page it should be found on. |
behat_mod_quiz::i_should_see_question_in_section_in_the_quiz_navigation | ( | $questionnumber, | |
$sectionheading | |||
) |
Check that a given question comes after a given section heading in the quiz navigation block.
@Then /^I should see question "(?P<questionnumber>::d+)" in section "(?P<section_heading_string>(?:[^"]|")*)" in the quiz navigation$/
int | $questionnumber | the number of the question to check. |
string | $sectionheading | which section heading it should appear after. |
behat_mod_quiz::quiz_contains_the_following_questions | ( | $quizname, | |
TableNode | $data | ||
) |
Put the specified questions on the specified pages of a given quiz.
The first row should be column names: | question | page | maxmark | requireprevious | The first two of those are required. The others are optional.
question needs to uniquely match a question name. page is a page number. Must start at 1, and on each following row should be the same as the previous, or one more. maxmark What the question is marked out of. Defaults to question.defaultmark. requireprevious The question can only be attempted after the previous one was completed.
Then there should be a number of rows of data, one for each question you want to add.
For backwards-compatibility reasons, specifying the column names is optional (but strongly encouraged). If not specified, the columns are asseumed to be | question | page | maxmark |.
string | $quizname | the name of the quiz to add questions to. |
TableNode | $data | information about the questions to add. |
@Given /^quiz "([^"]*)" contains the following questions:$/
behat_mod_quiz::quiz_contains_the_following_sections | ( | $quizname, | |
TableNode | $data | ||
) |
Put the specified section headings to start at specified pages of a given quiz.
The first row should be column names: | heading | firstslot | shufflequestions |
heading is the section heading text firstslot is the slot number where the section starts shuffle whether this section is shuffled (0 or 1)
Then there should be a number of rows of data, one for each section you want to add.
string | $quizname | the name of the quiz to add sections to. |
TableNode | $data | information about the sections to add. |
@Given /^quiz "([^"]*)" contains the following sections:$/
|
protected |
Convert page names to URLs for steps like 'When I am on the "[identifier]" "[page type]" page'.
Recognised page names are: | pagetype | name meaning | description | | View | Quiz name | The quiz info page (view.php) | | Edit | Quiz name | The edit quiz page (edit.php) | | Group overrides | Quiz name | The manage group overrides page | | User overrides | Quiz name | The manage user overrides page | | Grades report | Quiz name | The overview report for a quiz | | Responses report | Quiz name | The responses report for a quiz | | Statistics report | Quiz name | The statistics report for a quiz | | Attempt review | Quiz name > username > [Attempt] attempt no | Review page for a given attempt (review.php) |
string | $type | identifies which type of page this is, e.g. 'Attempt review'. |
string | $identifier | identifies the particular page, e.g. 'Test quiz > student > Attempt 1'. |
moodle_url | the corresponding URL. |
Exception | with a meaningful error message if the specified page cannot be found. |
|
protected |
Convert page names to URLs for steps like 'When I am on the "[page name]" page'.
Recognised page names are: | None so far! | |
string | $page | name of the page, with the component name removed e.g. 'Admin notification'. |
moodle_url | the corresponding URL. |
Exception | with a meaningful error message if the specified page cannot be found. |
behat_mod_quiz::should_have_number_on_the_edit_quiz_page | ( | $questionname, | |
$number | |||
) |
Check the number displayed alongside a question on the Edit quiz page.
@Given /^"(?P<question_name>(?:[^"]|::")*)" should have number "(?P<number>(?:[^"]|")*)" on the edit quiz page$/
string | $questionname | the name of the question we are looking for. |
number | $number | the number (or 'i') that should be displayed beside that question. |
behat_mod_quiz::shuffle_for_section_should_be | ( | $heading, | |
$value | |||
) |
Check the shuffle checkbox for a particular section.
string | $heading | the heading of the section to check shuffle for |
int | $value | whether the shuffle checkbox should be on or off. |
@Given /^shuffle for section "([^"]*)" should be "(On|Off)" on the quiz edit page$/
behat_mod_quiz::the_page_break_icon_after_question_should_exist | ( | $addorremoves, | |
$questionname | |||
) |
Assert the add or remove page-break icon after a particular question exists.
@When /^the "(Add|Remove)" page break icon after question "(?P<question_name>(?:[^"]|::")*)" should exist$/
string | $addorremoves | 'Add' or 'Remove'. |
string | $questionname | the name of the question before the icon to click. |
array | of steps. |
behat_mod_quiz::the_page_break_icon_after_question_should_not_exist | ( | $addorremoves, | |
$questionname | |||
) |
Assert the add or remove page-break icon after a particular question does not exist.
@When /^the "(Add|Remove)" page break icon after question "(?P<question_name>(?:[^"]|::")*)" should not exist$/
string | $addorremoves | 'Add' or 'Remove'. |
string | $questionname | the name of the question before the icon to click. |
array | of steps. |
behat_mod_quiz::the_page_break_link_after_question_should_contain | ( | $addorremoves, | |
$questionname, | |||
$paramdata | |||
) |
Check the add or remove page-break link after a particular question contains the given parameters in its url.
@When /^the "(Add|Remove)" page break link after question "(?P<question_name>(?:[^"]|::")*) should contain:"$/
string | $addorremoves | 'Add' or 'Remove'. |
string | $questionname | the name of the question before the icon to click. |
TableNode | $paramdata | with data for checking the page break url |
array | of steps. |
behat_mod_quiz::user_has_attempted_with_responses | ( | $username, | |
$quizname, | |||
TableNode | $attemptinfo | ||
) |
Attempt a quiz.
The first row should be column names: | slot | actualquestion | variant | response | The first two of those are required. The others are optional.
slot The slot actualquestion This column is optional, and is only needed if the quiz contains random questions. If so, this will let you control which actual question gets picked when this slot is 'randomised' at the start of the attempt. If you don't specify, then one will be picked at random (which might make the response meaningless). Give the question name. variant This column is similar, and also options. It is only needed if the question that ends up in this slot returns something greater than 1 for $question->get_num_variants(). Like with actualquestion, if you specify a value here it is used the fix the 'random' choice made when the quiz is started. response The response that was submitted. How this is interpreted depends on the question type. It gets passed to core_question_generator::get_simulated_post_data_for_question_attempt() and therefore to the un_summarise_response method of the question to decode.
Then there should be a number of rows of data, one for each question you want to add. There is no need to supply answers to all questions. If so, other qusetions will be left unanswered.
string | $username | the username of the user that will attempt. |
string | $quizname | the name of the quiz the user will attempt. |
TableNode | $attemptinfo | information about the questions to add, as above. @Given /^user "([^"]*)" has attempted "([^"]*)" with responses:$/ |
behat_mod_quiz::user_has_checked_answers_in_their_attempt_at_quiz | ( | $username, | |
$quizname, | |||
TableNode | $attemptinfo | ||
) |
Submit answers to questions an existing quiz attempt, with a simulated click on the 'Check' button.
This step should only be used with question behaviours that have have a 'Check' button. Those include Interactive with multiple tires, Immediate feedback and Immediate feedback with CBM.
Then there should be a number of rows of data, with two columns slot and response, as for user_has_attempted_with_responses() above. There is no need to supply answers to all questions. If so, other questions will be left unanswered.
string | $username | the username of the user that will attempt. |
string | $quizname | the name of the quiz the user will attempt. |
TableNode | $attemptinfo | information about the questions to add, as above. |
Behat::Mink::Exception::ExpectationException | @Given /^user "([^"]*)" has checked answers in their attempt at quiz "([^"]*)":$/ |
behat_mod_quiz::user_has_finished_an_attempt_at_quiz | ( | $username, | |
$quizname | |||
) |
Finish an existing quiz attempt.
string | $username | the username of the user that will attempt. |
string | $quizname | the name of the quiz the user will attempt. @Given /^user "([^"]*)" has finished an attempt at quiz "([^"]*)"$/ |
behat_mod_quiz::user_has_input_answers_in_their_attempt_at_quiz | ( | $username, | |
$quizname, | |||
TableNode | $attemptinfo | ||
) |
Input answers to particular questions an existing quiz attempt, without simulating a click of the 'Check' button, if any.
Then there should be a number of rows of data, with two columns slot and response, as for user_has_attempted_with_responses() above. There is no need to supply answers to all questions. If so, other questions will be left unanswered.
string | $username | the username of the user that will attempt. |
string | $quizname | the name of the quiz the user will attempt. |
TableNode | $attemptinfo | information about the questions to add, as above. |
Behat::Mink::Exception::ExpectationException | @Given /^user "([^"]*)" has input answers in their attempt at quiz "([^"]*)":$/ |
behat_mod_quiz::user_has_started_an_attempt_at_quiz | ( | $username, | |
$quizname | |||
) |
Start a quiz attempt without answers.
Then there should be a number of rows of data, one for each question you want to add. There is no need to supply answers to all questions. If so, other qusetions will be left unanswered.
string | $username | the username of the user that will attempt. |
string | $quizname | the name of the quiz the user will attempt. @Given /^user "([^"]*)" has started an attempt at quiz "([^"]*)"$/ |
behat_mod_quiz::user_has_started_an_attempt_at_quiz_with_details | ( | $username, | |
$quizname, | |||
TableNode | $attemptinfo | ||
) |
Start a quiz attempt without answers.
The supplied data table for have a row for each slot where you want to force either which random question was chose, or which random variant was used, as for user_has_attempted_with_responses() above.
string | $username | the username of the user that will attempt. |
string | $quizname | the name of the quiz the user will attempt. |
TableNode | $attemptinfo | information about the questions to add, as above. @Given /^user "([^"]*)" has started an attempt at quiz "([^"]*)" randomised as follows:$/ |
|
inherited |
And extended timeout for specific cases.
|
inherited |
The JS code to check that the page is ready.
The document must be complete and either M.util.pending_js must be empty, or it must not be defined at all.
|
inherited |
Small timeout.
A reduced timeout for cases where self::TIMEOUT is too much and a simple $this->getSession()->getPage()->find() could not be enough.
|
inherited |
The timeout for each Behat step (load page, wait for an element to load...).