[Summary view] [Print] [Text view]

   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   * Legacy SimpleTest layer.
  19   *
  20   * @deprecated since 2.3
  21   * @package    core
  22   * @category   phpunit
  23   * @author     Petr Skoda
  24   * @copyright  2012 Petr Skoda {@link http://skodak.org}
  25   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  26   */
  27  
  28  
  29  /**
  30   * Simplified emulation test case for legacy SimpleTest.
  31   *
  32   * Note: this is supposed to work for very simple tests only.
  33   *
  34   * @deprecated since 2.3
  35   * @package    core
  36   * @category   phpunit
  37   * @author     Petr Skoda
  38   * @copyright  2012 Petr Skoda {@link http://skodak.org}
  39   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40   */
  41  abstract class UnitTestCase extends PHPUnit_Framework_TestCase {
  42  
  43      /**
  44       * @deprecated since 2.3
  45       * @param bool $expected
  46       * @param string $message
  47       * @return void
  48       */
  49      public function expectException($expected, $message = '') {
  50          // alternatively use phpdocs: @expectedException ExceptionClassName
  51          if (!$expected) {
  52              return;
  53          }
  54          $this->setExpectedException('moodle_exception', $message);
  55      }
  56  
  57      /**
  58       * @deprecated since 2.3
  59       * @param bool $expected
  60       * @param string $message
  61       * @return void
  62       */
  63      public function expectError($expected = false, $message = '') {
  64          // alternatively use phpdocs: @expectedException PHPUnit_Framework_Error
  65          if (!$expected) {
  66              return;
  67          }
  68          $this->setExpectedException('PHPUnit_Framework_Error', $message);
  69      }
  70  
  71      /**
  72       * @deprecated since 2.3
  73       * @static
  74       * @param mixed $actual
  75       * @param string $messages
  76       * @return void
  77       */
  78      public static function assertTrue($actual, $messages = '') {
  79          parent::assertTrue((bool)$actual, $messages);
  80      }
  81  
  82      /**
  83       * @deprecated since 2.3
  84       * @static
  85       * @param mixed $actual
  86       * @param string $messages
  87       * @return void
  88       */
  89      public static function assertFalse($actual, $messages = '') {
  90          parent::assertFalse((bool)$actual, $messages);
  91      }
  92  
  93      /**
  94       * @deprecated since 2.3
  95       * @static
  96       * @param mixed $expected
  97       * @param mixed $actual
  98       * @param string $message
  99       * @return void
 100       */
 101      public static function assertEqual($expected, $actual, $message = '') {
 102          parent::assertEquals($expected, $actual, $message);
 103      }
 104  
 105      /**
 106       * @deprecated since 2.3
 107       * @static
 108       * @param mixed $expected
 109       * @param mixed $actual
 110       * @param float|int $margin
 111       * @param string $message
 112       * @return void
 113       */
 114      public static function assertWithinMargin($expected, $actual, $margin, $message = '') {
 115          parent::assertEquals($expected, $actual, '', $margin, $message);
 116      }
 117  
 118      /**
 119       * @deprecated since 2.3
 120       * @static
 121       * @param mixed $expected
 122       * @param mixed $actual
 123       * @param string $message
 124       * @return void
 125       */
 126      public static function assertNotEqual($expected, $actual, $message = '') {
 127          parent::assertNotEquals($expected, $actual, $message);
 128      }
 129  
 130      /**
 131       * @deprecated since 2.3
 132       * @static
 133       * @param mixed $expected
 134       * @param mixed $actual
 135       * @param string $message
 136       * @return void
 137       */
 138      public static function assertIdentical($expected, $actual, $message = '') {
 139          parent::assertSame($expected, $actual, $message);
 140      }
 141  
 142      /**
 143       * @deprecated since 2.3
 144       * @static
 145       * @param mixed $expected
 146       * @param mixed $actual
 147       * @param string $message
 148       * @return void
 149       */
 150      public static function assertNotIdentical($expected, $actual, $message = '') {
 151          parent::assertNotSame($expected, $actual, $message);
 152      }
 153  
 154      /**
 155       * @deprecated since 2.3
 156       * @static
 157       * @param mixed $actual
 158       * @param mixed $expected
 159       * @param string $message
 160       * @return void
 161       */
 162      public static function assertIsA($actual, $expected, $message = '') {
 163          if ($expected === 'array') {
 164              parent::assertEquals('array', gettype($actual), $message);
 165          } else {
 166              parent::assertInstanceOf($expected, $actual, $message);
 167          }
 168      }
 169  
 170      /**
 171       * @deprecated since 2.3
 172       * @static
 173       * @param mixed $pattern
 174       * @param mixed $string
 175       * @param string $message
 176       * @return void
 177       */
 178      public static function assertPattern($pattern, $string, $message = '') {
 179          parent::assertRegExp($pattern, $string, $message);
 180      }
 181  
 182      /**
 183       * @deprecated since 2.3
 184       * @static
 185       * @param mixed $pattern
 186       * @param mixed $string
 187       * @param string $message
 188       * @return void
 189       */
 190      public static function assertNotPattern($pattern, $string, $message = '') {
 191          parent::assertNotRegExp($pattern, $string, $message);
 192      }
 193  }