tests/phpunit/includes/api/query/ApiQueryTestBase.php

   1 <?php
   2 /**
   3  * Created on Feb 10, 2013
   4  *
   5  * Copyright © 2013 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  * @file
  23  */
  24
  25 /** This class has some common functionality for testing query module
  26  */
  27 abstract class ApiQueryTestBase extends ApiTestCase {
  28
  29         const PARAM_ASSERT = <<<STR
  30 Each parameter must be an array of two elements,
  31 first - an array of params to the API call,
  32 and the second array - expected results as returned by the API
  33 STR;
  34
  35         /**
  36          * Merges all requests parameter + expected values into one
  37          * @param ... list of arrays, each of which contains exactly two
  38          * @return array
  39          */
  40         protected function merge( /*...*/ ) {
  41                 $request = array();
  42                 $expected = array();
  43                 foreach ( func_get_args() as $v ) {
  44                         list( $req, $exp ) = $this->validateRequestExpectedPair( $v );
  45                         $request = array_merge_recursive( $request, $req );
  46                         $this->mergeExpected( $expected, $exp );
  47                 }
  48
  49                 return array( $request, $expected );
  50         }
  51
  52         /**
  53          * Check that the parameter is a valid two element array,
  54          * with the first element being API request and the second - expected result
  55          */
  56         private function validateRequestExpectedPair( $v ) {
  57                 $this->assertType( 'array', $v, self::PARAM_ASSERT );
  58                 $this->assertEquals( 2, count( $v ), self::PARAM_ASSERT );
  59                 $this->assertArrayHasKey( 0, $v, self::PARAM_ASSERT );
  60                 $this->assertArrayHasKey( 1, $v, self::PARAM_ASSERT );
  61                 $this->assertType( 'array', $v[0], self::PARAM_ASSERT );
  62                 $this->assertType( 'array', $v[1], self::PARAM_ASSERT );
  63
  64                 return $v;
  65         }
  66
  67         /**
  68          * Recursively merges the expected values in the $item into the $all
  69          */
  70         private function mergeExpected( &$all, $item ) {
  71                 foreach ( $item as $k => $v ) {
  72                         if ( array_key_exists( $k, $all ) ) {
  73                                 if ( is_array( $all[$k] ) ) {
  74                                         $this->mergeExpected( $all[$k], $v );
  75                                 } else {
  76                                         $this->assertEquals( $all[$k], $v );
  77                                 }
  78                         } else {
  79                                 $all[$k] = $v;
  80                         }
  81                 }
  82         }
  83
  84         /**
  85          * Checks that the request's result matches the expected results.
  86          * @param array $values Array is a two element array( request, expected_results )
  87          * @throws Exception
  88          */
  89         protected function check( $values ) {
  90                 list( $req, $exp ) = $this->validateRequestExpectedPair( $values );
  91                 if ( !array_key_exists( 'action', $req ) ) {
  92                         $req['action'] = 'query';
  93                 }
  94                 foreach ( $req as &$val ) {
  95                         if ( is_array( $val ) ) {
  96                                 $val = implode( '|', array_unique( $val ) );
  97                         }
  98                 }
  99                 $result = $this->doApiRequest( $req );
 100                 $this->assertResult( array( 'query' => $exp ), $result[0], $req );
 101         }
 102
 103         protected function assertResult( $exp, $result, $message = '' ) {
 104                 try {
 105                         $exp = self::sanitizeResultArray( $exp );
 106                         $result = self::sanitizeResultArray( $result );
 107                         $this->assertEquals( $exp, $result );
 108                 } catch ( PHPUnit_Framework_ExpectationFailedException $e ) {
 109                         if ( is_array( $message ) ) {
 110                                 $message = http_build_query( $message );
 111                         }
 112                         throw new PHPUnit_Framework_ExpectationFailedException(
 113                                 $e->getMessage() . "\nRequest: $message",
 114                                 new PHPUnit_Framework_ComparisonFailure(
 115                                         $exp,
 116                                         $result,
 117                                         print_r( $exp, true ),
 118                                         print_r( $result, true ),
 119                                         false,
 120                                         $e->getComparisonFailure()->getMessage() . "\nRequest: $message"
 121                                 )
 122                         );
 123                 }
 124         }
 125
 126         /**
 127          * Recursively ksorts a result array and removes any 'pageid' keys.
 128          * @param array $result
 129          * @return array
 130          */
 131         private static function sanitizeResultArray( $result ) {
 132                 unset( $result['pageid'] );
 133                 foreach ( $result as $key => $value ) {
 134                         if ( is_array( $value ) ) {
 135                                 $result[$key] = self::sanitizeResultArray( $value );
 136                         }
 137                 }
 138
 139                 // Sort the result by keys, then take advantage of how array_merge will
 140                 // renumber numeric keys while leaving others alone.
 141                 ksort( $result );
 142                 return array_merge( $result );
 143         }
 144 }