[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

   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  defined('MOODLE_INTERNAL') || die();
  18  
  19  global $CFG;
  20  
  21  require_once($CFG->dirroot . '/webservice/tests/helpers.php');
  22  
  23  /**
  24   * Abstract base testcase for mod_lti unit tests.
  25   *
  26   * @package    mod_lti
  27   * @author     Andrew Madden <andrewmadden@catalyst-au.net>
  28   * @copyright  2020 Catalyst IT
  29   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  30   */
  31  abstract class mod_lti_testcase extends externallib_advanced_testcase  {
  32  
  33      /**
  34       * Generate a tool type.
  35       *
  36       * @param string $uniqueid Each tool type needs a different base url. Provide a unique string for every tool type created.
  37       * @param int|null $toolproxyid Optional proxy to associate with tool type.
  38       * @return stdClass A tool type.
  39       */
  40      protected function generate_tool_type(string $uniqueid, ?int $toolproxyid = null): stdClass {
  41          // Create a tool type.
  42          $type = new stdClass();
  43          $type->state = LTI_TOOL_STATE_CONFIGURED;
  44          $type->name = "Test tool $uniqueid";
  45          $type->description = "Example description $uniqueid";
  46          $type->toolproxyid = $toolproxyid;
  47          $type->baseurl = $this->getExternalTestFileUrl("/test$uniqueid.html");
  48          lti_add_type($type, new stdClass());
  49          return $type;
  50      }
  51  
  52      /**
  53       * Generate a tool proxy.
  54       *
  55       * @param string $uniqueid Each tool proxy needs a different reg url. Provide a unique string for every tool proxy created.
  56       * @return stdClass A tool proxy.
  57       */
  58      protected function generate_tool_proxy(string $uniqueid): stdClass {
  59          // Create a tool proxy.
  60          $proxy = mod_lti_external::create_tool_proxy("Test proxy $uniqueid",
  61              $this->getExternalTestFileUrl("/proxy$uniqueid.html"), [], []);
  62          return (object)external_api::clean_returnvalue(mod_lti_external::create_tool_proxy_returns(), $proxy);
  63      }
  64  }