[Summary view]

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 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  /**
  18   * Provides core_update_api_testcase class.
  19   *
  20   * @package     core_plugin
  21   * @category    test
  22   * @copyright   2015 David Mudrak <david@moodle.com>
  23   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  global $CFG;
  29  require_once (__DIR__.'/fixtures/testable_update_api.php');
  30  
  31  /**
  32   * Tests for \core\update\api client.
  33   *
  34   * Please note many of these tests heavily depend on the behaviour of the
  35   * testable_api client. It is important to make sure that the behaviour of the
  36   * testable_api client perfectly matches the actual behaviour of the live
  37   * services on the given API version.
  38   *
  39   * @copyright 2015 David Mudrak <david@moodle.com>
  40   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class core_update_api_testcase extends advanced_testcase {
  43  
  44      /**
  45       * Make sure the $CFG->branch is mapped correctly to the format used by the API.
  46       */
  47      public function test_convert_branch_numbering_format() {
  48  
  49          $client = \core\update\testable_api::client();
  50  
  51          $this->assertSame('2.9', $client->convert_branch_numbering_format(29));
  52          $this->assertSame('3.0', $client->convert_branch_numbering_format('30'));
  53          $this->assertSame('3.1', $client->convert_branch_numbering_format(3.1));
  54          $this->assertSame('3.1', $client->convert_branch_numbering_format('3.1'));
  55          $this->assertSame('10.1', $client->convert_branch_numbering_format(101));
  56          $this->assertSame('10.2', $client->convert_branch_numbering_format('102'));
  57      }
  58  
  59      /**
  60       * Getting info about particular plugin version.
  61       */
  62      public function test_get_plugin_info() {
  63  
  64          $client = \core\update\testable_api::client();
  65  
  66          // The plugin is not found in the plugins directory.
  67          $this->assertFalse($client->get_plugin_info('non_existing', 2015093000));
  68  
  69          // The plugin is known but there is no such version.
  70          $info = $client->get_plugin_info('foo_bar', 2014010100);
  71          $this->assertInstanceOf('\core\update\remote_info', $info);
  72          $this->assertFalse($info->version);
  73  
  74          // Both plugin and the version are available.
  75          foreach (array(2015093000 => MATURITY_STABLE, 2015100400 => MATURITY_STABLE,
  76                  2015100500 => MATURITY_BETA) as $version => $maturity) {
  77              $info = $client->get_plugin_info('foo_bar', $version);
  78              $this->assertInstanceOf('\core\update\remote_info', $info);
  79              $this->assertNotEmpty($info->version);
  80              $this->assertEquals($maturity, $info->version->maturity);
  81          }
  82      }
  83  
  84      /**
  85       * Getting info about the most suitable plugin version for us.
  86       */
  87      public function test_find_plugin() {
  88  
  89          $client = \core\update\testable_api::client();
  90  
  91          // The plugin is not found in the plugins directory.
  92          $this->assertFalse($client->find_plugin('non_existing'));
  93  
  94          // The plugin is known but there is no sufficient version.
  95          $info = $client->find_plugin('foo_bar', 2016010100);
  96          $this->assertFalse($info->version);
  97  
  98          // Both plugin and the version are available. Of the two available
  99          // stable versions, the more recent one is returned.
 100          $info = $client->find_plugin('foo_bar', 2015093000);
 101          $this->assertInstanceOf('\core\update\remote_info', $info);
 102          $this->assertEquals(2015100400, $info->version->version);
 103  
 104          // If any version is required, the most recent most mature one is
 105          // returned.
 106          $info = $client->find_plugin('foo_bar', ANY_VERSION);
 107          $this->assertInstanceOf('\core\update\remote_info', $info);
 108          $this->assertEquals(2015100400, $info->version->version);
 109  
 110          // Less matured versions are returned if needed.
 111          $info = $client->find_plugin('foo_bar', 2015100500);
 112          $this->assertInstanceOf('\core\update\remote_info', $info);
 113          $this->assertEquals(2015100500, $info->version->version);
 114      }
 115  
 116      /**
 117       * Validating the pluginfo.php response data.
 118       */
 119      public function test_validate_pluginfo_format() {
 120  
 121          $client = \core\update\testable_api::client();
 122  
 123          $json = '{"id":127,"name":"Course contents","component":"block_course_contents","source":"https:\/\/github.com\/mudrd8mz\/moodle-block_course_contents","doc":"http:\/\/docs.moodle.org\/20\/en\/Course_contents_block","bugs":"https:\/\/github.com\/mudrd8mz\/moodle-block_course_contents\/issues","discussion":null,"version":{"id":8100,"version":"2015030300","release":"3.0","maturity":200,"downloadurl":"https:\/\/moodle.org\/plugins\/download.php\/8100\/block_course_contents_moodle29_2015030300.zip","downloadmd5":"8d8ae64822f38d278420776f8b42eaa5","vcssystem":"git","vcssystemother":null,"vcsrepositoryurl":"https:\/\/github.com\/mudrd8mz\/moodle-block_course_contents","vcsbranch":"master","vcstag":"v3.0","supportedmoodles":[{"version":2014041100,"release":"2.7"},{"version":2014101000,"release":"2.8"},{"version":2015041700,"release":"2.9"}]}}';
 124  
 125          $data = json_decode($json);
 126          $this->assertInstanceOf('\core\update\remote_info', $client->validate_pluginfo_format($data));
 127          $this->assertEquals(json_encode($data), json_encode($client->validate_pluginfo_format($data)));
 128  
 129          // All properties must be present.
 130          unset($data->version);
 131          $this->assertFalse($client->validate_pluginfo_format($data));
 132  
 133          $data->version = false;
 134          $this->assertEquals(json_encode($data), json_encode($client->validate_pluginfo_format($data)));
 135  
 136          // Some properties may be empty.
 137          $data = json_decode($json);
 138          $data->version->release = null;
 139          $this->assertEquals(json_encode($data), json_encode($client->validate_pluginfo_format($data)));
 140  
 141          // Some properties must not be empty.
 142          $data = json_decode($json);
 143          $data->version->downloadurl = '';
 144          $this->assertFalse($client->validate_pluginfo_format($data));
 145  
 146          // Download URL may be http:// or https:// only.
 147          $data = json_decode($json);
 148          $data->version->downloadurl = 'ftp://archive.moodle.org/block_course_contents/2014041100.zip';
 149          $this->assertFalse($client->validate_pluginfo_format($data));
 150      }
 151  }