xapi_test_case.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 logstore_xapi;

defined('MOODLE_INTERNAL') || die();

global $CFG;

require_once($CFG->dirroot . '/admin/tool/log/store/xapi/vendor/autoload.php');
require_once($CFG->dirroot . '/admin/tool/log/store/xapi/src/autoload.php');

foreach (glob($CFG->dirroot . '/admin/tool/log/store/xapi/tests/utils/*.php') as $filename) {
    require_once($filename);
}

use \Locker\XApi\Statement as LockerStatement;
use TestUtils as utils;

/**
 * Default test cases for the plugin.
 *
 * @package   logstore_xapi
 * @copyright Jerret Fowler <jerrett.fowler@gmail.com>
 *            Ryan Smith <https://www.linkedin.com/in/ryan-smith-uk/>
 *            David Pesce <david.pesce@exputo.com>
 *            Milt Reder <milt@yetanalytics.com>
 * @license   https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
abstract class xapi_test_case extends \advanced_testcase {

    /**
     * Retrieve the directory of the unit test.
     */
    abstract protected function get_test_dir();

    /**
     * Retrieve the plugin type being tested.
     */
    abstract protected function get_plugin_type();

    /**
     * Retrieve the plugin name being tested.
     */
    abstract protected function get_plugin_name();

    /**
     * Retrieve the test data from data.json.
     *
     * @return object
     */
    protected function get_test_data() {
        return json_decode(file_get_contents($this->get_test_dir().'/data.json'));
    }

    /**
     * Retrieve the event data from event.json.
     *
     * @return object
     */
    protected function get_event() {
        // TODO: only pull this once
        // get common event fields
        global $CFG;
        $commonEvent = json_decode(file_get_contents($CFG->dirroot . '/admin/tool/log/store/xapi/tests/common/event.json'));
        // get this event
        $event = json_decode(file_get_contents($this->get_test_dir().'/event.json'));
        // merge and return
        return utils\deep_merge_objects($event, $commonEvent);
    }

    /**
     * Retrieve the expected statement from statements.json.
     *
     * @return array
     */
    protected function get_expected_statements() {
        // TODO: only pull this once
        // Get common statement fields
        global $CFG;
        $commonStatement = json_decode(file_get_contents($CFG->dirroot . '/admin/tool/log/store/xapi/tests/common/statement.json'));
        return array_map(function ($statement) use ($commonStatement) {
            // add common expectations for all statements
            return utils\deep_merge_objects($statement, $commonStatement);
        }, json_decode(file_get_contents($this->get_test_dir().'/statements.json')));
    }

    /**
     * Create the test event.
     *
     * @return void
     */
    public function test_create_event() {
        $event = $this->get_event();
        $logerror = function ($message = '') {
            echo("ERROR: $message\n");
        };
        $loginfo = function ($message = '') {
            echo("INFO: $message\n");
        };
        $handlerconfig = [
            'log_error' => $logerror,
            'log_info' => $loginfo,
            'transformer' => $this->get_transformer_config(),
            'loader' => [
                'loader' => 'none',
                'lrs_endpoint' => '',
                'lrs_username' => '',
                'lrs_password' => '',
                'lrs_max_batch_size' => 1,
            ],
        ];
        $loadedevents = \src\handler($handlerconfig, [$event]);
        $statements = array_reduce($loadedevents, function ($result, $loadedevent) {
            $eventstatements = $loadedevent['statements'];
            return array_merge($result, $eventstatements);
        }, []);
        $this->assert_expected_statements($statements);
        foreach ($statements as $statement) {
            $this->assert_valid_xapi_statement($statement);
        }
    }

    /**
     * Get the transformer configuration.
     *
     * @return array
     */
    protected function get_transformer_config() {
        $testdata = $this->get_test_data();
        return [
            'source_url' => 'http://moodle.org',
            'source_name' => 'Moodle',
            'source_version' => '1.0.0',
            'source_lang' => 'en',
            'send_mbox' => false,
            'send_name' => true,
            'account_homepage' => 'http://www.example.org',
            'send_response_choices' => false,
            'send_short_course_id' => false,
            'send_course_and_module_idnumber' => false,
            'send_username' => false,
            'send_jisc_data' => false,
            'session_id' => 'test_session_id',
            'plugin_url' => 'https://github.com/xAPI-vle/moodle-logstore_xapi',
            'plugin_version' => '0.0.0-development',
            'repo' => new \src\transformer\repos\TestRepository($testdata),
            'app_url' => 'http://www.example.org',
        ];
    }

    /**
     * Assert that the statement is a valid xAPI statement.
     *
     * @param array $statement The xAPI statement.
     * @return void
     */
    private function assert_valid_xapi_statement(array $statement) {
        $errors = LockerStatement::createFromJson(json_encode($statement))->validate();
        $errorsjson = json_encode(array_map(function ($error) {
            return (string) $error;
        }, $errors));
        $this->assertEmpty($errors, $errorsjson);
    }

    /**
     * Assert that the statement generated matches the expected statement.
     *
     * @param array $statements The xAPI statements to match.
     * @return void
     */
    private function assert_expected_statements(array $statements) {

        // Skip the test if the plugin is not installed.
        $pluginname = $this->get_plugin_name();
        $plugintype = $this->get_plugin_type();
        $plugins = \core_plugin_manager::instance()->get_installed_plugins($plugintype);

        if (array_key_exists($pluginname, $plugins) || $plugintype == 'core') {
            $expectedstatements = $this->get_expected_statements();
            $this->assertEquals(
                utils\objectToArray($expectedstatements),
                utils\objectToArray($statements)
            );
        } else {
            $this->markTestSkipped('Plugin ' . $pluginname . ' not installed, skipping');
        }
    }
}