tests/phpunit/unit/includes/libs/GenericArrayObjectTest.php

   1 <?php
   2
   3 /**
   4  * Tests for the GenericArrayObject and deriving classes.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  * @since 1.20
  23  *
  24  * @ingroup Test
  25  * @group GenericArrayObject
  26  *
  27  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  28  */
  29 abstract class GenericArrayObjectTest extends PHPUnit\Framework\TestCase {
  30
  31         use MediaWikiCoversValidator;
  32
  33         /**
  34          * Returns objects that can serve as elements in the concrete
  35          * GenericArrayObject deriving class being tested.
  36          *
  37          * @since 1.20
  38          *
  39          * @return array
  40          */
  41         abstract public function elementInstancesProvider();
  42
  43         /**
  44          * Returns the name of the concrete class being tested.
  45          *
  46          * @since 1.20
  47          *
  48          * @return string
  49          */
  50         abstract public function getInstanceClass();
  51
  52         /**
  53          * Provides instances of the concrete class being tested.
  54          *
  55          * @since 1.20
  56          *
  57          * @return array
  58          */
  59         public function instanceProvider() {
  60                 $instances = [];
  61
  62                 foreach ( $this->elementInstancesProvider() as $elementInstances ) {
  63                         $instances[] = $this->getNew( $elementInstances[0] );
  64                 }
  65
  66                 return $this->arrayWrap( $instances );
  67         }
  68
  69         /**
  70          * @since 1.20
  71          *
  72          * @param array $elements
  73          *
  74          * @return GenericArrayObject
  75          */
  76         protected function getNew( array $elements = [] ) {
  77                 $class = $this->getInstanceClass();
  78
  79                 return new $class( $elements );
  80         }
  81
  82         /**
  83          * @dataProvider elementInstancesProvider
  84          *
  85          * @since 1.20
  86          *
  87          * @param array $elements
  88          *
  89          * @covers GenericArrayObject::__construct
  90          */
  91         public function testConstructor( array $elements ) {
  92                 $arrayObject = $this->getNew( $elements );
  93
  94                 $this->assertEquals( count( $elements ), $arrayObject->count() );
  95         }
  96
  97         /**
  98          * @dataProvider elementInstancesProvider
  99          *
 100          * @since 1.20
 101          *
 102          * @param array $elements
 103          *
 104          * @covers GenericArrayObject::isEmpty
 105          */
 106         public function testIsEmpty( array $elements ) {
 107                 $arrayObject = $this->getNew( $elements );
 108
 109                 $this->assertEquals( $elements === [], $arrayObject->isEmpty() );
 110         }
 111
 112         /**
 113          * @dataProvider instanceProvider
 114          *
 115          * @since 1.20
 116          *
 117          * @param GenericArrayObject $list
 118          *
 119          * @covers GenericArrayObject::offsetUnset
 120          */
 121         public function testUnset( GenericArrayObject $list ) {
 122                 if ( $list->isEmpty() ) {
 123                         $this->assertTrue( true ); // We cannot test unset if there are no elements
 124                 } else {
 125                         $offset = $list->getIterator()->key();
 126                         $count = $list->count();
 127                         $list->offsetUnset( $offset );
 128                         $this->assertEquals( $count - 1, $list->count() );
 129                 }
 130
 131                 if ( !$list->isEmpty() ) {
 132                         $offset = $list->getIterator()->key();
 133                         $count = $list->count();
 134                         unset( $list[$offset] );
 135                         $this->assertEquals( $count - 1, $list->count() );
 136                 }
 137         }
 138
 139         /**
 140          * @dataProvider elementInstancesProvider
 141          *
 142          * @since 1.20
 143          *
 144          * @param array $elements
 145          *
 146          * @covers GenericArrayObject::append
 147          */
 148         public function testAppend( array $elements ) {
 149                 $list = $this->getNew();
 150
 151                 $listSize = count( $elements );
 152
 153                 foreach ( $elements as $element ) {
 154                         $list->append( $element );
 155                 }
 156
 157                 $this->assertEquals( $listSize, $list->count() );
 158
 159                 $list = $this->getNew();
 160
 161                 foreach ( $elements as $element ) {
 162                         $list[] = $element;
 163                 }
 164
 165                 $this->assertEquals( $listSize, $list->count() );
 166
 167                 $this->checkTypeChecks( function ( GenericArrayObject $list, $element ) {
 168                         $list->append( $element );
 169                 } );
 170         }
 171
 172         /**
 173          * @since 1.20
 174          *
 175          * @param callable $function
 176          */
 177         protected function checkTypeChecks( $function ) {
 178                 $excption = null;
 179                 $list = $this->getNew();
 180
 181                 $elementClass = $list->getObjectType();
 182
 183                 foreach ( [ 42, 'foo', [], new stdClass(), 4.2 ] as $element ) {
 184                         $validValid = $element instanceof $elementClass;
 185
 186                         try {
 187                                 call_user_func( $function, $list, $element );
 188                                 $valid = true;
 189                         } catch ( InvalidArgumentException $exception ) {
 190                                 $valid = false;
 191                         }
 192
 193                         $this->assertEquals(
 194                                 $validValid,
 195                                 $valid,
 196                                 'Object of invalid type got successfully added to a GenericArrayObject'
 197                         );
 198                 }
 199         }
 200
 201         /**
 202          * @dataProvider elementInstancesProvider
 203          *
 204          * @since 1.20
 205          *
 206          * @param array $elements
 207          * @covers GenericArrayObject::getObjectType
 208          * @covers GenericArrayObject::offsetSet
 209          */
 210         public function testOffsetSet( array $elements ) {
 211                 if ( $elements === [] ) {
 212                         $this->assertTrue( true );
 213
 214                         return;
 215                 }
 216
 217                 $list = $this->getNew();
 218
 219                 $element = reset( $elements );
 220                 $list->offsetSet( 42, $element );
 221                 $this->assertEquals( $element, $list->offsetGet( 42 ) );
 222
 223                 $list = $this->getNew();
 224
 225                 $element = reset( $elements );
 226                 $list['oHai'] = $element;
 227                 $this->assertEquals( $element, $list['oHai'] );
 228
 229                 $list = $this->getNew();
 230
 231                 $element = reset( $elements );
 232                 $list->offsetSet( 9001, $element );
 233                 $this->assertEquals( $element, $list[9001] );
 234
 235                 $list = $this->getNew();
 236
 237                 $element = reset( $elements );
 238                 $list->offsetSet( null, $element );
 239                 $this->assertEquals( $element, $list[0] );
 240
 241                 $list = $this->getNew();
 242                 $offset = 0;
 243
 244                 foreach ( $elements as $element ) {
 245                         $list->offsetSet( null, $element );
 246                         $this->assertEquals( $element, $list[$offset++] );
 247                 }
 248
 249                 $this->assertEquals( count( $elements ), $list->count() );
 250
 251                 $this->checkTypeChecks( function ( GenericArrayObject $list, $element ) {
 252                         $list->offsetSet( mt_rand(), $element );
 253                 } );
 254         }
 255
 256         /**
 257          * @dataProvider instanceProvider
 258          *
 259          * @since 1.21
 260          *
 261          * @param GenericArrayObject $list
 262          *
 263          * @covers GenericArrayObject::getSerializationData
 264          * @covers GenericArrayObject::serialize
 265          * @covers GenericArrayObject::unserialize
 266          */
 267         public function testSerialization( GenericArrayObject $list ) {
 268                 $serialization = serialize( $list );
 269                 $copy = unserialize( $serialization );
 270
 271                 $this->assertEquals( $serialization, serialize( $copy ) );
 272                 $this->assertEquals( count( $list ), count( $copy ) );
 273
 274                 $list = $list->getArrayCopy();
 275                 $copy = $copy->getArrayCopy();
 276
 277                 $this->assertArrayEquals( $list, $copy, true, true );
 278         }
 279 }