tests/local/object_manipulator/pusher_test.php
<?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/>.

namespace tool_objectfs\local\object_manipulator;

use tool_objectfs\local\manager;
use tool_objectfs\local\object_manipulator\candidates\candidates_finder;

/**
 * Tests for object pusher.
 *
 * @covers \tool_objectfs\local\object_manipulator\pusher
 * @package   tool_objectfs
 * @copyright Catalyst IT
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
final class pusher_test extends \tool_objectfs\tests\testcase {

    /** @var string $manipulator */
    protected $manipulator = pusher::class;

    /** @var pusher Pusher object */
    protected $pusher;

    protected function setUp(): void {
        parent::setUp();
        $config = manager::get_objectfs_config();
        $config->sizethreshold = 0;
        $config->minimumage = 0;
        manager::set_objectfs_config($config);
        $this->logger = new \tool_objectfs\log\aggregate_logger();
        $this->pusher = new pusher($this->filesystem, $config, $this->logger);
        ob_start();
    }

    protected function tearDown(): void {
        ob_end_clean();
        parent::tearDown();
    }

    /**
     * set_pusher_config
     * @param mixed $key
     * @param mixed $value
     *
     * @return void
     */
    protected function set_pusher_config($key, $value) {
        $config = manager::get_objectfs_config();
        $config->$key = $value;
        manager::set_objectfs_config($config);
        $this->pusher = new pusher($this->filesystem, $config, $this->logger);
    }

    public function test_pusher_get_candidate_objects_will_get_local_objects(): void {
        $object = $this->create_local_object();

        self::assertTrue($this->objects_contain_hash($object->contenthash));;
    }

    public function test_pusher_get_candidate_objects_wont_get_duplicated_or_remote_objects(): void {
        $duplicatedobject = $this->create_duplicated_object();
        $remoteobject = $this->create_remote_object();

        self::assertFalse($this->objects_contain_hash($duplicatedobject->contenthash));
        self::assertFalse($this->objects_contain_hash($remoteobject->contenthash));
    }

    public function test_pusher_get_candidate_objects_wont_get_objects_bigger_than_maximum_filesize(): void {
        global $DB;
        $object = $this->create_local_object();
        $maximumfilesize = $this->filesystem->get_maximum_upload_filesize() + 1;
        $DB->set_field('tool_objectfs_objects', 'filesize', $maximumfilesize, ['contenthash' => $object->contenthash]);

        self::assertFalse($this->objects_contain_hash($object->contenthash));
    }

    public function test_pusher_get_candidate_objects_wont_get_objects_under_size_threshold(): void {
        global $DB;
        $this->set_pusher_config('sizethreshold', 100);
        $object = $this->create_local_object();
        $DB->set_field('tool_objectfs_objects', 'filesize', 10, ['contenthash' => $object->contenthash]);

        self::assertFalse($this->objects_contain_hash($object->contenthash));
    }

    public function test_pusher_get_candidate_objects_wont_get_objects_younger_than_minimum_age(): void {
        $this->set_pusher_config('minimumage', 100);
        $object = $this->create_local_object();

        self::assertFalse($this->objects_contain_hash($object->contenthash));
    }

    public function test_pusher_can_push_local_file(): void {
        global $DB;
        $object = $this->create_local_object();

        $this->pusher->execute([$object]);

        $location = $DB->get_field('tool_objectfs_objects', 'location', ['contenthash' => $object->contenthash]);
        $this->assertEquals(OBJECT_LOCATION_DUPLICATED, $location);
        $this->assertTrue($this->is_locally_readable_by_hash($object->contenthash));
        $this->assertTrue($this->is_externally_readable_by_hash($object->contenthash));
    }

    public function test_pusher_can_handle_duplicated_file(): void {
        global $DB;
        $object = $this->create_duplicated_object();

        $this->pusher->execute([$object]);

        $location = $DB->get_field('tool_objectfs_objects', 'location', ['contenthash' => $object->contenthash]);
        $this->assertEquals(OBJECT_LOCATION_DUPLICATED, $location);
        $this->assertTrue($this->is_locally_readable_by_hash($object->contenthash));
        $this->assertTrue($this->is_externally_readable_by_hash($object->contenthash));
    }

    public function test_pusher_can_handle_remote_file(): void {
        global $DB;
        $object = $this->create_remote_object();

        $this->pusher->execute([$object]);

        $location = $DB->get_field('tool_objectfs_objects', 'location', ['contenthash' => $object->contenthash]);
        $this->assertEquals(OBJECT_LOCATION_EXTERNAL, $location);
        $this->assertFalse($this->is_locally_readable_by_hash($object->contenthash));
        $this->assertTrue($this->is_externally_readable_by_hash($object->contenthash));
    }

    public function test_pusher_can_push_multiple_objects(): void {
        global $DB;
        $objects = [];
        for ($i = 0; $i < 5; $i++) {
            $objects[] = $this->create_local_object("Object $i");
        }

        $this->pusher->execute($objects);

        foreach ($objects as $object) {
            $location = $DB->get_field('tool_objectfs_objects', 'location', ['contenthash' => $object->contenthash]);
            $this->assertEquals(OBJECT_LOCATION_DUPLICATED, $location);
            $this->assertTrue($this->is_locally_readable_by_hash($object->contenthash));
            $this->assertTrue($this->is_externally_readable_by_hash($object->contenthash));
        }
    }

    public function test_get_candidate_objects_get_one_object_if_files_have_same_hash_different_mimetype(): void {
        global $DB;
        // Push initial objects so they arnt candidates.
        $config = manager::get_objectfs_config();
        $config->filesystem = get_class($this->filesystem);
        $finder = new candidates_finder($this->manipulator, $config);
        $objects = $finder->get();
        $this->pusher->execute($objects);

        $object = $this->create_local_object();
        $file = $DB->get_record('files', ['contenthash' => $object->contenthash]);

        // Update mimetype to something different and insert as new file.
        $file->mimetype = "differentMimeType";
        $file->pathnamehash = '1234';
        $DB->insert_record('files', $file);

        $objects = $finder->get();

        $this->assertEquals(1, count($objects));
    }
}
