tests/phpunit/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         /**
  32          * Returns objects that can serve as elements in the concrete
  33          * GenericArrayObject deriving class being tested.
  34          *
  35          * @since 1.20
  36          *
  37          * @return array
  38          */
  39         abstract public function elementInstancesProvider();
  40
  41         /**
  42          * Returns the name of the concrete class being tested.
  43          *
  44          * @since 1.20
  45          *
  46          * @return string
  47          */
  48         abstract public function getInstanceClass();
  49
  50         /**
  51          * Provides instances of the concrete class being tested.
  52          *
  53          * @since 1.20
  54          *
  55          * @return array
  56          */
  57         public function instanceProvider() {
  58                 $instances = [];
  59
  60                 foreach ( $this->elementInstancesProvider() as $elementInstances ) {
  61                         $instances[] = $this->getNew( $elementInstances[0] );
  62                 }
  63
  64                 return $this->arrayWrap( $instances );
  65         }
  66
  67         /**
  68          * @since 1.20
  69          *
  70          * @param array $elements
  71          *
  72          * @return GenericArrayObject
  73          */
  74         protected function getNew( array $elements = [] ) {
  75                 $class = $this->getInstanceClass();
  76
  77                 return new $class( $elements );
  78         }
  79
  80         /**
  81          * @dataProvider elementInstancesProvider
  82          *
  83          * @since 1.20
  84          *
  85          * @param array $elements
  86          *
  87          * @covers GenericArrayObject::__construct
  88          */
  89         public function testConstructor( array $elements ) {
  90                 $arrayObject = $this->getNew( $elements );
  91
  92                 $this->assertEquals( count( $elements ), $arrayObject->count() );
  93         }
  94
  95         /**
  96          * @dataProvider elementInstancesProvider
  97          *
  98          * @since 1.20
  99          *
 100          * @param array $elements
 101          *
 102          * @covers GenericArrayObject::isEmpty
 103          */
 104         public function testIsEmpty( array $elements ) {
 105                 $arrayObject = $this->getNew( $elements );
 106
 107                 $this->assertEquals( $elements === [], $arrayObject->isEmpty() );
 108         }
 109
 110         /**
 111          * @dataProvider instanceProvider
 112          *
 113          * @since 1.20
 114          *
 115          * @param GenericArrayObject $list
 116          *
 117          * @covers GenericArrayObject::offsetUnset
 118          */
 119         public function testUnset( GenericArrayObject $list ) {
 120                 if ( $list->isEmpty() ) {
 121                         $this->assertTrue( true ); // We cannot test unset if there are no elements
 122                 } else {
 123                         $offset = $list->getIterator()->key();
 124                         $count = $list->count();
 125                         $list->offsetUnset( $offset );
 126                         $this->assertEquals( $count - 1, $list->count() );
 127                 }
 128
 129                 if ( !$list->isEmpty() ) {
 130                         $offset = $list->getIterator()->key();
 131                         $count = $list->count();
 132                         unset( $list[$offset] );
 133                         $this->assertEquals( $count - 1, $list->count() );
 134                 }
 135         }
 136
 137         /**
 138          * @dataProvider elementInstancesProvider
 139          *
 140          * @since 1.20
 141          *
 142          * @param array $elements
 143          *
 144          * @covers GenericArrayObject::append
 145          */
 146         public function testAppend( array $elements ) {
 147                 $list = $this->getNew();
 148
 149                 $listSize = count( $elements );
 150
 151                 foreach ( $elements as $element ) {
 152                         $list->append( $element );
 153                 }
 154
 155                 $this->assertEquals( $listSize, $list->count() );
 156
 157                 $list = $this->getNew();
 158
 159                 foreach ( $elements as $element ) {
 160                         $list[] = $element;
 161                 }
 162
 163                 $this->assertEquals( $listSize, $list->count() );
 164
 165                 $this->checkTypeChecks( function ( GenericArrayObject $list, $element ) {
 166                         $list->append( $element );
 167                 } );
 168         }
 169
 170         /**
 171          * @since 1.20
 172          *
 173          * @param callable $function
 174          *
 175          * @covers GenericArrayObject::getObjectType
 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          *
 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 }