Merge branch 'MDL-63399-404' of https://github.com/lameze/moodle into MOODLE_404_STABLE

This commit is contained in:
Jun Pataleta
2024-09-06 12:29:21 +08:00
23 changed files with 313 additions and 39 deletions
@@ -5,16 +5,18 @@ Feature: I can download a preset
| name |
| Custom preset |
@javascript
Scenario: Custom preset settings can be downloaded
Given I log in as "admin"
And I navigate to "Site admin presets" in site administration
When I open the action menu in "Custom preset" "table_row"
Then following "Download" "link" in the "Custom preset" "table_row" should download between "0" and "5000" bytes
Then following "Download" in the "Custom preset" "table_row" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | Custom preset |
@javascript
Scenario: Core preset settings can be downloaded
Given I log in as "admin"
And I navigate to "Site admin presets" in site administration
When I open the action menu in "Starter" "table_row"
Then following "Download" "link" in the "Starter" "table_row" should download between "0" and "5000" bytes
Then following "Download" in the "Starter" "table_row" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | Starter |
@@ -55,7 +55,8 @@ Feature: Data export from the privacy API
And I reload the page
And I should see "Download ready" in the "Victim User 1" "table_row"
And I open the action menu in "Victim User 1" "table_row"
And following "Download" should download between "1" and "200000" bytes
And following "Download" should download a file that:
| Contains file in zip | index.html |
And the following config values are set as admin:
| privacyrequestexpiry | 1 | tool_dataprivacy |
And I wait "1" seconds
@@ -90,7 +91,8 @@ Feature: Data export from the privacy API
And I reload the page
And I should see "Download ready" in the "Export all of my personal data" "table_row"
And I open the action menu in "Victim User 1" "table_row"
And following "Download" should download between "1" and "200000" bytes
And following "Download" should download a file that:
| Contains file in zip | index.html |
And the following config values are set as admin:
| privacyrequestexpiry | 1 | tool_dataprivacy |
@@ -128,7 +130,8 @@ Feature: Data export from the privacy API
And I reload the page
And I should see "Download ready" in the "Victim User 1" "table_row"
And I open the action menu in "Victim User 1" "table_row"
And following "Download" should download between "1" and "200000" bytes
And following "Download" should download a file that:
| Contains file in zip | index.html |
And the following config values are set as admin:
| privacyrequestexpiry | 1 | tool_dataprivacy |
@@ -187,7 +190,8 @@ Feature: Data export from the privacy API
And I reload the page
And I should see "Download ready" in the "Victim User 1" "table_row"
And I open the action menu in "Victim User 1" "table_row"
And following "Download" should download between "1" and "172000" bytes
And following "Download" should download a file that:
| Contains file in zip | index.html |
And the following config values are set as admin:
| privacyrequestexpiry | 1 | tool_dataprivacy |
And I wait "1" seconds
@@ -231,7 +235,8 @@ Feature: Data export from the privacy API
And I reload the page
And I should see "Download ready" in the "Victim User 1" "table_row"
And I open the action menu in "Victim User 1" "table_row"
And following "Download" should download between "1" and "180000" bytes
And following "Download" should download a file that:
| Contains file in zip | index.html |
@javascript
Scenario: Filter before export data for a user and download it in the view request action
@@ -264,4 +269,5 @@ Feature: Data export from the privacy API
And I reload the page
And I should see "Download ready" in the "Victim User 1" "table_row"
And I open the action menu in "Victim User 1" "table_row"
And following "Download" should download between "1" and "180000" bytes
And following "Download" should download a file that:
| Contains file in zip | index.html |
+2 -1
View File
@@ -148,7 +148,8 @@ Feature: Manage analytics models
When I open the action menu in "Students at risk of not meeting the course completion conditions" "table_row"
And I choose "Export" in the open action menu
And I click on "Actions" "link" in the "Students at risk of not meeting the course completion conditions" "table_row"
And following "Export" should download between "100" and "500" bytes
And following "Export" should download a file that:
| Contains file in zip | model-config.json |
Scenario: Check invalid site elements
When I open the action menu in "Students at risk of not meeting the course completion conditions" "table_row"
+211
View File
@@ -0,0 +1,211 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Steps definitions to verify a downloaded file.
*
* @package core
* @category test
* @copyright 2024 Simey Lameze <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
use Behat\Gherkin\Node\TableNode;
use Behat\Mink\Exception\ExpectationException;
require_once(__DIR__ . '/../../behat/behat_base.php');
/**
* Steps definitions to verify a downloaded file.
*
* @package core
* @category test
* @copyright 2024 Simey Lameze <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class behat_download extends behat_base {
/**
* Downloads the file from a link on the page and verify the type and content.
*
* @Then following :link_text should download a file that:
*
* @param string $linktext the text of the link.
* @param TableNode $table the table of assertions to use the check the file contents.
* @throws ExpectationException if the file cannot be downloaded, or if the download does not pass all the checks.
*/
public function following_should_download_a_file_that(string $linktext, TableNode $table): void {
$this->following_in_element_should_download_a_file_that($linktext, '', '', $table);
}
/**
* Downloads the file from a link on the page and verify the type and content.
*
* @Then following :link_text in the :element_container_string :text_selector_string should download a file that:
*
* @param string $linktext the text of the link.
* @param string $containerlocator the container element.
* @param string $containertype the container selector type.
* @param TableNode $table the table of assertions to use the check the file contents.
* @throws ExpectationException if the file cannot be downloaded, or if the download does not pass all the checks.
*/
public function following_in_element_should_download_a_file_that(string $linktext, string $containerlocator,
string $containertype, TableNode $table): void {
$filecontent = $this->download_file($linktext, $containerlocator, $containertype);
$this->verify_file_content($filecontent, $table);
}
/**
* Download a file from the given link.
*
* @param string $linktext the text of the link.
* @param string $containerlocator the container element.
* @param string $containertype the container selector type.
* @return string the file contents.
* @throws ExpectationException if the download fails.
*/
protected function download_file(string $linktext, string $containerlocator, string $containertype): string {
return behat_context_helper::get('behat_general')->download_file_from_link($linktext, $containerlocator, $containertype);
}
/**
* Checks the content of the downloaded file.
*
* @param string $filecontent the content of the file.
* @param TableNode $table the table of assertions to check.
* @throws ExpectationException if the file content does not pass all the checks.
*/
private function verify_file_content(string $filecontent, TableNode $table): void {
foreach ($table->getRows() as $row) {
switch (strtolower(trim($row[0]))) {
case 'contains text':
$this->verify_file_contains_text($filecontent, $row[1]);
break;
case 'contains text in xml element':
$this->verify_xml_element_contains($filecontent, $row[1]);
break;
case 'has mimetype':
$this->verify_file_mimetype($filecontent, $row[1]);
break;
case 'contains file in zip':
$this->verify_zip_file_content($filecontent, $row[1]);
break;
default:
throw new ExpectationException(
'Invalid type of file assertion: ' . $row[0], $this->getSession());
}
}
}
/**
* Validates the downloaded file appears to be of the mimetype.
*
* @param string $filecontent the content of the file.
* @param string $expectedmimetype the expected file mimetype e.g. 'application/xml'.
* @throws ExpectationException if the file does not appear to be of the expected type.
*/
protected function verify_file_mimetype(string $filecontent, string $expectedmimetype): void {
$finfo = new finfo(FILEINFO_MIME_TYPE);
$actualmimetype = $finfo->buffer($filecontent);
if ($actualmimetype !== $expectedmimetype) {
throw new ExpectationException(
"The file downloaded should have been a $expectedmimetype file, " .
"but got $actualmimetype instead.",
$this->getSession(),
);
}
}
/**
* Asserts that the given string is present in the file content.
*
* @param string $filecontent the content of the file.
* @param string $expectedcontent the string to search for.
* @throws ExpectationException if verification fails.
*/
protected function verify_file_contains_text(string $filecontent, string $expectedcontent): void {
if (!str_contains($filecontent, $expectedcontent)) {
throw new ExpectationException(
"The string '$expectedcontent' was not found in the file content.",
$this->getSession(),
);
}
}
/**
* Asserts that the given XML file is valid and contains the expected string.
*
* @param string $filecontent the content of the file.
* @param string $expectedcontent the string to search for.
* @throws ExpectationException
*/
protected function verify_xml_element_contains(string $filecontent, string $expectedcontent): void {
$xml = new SimpleXMLElement($filecontent);
$result = $xml->xpath("//*[contains(text(), '$expectedcontent')]");
if (empty($result)) {
throw new ExpectationException(
"The string '$expectedcontent' was not found in the content of any element in this XML file.",
$this->getSession(),
);
}
}
/**
* Save the downloaded file to tempdir and return the path.
*
* @param string $filecontent the content of the file.
* @param string $fileextension the expected file type, given as a file extension, e.g. 'txt', 'xml'.
* @return string path where the file was saved temporarily.
*/
protected function save_to_temp_file(string $filecontent, string $fileextension): string {
// Then perform additional image-specific validations.
$tempdir = make_request_directory();
$filepath = $tempdir . '/downloaded.' . $fileextension;
file_put_contents($filepath, $filecontent);
return $filepath;
}
/**
* Asserts that the given zip archive contains the expected file(s).
*
* @param string $filecontent the content of the file.
* @param string $expectedfile the name of the file to search for.
* @throws ExpectationException if the zip file does not contain the expected files.
*/
protected function verify_zip_file_content(string $filecontent, string $expectedfile): void {
$zip = new ZipArchive();
$res = $zip->open($this->save_to_temp_file($filecontent, 'zip'));
if ($res !== true) {
throw new ExpectationException(
"Failed to open zip file.",
$this->getSession(),
);
}
if ($zip->locateName($expectedfile) === false) {
throw new ExpectationException(
"The file '$expectedfile' was not found in the downloaded zip archive.",
$this->getSession(),
);
}
}
}
+19 -5
View File
@@ -1644,15 +1644,24 @@ EOF;
/**
* Given the text of a link, download the linked file and return the contents.
*
* This is a helper method used by {@link following_should_download_bytes()}
* and {@link following_should_download_between_and_bytes()}
* A helper method used by the steps in {@see behat_download}, and the legacy
* {@see following_should_download_bytes()} and {@see following_should_download_between_and_bytes()}.
*
* @param string $link the text of the link.
* @param string $containerlocator optional container element locator.
* @param string $containertype optional container element selector type.
*
* @return string the content of the downloaded file.
*/
public function download_file_from_link($link) {
public function download_file_from_link(string $link, string $containerlocator = '', string $containertype = ''): string {
// Find the link.
$linknode = $this->find_link($link);
if ($containerlocator !== '' && $containertype !== '') {
$linknode = $this->get_node_in_container('link', $link, $containertype, $containerlocator);
} else {
$linknode = $this->find_link($link);
}
$this->ensure_node_is_visible($linknode);
// Get the href and check it.
@@ -1674,6 +1683,8 @@ EOF;
/**
* Downloads the file from a link on the page and checks the size.
*
* Not recommended any more. The steps in {@see behat_download} are much better!
*
* Only works if the link has an href attribute. Javascript downloads are
* not supported. Currently, the href must be an absolute URL.
*
@@ -1707,6 +1718,8 @@ EOF;
/**
* Downloads the file from a link on the page and checks the size is in a given range.
*
* Not recommended any more. The steps in {@see behat_download} are much better!
*
* Only works if the link has an href attribute. Javascript downloads are
* not supported. Currently, the href must be an absolute URL.
*
@@ -1714,10 +1727,11 @@ EOF;
* be between "5" and "10" bytes, and between "10" and "20" bytes.
*
* @Then /^following "(?P<link_string>[^"]*)" should download between "(?P<min_bytes>\d+)" and "(?P<max_bytes>\d+)" bytes$/
* @throws ExpectationException
*
* @param string $link the text of the link.
* @param number $minexpectedsize the minimum expected file size in bytes.
* @param number $maxexpectedsize the maximum expected file size in bytes.
* @throws ExpectationException
*/
public function following_should_download_between_and_bytes($link, $minexpectedsize, $maxexpectedsize) {
// If the minimum is greater than the maximum then swap the values.
+4 -3
View File
@@ -291,7 +291,6 @@ Feature: Users can view and manage data presets
And I should see "This is a short text"
Then "Use this preset" "button" should exist
@javascript
Scenario: Teachers can export any saved preset
Given I am on the "Mountain landscapes" "data activity" page logged in as teacher1
When I follow "Presets"
@@ -300,10 +299,12 @@ Feature: Users can view and manage data presets
# The teacher should be able to export any saved preset.
And I open the action menu in "Saved preset by teacher1" "table_row"
Then I should see "Export"
And following "Export" "link" in the "Saved preset by teacher1" "table_row" should download between "1" and "5000" bytes
And following "Export" in the "Saved preset by teacher1" "table_row" should download a file that:
| Contains file in zip | preset.xml |
And I open the action menu in "Saved preset 1" "table_row"
And I should see "Export"
And following "Export" "link" in the "Saved preset 1" "table_row" should download between "1" and "5000" bytes
And following "Export" in the "Saved preset 1" "table_row" should download a file that:
| Contains file in zip | preset.xml |
@javascript @_file_upload
Scenario Outline: Admins and Teachers can load a preset from a file
@@ -36,5 +36,8 @@ Feature: Files added in folder activity are visible in the recent activity block
And "//img[@alt='empty.txt']" "xpath_element" should exist
And "//img[contains(@src, 'preview=tinyicon')]" "xpath_element" should exist
# Confirm files are downloadable
And following "empty.txt" should download between "1" and "3000" bytes
And following "gd-logo.png" should download between "1" and "3000" bytes
And following "empty.txt" should download a file that:
| Has mimetype | text/plain |
| Contains text | empty file for testing purposes |
And following "gd-logo.png" should download a file that:
| Has mimetype | image/png |
@@ -44,5 +44,6 @@ Feature: Create a glossary entry.
# Confirm you can download attachment from student's entry as teacher
When I am on the "Test glossary" "glossary activity" page logged in as teacher1
Then I should see "Entry 1"
And I should see "musicians.xml"
And following "musicians.xml" should download between "1" and "3000" bytes
And following "musicians.xml" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | Paul McCartney |
@@ -26,7 +26,9 @@ Feature: Test exporting questions using Aiken format.
When I am on the "Course 1" "core_question > course question export" page logged in as "teacher1"
And I set the field "id_format_aiken" to "1"
When I press "Export questions to file"
Then following "click here" should download between "68" and "70" bytes
Then following "click here" should download a file that:
| Has mimetype | text/plain |
| Contains text | Which is the oddest number? |
# If the download step is the last in the scenario then we can sometimes run
# into the situation where the download page causes a http redirect but behat
# has already conducted its reset (generating an error). By putting a logout
@@ -31,7 +31,9 @@ Feature: Test importing questions from GIFT format.
And I am on the "Course 1" "core_question > course question export" page
And I set the field "id_format_gift" to "1"
And I press "Export questions to file"
And following "click here" should download between "1500" and "1800" bytes
And following "click here" should download a file that:
| Has mimetype | text/plain |
| Contains text | What's between orange and green in the spectrum? |
@javascript @_file_upload
Scenario: import a GIFT file which specifies the category
@@ -34,7 +34,10 @@ Feature: Test importing questions from Moodle XML format.
And I set the field "id_format_xml" to "1"
And I set the field "Export category" to "TrueFalse"
And I press "Export questions to file"
Then following "click here" should download between "57100" and "58150" bytes
Then following "click here" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | Moodle acronym (True) |
| Contains text in xml element | Moodle acronym (False) |
@javascript @_file_upload
Scenario: import some multiple choice questions from Moodle XML format
@@ -26,7 +26,9 @@ Feature: Test exporting drag and drop onto image questions
When I am on the "Course 1" "core_question > course question export" page logged in as teacher
And I set the field "id_format_xml" to "1"
And I press "Export questions to file"
Then following "click here" should download between "18600" and "19150" bytes
Then following "click here" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | Drag onto image |
# If the download step is the last in the scenario then we can sometimes run
# into the situation where the download page causes a http redirect but behat
# has already conducted its reset (generating an error). By putting a logout
@@ -26,7 +26,9 @@ Feature: Test exporting drag and drop markers questions
When I am on the "Course 1" "core_question > course question export" page logged in as teacher
And I set the field "id_format_xml" to "1"
And I press "Export questions to file"
Then following "click here" should download between "233700" and "233950" bytes
Then following "click here" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | Drag markers |
# If the download step is the last in the scenario then we can sometimes run
# into the situation where the download page causes a http redirect but behat
# has already conducted its reset (generating an error). By putting a logout
@@ -26,7 +26,9 @@ Feature: Test exporting drag and drop into text questions
When I am on the "Course 1" "core_question > course question export" page logged in as teacher
And I set the field "id_format_xml" to "1"
And I press "Export questions to file"
And following "click here" should download between "1550" and "1700" bytes
And following "click here" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | Drag to text |
# If the download step is the last in the scenario then we can sometimes run
# into the situation where the download page causes a http redirect but behat
# has already conducted its reset (generating an error). By putting a logout
@@ -25,7 +25,9 @@ Feature: Test exporting Description questions
When I am on the "Course 1" "core_question > course question export" page logged in as teacher
And I set the field "id_format_xml" to "1"
And I press "Export questions to file"
Then following "click here" should download between "650" and "900" bytes
Then following "click here" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | description-001 |
# If the download step is the last in the scenario then we can sometimes run
# into the situation where the download page causes a http redirect but behat
# has already conducted its reset (generating an error). By putting a logout
@@ -27,7 +27,11 @@ Feature: Test exporting Essay questions
When I am on the "Course 1" "core_question > course question export" page logged in as teacher
And I set the field "id_format_xml" to "1"
And I press "Export questions to file"
Then following "click here" should download between "3000" and "3500" bytes
Then following "click here" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | essay-001 |
| Contains text in xml element | essay-002 |
| Contains text in xml element | essay-003 |
# If the download step is the last in the scenario then we can sometimes run
# into the situation where the download page causes a http redirect but behat
# has already conducted its reset (generating an error). By putting a logout
@@ -32,7 +32,9 @@ Feature: Import and export select missing words questions
And I am on the "Course 1" "core_question > course question export" page logged in as teacher
And I set the field "id_format_xml" to "1"
And I press "Export questions to file"
And following "click here" should download between "1650" and "1800" bytes
And following "click here" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | Select missing words 001 |
# If the download step is the last in the scenario then we can sometimes run
# into the situation where the download page causes a http redirect but behat
# has already conducted its reset (generating an error). By putting a logout
@@ -25,7 +25,9 @@ Feature: Test exporting Matching questions
When I am on the "Course 1" "core_question > course question export" page logged in as teacher
And I set the field "id_format_xml" to "1"
And I press "Export questions to file"
Then following "click here" should download between "1600" and "1750" bytes
Then following "click here" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | matching-001 |
# If the download step is the last in the scenario then we can sometimes run
# into the situation where the download page causes a http redirect but behat
# has already conducted its reset (generating an error). By putting a logout
@@ -26,7 +26,10 @@ Feature: Test exporting Multiple choice questions
When I am on the "Course 1" "core_question > course question export" page logged in as teacher
And I set the field "id_format_xml" to "1"
And I press "Export questions to file"
Then following "click here" should download between "3900" and "4100" bytes
Then following "click here" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | Multi-choice-001 |
| Contains text in xml element | Multi-choice-002 |
# If the download step is the last in the scenario then we can sometimes run
# into the situation where the download page causes a http redirect but behat
# has already conducted its reset (generating an error). By putting a logout
@@ -26,7 +26,10 @@ Feature: Test exporting Numerical questions
When I am on the "Course 1" "core_question > course question export" page logged in as teacher
And I set the field "id_format_xml" to "1"
And I press "Export questions to file"
Then following "click here" should download between "3650" and "3750" bytes
Then following "click here" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | Numerical-001 |
| Contains text in xml element | Numerical-002 |
# If the download step is the last in the scenario then we can sometimes run
# into the situation where the download page causes a http redirect but behat
# has already conducted its reset (generating an error). By putting a logout
@@ -21,11 +21,13 @@ Feature: Test exporting Ordering questions
| questioncategory | qtype | name | template |
| Test questions | ordering | Moodle | moodle |
Scenario: Export a Matching question
Scenario: Export a ordering question
When I am on the "Course 1" "core_question > course question export" page logged in as teacher1
And I set the field "id_format_xml" to "1"
And I press "Export questions to file"
Then following "click here" should download between "1700" and "2350" bytes
Then following "click here" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | Moodle |
# If the download step is the last in the scenario then we can sometimes run
# into the situation where the download page causes a http redirect but behat
# has already conducted its reset (generating an error). By putting a logout
@@ -25,7 +25,9 @@ Feature: Test exporting Short answer questions
When I am on the "Course 1" "core_question > course question export" page logged in as teacher
And I set the field "id_format_xml" to "1"
And I press "Export questions to file"
Then following "click here" should download between "1200" and "1450" bytes
Then following "click here" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | shortanswer-001 |
# If the download step is the last in the scenario then we can sometimes run
# into the situation where the download page causes a http redirect but behat
# has already conducted its reset (generating an error). By putting a logout
@@ -25,7 +25,9 @@ Feature: Test exporting True/False questions
When I am on the "Course 1" "core_question > course question export" page logged in as teacher
And I set the field "id_format_xml" to "1"
And I press "Export questions to file"
Then following "click here" should download between "1000" and "1200" bytes
Then following "click here" should download a file that:
| Has mimetype | text/xml |
| Contains text in xml element | true-false-001 |
# If the download step is the last in the scenario then we can sometimes run
# into the situation where the download page causes a http redirect but behat
# has already conducted its reset (generating an error). By putting a logout