[Summary view]

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402]

   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  /**
  18   * Unit tests for localization support in lib/moodlelib.php
  19   *
  20   * @package     core
  21   * @category    phpunit
  22   * @copyright   2013 David Mudrak <david@moodle.com>
  23   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace core;
  27  
  28  use core_string_manager_standard;
  29  
  30  defined('MOODLE_INTERNAL') || die();
  31  
  32  global $CFG;
  33  require_once($CFG->libdir.'/moodlelib.php');
  34  
  35  /**
  36   * Tests for the API of the string_manager.
  37   *
  38   * Unit tests for localization support in lib/moodlelib.php
  39   *
  40   * @package   core
  41   * @category  test
  42   * @copyright 2013 David Mudrak <david@moodle.com>
  43   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  44   */
  45  class string_manager_standard_test extends \advanced_testcase {
  46  
  47      public function test_string_manager_instance() {
  48          $this->resetAfterTest();
  49  
  50          $otherroot = __DIR__.'/fixtures/langtest';
  51          $stringman = testable_core_string_manager::instance($otherroot);
  52          $this->assertInstanceOf('core_string_manager', $stringman);
  53      }
  54  
  55      public function test_get_language_dependencies() {
  56          $this->resetAfterTest();
  57  
  58          $otherroot = __DIR__.'/fixtures/langtest';
  59          $stringman = testable_core_string_manager::instance($otherroot);
  60  
  61          // There is no parent language for 'en'.
  62          $this->assertSame(array(), $stringman->get_language_dependencies('en'));
  63          // Language with no parent language declared.
  64          $this->assertSame(array('aa'), $stringman->get_language_dependencies('aa'));
  65          // Language with parent language explicitly set to English (en < de).
  66          $this->assertSame(array('de'), $stringman->get_language_dependencies('de'));
  67          // Language dependency hierarchy (de < de_du < de_kids).
  68          $this->assertSame(array('de', 'de_du', 'de_kids'), $stringman->get_language_dependencies('de_kids'));
  69          // Language with the parent language misconfigured to itself (sd < sd).
  70          $this->assertSame(array('sd'), $stringman->get_language_dependencies('sd'));
  71          // Language with circular dependency (cda < cdb < cdc < cda).
  72          $this->assertSame(array('cda', 'cdb', 'cdc'), $stringman->get_language_dependencies('cdc'));
  73          // Orphaned language (N/A < bb).
  74          $this->assertSame(array('bb'), $stringman->get_language_dependencies('bb'));
  75          // Descendant of an orphaned language (N/A < bb < bc).
  76          $this->assertSame(array('bb', 'bc'), $stringman->get_language_dependencies('bc'));
  77      }
  78  
  79      public function test_deprecated_strings() {
  80          $stringman = get_string_manager();
  81  
  82          // Check non-deprecated string.
  83          $this->assertFalse($stringman->string_deprecated('hidden', 'grades'));
  84  
  85          // Check deprecated string, make sure to update once that chosen below is finally removed.
  86          $this->assertTrue($stringman->string_deprecated('coursepage', 'core_admin'));
  87          $this->assertTrue($stringman->string_exists('coursepage', 'core_admin'));
  88          $this->assertDebuggingNotCalled();
  89          $this->assertEquals('Course page', get_string('coursepage', 'core_admin'));
  90          $this->assertDebuggingCalled('String [coursepage,core_admin] is deprecated. '.
  91              'Either you should no longer be using that string, or the string has been incorrectly deprecated, in which case you should report this as a bug. '.
  92              'Please refer to https://moodledev.io/general/projects/api/string-deprecation');
  93      }
  94  
  95      /**
  96       * Return all deprecated strings.
  97       *
  98       * @return array
  99       */
 100      public function get_deprecated_strings_provider() {
 101          global $CFG;
 102  
 103          $teststringman = testable_core_string_manager::instance($CFG->langotherroot, $CFG->langlocalroot, array());
 104          $allstrings = $teststringman->get_all_deprecated_strings();
 105          return array_map(function($string) {
 106              return [$string];
 107          }, $allstrings);
 108      }
 109  
 110      /**
 111       * This test is a built-in validation of deprecated.txt files in lang locations.
 112       *
 113       * It will fail if the string in the wrong format or non-existing (mistyped) string was deprecated.
 114       *
 115       * @dataProvider get_deprecated_strings_provider
 116       * @param   string      $string     The string to be tested
 117       */
 118      public function test_validate_deprecated_strings_files($string) {
 119          $stringman = get_string_manager();
 120  
 121          $result = preg_match('/^(.*),(.*)$/', $string, $matches);
 122          $this->assertEquals(1, $result);
 123          $this->assertCount(3, $matches);
 124          $this->assertEquals($matches[2], clean_param($matches[2], PARAM_COMPONENT),
 125              "Component name {$string} appearing in one of the lang/en/deprecated.txt files does not have correct syntax");
 126  
 127          list($pluginttype, $pluginname) = \core_component::normalize_component($matches[2]);
 128          $normcomponent = $pluginname ? ($pluginttype . '_' . $pluginname) : $pluginttype;
 129          $this->assertEquals($normcomponent, $matches[2],
 130              'String "'.$string.'" appearing in one of the lang/en/deprecated.txt files does not have normalised component name');
 131  
 132          $this->assertTrue($stringman->string_exists($matches[1], $matches[2]),
 133              "String {$string} appearing in one of the lang/en/deprecated.txt files does not exist");
 134      }
 135  
 136      /**
 137       * Test for $CFG->langlist (without installation of additional languages)
 138       */
 139      public function test_get_list_of_translations() {
 140          $this->resetAfterTest();
 141          $stringman = get_string_manager();
 142  
 143          $this->assertEquals(['en' => 'English ‎(en)‎'], $stringman->get_list_of_translations());
 144  
 145          set_config('langlist', 'en|En');
 146          get_string_manager(true);
 147          $stringman = get_string_manager();
 148  
 149          $this->assertEquals(['en' => 'En'], $stringman->get_list_of_translations());
 150  
 151          // Set invalid config, ensure original list is returned.
 152          set_config('langlist', 'xx');
 153          $this->assertEquals(['en' => 'English ‎(en)‎'], get_string_manager(true)->get_list_of_translations());
 154  
 155          set_config('langlist', 'xx,en|En');
 156          $this->assertEquals(['en' => 'En'], get_string_manager(true)->get_list_of_translations());
 157  
 158          set_config('langlist', '');
 159          get_string_manager(true);
 160      }
 161  
 162      /**
 163       * Test {@see core_string_manager_standard::get_list_of_countries()} under different conditions.
 164       */
 165      public function test_get_list_of_countries() {
 166  
 167          $this->resetAfterTest();
 168          $stringman = get_string_manager();
 169  
 170          $countries = $stringman->get_list_of_countries(true);
 171          $this->assertIsArray($countries);
 172          $this->assertArrayHasKey('AU', $countries);
 173          $this->assertArrayHasKey('BE', $countries);
 174          $this->assertArrayHasKey('CZ', $countries);
 175          $this->assertArrayHasKey('ES', $countries);
 176          $this->assertGreaterThan(4, count($countries));
 177  
 178          set_config('allcountrycodes', '');
 179          $countries = $stringman->get_list_of_countries(false);
 180          $this->assertArrayHasKey('AU', $countries);
 181          $this->assertArrayHasKey('BE', $countries);
 182          $this->assertArrayHasKey('CZ', $countries);
 183          $this->assertArrayHasKey('ES', $countries);
 184          $this->assertGreaterThan(4, count($countries));
 185  
 186          set_config('allcountrycodes', 'CZ,BE');
 187          $countries = $stringman->get_list_of_countries(true);
 188          $this->assertArrayHasKey('AU', $countries);
 189          $this->assertArrayHasKey('BE', $countries);
 190          $this->assertArrayHasKey('CZ', $countries);
 191          $this->assertArrayHasKey('ES', $countries);
 192          $this->assertGreaterThan(4, count($countries));
 193  
 194          $countries = $stringman->get_list_of_countries(false);
 195          $this->assertEquals(2, count($countries));
 196          $this->assertArrayHasKey('BE', $countries);
 197          $this->assertArrayHasKey('CZ', $countries);
 198  
 199          set_config('allcountrycodes', 'CZ,UVWXYZ');
 200          $countries = $stringman->get_list_of_countries();
 201          $this->assertArrayHasKey('CZ', $countries);
 202          $this->assertEquals(1, count($countries));
 203  
 204          set_config('allcountrycodes', 'UVWXYZ');
 205          $countries = $stringman->get_list_of_countries();
 206          $this->assertArrayHasKey('AU', $countries);
 207          $this->assertArrayHasKey('BE', $countries);
 208          $this->assertArrayHasKey('CZ', $countries);
 209          $this->assertArrayHasKey('ES', $countries);
 210          $this->assertGreaterThan(4, count($countries));
 211      }
 212  }
 213  
 214  /**
 215   * Helper class providing testable string_manager
 216   *
 217   * @copyright 2013 David Mudrak <david@moodle.com>
 218   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 219   */
 220  class testable_core_string_manager extends core_string_manager_standard {
 221  
 222      /**
 223       * Factory method
 224       *
 225       * @param string $otherroot full path to the location of installed upstream language packs
 226       * @param string $localroot full path to the location of locally customized language packs, defaults to $otherroot
 227       * @param bool $usecache use application permanent cache
 228       * @param array $translist explicit list of visible translations
 229       * @param string $menucache the location of a file that caches the list of available translations
 230       * @return testable_core_string_manager
 231       */
 232      public static function instance($otherroot, $localroot = null, $usecache = false, array $translist = array(), $menucache = null) {
 233          global $CFG;
 234  
 235          if (is_null($localroot)) {
 236              $localroot = $otherroot;
 237          }
 238  
 239          if (is_null($menucache)) {
 240              $menucache = $CFG->cachedir.'/languages';
 241          }
 242  
 243          return new testable_core_string_manager($otherroot, $localroot, $usecache, $translist, $menucache);
 244      }
 245  
 246      public function get_all_deprecated_strings() {
 247          return array_flip($this->load_deprecated_strings());
 248      }
 249  }