| 1 | 
           efrain | 
           1 | 
           <?php
  | 
        
        
            | 
            | 
           2 | 
           // This file is part of Moodle - http://moodle.org/
  | 
        
        
            | 
            | 
           3 | 
           //
  | 
        
        
            | 
            | 
           4 | 
           // Moodle is free software: you can redistribute it and/or modify
  | 
        
        
            | 
            | 
           5 | 
           // it under the terms of the GNU General Public License as published by
  | 
        
        
            | 
            | 
           6 | 
           // the Free Software Foundation, either version 3 of the License, or
  | 
        
        
            | 
            | 
           7 | 
           // (at your option) any later version.
  | 
        
        
            | 
            | 
           8 | 
           //
  | 
        
        
            | 
            | 
           9 | 
           // Moodle is distributed in the hope that it will be useful,
  | 
        
        
            | 
            | 
           10 | 
           // but WITHOUT ANY WARRANTY; without even the implied warranty of
  | 
        
        
            | 
            | 
           11 | 
           // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  | 
        
        
            | 
            | 
           12 | 
           // GNU General Public License for more details.
  | 
        
        
            | 
            | 
           13 | 
           //
  | 
        
        
            | 
            | 
           14 | 
           // You should have received a copy of the GNU General Public License
  | 
        
        
            | 
            | 
           15 | 
           // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  | 
        
        
            | 
            | 
           16 | 
              | 
        
        
            | 
            | 
           17 | 
           use core_external\external_api;
  | 
        
        
            | 
            | 
           18 | 
              | 
        
        
            | 
            | 
           19 | 
           defined('MOODLE_INTERNAL') || die();
  | 
        
        
            | 
            | 
           20 | 
              | 
        
        
            | 
            | 
           21 | 
           global $CFG;
  | 
        
        
            | 
            | 
           22 | 
              | 
        
        
            | 
            | 
           23 | 
           require_once($CFG->dirroot . '/webservice/tests/helpers.php');
  | 
        
        
            | 
            | 
           24 | 
           require_once($CFG->dirroot . '/mod/lti/locallib.php');
  | 
        
        
            | 
            | 
           25 | 
              | 
        
        
            | 
            | 
           26 | 
           /**
  | 
        
        
            | 
            | 
           27 | 
            * Abstract base testcase for mod_lti unit tests.
  | 
        
        
            | 
            | 
           28 | 
            *
  | 
        
        
            | 
            | 
           29 | 
            * @package    mod_lti
  | 
        
        
            | 
            | 
           30 | 
            * @author     Andrew Madden <andrewmadden@catalyst-au.net>
  | 
        
        
            | 
            | 
           31 | 
            * @copyright  2020 Catalyst IT
  | 
        
        
            | 
            | 
           32 | 
            * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  | 
        
        
            | 
            | 
           33 | 
            */
  | 
        
        
            | 
            | 
           34 | 
           abstract class mod_lti_testcase extends externallib_advanced_testcase  {
  | 
        
        
            | 
            | 
           35 | 
              | 
        
        
            | 
            | 
           36 | 
               /**
  | 
        
        
            | 
            | 
           37 | 
                * Generate a tool type.
  | 
        
        
            | 
            | 
           38 | 
                *
  | 
        
        
            | 
            | 
           39 | 
                * @param string $uniqueid Each tool type needs a different base url. Provide a unique string for every tool type created.
  | 
        
        
            | 
            | 
           40 | 
                * @param int|null $toolproxyid Optional proxy to associate with tool type.
  | 
        
        
            | 
            | 
           41 | 
                * @return stdClass A tool type.
  | 
        
        
            | 
            | 
           42 | 
                */
  | 
        
        
            | 
            | 
           43 | 
               protected function generate_tool_type(string $uniqueid, ?int $toolproxyid = null): stdClass {
  | 
        
        
            | 
            | 
           44 | 
                   // Create a tool type.
  | 
        
        
            | 
            | 
           45 | 
                   $type = new stdClass();
  | 
        
        
            | 
            | 
           46 | 
                   $type->state = LTI_TOOL_STATE_CONFIGURED;
  | 
        
        
            | 
            | 
           47 | 
                   $type->name = "Test tool $uniqueid";
  | 
        
        
            | 
            | 
           48 | 
                   $type->description = "Example description $uniqueid";
  | 
        
        
            | 
            | 
           49 | 
                   $type->toolproxyid = $toolproxyid;
  | 
        
        
            | 
            | 
           50 | 
                   $type->baseurl = $this->getExternalTestFileUrl("/test$uniqueid.html");
  | 
        
        
            | 
            | 
           51 | 
                   $type->coursevisible = LTI_COURSEVISIBLE_ACTIVITYCHOOSER;
  | 
        
        
            | 
            | 
           52 | 
                   $config = new stdClass();
  | 
        
        
            | 
            | 
           53 | 
                   $config->lti_coursevisible = LTI_COURSEVISIBLE_ACTIVITYCHOOSER;
  | 
        
        
            | 
            | 
           54 | 
              | 
        
        
            | 
            | 
           55 | 
                   $type->id = lti_add_type($type, $config);
  | 
        
        
            | 
            | 
           56 | 
                   return $type;
  | 
        
        
            | 
            | 
           57 | 
               }
  | 
        
        
            | 
            | 
           58 | 
              | 
        
        
            | 
            | 
           59 | 
               /**
  | 
        
        
            | 
            | 
           60 | 
                * Generate a tool proxy.
  | 
        
        
            | 
            | 
           61 | 
                *
  | 
        
        
            | 
            | 
           62 | 
                * @param string $uniqueid Each tool proxy needs a different reg url. Provide a unique string for every tool proxy created.
  | 
        
        
            | 
            | 
           63 | 
                * @return stdClass A tool proxy.
  | 
        
        
            | 
            | 
           64 | 
                */
  | 
        
        
            | 
            | 
           65 | 
               protected function generate_tool_proxy(string $uniqueid): stdClass {
  | 
        
        
            | 
            | 
           66 | 
                   // Create a tool proxy.
  | 
        
        
            | 
            | 
           67 | 
                   $proxy = mod_lti_external::create_tool_proxy("Test proxy $uniqueid",
  | 
        
        
            | 
            | 
           68 | 
                       $this->getExternalTestFileUrl("/proxy$uniqueid.html"), [], []);
  | 
        
        
            | 
            | 
           69 | 
                   return (object)external_api::clean_returnvalue(mod_lti_external::create_tool_proxy_returns(), $proxy);
  | 
        
        
            | 
            | 
           70 | 
               }
  | 
        
        
            | 
            | 
           71 | 
           }
  |