lib/tests/requirejs_test.php

   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 namespace core;
  18
  19 use core_requirejs;
  20
  21 /**
  22  * Unit tests for requirejs.
  23  *
  24  * @package   core
  25  * @author    Damyon Wiese <damyon@moodle.com>
  26  * @copyright 2016 Damyon Wiese
  27  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  28  */
  29 class requirejs_test extends \advanced_testcase {
  30
  31     /**
  32      * Test requirejs loader
  33      */
  34     public function test_requirejs() {
  35         global $CFG;
  36
  37         // Find a core module.
  38         $result = core_requirejs::find_one_amd_module('core', 'templates', false);
  39         $expected = ['core/templates' => $CFG->dirroot . '/lib/amd/build/templates.min.js'];
  40         $this->assertEquals($expected, $result);
  41
  42         $result = core_requirejs::find_one_amd_module('core', 'templates', true);
  43         $expected = ['core/templates' => $CFG->dirroot . '/lib/amd/src/templates.js'];
  44         $this->assertEquals($expected, $result);
  45
  46         // Find a subsystem module (none exist yet).
  47         $result = core_requirejs::find_one_amd_module('core_group', 'doesnotexist', false);
  48         $expected = [];
  49         $this->assertEquals($expected, $result);
  50
  51         // Find a plugin module.
  52         $result = core_requirejs::find_one_amd_module('mod_assign', 'grading_panel', true);
  53         $expected = ['mod_assign/grading_panel' => $CFG->dirroot . '/mod/assign/amd/src/grading_panel.js'];
  54         $this->assertEquals($expected, $result);
  55
  56         // Find all modules - no debugging.
  57         $result = core_requirejs::find_all_amd_modules(true);
  58         foreach ($result as $key => $path) {
  59             // Lets verify the first part of the key is a valid component name and the second part correctly contains "min" or not.
  60             list($component, $template) = explode('/', $key, 2);
  61             // Can we resolve it to a valid dir?
  62             $dir = \core_component::get_component_directory($component);
  63             $this->assertNotEmpty($dir);
  64
  65             // Only "core" is allowed to have no _ in component names.
  66             if (strpos($component, '_') === false) {
  67                 $this->assertEquals('core', $component);
  68             }
  69             $this->assertStringNotContainsString('.min', $path);
  70         }
  71
  72         // Find all modules - debugging.
  73         $result = core_requirejs::find_all_amd_modules(false);
  74         foreach ($result as $key => $path) {
  75             // Lets verify the first part of the key is a valid component name and the second part correctly contains "min" or not.
  76             list($component, $template) = explode('/', $key, 2);
  77             $dir = \core_component::get_component_directory($component);
  78             $this->assertNotEmpty($dir);
  79             // Only "core" is allowed to have no _ in component names.
  80             if (strpos($component, '_') === false) {
  81                 $this->assertEquals('core', $component);
  82             }
  83
  84             $this->assertStringContainsString('.min', $path);
  85         }
  86
  87     }
  88 }