MDL-26914 Added new language pack installer class and unit tests for it

The new class wraps some common coding patterns to install a language pack via component_installer. Most notably it deals with the parental dependency of the language packs. The new class should also be the only place holding the information about the location of language packs for the given Moodle version.
2011-03-31 12:20:54 +02:00
parent dae6b38c51
commit 15e16f0e93
2 changed files with 379 additions and 0 deletions
@@ -58,6 +58,121 @@ class componentlib_test extends UnitTestCase {
        //check if correct files were downloaded
        $this->assertEqual('2af180e813dc3f446a9bb7b6af87ce24', md5_file($destpath.'/'.'test.jpg'));
        $this->assertEqual('47250a973d1b88d9445f94db4ef2c97a', md5_file($destpath.'/'.'test.html'));
+    }

+    /**
+     * Test the public API of the {@link lang_installer} class
+     */
+    public function test_lang_installer() {
+
+        // test the manipulation with the download queue
+        $installer = new testable_lang_installer();
+        $this->assertFalse($installer->protected_is_queued());
+        $installer->protected_add_to_queue('cs');
+        $installer->protected_add_to_queue(array('cs', 'sk'));
+        $this->assertTrue($installer->protected_is_queued());
+        $this->assertTrue($installer->protected_is_queued('cs'));
+        $this->assertTrue($installer->protected_is_queued('sk'));
+        $this->assertFalse($installer->protected_is_queued('de_kids'));
+        $installer->set_queue('de_kids');
+        $this->assertFalse($installer->protected_is_queued('cs'));
+        $this->assertFalse($installer->protected_is_queued('sk'));
+        $this->assertFalse($installer->protected_is_queued('de'));
+        $this->assertFalse($installer->protected_is_queued('de_du'));
+        $this->assertTrue($installer->protected_is_queued('de_kids'));
+        $installer->set_queue(array('cs', 'de_kids'));
+        $this->assertTrue($installer->protected_is_queued('cs'));
+        $this->assertFalse($installer->protected_is_queued('sk'));
+        $this->assertFalse($installer->protected_is_queued('de'));
+        $this->assertFalse($installer->protected_is_queued('de_du'));
+        $this->assertTrue($installer->protected_is_queued('de_kids'));
+        $installer->set_queue(array());
+        $this->assertFalse($installer->protected_is_queued());
+        unset($installer);
+
+        // install a set of lang packs
+        $installer = new testable_lang_installer(array('cs', 'de_kids', 'xx'));
+        $result = $installer->run();
+        $this->assertEqual($result['cs'], lang_installer::RESULT_UPTODATE);
+        $this->assertEqual($result['de_kids'], lang_installer::RESULT_INSTALLED);
+        $this->assertEqual($result['xx'], lang_installer::RESULT_DOWNLOADERROR);
+        // the following two were automatically added to the queue
+        $this->assertEqual($result['de_du'], lang_installer::RESULT_INSTALLED);
+        $this->assertEqual($result['de'], lang_installer::RESULT_UPTODATE);
+
+        // exception throwing
+        $installer = new testable_lang_installer(array('yy'));
+        $this->expectException('lang_installer_exception');
+        $installer->run();
+    }
+}
+
+/**
+ * Testable lang_installer subclass that does not actually install anything
+ * and provides access to the protected methods of the parent class
+ *
+ * @copyright 2011 David Mudrak <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class testable_lang_installer extends lang_installer {
+
+    /**
+     * @see parent::is_queued()
+     */
+    public function protected_is_queued($langcode = '') {
+        return $this->is_queued($langcode);
+    }
+
+    /**
+     * @see parent::add_to_queue()
+     */
+    public function protected_add_to_queue($langcodes) {
+        return $this->add_to_queue($langcodes);
+    }
+
+    /**
+     * Simulate lang pack installation via component_installer
+     *
+     * Language packages 'de_du' and 'de_kids' reported as installed
+     * Language packages 'cs' and 'de' reported as up-to-date
+     * Language package 'xx' returns download error
+     * All other language packages will throw an unknown exception
+     *
+     * @see parent::install_language_pack()
+     */
+    protected function install_language_pack($langcode) {
+
+        switch ($langcode) {
+        case 'de_du':
+        case 'de_kids':
+            return self::RESULT_INSTALLED;
+
+        case 'cs':
+        case 'de':
+            return self::RESULT_UPTODATE;
+
+        case 'xx':
+            return self::RESULT_DOWNLOADERROR;
+
+        default:
+            throw new lang_installer_exception('testing-unknown-exception', $langcode);
+        }
+    }
+
+    /**
+     * Simulate detection of parent languge
+     *
+     * @see parent::get_parent_language()
+     */
+    protected function get_parent_language($langcode) {
+
+        switch ($langcode) {
+        case 'de_kids':
+            return 'de_du';
+        case 'de_du':
+            return 'de';
+        default:
+            return '';
+        }
    }
 }