Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
<?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/>.

/**
 * Unit tests for importziplib.
 *
 * @package    assignfeedback_file
 * @copyright  2020 Eric Merrill <merrill@oakland.edu>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

> namespace assignfeedback_file; defined('MOODLE_INTERNAL') || die(); > > use mod_assign_test_generator; global $CFG; >
require_once($CFG->dirroot . '/mod/assign/tests/generator.php'); require_once($CFG->dirroot . '/mod/assign/feedback/file/importziplib.php'); /** * Unit tests for importziplib. *
> * @package assignfeedback_file
* @copyright 2020 Eric Merrill <merrill@oakland.edu> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */
< class assignfeedback_importziplib_testcase extends advanced_testcase {
> class importziplib_test extends \advanced_testcase {
// Use the generator helper. use mod_assign_test_generator; /** * Test the assignfeedback_file_zip_importer->is_valid_filename_for_import() method. */ public function test_is_valid_filename_for_import() { // Do the initial assign setup. $this->resetAfterTest(); $course = $this->getDataGenerator()->create_course(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $assign = $this->create_instance($course, [ 'assignsubmission_onlinetext_enabled' => 1, 'assignfeedback_file_enabled' => 1, ]); // Create an online text submission. $this->add_submission($student, $assign); // Now onto the file work. $fs = get_file_storage(); // Setup a basic file we will work with. We will keep renaming and repathing it.
< $record = new stdClass;
> $record = new \stdClass;
$record->contextid = $assign->get_context()->id; $record->component = 'assignfeedback_file'; $record->filearea = ASSIGNFEEDBACK_FILE_FILEAREA; $record->itemid = $assign->get_user_grade($student->id, true)->id; $record->filepath = '/'; $record->filename = '1.txt'; $record->source = 'test'; $file = $fs->create_file_from_string($record, 'file content'); // The importer we will use.
< $importer = new assignfeedback_file_zip_importer();
> $importer = new \assignfeedback_file_zip_importer();
// Setup some variable we use. $user = null; $plugin = null; $filename = ''; $allusers = $assign->list_participants(0, false); $participants = array(); foreach ($allusers as $user) { $participants[$assign->get_uniqueid_for_user($user->id)] = $user; } $file->rename('/import/', '.hiddenfile'); $result = $importer->is_valid_filename_for_import($assign, $file, $participants, $user, $plugin, $filename); $this->assertFalse($result); $file->rename('/import/', '~hiddenfile'); $result = $importer->is_valid_filename_for_import($assign, $file, $participants, $user, $plugin, $filename); $this->assertFalse($result); $file->rename('/import/some_path_here/', 'RandomFile.txt'); $result = $importer->is_valid_filename_for_import($assign, $file, $participants, $user, $plugin, $filename); $this->assertFalse($result); $file->rename('/import/', '~hiddenfile'); $result = $importer->is_valid_filename_for_import($assign, $file, $participants, $user, $plugin, $filename); $this->assertFalse($result); // Get the students assign id. $studentid = $assign->get_uniqueid_for_user($student->id); // Submissions are identified with the format: // StudentName_StudentID_PluginType_Plugin_FilePathAndName. // Test a string student id. $badname = 'Student Name_StringID_assignsubmission_file_My_cool_filename.txt'; $file->rename('/import/', $badname); $result = $importer->is_valid_filename_for_import($assign, $file, $participants, $user, $plugin, $filename); $this->assertFalse($result); // Test an invalid student id. $badname = 'Student Name_' . ($studentid + 100) . '_assignsubmission_file_My_cool_filename.txt'; $file->rename('/import/', $badname); $result = $importer->is_valid_filename_for_import($assign, $file, $participants, $user, $plugin, $filename); $this->assertFalse($result); // Test an invalid submission plugin. $badname = 'Student Name_' . $studentid . '_assignsubmission_noplugin_My_cool_filename.txt'; $file->rename('/import/', $badname); $result = $importer->is_valid_filename_for_import($assign, $file, $participants, $user, $plugin, $filename); $this->assertFalse($result); // Test a basic, good file. $goodbase = 'Student Name_' . $studentid . '_assignsubmission_file_'; $file->rename('/import/', $goodbase . "My_cool_filename.txt"); $result = $importer->is_valid_filename_for_import($assign, $file, $participants, $user, $plugin, $filename); $this->assertTrue($result); $this->assertEquals($participants[$studentid], $user); $this->assertEquals('My_cool_filename.txt', $filename);
< $this->assertInstanceOf(assign_submission_file::class, $plugin);
> $this->assertInstanceOf(\assign_submission_file::class, $plugin);
// Test another good file, with some additional path and underscores. $user = null; $plugin = null; $filename = ''; $file->rename('/import/some_path_here/' . $goodbase . '/some_path/', 'My File.txt'); $result = $importer->is_valid_filename_for_import($assign, $file, $participants, $user, $plugin, $filename); $this->assertTrue($result); $this->assertEquals($participants[$studentid], $user); $this->assertEquals('/some_path/My File.txt', $filename);
< $this->assertInstanceOf(assign_submission_file::class, $plugin);
> $this->assertInstanceOf(\assign_submission_file::class, $plugin);
} }