mirrored from git://git.moodle.org/moodle.git
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-41945 mod_assign: Properly check if submission is empty
Previous empty submission checks required the submission to be saved to the database. This patch adds a new method to submission plugins that lets them report whether the submission is empty before it is saved.
- Loading branch information
1 parent
16b36d3
commit c89d23e
Showing
8 changed files
with
375 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,141 @@ | ||
<?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/>. | ||
|
||
/** | ||
* Tests for mod/assign/submission/file/locallib.php | ||
* | ||
* @package assignsubmission_file | ||
* @copyright 2016 Cameron Ball | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
global $CFG; | ||
require_once($CFG->dirroot . '/mod/assign/tests/base_test.php'); | ||
|
||
/** | ||
* Unit tests for mod/assign/submission/file/locallib.php | ||
* | ||
* @copyright 2016 Cameron Ball | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class assignsubmission_file_locallib_testcase extends advanced_testcase { | ||
|
||
/** @var stdClass $user A user to submit an assignment. */ | ||
protected $user; | ||
|
||
/** @var stdClass $course New course created to hold the assignment activity. */ | ||
protected $course; | ||
|
||
/** @var stdClass $cm A context module object. */ | ||
protected $cm; | ||
|
||
/** @var stdClass $context Context of the assignment activity. */ | ||
protected $context; | ||
|
||
/** @var stdClass $assign The assignment object. */ | ||
protected $assign; | ||
|
||
/** | ||
* Setup all the various parts of an assignment activity including creating an onlinetext submission. | ||
*/ | ||
protected function setUp() { | ||
$this->user = $this->getDataGenerator()->create_user(); | ||
$this->course = $this->getDataGenerator()->create_course(); | ||
$generator = $this->getDataGenerator()->get_plugin_generator('mod_assign'); | ||
$params = [ | ||
'course' => $this->course->id, | ||
'assignsubmission_file_enabled' => 1, | ||
'assignsubmission_file_maxfiles' => 12, | ||
'assignsubmission_file_maxsizebytes' => 10, | ||
]; | ||
$instance = $generator->create_instance($params); | ||
$this->cm = get_coursemodule_from_instance('assign', $instance->id); | ||
$this->context = context_module::instance($this->cm->id); | ||
$this->assign = new testable_assign($this->context, $this->cm, $this->course); | ||
$this->setUser($this->user->id); | ||
} | ||
|
||
/** | ||
* Test submission_is_empty | ||
* | ||
* @dataProvider submission_is_empty_testcases | ||
* @param string $data The file submission data | ||
* @param bool $expected The expected return value | ||
*/ | ||
public function test_submission_is_empty($data, $expected) { | ||
$this->resetAfterTest(); | ||
|
||
$itemid = file_get_unused_draft_itemid(); | ||
$submission = (object)['files_filemanager' => $itemid]; | ||
$plugin = $this->assign->get_submission_plugin_by_type('file'); | ||
|
||
if ($data) { | ||
$data += ['contextid' => context_user::instance($this->user->id)->id, 'itemid' => $itemid]; | ||
$fs = get_file_storage(); | ||
$fs->create_file_from_string((object)$data, 'Content of ' . $data['filename']); | ||
} | ||
|
||
$result = $plugin->submission_is_empty($submission); | ||
$this->assertTrue($result === $expected); | ||
} | ||
|
||
/** | ||
* Test new_submission_empty | ||
* | ||
* @dataProvider submission_is_empty_testcases | ||
* @param string $data The file submission data | ||
* @param bool $expected The expected return value | ||
*/ | ||
public function test_new_submission_empty($data, $expected) { | ||
$this->resetAfterTest(); | ||
|
||
$itemid = file_get_unused_draft_itemid(); | ||
$submission = (object)['files_filemanager' => $itemid]; | ||
|
||
if ($data) { | ||
$data += ['contextid' => context_user::instance($this->user->id)->id, 'itemid' => $itemid]; | ||
$fs = get_file_storage(); | ||
$fs->create_file_from_string((object)$data, 'Content of ' . $data['filename']); | ||
} | ||
|
||
$result = $this->assign->new_submission_empty($submission); | ||
$this->assertTrue($result === $expected); | ||
} | ||
|
||
/** | ||
* Dataprovider for the test_submission_is_empty testcase | ||
* | ||
* @return array of testcases | ||
*/ | ||
public function submission_is_empty_testcases() { | ||
return [ | ||
'With file' => [ | ||
[ | ||
'component' => 'user', | ||
'filearea' => 'draft', | ||
'filepath' => '/', | ||
'filename' => 'not_a_virus.exe' | ||
], | ||
false | ||
], | ||
'Without file' => [null, true] | ||
]; | ||
} | ||
|
||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
116 changes: 116 additions & 0 deletions
116
mod/assign/submission/onlinetext/tests/locallib_test.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
<?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/>. | ||
|
||
/** | ||
* Tests for mod/assign/submission/onlinetext/locallib.php | ||
* | ||
* @package assignsubmission_onlinetext | ||
* @copyright 2016 Cameron Ball | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
global $CFG; | ||
require_once($CFG->dirroot . '/mod/assign/tests/base_test.php'); | ||
|
||
/** | ||
* Unit tests for mod/assign/submission/onlinetext/locallib.php | ||
* | ||
* @copyright 2016 Cameron Ball | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class assignsubmission_onlinetext_locallib_testcase extends advanced_testcase { | ||
|
||
/** @var stdClass $user A user to submit an assignment. */ | ||
protected $user; | ||
|
||
/** @var stdClass $course New course created to hold the assignment activity. */ | ||
protected $course; | ||
|
||
/** @var stdClass $cm A context module object. */ | ||
protected $cm; | ||
|
||
/** @var stdClass $context Context of the assignment activity. */ | ||
protected $context; | ||
|
||
/** @var stdClass $assign The assignment object. */ | ||
protected $assign; | ||
|
||
/** | ||
* Setup all the various parts of an assignment activity including creating an onlinetext submission. | ||
*/ | ||
protected function setUp() { | ||
$this->user = $this->getDataGenerator()->create_user(); | ||
$this->course = $this->getDataGenerator()->create_course(); | ||
$generator = $this->getDataGenerator()->get_plugin_generator('mod_assign'); | ||
$params = ['course' => $this->course->id, 'assignsubmission_onlinetext_enabled' => 1]; | ||
$instance = $generator->create_instance($params); | ||
$this->cm = get_coursemodule_from_instance('assign', $instance->id); | ||
$this->context = context_module::instance($this->cm->id); | ||
$this->assign = new testable_assign($this->context, $this->cm, $this->course); | ||
$this->setUser($this->user->id); | ||
} | ||
|
||
/** | ||
* Test submission_is_empty | ||
* | ||
* @dataProvider submission_is_empty_testcases | ||
* @param string $submissiontext The online text submission text | ||
* @param bool $expected The expected return value | ||
*/ | ||
public function test_submission_is_empty($submissiontext, $expected) { | ||
$this->resetAfterTest(); | ||
|
||
$plugin = $this->assign->get_submission_plugin_by_type('onlinetext'); | ||
$data = new stdClass(); | ||
$data->onlinetext_editor = ['text' => $submissiontext]; | ||
|
||
$result = $plugin->submission_is_empty($data); | ||
$this->assertTrue($result === $expected); | ||
} | ||
|
||
/** | ||
* Test new_submission_empty | ||
* | ||
* @dataProvider submission_is_empty_testcases | ||
* @param string $submissiontext The file submission data | ||
* @param bool $expected The expected return value | ||
*/ | ||
public function test_new_submission_empty($submissiontext, $expected) { | ||
$this->resetAfterTest(); | ||
$data = new stdClass(); | ||
$data->onlinetext_editor = ['text' => $submissiontext]; | ||
|
||
$result = $this->assign->new_submission_empty($data); | ||
$this->assertTrue($result === $expected); | ||
} | ||
|
||
/** | ||
* Dataprovider for the test_submission_is_empty testcase | ||
* | ||
* @return array of testcases | ||
*/ | ||
public function submission_is_empty_testcases() { | ||
return [ | ||
'Empty submission string' => ['', true], | ||
'Empty submission null' => [null, true], | ||
'Value 0' => [0, false], | ||
'String 0' => ['0', false], | ||
'Text' => ['Ai! laurië lantar lassi súrinen, yéni únótimë ve rámar aldaron!', false] | ||
]; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.